Skip to content

Commit

Permalink
Add basic docs on configuring secrets backend.
Browse files Browse the repository at this point in the history
  • Loading branch information
rfk committed Jun 12, 2014
1 parent 608cdab commit 42fc60f
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/source/configuration.rst
Expand Up @@ -8,6 +8,7 @@ typical Paste configuration file.
Relevant sections:

- tokenserver
- tokenserver.secrets
- endpoints
- browserid

Expand All @@ -17,7 +18,8 @@ Example::
backend = tokenserver.assignment.fixednode.DefaultNodeAssignmentBackend
service_entry = example.com
applications = sync-1.0, aitc-1.0
secrets_file = tokenserver/tests/secrets
secrets.backend = mozsvc.secrets.FixedSecrets
secrets.secrets = abcdef123456

[endpoints]
aitc-1.0 = {node}/1.0/{uid}
Expand Down Expand Up @@ -48,7 +50,7 @@ tokenserver
of a name and a version.

**secrets.backend**
One of the classes from :module:`mozsvc.secrets` to be used for managing
One of the classes from :class:`mozsvc.secrets` to be used for managing
node-specific secret keys.

**sqluri** -- for SQL backends only
Expand Down Expand Up @@ -85,6 +87,32 @@ tokenserver
Defaults to 10.


tokenserver.secrets
~~~~~~~~~~~~~~~~~~~
Configures a "secrets management" class that is used to determine the
master token-signing secret for each node.

**backend**
The class used to manage per-node secret keys.

Possible values:

- :class:`mozsvc.secrets.Secrets`
- :class:`mozsvc.secrets.FixedSecrets`
- :class:`mozsvc.secrets.DerivedSecrets`

**filename** -- for Secrets class only
A file listing each available node along with its secret keys.

**secrets** -- for FixedSecrets class only
A list of hex-encoded secret keys, which will be used for all
nodes.

**master_secrets** -- for DerivedSecrets class only
A list of hex-encoded secret keys. Unique secrets for each node will
be derived from these master secrets using HKDF.


endpoint
~~~~~~~~
List of patterns for the api endpoints. The variable is the application name,
Expand Down

0 comments on commit 42fc60f

Please sign in to comment.