Table of Contents
Installing and Using Python Keyring Lib
- What is Python keyring lib?
- Installation Instructions
- Using Keyring
- Configure your keyring lib
- Integrate the keyring lib with your application
- Get involved
The Python keyring lib provides an easy way to access the system keyring service from python. It can be used in any application that needs safe password storage.
The keyring library is licensed under both the MIT license and the PSF license.
These recommended keyring backends are supported by the Python keyring lib:
- macOS Keychain
- Freedesktop Secret Service supports many DE including GNOME (requires secretstorage)
- KDE4 & KDE5 KWallet (requires dbus)
- Windows Credential Locker
Other keyring implementations are available through Third-Party Backends.
Install using your favorite installer. For example:
$ pip install keyring
On Linux, the KWallet backend relies on dbus-python, which does not always install correctly when using pip (compilation is needed). So we recommend that dbus-python is installed as a system package. The same also applies to the Secret Storage backend under Python 2 (under Python 3 a different D-Bus implementation is used).
The basic usage of keyring is pretty simple: just call keyring.set_password and keyring.get_password:
>>> import keyring >>> keyring.set_password("system", "username", "password") >>> keyring.get_password("system", "username") 'password'
Keyring supplies a
keyring command which is installed with the
package. After installing keyring in most environments, the
command should be available for setting, getting, and deleting
passwords. For more information on usage, invoke with no arguments
--help as so:
$ keyring --help $ keyring set system username Password for 'username' in 'system': $ keyring get system username password
The command-line functionality is also exposed as an executable package, suitable for invoking from Python like so:
$ python -m keyring --help $ python -m keyring set system username Password for 'username' in 'system': $ python -m keyring get system username password
The python keyring lib contains implementations for several backends. The
automatically choose the keyring that is most suitable for your current
environment. You can also specify the keyring you like to be used in the
config file or by calling the
This section describes how to change your option in the config file.
The configuration of the lib is stored in a file named "keyringrc.cfg". This file must be found in a platform-specific location. To determine where the config file is stored, run the following:
python -c "import keyring.util.platform_; print(keyring.util.platform_.config_root())"
Some keyrings also store the keyring data in the file system. To determine where the data files are stored, run this command:
python -c "import keyring.util.platform_; print(keyring.util.platform_.data_root())"
To specify a keyring backend, set the default-keyring option to the
full path of the class for that backend, such as
If keyring-path is indicated, keyring will add that path to the Python module search path before loading the backend.
For example, this config might be used to load the
SimpleKeyring from the
simplekeyring module in
./demo directory (not implemented):
[backend] default-keyring=simplekeyring.SimpleKeyring keyring-path=demo
In addition to the backends provided by the core keyring package for the most common and secure use cases, there are additional keyring backend implementations available for other use-cases. Simply install them to make them available:
- keyrings.cryptfile - Encrypted text file storage.
- keyring_jeepney - a pure Python backend using the secret service DBus API for desktop Linux.
- keyrings.alt - "alternate", possibly-insecure backends, originally part of the core package, but available for opt-in.
- gsheet-keyring - a backend that stores secrets in a Google Sheet. For use with ipython-secrets.
- bitwarden-keyring - a backend that stores secrets in the BitWarden password manager.
The interface for the backend is defined by
Every backend should derive from that base class and define a
attribute and three functions:
get_credential() function may be defined if
backend module for more detail on the interface of this class.
Keyring employs entry points to allow any third-party package to implement
backends without any modification to the keyring itself. Those interested in
creating new backends are encouraged to create new, third-party packages
keyrings namespace, in a manner modeled by the keyrings.alt
package. See the
in that project for a hint on how to create the requisite entry points.
Backends that prove essential may be considered for inclusion in the core
library, although the ease of installing these third-party packages should
mean that extensions may be readily available.
If you've created an extension for Keyring, please submit a pull request to have your extension mentioned as an available extension.
Keyring additionally allows programmatic configuration of the
backend calling the api
set_keyring(). The indicated backend
will subsequently be used to store and retrieve passwords.
Here's an example demonstrating how to invoke
# define a new keyring class which extends the KeyringBackend import keyring.backend class TestKeyring(keyring.backend.KeyringBackend): """A test keyring which always outputs same password """ priority = 1 def set_password(self, servicename, username, password): pass def get_password(self, servicename, username): return "password from TestKeyring" def delete_password(self, servicename, username, password): pass # set the keyring for keyring lib keyring.set_keyring(TestKeyring()) # invoke the keyring lib try: keyring.set_password("demo-service", "tarek", "passexample") print("password stored successfully") except keyring.errors.PasswordSetError: print("failed to store password") print("password", keyring.get_password("demo-service", "tarek"))
The following is a complete transcript for installing keyring in a virtual environment on Ubuntu 16.04. No config file was used.:
$ sudo apt install python3-venv libdbus-glib-1-dev $ cd /tmp $ pyvenv py3 $ source py3/bin/activate $ pip install -U pip $ pip install secretstorage dbus-python $ pip install keyring $ python >>> import keyring >>> keyring.get_keyring() <keyring.backends.SecretService.Keyring object at 0x7f9b9c971ba8> >>> keyring.set_password("system", "username", "password") >>> keyring.get_password("system", "username") 'password'
It is possible to use the SecretService backend on Linux systems without X11 server available (only D-Bus is required). To do that, you need the following:
Install the GNOME Keyring daemon.
Start a D-Bus session, e.g. run
dbus-run-session -- shand run the following commands inside that shell.
--unlockoption. The description of that option says:
Read a password from stdin, and use it to unlock the login keyring or create it if the login keyring does not exist.
When that command is started, enter your password into stdin and press Ctrl+D (end of data). After that the daemon will fork into background (use
--foregroundoption to prevent that).
Now you can use the SecretService backend of Keyring. Remember to run your application in the same D-Bus session as the daemon.
The keyring lib has a few functions:
get_keyring(): Return the currently-loaded keyring implementation.
get_password(service, username): Returns the password stored in the active keyring. If the password does not exist, it will return None.
get_credential(service, username): Return a credential object stored in the active keyring. This object contains at least
passwordattributes for the specified service, where the returned
usernamemay be different from the argument.
set_password(service, username, password): Store the password in the keyring.
delete_password(service, username): Delete the password stored in keyring. If the password does not exist, it will raise an exception.
In all cases, the parameters (
should be Unicode text. On Python 2, these parameters are accepted as
str in the default encoding as they will be implicitly
decoded to text. Some backends may accept
bytes for these parameters,
but such usage is discouraged.
The keyring lib raises following exceptions:
keyring.errors.KeyringError: Base Error class for all exceptions in keyring lib.
keyring.errors.InitError: Raised when the keyring can't be initialized.
keyring.errors.PasswordSetError: Raise when password can't be set in the keyring.
keyring.errors.PasswordDeleteError: Raised when the password can't be deleted in the keyring.
Python keyring lib is an open community project and highly welcomes new contributors.
- Repository: https://github.com/jaraco/keyring/
- Bug Tracker: https://github.com/jaraco/keyring/issues/
- Mailing list: http://groups.google.com/group/python-keyring
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
This project makes use of automated releases via Travis-CI. The simple workflow is to tag a commit and push it to Github. If it passes tests on a late Python version, it will be automatically deployed to PyPI.
Other things to consider when making a release:
- first ensure that tests pass (preferably on Windows and Linux)
- check that the changelog is current for the intended release
Tests are continuously run using Travis-CI.
To run the tests yourself, you'll want keyring installed to some environment in which it can be tested. Recommended technique is described below.
Keyring prefers use of tox to run tests.
Simply install and invoke
This technique is the one used by the Travis-CI script.