Merge remote-tracking branch 'github/letsencrypt/master' into docker

This commit is contained in:
Jakub Warmuz
2015-05-12 21:07:22 +00:00
276 changed files with 2290 additions and 1832 deletions
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.account`
--------------------------
.. automodule:: letsencrypt.account
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.achallenges`
------------------------------
.. automodule:: letsencrypt.achallenges
:members:
-61
View File
@@ -1,61 +0,0 @@
:mod:`letsencrypt.acme`
=======================
.. contents::
.. automodule:: letsencrypt.acme
:members:
Messages
--------
v00
~~~
.. automodule:: letsencrypt.acme.messages
:members:
v02
~~~
.. automodule:: letsencrypt.acme.messages2
:members:
Challenges
----------
.. automodule:: letsencrypt.acme.challenges
:members:
Other ACME objects
------------------
.. automodule:: letsencrypt.acme.other
:members:
Fields
------
.. automodule:: letsencrypt.acme.fields
:members:
Errors
------
.. automodule:: letsencrypt.acme.errors
:members:
:members:
Utilities
---------
.. automodule:: letsencrypt.acme.util
:members:
-67
View File
@@ -1,67 +0,0 @@
:mod:`letsencrypt.acme.jose`
============================
.. contents::
.. automodule:: letsencrypt.acme.jose
:members:
JSON Web Algorithms
-------------------
.. automodule:: letsencrypt.acme.jose.jwa
:members:
JSON Web Key
------------
.. automodule:: letsencrypt.acme.jose.jwk
:members:
JSON Web Signature
------------------
.. automodule:: letsencrypt.acme.jose.jws
:members:
Implementation details
----------------------
Interfaces
~~~~~~~~~~
.. automodule:: letsencrypt.acme.jose.interfaces
:members:
Errors
~~~~~~
.. automodule:: letsencrypt.acme.jose.errors
:members:
JSON utilities
~~~~~~~~~~~~~~
.. automodule:: letsencrypt.acme.jose.json_util
:members:
JOSE Base64
~~~~~~~~~~~
.. automodule:: letsencrypt.acme.jose.b64
:members:
Utilities
~~~~~~~~~
.. automodule:: letsencrypt.acme.jose.util
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.augeas_configurator`
--------------------------------------
.. automodule:: letsencrypt.augeas_configurator
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.auth_handler`
-------------------------------
.. automodule:: letsencrypt.auth_handler
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.account`
---------------------------------
.. automodule:: letsencrypt.client.account
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.achallenges`
-------------------------------------
.. automodule:: letsencrypt.client.achallenges
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.augeas_configurator`
---------------------------------------------
.. automodule:: letsencrypt.client.augeas_configurator
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.auth_handler`
--------------------------------------
.. automodule:: letsencrypt.client.auth_handler
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.client`
--------------------------------
.. automodule:: letsencrypt.client.client
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.configuration`
---------------------------------------
.. automodule:: letsencrypt.client.configuration
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.constants`
-----------------------------------
.. automodule:: letsencrypt.client.constants
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.continuity_auth`
-----------------------------------------
.. automodule:: letsencrypt.client.continuity_auth
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.crypto_util`
-------------------------------------
.. automodule:: letsencrypt.client.crypto_util
:members:
-29
View File
@@ -1,29 +0,0 @@
:mod:`letsencrypt.client.display`
---------------------------------
.. automodule:: letsencrypt.client.display
:members:
:mod:`letsencrypt.client.display.util`
======================================
.. automodule:: letsencrypt.client.display.util
:members:
:mod:`letsencrypt.client.display.ops`
=====================================
.. automodule:: letsencrypt.client.display.ops
:members:
:mod:`letsencrypt.client.display.enhancements`
==============================================
.. automodule:: letsencrypt.client.display.enhancements
:members:
:mod:`letsencrypt.client.display.revocation`
============================================
.. automodule:: letsencrypt.client.display.revocation
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.errors`
--------------------------------
.. automodule:: letsencrypt.client.errors
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.interfaces`
------------------------------------
.. automodule:: letsencrypt.client.interfaces
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.le_util`
---------------------------------
.. automodule:: letsencrypt.client.le_util
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.log`
-----------------------------
.. automodule:: letsencrypt.client.log
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.network`
---------------------------------
.. automodule:: letsencrypt.client.network
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.network2`
----------------------------------
.. automodule:: letsencrypt.client.network2
:members:
-29
View File
@@ -1,29 +0,0 @@
:mod:`letsencrypt.client.plugins.apache`
----------------------------------------
.. automodule:: letsencrypt.client.plugins.apache
:members:
:mod:`letsencrypt.client.plugins.apache.configurator`
=====================================================
.. automodule:: letsencrypt.client.plugins.apache.configurator
:members:
:mod:`letsencrypt.client.plugins.apache.dvsni`
==============================================
.. automodule:: letsencrypt.client.plugins.apache.dvsni
:members:
:mod:`letsencrypt.client.plugins.apache.obj`
============================================
.. automodule:: letsencrypt.client.plugins.apache.obj
:members:
:mod:`letsencrypt.client.plugins.apache.parser`
===============================================
.. automodule:: letsencrypt.client.plugins.apache.parser
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.plugins.common`
----------------------------------------
.. automodule:: letsencrypt.client.plugins.common
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.plugins.disco`
---------------------------------------
.. automodule:: letsencrypt.client.plugins.disco
:members:
-35
View File
@@ -1,35 +0,0 @@
:mod:`letsencrypt.client.plugins.nginx`
----------------------------------------
.. automodule:: letsencrypt.client.plugins.nginx
:members:
:mod:`letsencrypt.client.plugins.nginx.configurator`
=====================================================
.. automodule:: letsencrypt.client.plugins.nginx.configurator
:members:
:mod:`letsencrypt.client.plugins.nginx.dvsni`
==============================================
.. automodule:: letsencrypt.client.plugins.nginx.dvsni
:members:
:mod:`letsencrypt.client.plugins.nginx.obj`
============================================
.. automodule:: letsencrypt.client.plugins.nginx.obj
:members:
:mod:`letsencrypt.client.plugins.nginx.parser`
===============================================
.. automodule:: letsencrypt.client.plugins.nginx.parser
:members:
:mod:`letsencrypt.client.plugins.nginx.nginxparser`
====================================================
.. automodule:: letsencrypt.client.plugins.nginx.nginxparser
:members:
-11
View File
@@ -1,11 +0,0 @@
:mod:`letsencrypt.client.plugins.standalone`
--------------------------------------------
.. automodule:: letsencrypt.client.plugins.standalone
:members:
:mod:`letsencrypt.client.plugins.standalone.authenticator`
==========================================================
.. automodule:: letsencrypt.client.plugins.standalone.authenticator
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.client.proof_of_possession`
--------------------------------------------------
.. automodule:: letsencrypt.client.proof_of_possession
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.recovery_token`
--------------------------------------------------
.. automodule:: letsencrypt.client.recovery_token
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.reverter`
----------------------------------
.. automodule:: letsencrypt.client.reverter
:members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.client.revoker`
---------------------------------
.. automodule:: letsencrypt.client.revoker
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.configuration`
--------------------------------
.. automodule:: letsencrypt.configuration
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.constants`
-----------------------------------
.. automodule:: letsencrypt.constants
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.continuity_auth`
----------------------------------
.. automodule:: letsencrypt.continuity_auth
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.crypto_util`
------------------------------
.. automodule:: letsencrypt.crypto_util
:members:
+29
View File
@@ -0,0 +1,29 @@
:mod:`letsencrypt.display`
--------------------------
.. automodule:: letsencrypt.display
:members:
:mod:`letsencrypt.display.util`
===============================
.. automodule:: letsencrypt.display.util
:members:
:mod:`letsencrypt.display.ops`
==============================
.. automodule:: letsencrypt.display.ops
:members:
:mod:`letsencrypt.display.enhancements`
=======================================
.. automodule:: letsencrypt.display.enhancements
:members:
:mod:`letsencrypt.display.revocation`
=====================================
.. automodule:: letsencrypt.display.revocation
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.errors`
-------------------------
.. automodule:: letsencrypt.errors
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt`
------------------
.. automodule:: letsencrypt
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.interfaces`
-----------------------------
.. automodule:: letsencrypt.interfaces
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.le_util`
--------------------------
.. automodule:: letsencrypt.le_util
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.log`
----------------------
.. automodule:: letsencrypt.log
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.network`
--------------------------
.. automodule:: letsencrypt.network
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.network2`
---------------------------
.. automodule:: letsencrypt.network2
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.plugins.common`
---------------------------------
.. automodule:: letsencrypt.plugins.common
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.plugins.disco`
--------------------------------
.. automodule:: letsencrypt.plugins.disco
:members:
+11
View File
@@ -0,0 +1,11 @@
:mod:`letsencrypt.plugins.standalone`
-------------------------------------
.. automodule:: letsencrypt.plugins.standalone
:members:
:mod:`letsencrypt.plugins.standalone.authenticator`
===================================================
.. automodule:: letsencrypt.plugins.standalone.authenticator
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.recovery_token`
--------------------------------------------------
.. automodule:: letsencrypt.recovery_token
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.reverter`
---------------------------
.. automodule:: letsencrypt.reverter
:members:
+5
View File
@@ -0,0 +1,5 @@
:mod:`letsencrypt.revoker`
--------------------------
.. automodule:: letsencrypt.revoker
:members:
+8 -10
View File
@@ -67,12 +67,10 @@ Support for other Linux distributions coming soon.
Code components and layout
==========================
letsencrypt/acme
acme
contains all protocol specific code
letsencrypt/client
letsencrypt
all client code
letsencrypt/scripts
just the starting point of the code, main.py
Plugin-architecture
@@ -84,14 +82,14 @@ The interfaces available for plugins to implement are defined in
`interfaces.py`_.
The most common kind of plugin is a "Configurator", which is likely to
implement the `~letsencrypt.client.interfaces.IAuthenticator` and
`~letsencrypt.client.interfaces.IInstaller` interfaces (though some
implement the `~letsencrypt.interfaces.IAuthenticator` and
`~letsencrypt.interfaces.IInstaller` interfaces (though some
Configurators may implement just one of those).
There are also `~letsencrypt.client.interfaces.IDisplay` plugins,
There are also `~letsencrypt.interfaces.IDisplay` plugins,
which implement bindings to alternative UI libraries.
.. _interfaces.py: https://github.com/letsencrypt/lets-encrypt-preview/blob/master/letsencrypt/client/interfaces.py
.. _interfaces.py: https://github.com/letsencrypt/lets-encrypt-preview/blob/master/letsencrypt/interfaces.py
Authenticators
@@ -138,7 +136,7 @@ Installer Development
---------------------
There are a few existing classes that may be beneficial while
developing a new `~letsencrypt.client.interfaces.IInstaller`.
developing a new `~letsencrypt.interfaces.IInstaller`.
Installers aimed to reconfigure UNIX servers may use Augeas for
configuration parsing and can inherit from `~.AugeasConfigurator` class
to handle much of the interface. Installers that are unable to use
@@ -150,7 +148,7 @@ Display
~~~~~~~
We currently offer a pythondialog and "text" mode for displays. Display
plugins implement the `~letsencrypt.client.interfaces.IDisplay`
plugins implement the `~letsencrypt.interfaces.IDisplay`
interface.
+1
View File
@@ -13,6 +13,7 @@ Welcome to the Let's Encrypt client documentation!
:maxdepth: 1
api
pkgs
Indices and tables
+14
View File
@@ -0,0 +1,14 @@
========
Packages
========
.. note:: It is planned to distribute `acme` and plugins separately as
described in `#358`_. For the time being those packages are bundled
together into a single repo, and single documentation.
.. _`#358`: https://github.com/letsencrypt/lets-encrypt-preview/issues/358
.. toctree::
:glob:
pkgs/**
+61
View File
@@ -0,0 +1,61 @@
:mod:`acme`
===========
.. contents::
.. automodule:: acme
:members:
Messages
--------
v00
~~~
.. automodule:: acme.messages
:members:
v02
~~~
.. automodule:: acme.messages2
:members:
Challenges
----------
.. automodule:: acme.challenges
:members:
Other ACME objects
------------------
.. automodule:: acme.other
:members:
Fields
------
.. automodule:: acme.fields
:members:
Errors
------
.. automodule:: acme.errors
:members:
:members:
Utilities
---------
.. automodule:: acme.util
:members:
+67
View File
@@ -0,0 +1,67 @@
:mod:`acme.jose`
================
.. contents::
.. automodule:: acme.jose
:members:
JSON Web Algorithms
-------------------
.. automodule:: acme.jose.jwa
:members:
JSON Web Key
------------
.. automodule:: acme.jose.jwk
:members:
JSON Web Signature
------------------
.. automodule:: acme.jose.jws
:members:
Implementation details
----------------------
Interfaces
~~~~~~~~~~
.. automodule:: acme.jose.interfaces
:members:
Errors
~~~~~~
.. automodule:: acme.jose.errors
:members:
JSON utilities
~~~~~~~~~~~~~~
.. automodule:: acme.jose.json_util
:members:
JOSE Base64
~~~~~~~~~~~
.. automodule:: acme.jose.b64
:members:
Utilities
~~~~~~~~~
.. automodule:: acme.jose.util
:members:
+29
View File
@@ -0,0 +1,29 @@
:mod:`letsencrypt_apache`
-------------------------
.. automodule:: letsencrypt_apache
:members:
:mod:`letsencrypt_apache.configurator`
======================================
.. automodule:: letsencrypt_apache.configurator
:members:
:mod:`letsencrypt_apache.dvsni`
===============================
.. automodule:: letsencrypt_apache.dvsni
:members:
:mod:`letsencrypt_apache.obj`
=============================
.. automodule:: letsencrypt_apache.obj
:members:
:mod:`letsencrypt_apache.parser`
================================
.. automodule:: letsencrypt_apache.parser
:members:
+35
View File
@@ -0,0 +1,35 @@
:mod:`letsencrypt_nginx`
------------------------
.. automodule:: letsencrypt_nginx
:members:
:mod:`letsencrypt_nginx.configurator`
=====================================
.. automodule:: letsencrypt_nginx.configurator
:members:
:mod:`letsencrypt_nginx.dvsni`
==============================
.. automodule:: letsencrypt_nginx.dvsni
:members:
:mod:`letsencrypt_nginx.obj`
============================
.. automodule:: letsencrypt_nginx.obj
:members:
:mod:`letsencrypt_nginx.parser`
===============================
.. automodule:: letsencrypt_nginx.parser
:members:
:mod:`letsencrypt_nginx.nginxparser`
====================================
.. automodule:: letsencrypt_nginx.nginxparser
:members:
+2 -2
View File
@@ -5,8 +5,8 @@ Plugins
Let's Encrypt client supports dynamic discovery of plugins through the
`setuptools entry points`_. This way you can, for example, create a
custom implementation of
`~letsencrypt.client.interfaces.IAuthenticator` or the
'~letsencrypt.client.interfaces.IInstaller' without having to
`~letsencrypt.interfaces.IAuthenticator` or the
'~letsencrypt.interfaces.IInstaller' without having to
merge it with the core upstream source code. An example is provided in
``examples/plugins/`` directory.