| .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) |
| .\" |
| .\" Standard preamble: |
| .\" ======================================================================== |
| .de Sp \" Vertical space (when we can't use .PP) |
| .if t .sp .5v |
| .if n .sp |
| .. |
| .de Vb \" Begin verbatim text |
| .ft CW |
| .nf |
| .ne \\$1 |
| .. |
| .de Ve \" End verbatim text |
| .ft R |
| .fi |
| .. |
| .\" Set up some character translations and predefined strings. \*(-- will |
| .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| .\" nothing in troff, for use with C<>. |
| .tr \(*W- |
| .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| .ie n \{\ |
| . ds -- \(*W- |
| . ds PI pi |
| . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| . ds L" "" |
| . ds R" "" |
| . ds C` "" |
| . ds C' "" |
| 'br\} |
| .el\{\ |
| . ds -- \|\(em\| |
| . ds PI \(*p |
| . ds L" `` |
| . ds R" '' |
| . ds C` |
| . ds C' |
| 'br\} |
| .\" |
| .\" Escape single quotes in literal strings from groff's Unicode transform. |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .\" |
| .\" If the F register is turned on, we'll generate index entries on stderr for |
| .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| .\" entries marked with X<> in POD. Of course, you'll have to process the |
| .\" output yourself in some meaningful fashion. |
| .\" |
| .\" Avoid warning from groff about undefined register 'F'. |
| .de IX |
| .. |
| .nr rF 0 |
| .if \n(.g .if rF .nr rF 1 |
| .if (\n(rF:(\n(.g==0)) \{ |
| . if \nF \{ |
| . de IX |
| . tm Index:\\$1\t\\n%\t"\\$2" |
| .. |
| . if !\nF==2 \{ |
| . nr % 0 |
| . nr F 2 |
| . \} |
| . \} |
| .\} |
| .rr rF |
| .\" |
| .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| .\" Fear. Run. Save yourself. No user-serviceable parts. |
| . \" fudge factors for nroff and troff |
| .if n \{\ |
| . ds #H 0 |
| . ds #V .8m |
| . ds #F .3m |
| . ds #[ \f1 |
| . ds #] \fP |
| .\} |
| .if t \{\ |
| . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| . ds #V .6m |
| . ds #F 0 |
| . ds #[ \& |
| . ds #] \& |
| .\} |
| . \" simple accents for nroff and troff |
| .if n \{\ |
| . ds ' \& |
| . ds ` \& |
| . ds ^ \& |
| . ds , \& |
| . ds ~ ~ |
| . ds / |
| .\} |
| .if t \{\ |
| . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| .\} |
| . \" troff and (daisy-wheel) nroff accents |
| .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| .ds ae a\h'-(\w'a'u*4/10)'e |
| .ds Ae A\h'-(\w'A'u*4/10)'E |
| . \" corrections for vroff |
| .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| . \" for low resolution devices (crt and lpr) |
| .if \n(.H>23 .if \n(.V>19 \ |
| \{\ |
| . ds : e |
| . ds 8 ss |
| . ds o a |
| . ds d- d\h'-1'\(ga |
| . ds D- D\h'-1'\(hy |
| . ds th \o'bp' |
| . ds Th \o'LP' |
| . ds ae ae |
| . ds Ae AE |
| .\} |
| .rm #[ #] #H #V #F C |
| .\" ======================================================================== |
| .\" |
| .IX Title "swtpm-localca 8" |
| .TH swtpm-localca 8 "2017-11-13" "swtpm" "" |
| .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| .\" way too many mistakes in technical documents. |
| .if n .ad l |
| .nh |
| .SH "NAME" |
| swtpm\-localca \- Local CA to create EK and platform certs for swtpm |
| .SH "SYNOPSIS" |
| .IX Header "SYNOPSIS" |
| \&\fBswtpm-localca [\s-1OPTIONS\s0]\fR |
| .SH "DESCRIPTION" |
| .IX Header "DESCRIPTION" |
| \&\fBswtpm-localca\fR is a tool to create \s-1TPM\s0 Endorsement Key (\s-1EK\s0) and platform |
| certificates on the host. It uses the \fIswtpm_cert\fR program to create |
| the certificates. |
| .PP |
| The program will typically be invoked by the \fIswtpm_setup\fR program |
| that uses the \fI/etc/swtpm_setup.conf\fR configuration file where |
| a variable needs to be set that points to this program. |
| It implements command line options that the \fIswtpm_setup\fR |
| program uses to provide the necessary parameters to it. |
| .PP |
| \&\fBswtpm-localca\fR will automatically try to create the signing key and |
| certificate if the configuration points to a missing signing key. |
| Since this certificate must be signed by a \s-1CA,\s0 a root certificate authority |
| will also be created and will sign this certificate. The root \s-1CA\s0's |
| private key and certificate will be located in the same directory as the |
| signing key and have the names swtpm\-localca\-rootca\-privkey.pem and |
| swtpm\-localca\-rootca\-cert.pem respectively. The environment variable |
| \&\s-1SWTPM_ROOTCA_PASSWORD\s0 can be set for the password of the root \s-1CA\s0's |
| private key. |
| .PP |
| The following options are supported: |
| .IP "\fB\-\-type type\fR" 4 |
| .IX Item "--type type" |
| This parameter indicates the type of certificate to create. The type parameter may |
| be one of the following: \fIek\fR, or \fIplatform\fR |
| .IP "\fB\-\-dir dir\fR" 4 |
| .IX Item "--dir dir" |
| This parameter indicates the directory into which the certificate is to be stored. |
| The \s-1EK\s0 certificate is stored in this directory under the name |
| ek.cert and the platform certificate under the name platform.cert. |
| .IP "\fB\-\-ek ek\fR" 4 |
| .IX Item "--ek ek" |
| This parameter indicates the modulus of the public key of the endorsement key |
| (\s-1EK\s0). The public key is provided as a sequence of \s-1ASCII\s0 hex digits. |
| .Sp |
| In case \s-1ECC \s0(elliptic curve crypography) keys are used, the parameter must |
| have the format \-\-ek x=<hex digits>,y=<hex digits>. |
| .IP "\fB\-\-vmid \s-1ID\s0\fR" 4 |
| .IX Item "--vmid ID" |
| This parameter indicates the \s-1ID\s0 of the \s-1VM\s0 for which to create the certificate. |
| .IP "\fB\-\-logfile <logfile\fR>" 4 |
| .IX Item "--logfile <logfile>" |
| The log file to log output to; by default logging goes to stdout and stderr |
| on the console. |
| .IP "\fB\-\-configfile <configuration file\fR>" 4 |
| .IX Item "--configfile <configuration file>" |
| The configuration file to use. If omitted, the default configuration |
| file \fI/etc/swtpm\-localca.conf\fR will be used. |
| .IP "\fB\-\-optsfile <options file\fR>" 4 |
| .IX Item "--optsfile <options file>" |
| The options file to use. If omitted, the default options file |
| \&\fI/etc/swtpm\-localca.options\fR will be used. |
| .IP "\fB\-\-tpm\-spec\-family\fR, \fB\-\-tpm\-spec\-revision\fR, \fB\-\-tpm\-spec\-level\fR" 4 |
| .IX Item "--tpm-spec-family, --tpm-spec-revision, --tpm-spec-level" |
| \&\s-1TPM\s0 specification parameters that describe the specification that was |
| followed for the \s-1TPM\s0 implementation. The parameters will be passed |
| to swtpm_cert for the creation of the \s-1EK\s0 certificate. |
| .IP "\fB\-\-tpm2\fR" 4 |
| .IX Item "--tpm2" |
| Create \s-1TPM 2\s0 compliant certificates. |
| .IP "\fB\-\-allow\-signing\fR" 4 |
| .IX Item "--allow-signing" |
| Create an \s-1EK\s0 that can also be used for signing. Without this option, the |
| \&\s-1EK\s0 can only be used for key encipherment. This option requires \-\-tpm2. |
| .IP "\fB\-\-decryption\fR" 4 |
| .IX Item "--decryption" |
| If \-\-allow\-signing is passed and the \s-1EK\s0 should also be useable for key |
| encipherment, this option must be passed. Otherwise key encipherment is the |
| default. This option requires \-\-tpm2. |
| .SH "SEE ALSO" |
| .IX Header "SEE ALSO" |
| \&\fBswtpm\-localca.conf\fR, \fBswtpm\-localca.options\fR, |
| \&\fBswtpm_setup\fR, \fBswtpm_setup.conf\fR |
| .SH "REPORTING BUGS" |
| .IX Header "REPORTING BUGS" |
| Report bugs to Stefan Berger <stefanb@linux.vnet.ibm.com> |