valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 09:23:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc issues

Browse Source
This commit is contained in:
Clint Armstrong 2015-03-31 08:46:08 -04:00
parent 3840e7214f
commit 0d108f6701
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
salt/modules/x509.py
View File

@ -461,9 +461,9 @@ def read_csr(csr):
'''
Returns a dict containing details of a certificate request.
:depends - openssl command line tool
:depends: - OpenSSL command line tool
param: csr:
csr:
A path or PEM encoded string containing the CSR to read.
CLI Example:
@ -492,9 +492,9 @@ def read_crl(crl):
'''
Returns a dict containing details of a certificate revocation list. Input can be a PEM string or file path.
:depends - openssl command line tool
:depends: - OpenSSL command line tool
param: csl:
csl:
A path or PEM encoded string containing the CSL to read.
CLI Example:
@ -519,7 +519,7 @@ def get_public_key(key):
'''
Returns a string containing the public key in PEM format.
param: key:
key:
A path or PEM encoded string containing a CSR, Certificate or Private Key from which
a public key can be retrieved.
@ -555,7 +555,7 @@ def get_private_key_size(private_key):
'''
Returns the bit length of a private key in PEM format.
param: private_key:
private_key:
A path or PEM encoded string containing a private key.
CLI Example:
@ -775,6 +775,10 @@ def sign_remote_certificate(argdic, **kwargs):
def get_signing_policy(signing_policy):
'''
Returns the details of a names signing policy, including the text of the public key that will be used
to sign it. Does not return the private key.
'''
if signing_policy not in __salt__['config.get']('x509_signing_policies'):
return 'Signing policy {0} does not exist.'.format(signing_policy)
signing_policy = __salt__['config.get']('x509_signing_policies')[signing_policy]

8
salt/states/x509.py
View File

@ -11,6 +11,7 @@ signed by ``ca``.
For remote signing, peers must be permitted to remotely call the ``sign_remote_certificate`` function.
/srv/salt/master.d/peer.sls
.. code-block:: yaml
peer:
@ -19,6 +20,7 @@ For remote signing, peers must be permitted to remotely call the ``sign_remote_c
/srv/salt/top.sls
.. code-block:: yaml
base:
@ -34,6 +36,7 @@ This state creates the CA key, certificate and signing policy. It also publishes
the mine where it can be easily retrieved by other minions.
/srv/salt/ca.sls
.. code-block:: yaml
salt-minion:
@ -86,6 +89,7 @@ The signing policy defines properties that override any property requested or in
can define a restricted list of minons which are allowed to remotely invoke this signing policy.
/srv/salt/signing_policies.conf
.. code-block:: yaml
x509_signing_policies:
@ -107,6 +111,7 @@ can define a restricted list of minons which are allowed to remotely invoke this
This state will instruct all minions to trust certificates signed by our new CA. I'm intentionally stripping newlines from the text because dealing with newlines in yaml can be painful, and the pem_managed state will properly format the string before writing it out.
/srv/salt/cert.sls
.. code-block:: yaml
/usr/local/share/ca-certificates/intca.crt
@ -117,6 +122,7 @@ This state will instruct all minions to trust certificates signed by our new CA.
This state creates a private key then requests a certificate signed by ``ca`` according to the www policy.
/srv/salt/www.sls
.. code-block:: yaml
/etc/pki/www.key:
@ -296,7 +302,7 @@ def certificate_managed(name,
kwargs:
Any arguments supported by the ``x509.create_certificate`` module are supported.
Example:
Examples:
.. code-block:: yaml