.TH CERTMONGER 1 "February 9, 2015" "certmonger Manual"

.SH NAME
getcert

.SH SYNOPSIS
getcert start\-tracking [options]

.SH DESCRIPTION
Tells \fIcertmonger\fR to monitor an already\-issued certificate.
Optionally, when the certificate nears expiration, use an existing key
pair (or to generate one if one is not already found in the specified
location), to generate a signing request using the key pair and to
submit them for signing to a CA.

.SH SPECIFYING EXISTING REQUESTS
.TP
\fB\-i\fR \fINAME\fR, \fB\-\-id\fR=\fINAME\fR
Modify the request which has this nickname.  If this option is not specified,
and a tracking entry which matches the key and certificate storage options
which are specified already exists, that entry will be modified.  Otherwise, a
new tracking entry will be added.

.SH KEY AND CERTIFICATE STORAGE OPTIONS
.TP
\fB\-d\fR \fIDIR\fR, \fR\-\-dbdir\fR=\fIDIR\fR
Use an NSS database in the specified directory for reading this
certificate and, if possible, the corresponding key.
.TP
\fB\-n\fR \fINAME\fR, \fR\-\-nickname\fR=\fINAME\fR
Use the certificate with this nickname, and if a private key with the
same nickname or which corresponds to the certificate is available, to
use it, too.
Only valid with \fB\-d\fR.
.TP
\fB\-t\fR \fITOKEN\fR, \fB\-\-token\fR=\fITOKEN\fR
If the NSS database has more than one token available, use the token
with this name for accessing the certificate and key.  This argument
only rarely needs to be specified.
Only valid with \fB\-d\fR.
.TP
\fB\-f\fR \fIFILE\fR, \fB\-\-certfile\fR=\fIFILE\fR
Read the certificate from this file.  For safety's sake, do not use the
same file specified with the \fB\-k\fR option.
.TP
\fB\-k\fR \fIFILE\fR, \fB\-\-keyfile\fR=\fIFILE\fR
Use the key stored in this file to generate a signing request for
refreshing the certificate.  If no such file is found when needed,
generate a new key pair and store them in the file.
Only valid with \fB\-f\fR.

.SH KEY ENCRYPTION OPTIONS
.TP
\fB\-p\fR \fIFILE\fR, \fB\-\-pinfile\fR=\fIFILE\fR
The private key files or databases are encrypted using the PIN stored in the
named file as the passphrase.
.TP
\fB\-P\fR \fIPIN\fR, \fB\-\-pin\fR=\fIPIN\fR
The private key files or databases are encrypted using the specified PIN as the
passphrase.  Because command\-line arguments to running processes are trivially
discoverable, use of this option is not recommended except for testing.

.SH TRACKING OPTIONS
.TP
\fB\-I\fR \fINAME\fR, \fB\-\-new\-id\fR=\fINAME\fR
Assign the specified nickname to this task.  If this option is not specified,
a name will be assigned automatically.
.TP
\fB\-r\fR, \fB\-\-renew\fR
Attempt to obtain a new certificate from the CA when the expiration date of a
certificate nears.  This is the default setting.
.TP
\fB\-R\fR, \fB\-\-no\-renew\fR
Don't attempt to obtain a new certificate from the CA when the expiration date
of a certificate nears.  If this option is specified, an expired certificate
will simply stay expired.

.SH ENROLLMENT OPTIONS
.TP
\fB\-c\fR  \fINAME\fR, \fB\-\-ca\fR=\fINAME\fR
Enroll with the specified CA rather than a possible default.  The name of
the CA should correspond to one listed by \fIgetcert list\-cas\fR.  Only
useful in combination with \fB\-r\fR.
.TP
\fB\-T\fR \fINAME\fR, \fB\-\-profile\fR=\fINAME\fR
Request a certificate using the named profile, template, or certtype,
from the specified CA.
.TP
\fB\-\-ms\-template\-spec\fR \fISPEC\fR
Include a V2 Certificate Template extension in the signing request.
This datum includes an Object Identifier, a major version number
(positive integer) and an optional minor version number.  The format
is: \fB<oid>:<majorVersion>[:<minorVersion>]\fR.
.TP
\fB\-X\fR \fINAME\fR, \fB\-\-issuer\fR=\fINAME\fR
Request a certificate using the named issuer from the specified CA.

.SH SIGNING REQUEST OPTIONS
If and when \fIcertmonger\fR attempts to obtain a new certificate to replace
the one being monitored, the values to be added to the signing request will be
taken from the current certificate, unless preferred values are set using one
or more of \fB\-u\R, \fB\-U\fR, \fB\-K\fR, \fB\-E\fR, and \fB\-D\fR.

.TP
\fB\-u\fR \fIkeyUsage\fR, \fB\-\-key\-usage\fR=\fIkeyUsage\fR
Add an extensionRequest for the specified keyUsage to the
signing request.  The keyUsage value is expected to be one of these names:

digitalSignature

nonRepudiation

keyEncipherment

dataEncipherment

keyAgreement

keyCertSign

cRLSign

encipherOnly

decipherOnly
.TP
\fB\-U\fR \fIEKU\fR, \fB\-\-extended\-key\-usage\fR=\fIEKU\fR
Add an extensionRequest for the specified extendedKeyUsage to the
signing request.  The EKU value is expected to be an object identifier
(OID).
.TP
\fB\-K\fR \fINAME\fR, \fB\-\-principal\fR=\fINAME\fR
Add an extensionRequest for a subjectAltName, with the specified Kerberos
principal name as its value, to the signing request.
.TP
\fB\-E\fR \fIEMAIL\fR, \fB\-\-email\fR=\fIEMAIL\fR
Add an extensionRequest for a subjectAltName, with the specified email
address as its value, to the signing request.
.TP
\fB\-D\fR \fIDNSNAME\fR, \fB\-\-dns\fR=\fIDNSNAME\fR
Add an extensionRequest for a subjectAltName, with the specified DNS name
as its value, to the signing request.
.TP
\fB\-A\fR \fIADDRESS\fR, \fB\-\-ip\-address\fR=\fIADDRESS\fR
Add an extensionRequest for a subjectAltName, with the specified IP address
as its value, to the signing request.
.TP
\fB\-l\fR \fIFILE\fR, \fB\-\-challenge\-password\-file\fR=\fIFILE\fR
Add an optional ChallengePassword value, read from the file, to the signing
request.  A ChallengePassword is often required when the CA is accessed using
SCEP.
.TP
\fB\-L\fR \fIPASSWORD\fR, \fB\-\-challenge\-password\fR=\fIPASSWORD\fR
Add the argument value to the signing request as a ChallengePassword attribute.
A ChallengePassword is often required when the CA is accessed using SCEP.

.SH OTHER OPTIONS
.TP
\fB\-B\fR \fICOMMAND\fR, \fB\-\-before\-command\fR=\fICOMMAND\fR
When ever the certificate or the CA's certificates are saved to the
specified locations, run the specified command as the client user before
saving the certificates.
.TP
\fB\-C\fR \fICOMMAND\fR, \fB\-\-after\-command\fR=\fICOMMAND\fR
When ever the certificate or the CA's certificates are saved to the
specified locations, run the specified command as the client user after
saving the certificates.
.TP
\fB\-a\fR \fIDIR\fR, \fB\-\-ca\-dbdir\fR=\fIDIR\fR
When ever the certificate is saved to the specified location, if root
certificates for the CA are available, save them to the specified NSS database.
.TP
\fB\-F\fR \fIFILE\fR, \fB\-\-ca\-file\fR=\fIFILE\fR
When ever the certificate is saved to the specified location, if root
certificates for the CA are available, and when the local copies of the
CA's root certificates are updated, save them to the specified file.
.TP
\fB\-w\fR, \fB\-\-wait\fR
Wait for the certificate to become valid or to be reissued and saved, or for
the attempt to obtain a new one to fail.
.TP
\fB\-\-wait\-timeout\fR=\fITIMEOUT\fR
Maximum time to wait for the certificate to be issued.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose about errors.  Normally, the details of an error received from
the daemon will be suppressed if the client can make a diagnostic suggestion.
.TP
\fB\-o\fR \fIOWNER\fR, \fB\-\-key\-owner\fR=\fIOWNER\fR
After generation set the owner on the private key file or database to OWNER.
.TP
\fB\-m\fR \fIMODE\fR, \fB\-\-key\-perms\fR=\fIMODE\fR
After generation set the file permissions on the private key file or database to MODE.
.TP
\fB\-O\fR \fIOWNER\fR, \fR\-\-cert\-owner\fR=\fIOWNER\fR
After generation set the owner on the certificate file or database to OWNER.
.TP
\fB\-M\fR \fIMODE\fR, \fR\-\-cert\-perms\fR=\fIMODE\fR
After generation set the file permissions on the certificate file or database to MODE.
.SH BUS OPTIONS
.TP
\fB\-s\fR, \fB\-\-session\fR
Connect to certmonger on the session bus rather than the system bus.
.TP
\fB\-S\fR, \fB\-\-system\fR
Connect to certmonger on the system bus rather than the session bus.  This
is the default.
.SH NOTES
Locations specified for key and certificate storage need to be
accessible to the \fIcertmonger\fR daemon process.  When run as a system
daemon on a system which uses a mandatory access control mechanism such
as SELinux, the system policy must ensure that the daemon is allowed to
access the locations where certificates and keys that it will manage
will be stored (these locations are typically labeled as \fIcert_t\fR or
an equivalent).  More SELinux\-specific information can be found in the
\fIselinux.txt\fR documentation file for this package.

.SH BUGS
Please file tickets for any that you find at https://fedorahosted.org/certmonger/

.SH SEE ALSO
\fBcertmonger\fR(8)
\fBgetcert\fR(1)
\fBgetcert\-add\-ca\fR(1)
\fBgetcert\-add\-scep\-ca\fR(1)
\fBgetcert\-list\-cas\fR(1)
\fBgetcert\-list\fR(1)
\fBgetcert\-modify\-ca\fR(1)
\fBgetcert\-refresh\-ca\fR(1)
\fBgetcert\-refresh\fR(1)
\fBgetcert\-rekey\fR(1)
\fBgetcert\-remove\-ca\fR(1)
\fBgetcert\-request\fR(1)
\fBgetcert\-resubmit\fR(1)
\fBgetcert\-status\fR(1)
\fBgetcert\-stop\-tracking\fR(1)
\fBcertmonger\-certmaster\-submit\fR(8)
\fBcertmonger\-dogtag\-ipa\-renew\-agent\-submit\fR(8)
\fBcertmonger\-dogtag\-submit\fR(8)
\fBcertmonger\-ipa\-submit\fR(8)
\fBcertmonger\-local\-submit\fR(8)
\fBcertmonger\-scep\-submit\fR(8)
\fBcertmonger_selinux\fR(8)