usr/src/man/man1m/tpmadm.1m

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH TPMADM 1M "April 9, 2016"
   7 .SH NAME
   8 tpmadm \- administer Trusted Platform Module
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBtpmadm status\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBtpmadm init\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBtpmadm clear\fR [\fBowner\fR | \fBlock\fR]
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBtpmadm auth\fR
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBtpmadm keyinfo\fR [\fIuuid\fR]
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBtpmadm deletekey\fR \fIuuid\fR
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .LP
  42 A Trusted Platform Module (TPM) is a hardware component that provides for
  43 protected key storage and reliable measurements of software used to boot the
  44 operating system. The \fBtpmadm\fR utility is used to initialize and administer
  45 the TPM so that it can be used by the operating system and other programs.
  46 .sp
  47 .LP
  48 The TPM subsystem can store and manage an unlimited number of keys for use by
  49 the operating system and by users. Each key is identified by a Universally
  50 Unique Identifier, or UUID.
  51 .sp
  52 .LP
  53 Although the TPM can hold only a limited number of keys at any given time, the
  54 supporting software automatically loads and unloads keys as needed. When a key
  55 is stored outside the TPM, it is always encrypted or "wrapped" by its parent
  56 key so that the key is never exposed in readable form outside the TPM.
  57 .sp
  58 .LP
  59 Before the TPM can be used, it must be initialized by the platform owner. This
  60 process involves setting an owner password which is used to authorize
  61 privileged operations.
  62 .sp
  63 .LP
  64 Although the TPM owner is similar to a traditional superuser, there are two
  65 important differences. First, process privilege is irrelevant for access to TPM
  66 functions. All privileged operations require knowledge of the owner password,
  67 regardless of the privilege level of the calling process. Second, the TPM owner
  68 is not able to override access controls for data protected by TPM keys. The
  69 owner can effectively destroy data by re-initializing the TPM, but he cannot
  70 access data that has been encrypted using TPM keys owned by other users.
  71 .SH SUBCOMMANDS
  72 .LP
  73 The following subcommands are used in the form:
  74 .sp
  75 .in +2
  76 .nf
  77 # tpmadm \fI<subcommand>\fR \fI[operand]\fR
  78 .fi
  79 .in -2
  80 .sp
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBstatus\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Report status information about the TPM. Output includes basic information
  90 about whether ownership of the TPM has been established, current PCR contents,
  91 and the usage of TPM resources such as communication sessions and loaded keys.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBinit\fR\fR
  98 .ad
  99 .sp .6
 100 .RS 4n
 101 Initialize the TPM for use. This involves taking ownership of the TPM by
 102 setting the owner authorization password. Taking ownership of the TPM creates a
 103 new storage root key, which is the ancestor of all keys created by this TPM.
 104 Once this command is issued, the TPM must be reset using BIOS operations before
 105 it can be re-initialized.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBauth\fR\fR
 112 .ad
 113 .sp .6
 114 .RS 4n
 115 Change the owner authorization password for the TPM.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBclear\fR \fBlock\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Clear the count of failed authentication attempts. After a number of failed
 126 authentication attempts, the TPM responds more slowly to subsequent attempts,
 127 in an effort to thwart attempts to find the owner password by exhaustive
 128 search. This command, which requires the correct owner password, resets the
 129 count of failed attempts.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBclear\fR \fBowner\fR\fR
 136 .ad
 137 .sp .6
 138 .RS 4n
 139 Deactivate the TPM and return it to an unowned state. This operation, which
 140 requires the current TPM owner password, invalidates all keys and data tied to
 141 the TPM. Before the TPM can be used again, the system must be restarted, the
 142 TPM must  be reactivated from the BIOS or ILOM pre-boot environment, and the
 143 TPM must be re-initialized using the \fBtpmadm init\fR command.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBkeyinfo\fR [\fIuuid\fR]\fR
 150 .ad
 151 .sp .6
 152 .RS 4n
 153 Report information about keys stored in the TPM subsystem. Without additional
 154 arguments, this subcommand produces a brief listing of all keys. If the UUID of
 155 an individual key is specified, detailed information about that key is
 156 displayed.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBdeletekey\fR \fIuuid\fR\fR
 163 .ad
 164 .sp .6
 165 .RS 4n
 166 Delete the key with the specified UUID from the TPM subsystem's persistent
 167 storage.
 168 .RE
 169
 170 .SH EXIT STATUS
 171 .LP
 172 After completing the requested operation, \fBtpmadm\fR exits with one of the
 173 following status values.
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB0\fR\fR
 178 .ad
 179 .sp .6
 180 .RS 4n
 181 Successful termination.
 182 .RE
 183
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fB1\fR\fR
 188 .ad
 189 .sp .6
 190 .RS 4n
 191 Failure. The requested operation could not be completed.
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fB2\fR\fR
 198 .ad
 199 .sp .6
 200 .RS 4n
 201 Usage error. The \fBtpmadm\fR command was invoked with invalid arguments.
 202 .RE
 203
 204 .SH ATTRIBUTES
 205 .LP
 206 See \fBattributes\fR(5) for descriptions of the following attributes:
 207 .sp
 208
 209 .sp
 210 .TS
 211 box;
 212 c | c
 213 l | l .
 214 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 215 _
 216 Interface Stability     Committed
 217 .TE
 218
 219 .SH SEE ALSO
 220 .LP
 221 \fBattributes\fR(5)
 222 .sp
 223 .LP
 224 TCG Software Stack (TSS) Specifications:
 225 \fBhttps://www.trustedcomputinggroup.org/specs/TSS\fR (as of the date of
 226 publication)