diff options
Diffstat (limited to 'man/man8/puppetca.8')
| -rw-r--r-- | man/man8/puppetca.8 | 297 |
1 files changed, 168 insertions, 129 deletions
diff --git a/man/man8/puppetca.8 b/man/man8/puppetca.8 index ec1f5045c..17369aa20 100644 --- a/man/man8/puppetca.8 +++ b/man/man8/puppetca.8 @@ -1,130 +1,169 @@ -.TH "" "" "" -.SH NAME - \- -.\" Man page generated from reStructeredText. -. -.SH SYNOPSIS -.sp -Stand\-alone certificate authority. Capable of generating certificates -but mostly meant for signing certificate requests from puppet clients. -.SH USAGE -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.TP -.B puppet cert [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] -. -[\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] -[\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [\-\-digest DIGEST] -[\-\-fingerprint] [host] -.UNINDENT -.UNINDENT -.UNINDENT -.SH DESCRIPTION -.sp -Because the puppetmasterd daemon defaults to not signing client -certificate requests, this script is available for signing outstanding -requests. It can be used to list outstanding requests and then either -sign them individually or sign all of them. -.SH OPTIONS -.sp -Note that any configuration parameter that\(aqs valid in the configuration -file is also a valid long argument. For example, \(aqssldir\(aq is a valid -configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an -argument. -.sp -See the configuration file documentation at -\fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for -the full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppet cert with -\(aq\-\-genconfig\(aq. -.INDENT 0.0 -.TP -.B all: Operate on all items. Currently only makes sense with -. -\(aq\-\-sign\(aq, \(aq\-\-clean\(aq, or \(aq\-\-list\(aq. -.TP -.B digest: Set the digest for fingerprinting (defaults to md5). Valid -. -values depends on your openssl and openssl ruby extension -version, but should contain at least md5, sha1, md2, -sha256. -.TP -.B clean: Remove all files related to a host from puppet cert\(aqs -. -storage. This is useful when rebuilding hosts, since new -certificate signing requests will only be honored if puppet -cert does not have a copy of a signed certificate for that -host. The certificate of the host remains valid. If \(aq\-\-all\(aq -is specified then all host certificates, both signed and -unsigned, will be removed. -.UNINDENT -.sp -debug: Enable full debugging. -.INDENT 0.0 -.TP -.B generate: Generate a certificate for a named client. A -. -certificate/keypair will be generated for each client named -on the command line. -.UNINDENT -.sp -help: Print this help message -.INDENT 0.0 -.TP -.B list: List outstanding certificate requests. If \(aq\-\-all\(aq is -. -specified, signed certificates are also listed, prefixed by -\(aq+\(aq, and revoked or invalid certificates are prefixed by -\(aq\-\(aq (the verification outcome is printed in parenthesis). -.UNINDENT -.sp -print: Print the full\-text version of a host\(aqs certificate. -.INDENT 0.0 -.TP -.B fingerprint: Print the DIGEST (defaults to md5) fingerprint of a host\(aqs -. -certificate. -.TP -.B revoke: Revoke the certificate of a client. The certificate can be -. -specified either by its serial number, given as a decimal -number or a hexadecimal number prefixed by \(aq0x\(aq, or by its -hostname. The certificate is revoked by adding it to the -Certificate Revocation List given by the \(aqcacrl\(aq config -parameter. Note that the puppetmasterd needs to be -restarted after revoking certificates. -.TP -.B sign: Sign an outstanding certificate request. Unless \(aq\-\-all\(aq is -. -specified, hosts must be listed after all flags. -.UNINDENT -.sp -verbose: Enable verbosity. -.sp -version: Print the puppet version number and exit. -.INDENT 0.0 -.TP -.B verify: Verify the named certificate against the local CA -. -certificate. -.UNINDENT -.SH EXAMPLE -.INDENT 0.0 -.INDENT 3.5 -.sp -$ puppet cert \-l -culain.madstop.com -$ puppet cert \-s culain.madstop.com -.UNINDENT -.UNINDENT -.SH AUTHOR -.sp -Luke Kanies -.SH COPYRIGHT -.sp -Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public -License -.\" Generated by docutils manpage writer. -.\" +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 . +.TH "PUPPETCA" "8" "August 2010" "" "" +Stand\-alone certificate authority\. Capable of generating certificates but mostly meant for signing certificate requests from puppet clients\.puppet cert [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] +. +.IP "" 4 +. +.nf + + [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] + [\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [\-\-digest DIGEST] + [\-\-fingerprint] [host] +. +.fi +. +.IP "" 0 +Because the puppetmasterd daemon defaults to not signing client certificate requests, this script is available for signing outstanding requests\. It can be used to list outstanding requests and then either sign them individually or sign all of them\.Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid configuration parameter, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\. +. +.P +See the configuration file documentation at http://reductivelabs\.com/projects/puppet/reference/configref\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet cert with \'\-\-genconfig\'\. +. +.P +all: Operate on all items\. Currently only makes sense with +. +.IP "" 4 +. +.nf + + \'\-\-sign\', \'\-\-clean\', or \'\-\-list\'\. +. +.fi +. +.IP "" 0 +. +.P +digest: Set the digest for fingerprinting (defaults to md5)\. Valid +. +.IP "" 4 +. +.nf + + values depends on your openssl and openssl ruby extension + version, but should contain at least md5, sha1, md2, + sha256\. +. +.fi +. +.IP "" 0 +. +.P +clean: Remove all files related to a host from puppet cert\'s +. +.IP "" 4 +. +.nf + + storage\. This is useful when rebuilding hosts, since new + certificate signing requests will only be honored if puppet + cert does not have a copy of a signed certificate for that + host\. The certificate of the host remains valid\. If \'\-\-all\' + is specified then all host certificates, both signed and + unsigned, will be removed\. +. +.fi +. +.IP "" 0 +. +.P +debug: Enable full debugging\. +. +.P +generate: Generate a certificate for a named client\. A +. +.IP "" 4 +. +.nf + + certificate/keypair will be generated for each client named + on the command line\. +. +.fi +. +.IP "" 0 +. +.P +help: Print this help message +. +.P +list: List outstanding certificate requests\. If \'\-\-all\' is +. +.IP "" 4 +. +.nf + + specified, signed certificates are also listed, prefixed by + \'+\', and revoked or invalid certificates are prefixed by + \'\-\' (the verification outcome is printed in parenthesis)\. +. +.fi +. +.IP "" 0 +. +.P +print: Print the full\-text version of a host\'s certificate\. +. +.P +fingerprint: Print the DIGEST (defaults to md5) fingerprint of a host\'s +. +.IP "" 4 +. +.nf + + certificate\. +. +.fi +. +.IP "" 0 +. +.P +revoke: Revoke the certificate of a client\. The certificate can be +. +.IP "" 4 +. +.nf + + specified either by its serial number, given as a decimal + number or a hexadecimal number prefixed by \'0x\', or by its + hostname\. The certificate is revoked by adding it to the + Certificate Revocation List given by the \'cacrl\' config + parameter\. Note that the puppetmasterd needs to be + restarted after revoking certificates\. +. +.fi +. +.IP "" 0 +. +.P +sign: Sign an outstanding certificate request\. Unless \'\-\-all\' is +. +.IP "" 4 +. +.nf + + specified, hosts must be listed after all flags\. +. +.fi +. +.IP "" 0 +. +.P +verbose: Enable verbosity\. +. +.P +version: Print the puppet version number and exit\. +. +.P +verify: Verify the named certificate against the local CA +. +.IP "" 4 +. +.nf + + certificate\. +. +.fi +. +.IP "" 0 +$ puppet cert \-l culain\.madstop\.com $ puppet cert \-s culain\.madstop\.comLuke KaniesCopyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License |