.nr HAVE_TCTI_DEV 1
.nr HAVE_TCTI_SOCK 1
.\" Copyright (c) 2016, Intel Corporation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright notice,
.\" this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright notice,
.\" this list of conditions and the following disclaimer in the documentation
.\" and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of Intel Corporation nor the names of its contributors
.\" may be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.TH tpm2_getpubak 8 "DECEMBER 2016" Intel "tpm2.0-tools"
.SH NAME
tpm2_getpubak\ - Generate attestation key with given algorithm under endorsement hierarchy,
make it persistent with given ak handle, and return pub AK and AK name,
if any passwd option is missing, assume NULL, default type/alg is 0x1(RSA),
default digestAlg is 0xb(SHA256), default signAlg is 0x14(RSASSA) for RSA,
0x18(ECDSA) for ECC
.SH SYNOPSIS
.B tpm2_getpubak[ COMMON OPTIONS ] [ TCTI OPTIONS ] [ \fB\-\-endorsePasswd\fR|\fB\-\-akPasswd\fR|\fB\-\-ownerPasswd\fR|\fB\-\-ekHandle\fR|\fB\-\-akHandle\fR|\fB\-\-alg\fR|\fB\-\-digestAlg\fR|\fB\-\-signAlg\fR|\fB\-\-file\fR|\fB\-\-akName\fR|\fB\-\-passwdInHex\fR|\fB ]
.PP
Generate attestation key with given algorithm under endorsement hierarchy,
make it persistent with given ak handle, and return pub AK and AK name,
if any passwd option is missing, assume NULL, default type/alg is 0x1(RSA),
default digestAlg is 0xb(SHA256), default signAlg is 0x14(RSASSA) for RSA,
0x18(ECDSA) for ECC
.SH DESCRIPTION
.B tpm2_getpubak
Generate attestation key with given algorithm under endorsement hierarchy,
make it persistent with given ak handle, and return pub AK and AK name,
if any passwd option is missing, assume NULL, default type/alg is 0x1(RSA),
default digestAlg is 0xb(SHA256), default signAlg is 0x14(RSASSA) for RSA,
0x18(ECDSA) for ECC
.SH OPTIONS
.TP
\fB\-e ,\-\-endorsePasswd\fR
specifies current endorsement password  (string,optional,default:NULL). 
.TP
\fB\-P ,\-\-akPasswd\fR
specifies the AK password when created  (string,optional,default:NULL). 
.TP
\fB\-o ,\-\-ownerPasswd\fR
specifies current owner password  (string,optional,default:NULL). 
.TP
\fB\-E ,\-\-ekHandle\fR
specifies the handle of EK (hex).
.TP
\fB\-k ,\-\-akHandle\fR
specifies the handle used to make AK  persistent (hex). 
.TP
\fB\-g ,\-\-alg\fR
specifies the algorithm type of AK  (default:0x01/TPM_ALG_RSA):   TPM_ALG_RSA 0x0001   TPM_ALG_KEYEDHASH 0x0008   TPM_ALG_ECC 0x0023 
.TP
\fB\-D ,\-\-digestAlg\fR
specifies the algorithm of digest.  0x0004 TPM_ALG_SHA1   0x000B TPM_ALG_SHA256   0x000C TPM_ALG_SHA384   0x000D TPM_ALG_SHA512   0x0012 TPM_ALG_SM3_256 
.TP
\fB\-s ,\-\-signAlg\fR
specifies the algorithm of sign.  0x0005 TPM_ALG_HMAC   0x0014 TPM_ALG_RSASSA   0x0016 TPM_ALG_RSAPSS   0x0018 TPM_ALG_ECDSA   0x001A TPM_ALG_ECDAA   0x001B TPM_ALG_SM2   0x001C TPM_ALG_ECSCHNORR 
.TP
\fB\-f ,\-\-file\fR
specifies the file used to save the public  portion of AK. 
.TP
\fB\-n ,\-\-akName\fR
specifies the file used to save the ak name.
.TP
\fB\-X ,\-\-passwdInHex\fR
passwords given by any options are hex format.
.TP
[\fBCOMMON OPTIONS\fR ]
This collection of options are common to many programs and provide
information that many users may expect.
.TP
\fB\-h,\ \-\-help\fR
Display a manual describing the tool and its usage.
.TP
\fB\-v,\ \-\-version\fR
Display version information for this tool.
.TP
\fB\-V,\ \-\-verbose\fR
Increase the information that the tool prints to the console during its
execution.
.TP
[\fBTCTI OPTIONS\fR ]
This collection of options are used to configure the varous TCTI modules
available.
.TP
\fB\-T,\ \-\-tcti\fR
Select the TCTI used for communication with the next component down the TSS
stack.
In most configurations this will be the TPM but it could be a simulator or
proxy.
Supported TCTIs are
.if (\n[HAVE_TCTI_DEV]) or \fB\*(lqdevice\*(rq\fR
.if (\n[HAVE_TCTI_SOCK]) or \fB\*(lqsocket\*(rq\fR
.if (\n[HAVE_TCTI_TABRMD]) or \fB\*(lqtabrmd\*(rq\fR
\[char46]
.TP
.if (\n[HAVE_TCTI_DEV]) \{
\fB\-d,\ \-\-device-file\fR
Specify the TPM device file for use by the device TCTI. The default is
/dev/tpm0.
\}
.if (\n[HAVE_TCTI_SOCK]) \{
.TP
\fB\-R,\ \-\-socket-address\fR
Specify the domain name or IP address used by the socket TCTI. The default
is 127.0.0.1.
.TP
\fB\-p,\ \-\-socket-port\fR
Specify the port number used by the socket TCTI. The default is 2321.
\}
.TP
\fBENVIRONMENT: TCTI\fR
This collection of environment variables that may be used to configure the
varous TCTI modules available.
The values passed through these variables can be overridden on a per-command
basis using the available command line options.
.TP
\fBTPM2TOOLS_TCTI_NAME\fR
Select the TCTI used for communication with the next component down the TSS
stack.
In most configurations this will be the TPM but it could be a simulator or
proxy.
See '\fBOPTIONS\fR' section for the names of supported TCTIs.
.TP
.if (\n[HAVE_TCTI_DEV]) \{
\fBTPM2TOOLS_DEVICE_FILE\fR
Specify the TPM device file for use by the device TCTI.
\}
.if (\n[HAVE_TCTI_SOCK]) \{
.TP
\fBTPM2TOOLS_SOCKET_ADDRESS\fR
Specify the domain name or IP address used by the socket TCTI.
.TP
\fBTPM2TOOLS_SOCKET_PORT\fR
Specify the port number used by the socket TCTI.
\}
.SH EXAMPLES
.B tpm2_getpubak
.PP
.nf
.RS
tpm2_getpubak -e abc123 -P abc123 -o passwd -E 0x81010001 -k 0x81010002 -f ./ak.pub -n ./ak.name
tpm2_getpubak -e 1a1b1c -P 123abc -o 1a1b1c -X -E 0x81010001 -k 0x81010002 -f ./ak.pub -n ./ak.name
.RE
.fi