Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 5.64 KB

README.md

File metadata and controls

97 lines (69 loc) · 5.64 KB
Raw

Keypirinha Plugin: pass

This is a plugin for the Keypirinha launcher that provides an interface to a password store. I wanted passmenu for Windows.

Download

https://github.com/clarkb7/keypirinha-pass/releases

Quick Install

Once the pass.keypirinha-package file is downloaded, move it to the InstalledPackage folder located at:

  • Keypirinha\portable\Profile\InstalledPackages in Portable mode
  • Or %APPDATA%\Keypirinha\InstalledPackages in Installed mode

Usage

To display a list of your password files, activate keypirinha (default Ctrl+Win+K), type Password Store until the item comes up then press tab.

To temporarily copy the password to your clipboard, select a password file in the list and activate it (press enter).

To display each line in a password file, select it in the list and press tab. By default, pass will censor the first line (the password) of a file. Subsequent lines that follow the recommended KEY: VALUE syntax will display only the KEY part. If a line does not contain a KEY: VALUE pair, the full line will be censored. If you activate (press enter) a KEY line, only the VALUE part will be temporarily copied to your clipboard (even though it is not shown in keypirinha).

Configuration

IMPORTANT: The following options affect the security of your data and you should be aware of them and their default values.

  • safe_keys - Each KEY in this list will always have its VALUE part shown in keypirinha. Default: ["URL", "Username"]
  • show_secrets - Always show every line in full and uncensored in keypirinha. Default: False
  • clip_time - Number of seconds to wait before restoring the clipboard. Default: 45
  • save_history - Save selected password file names to keypirinha history. Default: True

See the configuration file for other options and their descriptions.

To view and edit the current configuration, right click the Keypirinha icon in the system tray, mouse over Configure Package, and click pass.

Backends

There are two backends implemented for decrypting your password files. You may configure which is used, all keypirinha-pass features are supported by both backends.

Gpg4win

Depends

WSL

Depends

  • WSL installed
  • bash.exe on Windows %PATH%
  • pass installed in WSL
  • pass and wslpath on WSL $PATH

Detailed Installation

Keypirinha

For the best instructions follow the Keypirinha installation guide.

  1. Download Keypirinha
    • Keypirinha is distributed inside a 7z archive. You will need the amazing 7-Zip tool to extract it.
  2. Right click the Keypirinha archive, choose 7-Zip -> Extract to keypirinha-full-portable
  3. Copy the Keypirinha directory somewhere, such as %APPDATA% (type it into the Windows explorer bar)
  4. Run keypirinha.exe from the new location

keypirinha-pass plugin

  1. Download the latest pass.keypirinha-package release
  2. Copy the downloaded pass.keypirinha-package to your Keypirinha InstalledPackages directory
    • Shortcut: Right click the Keypirinha icon in the system tray and click Browse Profile Dir

Choosing a backend

There are two backends implemented for decrypting your password files. You may configure which is used, all keypirinha-pass features are supported by both backends.

If you are running a version of Windows BELOW Windows 10 1803 (Build 17134), you must use Gpg4win.

  • To check which version you are running, press Win+r to open the run prompt, type winver and press Enter.

I recommend using WSL as it wlll enable you to use the full password-store ecosystem and plugin suites; using keypirinha-pass only to conveniently retrieve passwords and fields. However, if you do not have administrative privileges, use an old version of Windows, or only need read-only access to an existing password store from this computer, then Gpg4win may be the right choice.

Installing Gpg4win

  1. Download Gpg4win
  2. Run the installer and follow the prompts
    • Administrator privileges are not required, without it will be installed to %LOCALAPPDATA%. The installer should automatically add gpg.exe to your Windows %PATH%
  3. Import your GPG key: gpg.exe --import C:\path\to\private.key, substituting the correct path
  4. Place your password store somewhere, such as %USERPROFILE%\.password-store
    • Edit the keypirinha-pass configuration to add path = C:\path\to\.password-store, substituting the correct path, under the [pass] section
  5. Edit the keypirinha-pass configuration to add backend = gpg4win under the [main] section

Installing WSL + password-store

  1. Follow the WSL installation instructions
  2. Follow the password-store download instructions for the Linux distribution chosen during WSL installation
  3. Follow the password-store initialization instructions to create a password store

Credits

Icon made by Pixel perfect from www.flaticon.com