Skip to main content

store and retrieve passwords securely all while being scriptable!

Project description

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. 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 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

Project details


Download files

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

Source Distribution

spw-1.11.0.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

spw-1.11.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file spw-1.11.0.tar.gz.

File metadata

  • Download URL: spw-1.11.0.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.6.32-1-lts

File hashes

Hashes for spw-1.11.0.tar.gz
Algorithm Hash digest
SHA256 d8cf9fad69c75ac020a24b9f54cd5acb65e4b1c71ac8dc3dc8a4aab06205a0c9
MD5 5ad7ec566a03a3c62ae0064a38fd86fa
BLAKE2b-256 02effb4af5b705d3e831928d56738eeefe927f9b848c2b7a4aa9677c584d36c4

See more details on using hashes here.

File details

Details for the file spw-1.11.0-py3-none-any.whl.

File metadata

  • Download URL: spw-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.6.32-1-lts

File hashes

Hashes for spw-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fdea110708b676f38e844d95ea7e4867eb8bcc3e948badafc2a502e1e6d7153
MD5 45202f87bcd95811ebda353dbc0f7f5c
BLAKE2b-256 f0cd70918c492694360b5f4ad3de3b41927249bb2c395e04238e99a785f5e5e0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page