Skip to main content

Python library for signing x509 using keys in an pkcs11 device such as a HSM

Project description

python_x509_pkcs11

Seamless signing x509 using PKCS11 device for key storage

Currently supports

  • Creating a root CA and generating its RSA key in the PKCS11 device
  • Using the key in the PKCS11 device to sign certificates (or Intermediate CAs)
  • Creating CRLs with the PKCS11 device key
  • Store multiple keys in the PKCS11 device enabling a full PKI infrastructure
  • 'Advanced' handling of fragile persistent PKCS11 sessions, including recreating the session if PKCS11 operation timeout

This package is pretty much a wrapper around python-pkcs11 and asn1crypto

Setup

# Install this package
pip install python_x509_pkcs11

# Install deps and add your user to the softhsm group
sudo apt-get install opensc softhsm2
sudo usermod -a -G softhsm $USER
sudo reboot # Yeah seem to not update your groups without a reboot

# export env values the code will use
export PKCS11_MODULE="/usr/lib/softhsm/libsofthsm2.so"
export PKCS11_PIN="1234"
export PKCS11_TOKEN="my_test_token_1"

# Initialize the token
softhsm2-util --init-token --slot 0 --label $PKCS11_TOKEN --pin $PKCS11_PIN --so-pin $PKCS11_PIN

Usage

Look at the tests/test_root_ca.py

Tests

# Install the package
pip install python_x509_pkcs11

# Export env vars
export PKCS11_MODULE="/usr/lib/softhsm/libsofthsm2.so"
export PKCS11_TOKEN='my_test_token_1'
export PKCS11_PIN='1234'

# Delete and init a token
softhsm2-util --delete-token --token my_test_token_1
softhsm2-util --init-token --slot 0 --label $PKCS11_TOKEN --pin $PKCS11_PIN --so-pin $PKCS11_PIN

# Run unittest with mypy and pylint
mypy --strict --namespace-packages --ignore-missing-imports tests/*.py
pylint tests/*.py
python3 -m unittest tests/*.py

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

python_x509_pkcs11-0.1.5.tar.gz (355.7 kB view details)

Uploaded Source

Built Distribution

python_x509_pkcs11-0.1.5-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file python_x509_pkcs11-0.1.5.tar.gz.

File metadata

  • Download URL: python_x509_pkcs11-0.1.5.tar.gz
  • Upload date:
  • Size: 355.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.2

File hashes

Hashes for python_x509_pkcs11-0.1.5.tar.gz
Algorithm Hash digest
SHA256 75a358a138a3e58cddbabfc1237a60ab58544c47d6f4b5bc72174cb5af9fbbf7
MD5 2fd320ff8dc89a93f723f8fcb54ab7cd
BLAKE2b-256 173ab05bf2c2259dfe4b99f9b6fb57238240b14587d7610de4d9497903256eef

See more details on using hashes here.

File details

Details for the file python_x509_pkcs11-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for python_x509_pkcs11-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bcd8a98e38976665dea1a670ab753a073db0cba500cabb920bcf7191fef3f02e
MD5 8355be7f0d4ab5596d57aa8807b2c17c
BLAKE2b-256 04dc063a63e72bb65d096110ea503195b61beaa6dee524f72036d1481f893263

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