Skip to main content

A simple commandline password vault written in python.

Project description

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.

Description: # PYPASSVAULT

A simple command line password vault written in python.

## Description

This tool was developed as a personal experiment to try out cryptography in python and also to develop a handy tool that can act as a secure command line password vault.

## Installation

```
pip install pypassvault
```

## Usage

Once you install the package, you will can use ```passvault``` utility from command line to use this tool.

- Help

```
> passvault -h
Usage: passvault [--core-opts] <subcommand> [--subcommand-opts] ...

Core options:

--complete Print tab-completion candidates for given parse remainder.
--hide=STRING Set default value of run()'s 'hide' kwarg.
--write-pyc Enable creation of .pyc files.
-d, --debug Enable debug output.
-e, --echo Echo executed commands before running.
-f STRING, --config=STRING Runtime configuration file to use.
-h [STRING], --help[=STRING] Show core or per-task help and exit.
-l, --list List available tasks.
-p, --pty Use a pty when executing shell commands.
-V, --version Show version and exit.
-w, --warn-only Warn, instead of failing, when shell commands fail.

Subcommands:

configure Set the configuration
get Get password for a username and application (optional)
list List all applications and users for which password is set
setpasswd Set password for a username and application (optional)
```

If you need help on any sub command you can type ```passvalut -h <subcommand>``` to see the specific help for it.

e.g.
```
> passvault -h configure
Usage: passvault [--core-opts] configure [--options] [other tasks here ...]

Docstring:
Set the configuration

Options:
-c STRING, --confdir=STRING
```

- Set a password
```
passvault setpasswd -a appname -u username
Enter vault password:
Set an app password for username:
```

When you run passvault for the first time you will be asked to set up a vault password. Please note that Vault password is the single password that you will need for all future operations.

**Please do not forget your _vault password_ as if you forget it then the vault will not be recoverable.**

- Get the password details

```
> passvault get -a appname -u username
Enter vault password:
<Password>
```
- List Applications and Usernames present under passvault

```
> passvault list -a appname
Enter valult password:
Users for application appname are:
['username']
```
To list all applications & Usernames

```
> passvault list
```

- To check pypassvault version

```
passvault -V or passvault --version
```

## Todo

- Refactoring of existing APIs
- Functionality of deleting records by appname or user
- Generate password feature
- Import and Export of Data
- Better Documentation
- Providing an API interface for passvault
- Improvement in Encryption & Portability of Password Vault
- Support for Clipboard
- Testing

**Better to have features:**

- Password expiration notification/reminder
- UI for pypassvault
- Cloud Backup & Sync of Vault File

## LICENSE

```
Copyright 2018 cryptbytestech

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.
```
Keywords: password vault program cryptography
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pypassvault, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size pypassvault-0.1.3.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page