Skip to content

Commit 9a5b62a

Browse files
authored
Merge pull request #4685 from Netflix/jmcrawford45-patch-7
Document CIS issuer plugin options
2 parents 493e3ac + d2ce806 commit 9a5b62a

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

docs/administration.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1627,6 +1627,50 @@ The following configuration properties are required to use the Digicert issuer p
16271627

16281628
This is whether or not to issue a private certificate. (Default: False)
16291629

1630+
Digicert CIS Issuer Plugin
1631+
~~~~~~~~~~~~~~~~~~~~~~~~~~
1632+
1633+
The following configuration properties are required to use the Digicert CIS issuer plugin.
1634+
1635+
1636+
.. data:: DIGICERT_CIS_URL
1637+
:noindex:
1638+
1639+
This is the url for the Digicert CIS API (e.g. https://ws.digicert.com)
1640+
1641+
1642+
.. data:: DIGICERT_CIS_API_KEY
1643+
:noindex:
1644+
1645+
This is the Digicert API key
1646+
1647+
1648+
.. data:: DIGICERT_CIS_PROFILE_NAMES
1649+
:noindex:
1650+
1651+
A string->string mapping from human readable representations to profile identifiers. For example {"Digicert": "my_company_ssl"} specifies that when users
1652+
request a Digicert issuer cert, the plugin will pass profile=my_company_ssl to the API.
1653+
1654+
The following configuration properties are optional when using the Digicert CIS issuer plugin.
1655+
1656+
1657+
.. data:: DIGICERT_CIS_SIGNING_ALGORITHMS
1658+
:noindex:
1659+
1660+
Defines the default signing algorithm for a given issuer name e.g. {"Digicert": "sha1"} will result in sha1 certs issued with the Digicert issuer (default = {}).
1661+
1662+
1663+
.. data:: DIGICERT_CIS_ROOTS
1664+
:noindex:
1665+
1666+
A string->string mapping from issuer name to root PEM. These will be optionally be appended to / stripped from response chains as requested by users.
1667+
1668+
1669+
.. data:: DIGICERT_CIS_USE_CSR_FIELDS
1670+
:noindex:
1671+
1672+
Controls the setting of the `use_csr_fields` parameter of the create certificate endpoint. When set, certificates will be issued with values from the csr instead of via API fields (default = False).
1673+
16301674

16311675
CFSSL Issuer Plugin
16321676
~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)