Secure Credentials Kit
A secure, encrypted credentials system for Django and FastAPI, inspired by Rails credentials.
Features
- Environment-specific encrypted credentials
- Framework-neutral CLI for generating and editing encrypted credentials
- Master keys for editing credentials and read-only keys for application runtime access
- Signed encrypted credential files backed by an asymmetric signing/verification key pair
- Django management commands
- FastAPI helpers for loading credentials into application state
Installation
The PyPI distribution, Python package, and CLI are all named for Secure Credentials Kit:
- Distribution:
secure-credentials-kit - Python package:
secure_credentials_kit - CLI:
secure-credentials-kit
Supported versions:
- Python 3.10, 3.11, 3.12, 3.13, and 3.14
- Django 5.2 LTS on Python 3.10–3.11 and Django 6.1 on Python 3.12–3.14
For Django:
pip install "secure-credentials-kit[django]"
For FastAPI:
pip install "secure-credentials-kit[fastapi]"
Local Development
This project uses pyproject.toml for package metadata and uv for local
dependency management.
Install uv, then create a development environment:
uv sync
Install framework extras when you need to test integrations:
uv sync --extra django
uv sync --extra fastapi
Upgrade all dependencies, including transitive dependencies, and install both extras:
uv lock --upgrade
uv sync --all-extras
Run tests:
uv run python -m unittest discover -v
Build the package:
uv run python -m build
Credentials Files
Add secret keys to .gitignore:
echo "secrets/*.key" >> .gitignore
Generate a new key pair:
secure-credentials-kit generate-key <environment>
This creates two role-specific keys:
secrets/<environment>.master.keycan decrypt, edit, encrypt, and sign credentials with the private signing key.secrets/<environment>.readonly.keycan decrypt and verify credentials with the public verification key, but cannot produce accepted credential updates.
Key files are stored as one-line base64url payloads. The decoded payload contains
the key material and format version; the package detects the key role
automatically from the key material, so there is no visible master: or
readonly: prefix in the file contents.
You can regenerate a read-only key from an existing master key:
secure-credentials-kit generate-key <environment> --role readonly
Edit encrypted credentials:
secure-credentials-kit edit <environment>
Editing requires secrets/<environment>.master.key. Applications should normally
run with only secrets/<environment>.readonly.key.
The editor opens the decrypted YAML. The YAML root must be a mapping:
SOME_ENV_VAR: secret-value
database:
url: postgres://user:password@localhost:5432/app
api:
token: token-value
Credentials are stored in secrets/<environment>.yml.enc, and keys are stored in
secrets/<environment>.master.key and secrets/<environment>.readonly.key.
The encrypted file is generated by the tool and should not be edited by hand. It
contains a signed encrypted payload similar to:
{
"version": 2,
"payload": "gAAAAAB...",
"signature": "..."
}
Django Usage
Add secure_credentials_kit to your INSTALLED_APPS in settings.py:
INSTALLED_APPS = [
...
'secure_credentials_kit',
...
]
You can also use Django management commands:
python manage.py credentials_generate_key <environment>
python manage.py credentials_generate_key <environment> --role readonly
python manage.py credentials_edit <environment>
To load the credentials in your Django app:
from secure_credentials_kit.secrets_loader import decrypt_credentials
credentials = decrypt_credentials("environment")
Where credentials is an instance of class CredentialsContainer containing the decrypted credentials.
FastAPI Usage
Load credentials into FastAPI application state:
from fastapi import Depends, FastAPI
from secure_credentials_kit.fastapi import (
credentials_dependency,
setup_secure_credentials_kit,
)
app = FastAPI()
setup_secure_credentials_kit(app, "production")
@app.get("/settings")
def settings(credentials=Depends(credentials_dependency())):
return {"api_host": credentials.get("api_host")}
If no environment is passed to setup_secure_credentials_kit, the helper checks
SECURE_CREDENTIALS_KIT_ENV, FASTAPI_ENV, ENV, then falls back to development.
Accessing Credentials
To access a credential:
credentials.get('key')
or
credentials.dig('key', 'subkey')
for complex nested credentials.
To access and cast a credential:
credentials.get_as_type('port', int)
or
credentials.dig_as_type(int, 'database', 'port')
Metadata
Release files for secure-credentials-kit 0.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| secure_credentials_kit-0.3.3.tar.gz | 14.5 kB | Without provenance | Details for secure_credentials_kit-0.3.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| secure_credentials_kit-0.3.3-py3-none-any.whl | Python 3 | none | any | Details for secure_credentials_kit-0.3.3-py3-none-any.whl |
Total release size: 26.5 kB
Release files / secure_credentials_kit-0.3.3.tar.gz
| Download URL | secure_credentials_kit-0.3.3.tar.gz |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ee967e6697957933071c7797df621350490ccd48204fc8fa6f80d2080ccdcb3
|
|
BLAKE2b-256 checksum How to use checksums |
ab371647d6b9b29debb57475b0c6ba95cb9ec7b39b14559653ba9baf74288f26
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / secure_credentials_kit-0.3.3-py3-none-any.whl
| Download URL | secure_credentials_kit-0.3.3-py3-none-any.whl |
|---|---|
| Size | 12.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d717b958f720905b83117e0266ac991cb3269788836fd427b28a78cfc61fbb2
|
|
BLAKE2b-256 checksum How to use checksums |
ad59a072ace3c78f9421f3fe57da7030c5743fadbcb082f08cc2aa7ab738bae2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for secure-credentials-kit 0.3.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.