### About
spw is an application that stores and retrieves passwords in a secure manner. spw is designed to be quick, light on resources/dependencies, and command line/script driven.
Passwords are stored in an encrypted format using PKCS1_OAEP encryption. This means you use a public and private key to encrypt and decrypt items stored within the store. This is a secure method of password storage and there is virtually no chance someone (including yourself) can view decrypted passwords without the private key.
spw is intended to provide a secure mechanism to store (and more importantly retrieve) passwords. spw's command-line interface allows easy integration into openbox's keyboard shortcut functionality (or similar tools). spw provides an easy mechanism for copying a password to the clipboard (e.g. C+A+j will copy the gmail junk account's password to your clipboard).
### Latest Changes
- minor cleanup of --version
- update copyright date
### Requiremnts
- python3
### Install
We recommend using [pipx](https://github.com/pypa/pipx). To install:
- with pipx: `pipx install spw`
- with pip: `pip install --user spw`
### Configure
cryptik uses a config file to store your setup. This file contains information where your secure database is stored and the private key to use as well as other configuration items. You can grab the sample config file from [spw/example/spw.ini.template](https://gitlab.com/drad/spw/-/blob/master/examples/spw.ini.template) and place it at `~/.config/spw/spw.ini`.
Refer to the example `spw.ini.template` file for details on each config item. The default (e.g. `spw.ini.template`) should suffice for most usage; however, you can change where your keys are located, logging level, and more in the file.
### Usage
After spw has been installed and setup you can use it as follows:
- add a key: `spw --add-key="abc" --value="123"`
- get a key: `spw --get-key="abc"`
+ note that the password retrieved is not show but rather placed on your clipboard so you can easily paste it somewhere ;-)
You can find more on the usage by calling help: `spw --help`
### Notes
- to avoid special character issues in keys/values, surround them with single (') or double (") quotes. If your password has single quotes in it, surround it with double quotes. If your password has double quotes in it, surround it with single quotes.
- you can use spw to store any string for quick retrieval, a commonly used URL, a base64 encoded picture, a snippet of code, etc.
### More Info
- [Wiki](https://g.dradux.com/dradux/spw/wikis/home)
- [Issues/Enhancements](https://g.dradux.com/dradux/spw/issues)
- [bandit](https://github.com/PyCQA/bandit)
- [flake8](https://gitlab.com/pycqa/flake8)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/drad/spw",
"name": "spw",
"maintainer": "drad",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "sa@adercon.com",
"keywords": "cli, encryption, password, openbox, scriptable",
"author": "drad",
"author_email": "sa@adercon.com",
"download_url": "https://files.pythonhosted.org/packages/02/ef/fb4af5b705d3e831928d56738eeefe927f9b848c2b7a4aa9677c584d36c4/spw-1.11.0.tar.gz",
"platform": null,
"description": "### About\n\nspw is an application that stores and retrieves passwords in a secure manner. spw is designed to be quick, light on resources/dependencies, and command line/script driven.\n\nPasswords are stored in an encrypted format using PKCS1_OAEP encryption. This means you use a public and private key to encrypt and decrypt items stored within the store. This is a secure method of password storage and there is virtually no chance someone (including yourself) can view decrypted passwords without the private key.\n\nspw is intended to provide a secure mechanism to store (and more importantly retrieve) passwords. spw's command-line interface allows easy integration into openbox's keyboard shortcut functionality (or similar tools). spw provides an easy mechanism for copying a password to the clipboard (e.g. C+A+j will copy the gmail junk account's password to your clipboard).\n\n\n### Latest Changes\n\n- minor cleanup of --version\n- update copyright date\n\n\n### Requiremnts\n\n- python3\n\n\n### Install\n\nWe recommend using [pipx](https://github.com/pypa/pipx). To install:\n\n- with pipx: `pipx install spw`\n- with pip: `pip install --user spw`\n\n\n### Configure\n\ncryptik uses a config file to store your setup. This file contains information where your secure database is stored and the private key to use as well as other configuration items. You can grab the sample config file from [spw/example/spw.ini.template](https://gitlab.com/drad/spw/-/blob/master/examples/spw.ini.template) and place it at `~/.config/spw/spw.ini`.\n\nRefer to the example `spw.ini.template` file for details on each config item. The default (e.g. `spw.ini.template`) should suffice for most usage; however, you can change where your keys are located, logging level, and more in the file.\n\n\n### Usage\n\nAfter spw has been installed and setup you can use it as follows:\n- add a key: `spw --add-key=\"abc\" --value=\"123\"`\n- get a key: `spw --get-key=\"abc\"`\n + note that the password retrieved is not show but rather placed on your clipboard so you can easily paste it somewhere ;-)\n\nYou can find more on the usage by calling help: `spw --help`\n\n\n### Notes\n\n- to avoid special character issues in keys/values, surround them with single (') or double (\") quotes. If your password has single quotes in it, surround it with double quotes. If your password has double quotes in it, surround it with single quotes.\n- you can use spw to store any string for quick retrieval, a commonly used URL, a base64 encoded picture, a snippet of code, etc.\n\n\n### More Info\n\n- [Wiki](https://g.dradux.com/dradux/spw/wikis/home)\n- [Issues/Enhancements](https://g.dradux.com/dradux/spw/issues)\n- [bandit](https://github.com/PyCQA/bandit)\n- [flake8](https://gitlab.com/pycqa/flake8)\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "store and retrieve passwords securely all while being scriptable!",
"version": "1.11.0",
"project_urls": {
"Homepage": "https://gitlab.com/drad/spw",
"Repository": "https://gitlab.com/drad/spw"
},
"split_keywords": [
"cli",
" encryption",
" password",
" openbox",
" scriptable"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0cd70918c492694360b5f4ad3de3b41927249bb2c395e04238e99a785f5e5e0",
"md5": "45202f87bcd95811ebda353dbc0f7f5c",
"sha256": "5fdea110708b676f38e844d95ea7e4867eb8bcc3e948badafc2a502e1e6d7153"
},
"downloads": -1,
"filename": "spw-1.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45202f87bcd95811ebda353dbc0f7f5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 18823,
"upload_time": "2024-06-10T15:17:34",
"upload_time_iso_8601": "2024-06-10T15:17:34.387975Z",
"url": "https://files.pythonhosted.org/packages/f0/cd/70918c492694360b5f4ad3de3b41927249bb2c395e04238e99a785f5e5e0/spw-1.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02effb4af5b705d3e831928d56738eeefe927f9b848c2b7a4aa9677c584d36c4",
"md5": "5ad7ec566a03a3c62ae0064a38fd86fa",
"sha256": "d8cf9fad69c75ac020a24b9f54cd5acb65e4b1c71ac8dc3dc8a4aab06205a0c9"
},
"downloads": -1,
"filename": "spw-1.11.0.tar.gz",
"has_sig": false,
"md5_digest": "5ad7ec566a03a3c62ae0064a38fd86fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 17897,
"upload_time": "2024-06-10T15:17:35",
"upload_time_iso_8601": "2024-06-10T15:17:35.988329Z",
"url": "https://files.pythonhosted.org/packages/02/ef/fb4af5b705d3e831928d56738eeefe927f9b848c2b7a4aa9677c584d36c4/spw-1.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-10 15:17:35",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "drad",
"gitlab_project": "spw",
"lcname": "spw"
}
JSON