A tiny ACME (Let's Encrypt) Python 2 & 3 client library with minimal dependencies
A tiny ACME Python 2 & 3 client library with minimal dependencies. ACME is a protocol for domain certificate verification and signing initiated by Let’s Encrypt. This package is meant to be used as a library and also comes with command line scripts.
You can choose to either install it in your user’s home directory or in the system directories.
This package depends on having the OpenSSL executable in the PATH.
pip install certsign
You can also install it from a code checkout using:
pip install .
Install to user home directory
With pip you can use the --user option to install it to your user’s home directory:
pip install --user certsign
If you install to the user directory on Linux $HOME/.local/bin should be in your $PATH-variable. On Linux you can add the following to .profile or .bashrc in your home directory, if $HOME/.local/bin is not already in you PATH.
# set PATH so it includes user's private .local/bin if it exists if [ -d "$HOME/.local/bin" ] ; then PATH="$HOME/.local/bin:$PATH" fi
The location for the scripts and the method to add it to the PATH is different for MacOS/OSX and Windows.
As a library
Signing a Certificate Signing Request (CSR)
This is the primary usage of this library:
from certsign import client account_key = 'acme_directory_account.key' csr_file = 'your_domain.csr' challenges_path = '/path/served/by/your/http/server' account_email = 'email@example.com' signed_cert = client.sign_csr( account_key, csr_file, challenges_path, account_email=account_email )
Creating a private key and a CSR
from certsign import crypto privkey_path = '/tmp/privkey.pem' csr_path = '/tmp/example.com.csr' privkey = crypto.create_private_key(bits=2048) with open(privkey_path, 'w') as f: f.write(privkey.encode('utf-8')) csr = crypto.create_csr( privkey_path, ['example.com', 'www.example.com'], openssl_conf='/etc/ssl/openssl.cnf' ) with open(csr_path, 'w') as f: f.write(csr.encode('utf-8'))
For signing a Certificate Signing Request (CSR):
certsign --account-key /path/to/account/key --csr /path/to/domain.csr \ --challenge-dir /path/served/by/your/http/server \ --account-email firstname.lastname@example.org
Create a private key:
certsign-tool privkey --bits=4096 --out=/path/to/privkey.pem
Create a CSR:
certsign-tool csr --privkey=/path/to/privkey.pem \ --out=/path/to/example.com.csr example.com www.example.com
View the CSR you just created:
certsign-tool view /path/to/example.com.csr
A simple server to respond to ACME challenges:
certsign-server --challenge-dir /path/served/by/your/http/server \ --addr localhost \ --port 8000 \ --pidfile /tmp/certsign.pid &
To kill the server when finished:
if [ -f /tmp/certsign.pid ]; then pkill -F /tmp/certsign.pid fi
Go to the root of this project (where setup.py is located) and run the following commands:
- For Python 3: pyvenv venv-certsign-py3 and source venv-certsign-py3/bin/activate to activate.
- For Python 2: virtualenv venv-certsign-py2 and source venv-certsign-py2/bin/activate to activate.
Set up a development environment using the following command (with literal square brackets):
pip install -e .[dev]
To run the test in your current environment:
python setup.py test
To run the tests for several Python versions:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size certsign-0.1-py2.py3-none-any.whl (15.1 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View hashes|
|Filename, size certsign-0.1.tar.gz (11.4 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for certsign-0.1-py2.py3-none-any.whl