Pysswords 0.0.12

Description:

pysswords 0.0.12

Pysswords lets you manage
your login credentials from the terminal. Password files are saved into
GnuGPG encrypted
files into the Database Path_. Only with the passphrase used to create
the pyssword database you can decrypt password files. If you want to
know more about how pysswords works internally, check the Under the
Hood_ section.

Pysswords console interface

Main Features

☑ Console interface
☑ Manage multiple databases
☑ Add, edit, remove credentials
☑ Copy passwords to clipboard
☑ List credentials as a table
☑ Colored output
☑ Search credentials by name, login or comments
☑ Search with regular expression
☑ Bulk update/remove credentials
☑ Select credentials by fullname syntax
☑ Grouping credentials
☑ Exporting Pysswords database
☑ Importing Pysswords database
☑ Importing credentials from
1password
☑ Randomly generated credential passwords
☐ Undo/Redo updates to the database

☑ implemented feature, ☐ not implemented feature.

Installation

Stable version
Make sure you have GPG and
pip
installed:
pip install pysswords

Development version

Linux/OSX
Windows

The latest development version can be installed directly from
GitHub:
$ pip install --upgrade https://github.com/marcwebbie/pysswords/tarball/master

Quickstart
# create a new credentials database. Option: `-I` or `--init`
pysswords --init

# add new credentials. Option: `-a` or `--add`
pysswords -a

# get credential "example". Option: `-g` or `--get`
pysswords -g example

# edit credential "example". Option: `-u` or `--update`
pysswords -u example

# remove credential "example". Option: `-r` or `--remove`
pysswords -r example

# search credentials by "exam". Option: `-s` or `--search`
pysswords -s exam

# search credentials using regular expressions Option: `-s` or `--search`.
pysswords -s example\.com|org

# copy password from credential "example" into system clipboard.
# Option: `-c` or `--clipboard`
pysswords -c example

# print all credentials as a table with hidden passwords
pysswords

# print all credentials as a table with passwords in plain text.
# Option: `-P` or `--show-password`
pysswords -P

# specify other Pysswords database. Option `-D` or `--database`
pysswords -D /path/to/other/database

# delete database and remove all credentials
# Option: `--clean`
pysswords --clean

# shows help. Option `-h` or `--help`
pysswords --help

# shows version. Option `--version`
pysswords --version

Tutorials

1) Syncing your database

Dropbox
With Pysswords database on default path ~/.pysswords and with a
Dropbox shared directory on path ~/Dropbox
# move your Pysswords database inside your Dropbox directory
mv ~/.pysswords ~/Dropbox/.pysswords

# create a symbolic link to your shared .pysswords directory on the default path.
ln -s ~/Dropbox/.pysswords ~/.pysswords

Google Drive
With Pysswords database on default path ~/.pysswords and with a
GoogleDrive shared directory on path ~/GoogleDrive
# move your Pysswords database inside your Dropbox directory
mv ~/.pysswords ~/GoogleDrive/.pysswords

# create a symbolic link to your shared .pysswords directory on the default path.
ln -s ~/GoogleDrive/.pysswords ~/.pysswords

2) Exporting/Importing Pyssword databases
# export database to a pysswords database file called pysswords.db
# Option: `--export`
pysswords --export pysswords.db

# import database from pysswords database file called pysswords.db
# Option: `--import`
pysswords --import pysswords.db

# import 1password 1pif exported file
pysswords --import passwords.1pif/data1.1pif

3) Grouping credentials by name
Pysswords credentials handles multiple logins for each name which groups
credentials by name:
# create john credential
pysswords -a
Name: example.com
Login: john
Password: **********
Comment: No comment

# create doe credential
pysswords -a
Name: example.com
Login: doe
Password: **********
Comment:

# listing credentials
pysswords

| Name | Login | Password | Comment |
|-------------+---------+------------+------------|
| example.com | doe | *** | |
| example.com | john | *** | No comment |

4) Selecting credentials by fullname syntax
You can select grouped credentials by using fullname syntax
login@name:
pysswords -g [email protected]

| Name | Login | Password | Comment |
|-------------+---------+------------+-----------|
| example.com | doe | *** | |

5) Using multiple databases
Sometimes it is useful to have multiple databases with different
passphrases for higher security. This can be done using -D Pysswords
option.

Creating databases on a given directory (ex: ~/databases)
# create personal Pysswords database
pysswords --init -D ~/databases/personal_passwords

# create work Pysswords database
pysswords --init -D ~/databases/work_passwords

# create junk Pysswords database
pysswords --init -D ~/databases/junk_passwords

Adding passwords to specific database
# add password to personal Pysswords database
pysswords -D ~/databases/personal_passwords -a

# add password to junk Pysswords database
pysswords -D ~/databases/junk_passwords -a

Adding passwords to specific database
# listing specific databases
pysswords -D ~/databases/junk_passwords

Under The Hood

Encryption
Encryption is done with GnuGPG using
AES256.
Take a look at
pysswords.crypt
module to know more.

Database Path
The default database path is at ~/.pysswords. If you want to change
the database path, add --database option to pysswords together with
--init.
pysswords --init --database "/path/to/another/database/"

Database structure
Pysswords database is structured in a directory hierachy. Every
credential is a .pyssword file inside a directory named after a
credential group.
An empty database would look like this:
pysswords --database /tmp/pysswords --init

tree /tmp/pysswords -la
# /tmp/pysswords
# └── .keys
# ├── pubring.gpg
# ├── random_seed
# ├── secring.gpg
# └── trustdb.gpg
After adding a new credential the database would look like this:
pysswords --database /tmp/pysswords -a
# Name: github.com
# Login: octocat
# Password: **********
# Comments:

tree /tmp/pysswords -la
# /tmp/pysswords
# ├── .keys
# │ ├── pubring.gpg
# │ ├── random_seed
# │ ├── secring.gpg
# │ └── trustdb.gpg
# └── github.com
# └── octocat.pyssword
If we add more credentials to group github.com. Directory structure
would be:
pysswords --database /tmp/pysswords -a
# Name: github.com
# Login: octocat2
# Password: **********
# Comments:

tree /tmp/pysswords -la
# /tmp/pysswords
# ├── .keys
# │ ├── pubring.gpg
# │ ├── random_seed
# │ ├── secring.gpg
# │ └── trustdb.gpg
# └── github
# └── octocat.pyssword
# └── octocat2.pyssword

Contributing

Fork the repository https://github.com/marcwebbie/pysswords/fork
Read the
Makefile
Write your tests on tests/test.py
If everything is OK. push your changes and make a pull request. ;)

License (MIT License)
The MIT License (MIT)
Copyright (c) 2014-2015 Marc Webbie, http://github.com/marcwebbie
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
“Software”), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Files In This Product: