Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 3.9 KB

README.md

File metadata and controls

91 lines (59 loc) · 3.9 KB
Raw

KeePass for Stream Deck

Description

Simple interface to retrieve information from a KeePass database and generate passwords using KeePassLib.

I wanted to learn how to use the Elgato Stream Deck SDK using BarRaider's Stream Deck Tools, so I created this simple plug-in.

Features

Retrieve

It retrieves a field of a stored entry from a .kdbx file and copies it to the clipboard.

It uses the following configuration:

  • KeePass db path. The absolute path to the KeePass file.
  • KeePass db password. The main password of the KeePass file.
  • Entry Name or UUID. The name or UUID of the entry that has the desired information.
  • Field to retrieve. The field whose content will be copied to the clipboard
    • Password
    • Username
    • Notes
    • URL
  • Clear Time. The time in seconds to keep the value in the clipboard. Use 0 to leave it indefinitely (default).

Generate

it will generate a random password using KeePassLib using the given configuration.

It uses the following configuration:

  • Password Length. Default 20.
  • Lower Case. abcdefghijklmnopqrstuvwxyz. Default true.
  • Upper Case. ABCDEFGHIJKLMNOPQRSTUVWXYZ. Default true.
  • Use Digits. 0123456789. Default true.
  • Use Punctuation. ,.;:. Default true.
  • Use Brackets. ()[]{}<>. Default true.
  • Use Special Characters. !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~. Default true.
  • Exclude Look-Alike characters. It will avoid using two character that look similar, like O and 0. Default false.
  • Must occur at most Once. It will prevent characters from appearing more than once. Default false.
  • Characters to Exclude. Any character included in the text field will be excluded from the generated password.
  • Custom Pattern. Allows to use a custom defined password generation pattern. Refer to the section Generating Passwords that Follow Rules of KeePass Password Generator documentation.
    • Note: Using a custom pattern will override all the previous configuration.
  • Clear Time. The time in seconds to keep the value in the clipboard. Use 0 to leave it indefinitely (default).

Check KeePass Password Generator help site for more information.

Aware

Its function its identical to Retrieve, except it retrieves the stored field based on the current active window.

It only replaces the Entry Name option with a new one:

  • Process Mapping. A key=value that maps a running process with a KeePass entry title/UUID.
    • Examples:
      • steam.exe=Steam
      • Discord.exe=2A8CC713A463524C928E1F613BA10DAC
    • Add one mapping per line.

MircoBabin's KeePassCommander

It allows direct communication with the KeePass application to retrieve a field of a stored entry to the clipboard. Note: It requires the KeePassCommander plugin for KeePass.

It uses the following configuration:

  • CommandDLL path. The absolute path to the KeePassCommandDll.dll.
  • Entry Name. The name of the entry that has the desired information.
    • Note: It does not support search by UUID.
  • Field to retrieve. The field whose content will be copied to the clipboard
    • Password
    • Username
    • Notes
    • URL
  • Clear Time. The time in seconds to keep the value in the clipboard. Use 0 to leave it indefinitely (default).

My other Stream Deck plugins

The icon for this action is a modified version of iOS Filled at Icon8.