lihim 1.1.0

CLI for managing secret keys, tokens, sensitive and/or public key-value pairs.

CLI tool for managing secret keys, tokens, sensitive and/or public key-value pairs. AKA "A glorified note-taking CLI tool with added security and complexity for listing key-value pairs."

Overview

Lihim (Filipino word for secret) uses PyNaCl's SecretBox for secret key encryption, and stores the key-value pairs in an SQLite (PostgreSQL coming soon) database. Secret keys are managed according to users and groups. That is, each user has groups and these groups can contain several key-value pairs.

Installation

pip install lihim

Get Started

1. Run lihim initdb to create the database and tables,
2. Next, lihim useradd [username] to add your first user. You may read Notes section > Re: Users' key for prompts to expect.
3. Then, lihim login [username] to login.
4. Before you can add key-value pairs, you need a group. Run lihim groupadd [group name] to create a group.
5. Now you can add a pair. lihim pairadd command will prompt interactively for key, value, and group.
6. You just added your first key-val pair! Refer to Commands section below for more commands.

Commands

Command	Description
initdb	One-off command to create the database and tables.
users	Check registered users.
useradd [username]	Create a new user with username of ____.
login [username]	Login as user with username of ____.
logout	Logout current user.
check	Check who is currently logged in.
groups	Display all the groups of current user.
group [group name]	Display all the keys of key-value pairs in the group with name of ____.
groupadd [group name]	Add new group with name of ____.
groupdel [group name]	Delete group with name of ____
pairs	Display all the keys of available pairs of the current user.
pair [key]	Display the key-value pair with key of ____.
pairadd	Add a new key-value pair. Will prompt interactively for key, value, and group.
pairdel [key] [group name]	Delete pair with key ____ and within group ____.

Notes

Re: User's "key"

As per PyNaCl's documentation:

The 32 bytes key given to SecretBox must be kept secret. It is the combination to your “safe” and anyone with this key will be able to decrypt the data, or encrypt new data.

In Lihim, this "key" is generated when creating a new user. The key's path (where to put it) and name (unique, only you knows) are all up to the user. When creating a user by useradd [username], there will be prompts asking where and what to name the key. This is only for generating the key and the user can (absolutely) rename and/or move the key elsewhere anytime. The key's path and name are not stored in the database.

When logging in, there will be prompts asking where your key is and what is its name. This happens every login [username]. You must give the current key path and key name if you ever moved and/or renamed the key.

Re: SQLite3

The project currently uses sqlite. Postgresql option is on the roadmap. All values of key-value pairs are encrypted using PyNaCl's SecretBox.

Development

The project uses Poetry to package and manage dependencies:

poetry install

Run tests:

pytest

License

MIT License

Copyright (c) 2021 Neil Van

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.