ktwombley / PoShKeePass

PowerShell module for KeePass

PowerShell KeePass

PoShKeePass is a PowerShell module that combines the ease of the PowerShell cli and the extensibility of the KeePassLib API to provide a powerful and easy to use management and automating platform for KeePass databases.

Features

1. Database Configuration Profiles - Supports mutliple databases and authentication options.
2. Getting, Creating, Updating, and Removing KeePass Entries and Groups - All of these perform as much automatic database authentication as possible using the database configuration profile. For databases that use a masterkey (password) it will prompt for it.
3. Generating KeePass Passwords - Supports most character sets and advanced keepass options. Also supports creating password profiles that can be specified to create a new password with the same rule set.

Getting Started

Install

Install-Module -Name PoShKeePass

Documentation

Please check out our Getting Started documentation on our wiki.

Important Notes & Reminders

1. Please always keep up to date backups of your KeePass database files .kdbx and .key files.
2. The module uses the KeePassLib 2.3.x which is embedded in the module file.
3. This module was built and tested in PowerShell 5 on Windows 10 but should work in PowerShell 4 and Windows 8.1 and Server 2012 R2 and up. It may work in some earlier versions but is currently untested and not supported. If you come across issues create an issue and I will look into fixing it or create a pull request.
4. There is an underlying framework that I wrote into the module to make all of the api calls that I will eventually expose for advanced scripting.

Changelog

Please review the changelog document for a full history.

v2.0.4.5

• #135 - Restructured Module to a more modular structure. Single file per function, seperate root folders for exported functions vs internal functions, (functions, internal).
• Added global variable $Global:KeePassConfigurationFile with the path of the config file and updated all references to file.
• Updated formatting of readme and changelog to abide by md standards.

v2.0.4.4

• Some Community PR here, great help thank you
• #53, #117 -AsPSCredential Support to Get-KeePassEntry
• -Title Parameter Added to Get-KeePassEntry
• General bug fixes #115, #116, #120, #123, #127
• New-KeePassDatabase function added

v2.0.4.3

• #133 Fixed

v2.0.4.1

• #132 Fixed - Windows Defender identifies PoshKeepass as trojan. Please see the issue for more details.

v2.0.4.0

• #108 Fixed bug by capturing PSCredential to MasterKey variable.

Known Issues

See the Known-Issue tag to get a list of known issues and their status.

Contributing

• If you are insterested in fixing issues and contributing directly to the code base, please see the documentation on How to Contribute.
• If you come across a bug or have a feature request feel free to create an issue with the appropriate label.

Shout-Outs

• PSKeePass would like to thank Jason Fossen for his initial work with KeePass in PowerShell.
• PSKeePass would like to thank Andrzej Pilacik (aka @cypisek77) for his review and feedback on documentation and over all rubber ducking.

License

Copyright (c) John Klann, Christian Lehrer. All rights reserved.

Licensed under the MIT License.