Skip to main content

A stripped down Let's Encrypt (ACME) client

Project description

[![Build Status](https://travis-ci.org/costela/wile.svg?branch=master)](https://travis-ci.org/costela/wile) [![PyPI version](https://badge.fury.io/py/wile.svg)](https://badge.fury.io/py/wile)

# Overview

Wile is a simple [Let’s Encrypt](https://letsencrypt.org) (ACME) client that only supports the “webroot” method of validation. It only needs access to the root folder serving the domains in question. Specifically, it only needs access to the .well-known sub-folder and therefore doesn’t need permission to access the actual website’s content.

The .well-known folder must also be accessible from external sources. I.e.: if you run a reverse proxy for some backend application, it should include an exception for this folder.

# Usage

## Generating a certificate request

Simple anonymous certificate request: ` $ wile cert request example.com:/var/www/example.com/ `

Registration with contact information, and saving certs to some other location (by default the certificate is saved to current folder): ` $ wile register -e name@example.com $ wile cert request --output-dir /etc/ssl/private/ example.com:/var/www/example.com/ `

Certificate request using remote webroot validation of SSH/SFTP: ` $ wile cert request example.com:username@example.com:/var/www/example.com/ `

Syntax for remote webroot validation argument is: DOMAIN:[[[USER@]HOST[:PORT]:]PATH].

Storing remote webroot validation is done via SFTP using SSH public key authentication. You can explicitly define path to your private key using –ssh-private-key option. Also, if your private key has been secured with a password you must provide your private key password using an ENV variable (WILE_SSH_PASS=’<your password>’). Note that there are single quotes around the password so that your shell doesn’t try to expand the symbols within the password.

Note that you can also pass multiple domains with a single document root, which creates a certificate with [Subject Alternative Names](https://en.wikipedia.org/wiki/Subject_Alternative_Name). ` $ wile cert request example.com:/var/www/example.com/ www.example.com `

In case of a remote webroot validation: ` $ wile cert request example.com:username@example.com:/var/www/example.com/ www.example.com `

## Revoking a certificate

Simple anonymous certificate revocation: ` $ wile cert revoke /etc/ssl/private/example.com.crt `

## Certificate renewal

By default, no new request will be made if wile detects an existing certificate for the same requested domains with a validity of at least 1 week. This can be changed with the –min-valid-time and –force options.

This way a simple daily cronjob is enough to ensure certificate freshness and should make renewals resiliant against moderate letsencrypt API downtime.

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

wile-1.0.6.tar.gz (29.9 kB view details)

Uploaded Source

Built Distributions

wile-1.0.6-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

wile-1.0.6-py2-none-any.whl (24.8 kB view details)

Uploaded Python 2

File details

Details for the file wile-1.0.6.tar.gz.

File metadata

  • Download URL: wile-1.0.6.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

File hashes

Hashes for wile-1.0.6.tar.gz
Algorithm Hash digest
SHA256 948ab7fcc49cad16bd7ad7b77c4f919b29e96de968498f8b48e5da7dab7bdbd2
MD5 9787a2ca81aa83cc065933fef7dc0b5c
BLAKE2b-256 38d75747ae5e3aaf9ca3c6febecd3fd175e24c8adaeab5510d59e603e9d1c67c

See more details on using hashes here.

File details

Details for the file wile-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: wile-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for wile-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 78723908cba312754154d7f10fd67f2337dc435f6b735a6605c6c91d22e09637
MD5 60992066523ec86a8d6aa99c1ccfc93e
BLAKE2b-256 93ba93c2c66e12b9f6c6f1b4f49dd7907aa0c4b4b38cba068e5d2ba0683f1091

See more details on using hashes here.

File details

Details for the file wile-1.0.6-py2-none-any.whl.

File metadata

  • Download URL: wile-1.0.6-py2-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

File hashes

Hashes for wile-1.0.6-py2-none-any.whl
Algorithm Hash digest
SHA256 96f4173289408002720b70abe30f9f16fc99d79cec2f256cdb26bb142c64d88d
MD5 c6e1d6bfc04d85e9d9696db300234590
BLAKE2b-256 ae417e1e31031dd679b7e98ccd0dfaa7f4221a4501f1fda0c6589a5beb59568d

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