| .\" 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_bios 8" |
| .TH swtpm_bios 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_bios \- BIOS simulation tool for swtpm |
| .SH "SYNOPSIS" |
| .IX Header "SYNOPSIS" |
| \&\fBswtpm_bios [\s-1OPTIONS\s0]\fR |
| .SH "DESCRIPTION" |
| .IX Header "DESCRIPTION" |
| \&\fBswtpm_bios\fR is a tool that can send the commands to the \s-1TPM \s0(\fIswtpm\fR |
| program) that typically are used by the \s-1BIOS\s0 to initialize the \s-1TPM.\s0 |
| The user can choose among several command line options to choose the |
| state the \s-1TPM\s0 should be set to. |
| .PP |
| This command requires the environment variable \fI\s-1TCSD_USE_TCP_DEVICE\s0\fR |
| to be set for communication via \s-1TCP.\s0 Otherwise it will use the device |
| set in the environment variable \fI\s-1TPM_DEVICE\s0\fR or fall back to use |
| \&\fI/dev/tpm0\fR to send the commands to. In \s-1TCP\s0 mode, the environment variable |
| \&\fI\s-1TCSD_TCP_DEVICE_HOSTNAME\s0\fR is used to indicate the host to send the commands |
| to. By default \fIlocalhost\fR is assumed. The default \s-1TCP\s0 port is 6545 unless |
| the environment variable \fI\s-1TCSD_TCP_DEVICE_PORT\s0\fR indicates another port. |
| .PP |
| In case of success 0 will be returned. In case a \s-1TPM\s0 error was |
| encountered the return code will be 128. In case of communcation |
| failure 255 is returned. In case the \s-1TPM\s0 needs to be reset to become |
| activated, 129 will be returned. |
| .PP |
| This command will send the following sequence of commands to the \s-1TPM.\s0 |
| .IP "\fBTPM_Startup(chosen mode)\fR \*(-- startup \s-1TPM\s0" 4 |
| .IX Item "TPM_Startup(chosen mode) startup TPM" |
| .PD 0 |
| .IP "\fBTSC_PhysicalPresence(0x20)\fR \*(-- PhysicalPresenceCMDEnable" 4 |
| .IX Item "TSC_PhysicalPresence(0x20) PhysicalPresenceCMDEnable" |
| .IP "\fBTSC_PhysicalPresence(0x08)\fR \*(-- turn on physical presence" 4 |
| .IX Item "TSC_PhysicalPresence(0x08) turn on physical presence" |
| .IP "\fBTPM_GetCapability\fR \*(-- get permanent flags" 4 |
| .IX Item "TPM_GetCapability get permanent flags" |
| .IP "\fBTPM_PhysicalEnable\fR \*(-- enable the \s-1TPM\s0" 4 |
| .IX Item "TPM_PhysicalEnable enable the TPM" |
| .IP "\fBTPM_PhysicalSetDeactivated(0x0)\fR \*(-- activate \s-1TPM\s0" 4 |
| .IX Item "TPM_PhysicalSetDeactivated(0x0) activate TPM" |
| .IP "\fBTPM_ContinueSelfTest\fR \*(-- continue self test" 4 |
| .IX Item "TPM_ContinueSelfTest continue self test" |
| .IP "\fBTSC_PhysicalPresence(0x20)\fR \*(-- PhysicalPresenceCMDEnable" 4 |
| .IX Item "TSC_PhysicalPresence(0x20) PhysicalPresenceCMDEnable" |
| .IP "\fBTSC_PhysicalPresence(0x14)\fR \*(-- turn off physical presence & lock it" 4 |
| .IX Item "TSC_PhysicalPresence(0x14) turn off physical presence & lock it" |
| .PD |
| .PP |
| The following options are supported: |
| .IP "\fB\-\-tpm\-device <device>\fR" 4 |
| .IX Item "--tpm-device <device>" |
| Use the given device rather than the default /dev/tpm0. This option overrides |
| the \s-1TPM_DEVICE\s0 environment variable. |
| .IP "\fB\-\-tcp <server>:<port>\fR" 4 |
| .IX Item "--tcp <server>:<port>" |
| Connect to the given server and port; if no server is given, 127.0.0.1 is used; |
| if port is not given, the default port 6545 is used. |
| .IP "\fB\-\-unixio <path>\fR" 4 |
| .IX Item "--unixio <path>" |
| Connect to the given UnixIO path. |
| .IP "\fB\-tpm2\fR" 4 |
| .IX Item "-tpm2" |
| The device is a \s-1TPM 2.\s0 |
| .IP "\fB\-c\fR" 4 |
| .IX Item "-c" |
| Send TPM_Startup(\s-1ST_CLEAR\s0) (default). This instructs the \s-1TPM\s0 to start |
| with clear state. |
| .IP "\fB\-s\fR" 4 |
| .IX Item "-s" |
| Send TPM_Startup(\s-1ST_STATE\s0). This instructs the \s-1TPM\s0 to start by restoring |
| previously saved state. |
| .IP "\fB\-d\fR" 4 |
| .IX Item "-d" |
| Send TPM_Startup(\s-1ST_DEACTIVATED\s0). This instructs the \s-1TPM\s0 to start in |
| deactivated mode. This option has no effect on a \s-1TPM 2.\s0 |
| .IP "\fB\-n\fR" 4 |
| .IX Item "-n" |
| Don't send a TPM_Startup command. |
| .IP "\fB\-o\fR" 4 |
| .IX Item "-o" |
| Only send the startup command and nothing else. |
| .IP "\fB\-ea\fR" 4 |
| .IX Item "-ea" |
| Make sure that the \s-1TPM\s0 is activated; if the \s-1TPM\s0 requires a reset, the program |
| will exist and return a return code of 129. |
| .IP "\fB\-cs\fR" 4 |
| .IX Item "-cs" |
| Send a TPM_ContinueSelfTest command to a \s-1TPM 1.2\s0 and a TPM2_IncrementalSelfTest |
| command to a \s-1TPM 2.\s0 |
| .IP "\fB\-u\fR" 4 |
| .IX Item "-u" |
| Give up physical presence on a \s-1TPM 1.2.\s0 In case of a \s-1TPM 2\s0 set the platform |
| hierarchy to a random password. |
| .IP "\fB\-v\fR" 4 |
| .IX Item "-v" |
| Display version and exit. |
| .IP "\fB\-h\fR" 4 |
| .IX Item "-h" |
| Display the help screen and exit. |
| .SH "SEE ALSO" |
| .IX Header "SEE ALSO" |
| .SH "REPORTING BUGS" |
| .IX Header "REPORTING BUGS" |
| Report bugs to Stefan Berger <stefanb@linux.vnet.ibm.com> |
