blob: 2552cc91a87871ed2ec2567ee98559ab8d2f90c8 [file] [log] [blame]
.\" 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_cert 8"
.TH swtpm_cert 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_cert \- Tool to create EK and platform certs for swtpm (1.2 & 2.0)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBswtpm_cert [\s-1OPTIONS\s0]\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBswtpm_cert\fR is a local \s-1CA\s0 tool for creating X.509v3 certificates for the \s-1TPM\s0's
Endorsement Key. The reason for this specific tool is that it works without access
to the Endorsement Key's private key. Typically tools require either a self-signed
certificate request or access to the private key to issue a certificate.
This tool works with only the public key part.
.PP
The following options are supported:
.IP "\fB\-\-type {ek|platform|aik}\fR" 4
.IX Item "--type {ek|platform|aik}"
The type of certificate to create; by default an \s-1EK\s0 certificate is created.
.IP "\fB\-\-pubkey <filename\fR>" 4
.IX Item "--pubkey <filename>"
The public key (\s-1EK\s0) in \s-1PEM\s0 format.
.IP "\fB\-\-modulus <hex digits\fR>" 4
.IX Item "--modulus <hex digits>"
The modulus of the public key as a string of hex digits. This option
can be used in place of the \-\-pubkey option.
.IP "<\-\-ecc\-x <hex digits>>" 4
.IX Item "<--ecc-x <hex digits>>"
The elliptic curve parameter x as string of hex digits.
.IP "<\-\-ecc\-y <hex digits>>" 4
.IX Item "<--ecc-y <hex digits>>"
The elliptic curve parameter y as string of hex digits.
.IP "\fB\-\-exponent <exponent\fR>" 4
.IX Item "--exponent <exponent>"
The exponent of the public key. By default 0x10001 is assumed.
.IP "\fB\-\-signkey <filename\fR>" 4
.IX Item "--signkey <filename>"
The key used for signing the certificate. The file must be in \s-1PEM\s0 format.
.IP "\fB\-\-signkey\-password <password\fR>" 4
.IX Item "--signkey-password <password>"
Optional password for the signing key.
.IP "\fB\-\-parent\-password <password\fR>" 4
.IX Item "--parent-password <password>"
Optional password for a parent key. In case a \s-1TPM\s0 key is used for signing
this would be the password for the \s-1TPM\s0's storage root key (\s-1SRK\s0).
.IP "\fB\-\-issuercert <filename\fR>" 4
.IX Item "--issuercert <filename>"
The X.509 certificate of this signer that takes on the role of a local \s-1CA.\s0
.IP "\fB\-\-out\-cert <filename\fR>" 4
.IX Item "--out-cert <filename>"
The name of the file to write the X.509v3 certificate into. The output will
be in \s-1PEM\s0 format.
.IP "\fB\-\-serial <serial number\fR>" 4
.IX Item "--serial <serial number>"
Optional 32bit serial number for the certificate.
.IP "\fB\-\-days <number\fR>" 4
.IX Item "--days <number>"
The number of days the certificate is valid; by default it is valid for 365 days.
.IP "\fB\-\-pem\fR" 4
.IX Item "--pem"
Write the resulting certificate in \s-1PEM\s0 format; \s-1DER\s0 format is the default.
.IP "\fB\-\-tpm\-manufacturer <name\fR>" 4
.IX Item "--tpm-manufacturer <name>"
The name of the \s-1TPM\s0 manufacturer.
.IP "\fB\-\-tpm\-model <model\fR>" 4
.IX Item "--tpm-model <model>"
The \s-1TPM\s0 model (part number).
.IP "\fB\-\-tpm\-version <version\fR>" 4
.IX Item "--tpm-version <version>"
The \s-1TPM\s0's firmware version.
.IP "\fB\-\-platform\-manufacturer <name\fR>" 4
.IX Item "--platform-manufacturer <name>"
The name of the platform manufacturer.
.IP "\fB\-\-platform\-model <model\fR>" 4
.IX Item "--platform-model <model>"
The platform model.
.IP "\fB\-\-platform\-version <version\fR>" 4
.IX Item "--platform-version <version>"
The platform's version.
.IP "\fB\-\-subject <subject\fR>" 4
.IX Item "--subject <subject>"
Subject to for example provide the location of the \s-1TPM\s0 in the format of
C=<country>,ST=<state>,L=<location>.
Note that the location must no contain any spaces.
.IP "\fB\-\-tpm2\fR" 4
.IX Item "--tpm2"
Issue \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.
.IP "\fB\-\-help, \-h\fR" 4
.IX Item "--help, -h"
Display the help screen
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
Report bugs to Stefan Berger <stefanb@linux.vnet.ibm.com>