Skip to main content

Python bindings to FreeDesktop.org Secret Service API

Project description

GitHub Actions status Coverage status ReadTheDocs status

Module description

This module provides a way for securely storing passwords and other secrets.

It uses D-Bus Secret Service API that is supported by GNOME Keyring, KSecretsService and KeePassXC.

The main classes provided are secretstorage.Item, representing a secret item (that has a label, a secret and some attributes) and secretstorage.Collection, a place items are stored in.

SecretStorage supports most of the functions provided by Secret Service, including creating and deleting items and collections, editing items, locking and unlocking collections (asynchronous unlocking is also supported).

The documentation can be found on secretstorage.readthedocs.io.

Building the module

SecretStorage requires these packages to work:

To build SecretStorage, use this command:

python3 setup.py build

If you have Sphinx installed, you can also build the documentation:

python3 setup.py build_sphinx

Testing the module

First, make sure that you have the Secret Service daemon installed. The GNOME Keyring is the reference server-side implementation for the Secret Service specification.

Then, start the daemon and unlock the default collection, if needed. The testsuite will fail to run if the default collection exists and is locked. If it does not exist, the testsuite can also use the temporary session collection, as provided by the GNOME Keyring.

Then, run the Python unittest module:

python3 -m unittest discover -s tests

If you want to run the tests in an isolated or headless environment, run this command in a D-Bus session:

dbus-run-session -- python3 -m unittest discover -s tests

Get the code

SecretStorage is available under BSD license. The source code can be found on GitHub.

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

SecretStorage-3.3.2.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

SecretStorage-3.3.2-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file SecretStorage-3.3.2.tar.gz.

File metadata

  • Download URL: SecretStorage-3.3.2.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for SecretStorage-3.3.2.tar.gz
Algorithm Hash digest
SHA256 0a8eb9645b320881c222e827c26f4cfcf55363e8b374a021981ef886657a912f
MD5 4de3603efceaeba6194a833c32365812
BLAKE2b-256 bc3b6e294fcaa5aed4059f2aa01a1ee7d343953521f8e0f6965ebcf63c950269

See more details on using hashes here.

File details

Details for the file SecretStorage-3.3.2-py3-none-any.whl.

File metadata

  • Download URL: SecretStorage-3.3.2-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for SecretStorage-3.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 755dc845b6ad76dcbcbc07ea3da75ae54bb1ea529eb72d15f83d26499a5df319
MD5 00bff7c27476e1a3072a6c454b4b6ace
BLAKE2b-256 54427cf083c31a9739b40ed683fad17460d1db97ecd23c344df25e41fa9e85e2

See more details on using hashes here.

Supported by

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