sdc-cryptography
Basic Use (with pipenv, recommended)
Install requirements
pip install pipenv
make build
Run the unit tests
pipenv run make test
Create a package for deployment
pipenv run make sdist
Basic Use (with activated virtual environment)
Install requirements
These commands will generate a requirements file that pip can use. It doesn't have to be created this way but this is the easiest way.
pip install pipenv
pipenv lock -r --dev > requirements.txt
pip install -r requirements.txt
Run the unit tests
make test
Create a package for deployment
make sdist
Usage
Need to generate a keys.yml file first. Note, this requires a file system to store the file. Then it needs to be loaded, and a key store generated.
generate_keys.py <key_folder_location>
After this has been configured, encrypting and decrypting can be done as in the example below.
secrets_from_file = yaml.safe_load("keys.yml")
validate_required_secrets(secrets_from_file, EXPECTED_SECRETS, KEY_PURPOSE_SUBMISSION)
key_store = KeyStore(secrets_from_file)
# Encrypt JSON (Purpose has a single encryption key in the key store)
from sdc.crypto.encrypter import encrypt
encrypted_json = encrypt(json, key_store, key_purpose)
# Encrypt JSON with encryption service (Purpose has multiple encryption keys in the key store each tagged with a service)
from sdc.crypto.encrypter import encrypt
encrypted_json = encrypt(json, key_store, key_purpose, encryption_for_service="some-service")
# Decrypt UTF8 jwe token
from sdc.crypto.decrypter import decrypt
data_bytes = data.decode('UTF8')
decrypted_json = decrypt(data_bytes, key_store, key_purpose)
PyPi
This repo is available from PyPi at sdc-cryptography
The package is published automatically to PyPi when a tag is created in Github. The configuration for this is in the .travis.yml file.
1 maintainer
Metadata
1 maintainer
Release files for sdc-cryptography 1.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sdc-cryptography-1.1.4.tar.gz | 19.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sdc_cryptography-1.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 33.3 kB
Release files / sdc-cryptography-1.1.4.tar.gz
| Download URL | sdc-cryptography-1.1.4.tar.gz |
|---|---|
| Size | 19.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b2cc663d03e43a45919b49e6d4e4818f6a344b971322e6980bf64379e466548
|
|
BLAKE2b-256 checksum How to use checksums |
0b925fd09ea2c1c72eb45662d9dbe2f9b35c3d4ba87418951f64516195b9fe90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.18
|
Release files / sdc_cryptography-1.1.4-py3-none-any.whl
| Download URL | sdc_cryptography-1.1.4-py3-none-any.whl |
|---|---|
| Size | 13.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d6ecbe45b42d9449ee4fd47774fc9ba6f5e14a4e8531517468fc391902ad98fd
|
|
BLAKE2b-256 checksum How to use checksums |
da8269aaa405ed6906b69374797ae3e96fe4e7332d9a4490bdfe85ee859ce8da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.18
|
