summaryrefslogtreecommitdiffstats
path: root/ipaserver/plugins/ca.py
diff options
context:
space:
mode:
authorFraser Tweedale <ftweedal@redhat.com>2016-09-23 16:05:55 +1000
committerMartin Basti <mbasti@redhat.com>2016-10-06 19:24:54 +0200
commit2b8163ab5dfcf28a9eba319ef685046ae9d8b5e8 (patch)
tree4bbc443f2711e8711f1e0d8b21a35e6297c78a32 /ipaserver/plugins/ca.py
parent6b3f4984296f3caff8f29490eae3ed1dca64b8c3 (diff)
downloadfreeipa-2b8163ab5dfcf28a9eba319ef685046ae9d8b5e8.tar.gz
freeipa-2b8163ab5dfcf28a9eba319ef685046ae9d8b5e8.tar.xz
freeipa-2b8163ab5dfcf28a9eba319ef685046ae9d8b5e8.zip
Add commentary about CA deletion to plugin doc
Add commentary to 'ca' plugin documentation to explain what happens when a CA gets deleted - namely, that its signing cert gets revoked and its private key deleted. Also break the docstring up into smaller chunks to aid translation. Fixes: https://fedorahosted.org/freeipa/ticket/6256 Reviewed-By: Martin Basti <mbasti@redhat.com>
Diffstat (limited to 'ipaserver/plugins/ca.py')
-rw-r--r--ipaserver/plugins/ca.py21
1 files changed, 13 insertions, 8 deletions
diff --git a/ipaserver/plugins/ca.py b/ipaserver/plugins/ca.py
index 4d83fe81c..d9ae8c81f 100644
--- a/ipaserver/plugins/ca.py
+++ b/ipaserver/plugins/ca.py
@@ -14,33 +14,38 @@ from ipalib import _, ngettext
__doc__ = _("""
Manage Certificate Authorities
-
+""") + _("""
Subordinate Certificate Authorities (Sub-CAs) can be added for scoped issuance
of X.509 certificates.
-
+""") + _("""
CAs are enabled on creation, but their use is subject to CA ACLs unless the
operator has permission to bypass CA ACLs.
-
+""") + _("""
All CAs except the 'IPA' CA can be disabled or re-enabled. Disabling a CA
prevents it from issuing certificates but does not affect the validity of its
certificate.
-
-
+""") + _("""
+CAs (all except the 'IPA' CA) can be deleted. Deleting a CA causes its signing
+certificate to be revoked and its private key deleted.
+""") + _("""
EXAMPLES:
-
+""") + _("""
Create new CA, subordinate to the IPA CA.
ipa ca-add puppet --desc "Puppet" \\
--subject "CN=Puppet CA,O=EXAMPLE.COM"
-
+""") + _("""
Disable a CA.
ipa ca-disable puppet
-
+""") + _("""
Re-enable a CA.
ipa ca-enable puppet
+""") + _("""
+ Delete a CA.
+ ipa ca-del puppet
""")