Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 2.46 KB

passwordgen.md

File metadata and controls

39 lines (29 loc) · 2.46 KB

passwordgen

A simple CLI password generator (in python)

Requirements

  • python3
  • tkinter (optional, for clipboard)
  • python-dbus (optional, for clipboard on kde)
  • termux-api (optional, for clipboard on termux)

Installation

Install the requirements, if not already met.

Clone the repo & add it to the PATH, or download the file, put it in a directory on the PATH (such as /usr/local/bin, or ~/.local/bin) and mark it executable.

Usage

Run the file from the terminal (by typing passwordgen). A random, url-safe string of characters will be generated & displayed in the terminal. By default the string will be 64 characters long, but that can be changed by including a number after the command.

Using environment variables to alter program's behaviour

passwordgen accepts advanced parameters through environment variables. The variable names are case sensitive. Variable values are not case sensitive. They and their meaning are listed below:

  • MBPASS_TYPE: Specifies the type of generated password and the allowed character set. Possible values:
    • urlsafe: Default. Uses secrets.token_urlsafe() to generate the password. Can contain letters, numbers and the characters: -_
    • alphanum: Picks from a list of alphanumerical characters. Can contain letters and numbers
    • ascii: Picks from a list of printable ascii characters, excluding whitespace. Can contain letters, numbers and punctuation.
    • base64/b64: Encodes bytes from secrets.token_bytes() using base64 to generate the password.
    • hex: Uses secrets.token_hex() to generate the password. Can contain numbers and lowercase letters a-f.
  • MBPASS_MODE: Specifies where the generated password will be displayed. Possible values:
    • print/terminal: Default mode. Prints the password on the terminal.
    • copy/clipboard: Copies the password into the clipboard. May require extra dependencies, see MBPASS_CLIPBOARD
    • both: Prints the password on the terminal & copies it into the clipboard. May require extra dependencies, see MBPASS_CLIPBOARD
  • MBPASS_CLIPBOARD: Selects the method used to insert the password into your clipboard. Possible values:
    • tkinter/tk - requires a working tkinter module. Often the default value.
    • klipper/kde - requires the python-dbus module. Default if XDG_SESSION_DESKTOP is set to KDE
    • termux/android - requires the termux-api package. Default if the termux-clipboard-set binary is detected on PATH