Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thilinamanamgoda/password-manager
Encrypt your passwords into a file and have easy access
https://github.com/thilinamanamgoda/password-manager
Last synced: 3 months ago
JSON representation
Encrypt your passwords into a file and have easy access
- Host: GitHub
- URL: https://github.com/thilinamanamgoda/password-manager
- Owner: ThilinaManamgoda
- License: apache-2.0
- Created: 2019-08-13T22:52:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T04:08:23.000Z (over 4 years ago)
- Last Synced: 2024-10-16T20:57:09.816Z (4 months ago)
- Language: Go
- Homepage: https://thilinamanamgoda.github.io/password-manager/
- Size: 34 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Password Manager
[](https://travis-ci.com/ThilinaManamgoda/password-manager) [](https://goreportcard.com/report/github.com/ThilinaManamgoda/password-manager) [](https://gitter.im/ThilinaManamgoda/password-manager)
Encrypt your passwords into a file and have easy access.
### Synopsis
A local password manager which simply encrypts your passwords in to a file and managing passwords made easy .
### How to install
#### Ubuntu 
1. Using the command line, add the following to your /etc/apt/sources.list system config file,
`sudo echo "deb https://dl.bintray.com/maanafunedu/maanadev-debian stable main" | sudo tee -a /etc/apt/sources.list`
1. Configure Bintray public GPG key,
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 379CE192D401AB61`
1. Update repository,
```sudo apt update```
1. Install password-manager,
```sudo install password-manager```
#### MacOS 
1. Tap into password-manager brew formula with the following command,
```brew tap ThilinaManamgoda/homebrew-password-manager```
1. Install password-manager, with the following command,
```brew install password-manager```
### How to use
1. Initialize the password manager with the following command,
```bash
password-manager init
```
Enter the Master password once prompted.
2. Add a password entry with the following command,
```bash
password-manager add TEST -i
```
Here password entry id is **TEST** which always should be a unique value. By passing **-i** parameter we are enabling
the **Interactive** mode. Once this command is executed, the following entries will be listed,
```bash
Username:
Password:
Enter the Password again:
Description:
Lables:
Master password:
Example:
Username: [email protected]
Password: ***********
Enter the Password again: ***********
Description: Test descritption
Lables: test,first,firstTime
Master password:
```
1. Get a password entry with **ID**
```bash
password-manager get
```
Enter the Master password once prompted. For an example,
```bash
password-manager get TEST
```
1. Search a password entry with a **ID**
```bash
password-manager search
```
Enter the Master password once prompted. For an example,
```bash
password-manager search test
```
Once you enter the Master password, a list of password entries will be listed that match the given label. Once the entry is selected, the **password** will be copied to the clipboard.
1. Search a password entry with a **label**
```bash
password-manager search -l
```
Enter the Master password once prompted. For an example,
```bash
password-manager search -l test
```
Once you enter the Master password, a list of password entries will be listed that match the given label. Once the entry is selected, the **password** will be copied to the clipboard.
### Configuration
1. Follow the instructions to override default configurations using a configuration file.
1. Create a password-manager.yaml file with following content. Keep configurations that need to be overridden.
```yaml
# Set encryptor for encryping passwords. Ex: "AES"
encryptorID: "AES"
# Maximum list size for selection drop down.
selectListSize: 5
# Directory which holds the Password manager related files.
directoryPath: "~/password-manager"
# Set storage configurations.
storage:
# File storage configuration.
file:
# Enable File storage.
enable: true
# Password Database file name.
passwordDBFile: "password_db"
# File permission for given file in the path.
permission: 0640
# Google Drive storage configuration.
googleDrive:
# Enable Google Drive storage.
enable: false
# Directory where the password Database file resides.
directory: "password-manager"
# Password Database file name.
passwordDBFile: "password_db"
```
1. Export Environment variable to point the configuration file.
`export PM_CONF_PATH=${PATH_TO_PASSOWRD_MANAGER_YAML}`
1. Follow the instructions to override default configurations using environment variables.
1. Export required override configuration as environment variable. For example let's assume that you need
to override **file permission** of the File storage type.
```bash
export PM_STORAGE_FILE_PERMISSION=0640
```
Environment variable should have the prefix `PM_` and the hierarchy separation with `_` and keyword **ALL CAPS**.
examples:
`PM_SELECTLISTSIZE=2`
`PM_ENCRYPTORID=AES`
`PM_STORAGE_FILE_PASSOWRDDBFILE=password_db`
### Export passwords
If you need to transfer your passwords to a different PC where you have installed password-manager,
it can be achieved by making a copy of your password database file assuming storage type is **File**. This is not required
if the storage type is **Google Drive**.
1. Export passwords to **CVS file** with the following command,
```bash
pasword-manager export --csv-file ${PATH_TO_CSV_FILE}
```
Exported CSV file will have the following format([Ex: test/mock-data/data.csv](test/mock-data/data.csv)),
```bash
id,username,password,description,labels
[email protected],[email protected],gijggx3MDxZ,"Desciption of the password","foo,com"
```
1. Export passwords to **HTML file** with the following command,
```bash
pasword-manager export --html-file ${PATH_TO_HTML_FILE}
```
### Import Passwords
You can import passwords from a **CSV file** with following command,
```bash
pasword-manager import --csv-file ${PATH_TO_CSV_FILE}
```
CSV file should be in the following format([Ex: test/mock-data/data.csv](test/mock-data/data.csv)),
```bash
id,username,password,description,labels
[email protected],[email protected],gijggx3MDxZ,"Desciption of the password","foo,com"
```
### STORAGE PRECEDENCE
If all the Storage types are enabled, the priority will be given as follow,
* Google drive storage
* Local file storage
### Upgrading password database version
When upgrading password-manager cli, please make sure that whether it is required to upgrade the password database as well.
**It will be mentioned in the release note**. If it is mentioned in the release note that the password-database must be upgraded,
then after installing run the following command,
`password-manager upgrade-db`
This command upgrades the password database to latest version and creates a backup of the current password database.
Please find more details on `upgrade-db` command [here](doc/password-manager_upgrade-db.md).
### SEE ALSO
* [password-manager init](doc/password-manager_init.md) - Initialize the Password Manager
* [password-manager add](doc/password-manager_add.md) - Add a new password
* [password-manager change](doc/password-manager_change.md) - Change a password entry
* [password-manager change-master-password](doc/password-manager_change-master-password.md) - Change Master password
* [password-manager generate-password](doc/password-manager_generate-password.md) - Generate a secure password
* [password-manager get](doc/password-manager_get.md) - Get a password
* [password-manager search](doc/password-manager_search.md) - Search Password with ID
* [password-manager import](doc/password-manager_import.md) - Import passwords
* [password-manager export](doc/password-manager_export.md) - Export password repository to a file
* [password-manager remove](doc/password-manager_remove.md) - Remove a password
* [password-manager upgrade-db](doc/password-manager_upgrade-db.md) - Upgrade password database to latest version
### [Common issues](doc/common-issues/common-issues.md)