Skip to content

Latest commit

 

History

History
182 lines (143 loc) · 5 KB

README.md

File metadata and controls

182 lines (143 loc) · 5 KB
Raw

clipw

Python3 Powered Command Line Password Manager

Description:

Clipw is a very simply, secure (audits welcome) command line interface, python3 powered password manager utilizing AES-256 (via *pure python powered* pyaes)! Store passwords, along with a description; with the option to create secure random passwords. Notice: This is work in progress. New features will be added as I get to them. If you want to fork and help out, pull requests are welcome.

Note: So far only tested on Android (termux) & Linux - TODO: test on windows , osx, etc

Features:

  • Fast sqlite powered database
    • simple db structure
    • --init_database function makes copy of old db first
    • TODO: Add fields for timestamp, URL, username, etc
  • Passwords encrypted in AES-CRT 256
    • no system compiled libaries needed (unlike pycrypto)
    • Encrypted with a master passphrase (hashed & salted 1000000x via sha-256)
  • Libs organized into neat packages for easy reuse or expansion
    • For developers: Portable libraries for AES, Password Hashing, SQL, and configuration
  • Easy install via setup.py script
  • Option to store or generate a random password of n length
  • Simple cli friendly interface
    • Interactive mode
      • Keeps db unlocked until timeout expires for security
    • Quick command line functionality with argparse
      • see usage below
    • Reset console after timeout/on program exit(for security)
    • Timeout time configurable
      • defaults to 600 seconds / 10 minutes
  • Pure python3
    • Encryption uses pyaes, no OS libraries needed.
    • Dependencies minimized, only needs pyaes

Installation:

  • Clone this repository to your computer.
  • Run pip3 install -r requirements.txt to install dependencies
  • Install via setup.py:
$ python3 setup.py build
$ python3 setup.py install --user

Usage:

usage: clipw [-h] [--init] [-i] [-t, TIMEOUT] [-o] [-s] [-e] [-d]
             [-r [GEN_RANDOM [GEN_RANDOM ...]]]

Python Cli Password Manager

optional arguments:
  -h, --help            show this help message and exit
  --init, --init_database
                        Re|Init Database
  -i, --interactive     Interactive mode
  -t, TIMEOUT, --timeout TIMEOUT
                        Override timeout - close afterthis amount of seconds.
  -o, --open            Open the password database
  -s, --store           Enter and store a new password in the database
  -e, --edit            Edit an entry.
  -d, --delete          Delete an entry
  -r [GEN_RANDOM [GEN_RANDOM ...]], --random [GEN_RANDOM [GEN_RANDOM ...]]
                        Generate and store a random password of n length

First, run with --init_database. You will be prompted to enter a master passphrase which will be used to encrypt all of the passwords which you store in the database. Key must be at least 8 and up to 32 characters long. Pick a strong master passphrase.

New: Interactive mode (clipw -i)

Interactive mode keeps the program open without having to re-enter the key over and over over every time you need to retrieve a password. TODO: add a timeout feature

$ clipw -i
Master Password: 
Success!
Running in interactive mode.
Enter action: store (s), generate: (g), open and select entry: (o), edit entry: (e), delete entry: (d), quit program (q)

Generate a random password 8 characters long:

$ clipw.py -r 8 
Master Password: 
Success!
Description: test4
Password: cnY{2k"6|@Ho

Store a password into the database:

$ clipw.py -s
Master Password: 
Success!
Description: test 
Password: 
Confirm: 
Stored password ok.

Open the database and retrieve a password:

Master Password: 
Success!
ID:  0 Description test 1
ID:  1 Description gmail
ID:  2 Description github
ID:  3 Description test 2
Enter ID of password to decrypt: 3
Retrieving ID  3
Id:  3
Description: test test 
Password: lol

Flowchart / Psuedocode

Functions:

  • init database:

    • input master key
      • Check keysize - add padding for AES compliance if necessary
    • hash & salt master key
    • store hash in file
    • create empty database

  • generate_password / store:

    • store from getpass || generate random password
    • encrypt password
    • get description data
    • append to db: encrypted password with description data

  • open_database:

    • prompt use for master key
    • check master key against stored hash
    • if correct:
      • open database
      • iterate through database
      • display description with numeric id
      • prompt for id of password to retrieve
      • show password
      • clean exit (security features:)
        • remove AES key from memory
        • reset console
    • if incorrect:
      • prompt to try again (?)
      • nah, just exit

  • Interactive Mode:

    • Run in while loop
      • Get selection (store (s), generate: (g), open and select entry: (o), edit entry: (e), delete entry: (d), quit program (q))
      • Perform action
      • Repeat until SIGINT or Lock Timeout reached then break
        • clean master key from memory
        • exit