usr/src/man/man5/pkcs11_tpm.5

   1 '\" te
   2 .\"  Copyright (c) 2006, 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 PKCS11_TPM 5 "May 13, 2017"
   7 .SH NAME
   8 pkcs11_tpm \- RSA PKCS#11 token for Trusted Platform Modules (TPM)
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 /usr/lib/security/pkcs11_tpm.so
  13 .fi
  14
  15 .LP
  16 .nf
  17 /usr/lib/security/64/pkcs11_tpm.so
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .LP
  22 The \fBpkcs11_tpm.so\fR object implements the RSA PKCS#11 v2.20 specification
  23 using Trusted Computing Group protocols to talk to a TPM security device. This
  24 provider implements the PKCS#11 specification and uses the TCG Software Stack
  25 (TSS) APIs in the \fBtrousers\fR package.
  26 .sp
  27 .LP
  28 Application developers should link to \fBlibpkcs11.so.1\fR rather than link
  29 directly with \fBpkcs11_tpm.so\fR. See \fBlibpkcs11\fR(3LIB).
  30 .sp
  31 .LP
  32 The following cryptographic algorithms are implemented: \fBRSA\fR, \fBSHA1\fR,
  33 and \fBMD5\fR.
  34 .sp
  35 .LP
  36 All of the standard PKCS#11 functions listed in \fBlibpkcs11\fR(3LIB) are
  37 implemented except for the following:
  38 .sp
  39 .in +2
  40 .nf
  41 C_EncryptUpdate
  42 C_EncryptFinal
  43 C_DecryptUpdate
  44 C_DecryptFinal
  45 C_DigestEncryptUpdate
  46 C_DecryptDigestUpdate
  47 C_SignEncryptUpdate
  48 C_DecryptVerifyUpdate
  49 C_GetFunctionStatus
  50 C_CancelFunction
  51 C_WaitForSlotEvent
  52 C_GenerateKey
  53 C_DeriveKey
  54 .fi
  55 .in -2
  56 .sp
  57
  58 .sp
  59 .LP
  60 The following RSA PKCS#11 v2.20 mechanisms are supported:
  61 .sp
  62 .in +2
  63 .nf
  64 CKM_RSA_PKCS_KEY_PAIR_GEN
  65 CKM_RSA_PKCS
  66 CKM_RSA_PKCS_OAEP
  67 CKM_RSA_X_509
  68 CKM_MD5_RSA_PKCS
  69 CKM_SHA1_RSA_PKCS
  70 CKM_SHA_1
  71 CKM_SHA_1_HMAC
  72 CKM_SHA_1_HMAC_GENERAL
  73 CKM_MD5
  74 CKM_MD5_HMAC
  75 CKM_MD5_HMAC_GENERAL
  76 .fi
  77 .in -2
  78 .sp
  79
  80 .SS "Per-User Initialization"
  81 .LP
  82 The \fBpkcs11_tpm\fR provider can only be used on a system which has a TPM
  83 device and which also has the \fBtrousers\fR package installed. If those
  84 prerequisites are met, users can create their own private tokens using
  85 \fBpktool\fR(1), which will allow them to perform operations using the TPM
  86 device and protect their private data with TPM-protected keys.
  87 .sp
  88 .LP
  89 To prepare and initialize a user's TPM token, the following steps must be
  90 performed:
  91 .RS +4
  92 .TP
  93 1.
  94 Initialize the token.
  95 .RE
  96 .RS +4
  97 .TP
  98 2.
  99 Set the SO (security officer) PIN.
 100 .RE
 101 .RS +4
 102 .TP
 103 3.
 104 Set the user's unique PIN.
 105 .RE
 106 .sp
 107 .LP
 108 Initializing the token is done using the \fBpktool\fR(1) command as follows:
 109 .sp
 110 .in +2
 111 .nf
 112 $ \fBpktool inittoken currlabel=TPM newlabel=tpm/myname\fR
 113 .fi
 114 .in -2
 115 .sp
 116
 117 .RS +4
 118 .TP
 119 .ie t \(bu
 120 .el o
 121 By default, an uninitialized TPM is recognized by the name \fBTPM\fR. When a
 122 user initializes their own private token, it can either be renamed to something
 123 else (for example, \fBtpm/joeuser\fR) or kept as \fBTPM\fR (in which case the
 124 \fBnewlabel\fR argument would be omitted).
 125 .RE
 126 .RS +4
 127 .TP
 128 .ie t \(bu
 129 .el o
 130 The user will have to supply the default SO PIN before being able to initialize
 131 his or her token. The default SO PIN is \fB87654321\fR. It is changed in step
 132 2, above.
 133 .RE
 134 .sp
 135 .LP
 136 Once the token is initialized, the SO and user PINs must be changed from the
 137 default values. Again, \fBpktool\fR(1) is used to change these PIN values.
 138 .sp
 139 .LP
 140 Changing the SO PIN:
 141 .sp
 142 .in +2
 143 .nf
 144 $ \fBpktool setpin token=tpm/joeuser so\fR
 145 .fi
 146 .in -2
 147 .sp
 148
 149 .sp
 150 .LP
 151 The \fBso\fR option indicates that this "setpin" operation is to change the SO
 152 PIN and must be present. The user must then enter the default SO PIN
 153 (\fB87654321\fR) and then enter (and confirm) a new PIN.
 154 .sp
 155 .LP
 156 Once the SO PIN is reset from the default, the user's unique PIN must also be
 157 changed.
 158 .sp
 159 .LP
 160 Changing the user's PIN:
 161 .sp
 162 .in +2
 163 .nf
 164 $ \fBpktool setpin token=tmp/joeuser\fR
 165 .fi
 166 .in -2
 167 .sp
 168
 169 .sp
 170 .LP
 171 The default PIN for a non-SO user is \fB12345678\fR. The user must enter the
 172 default PIN and then enter (and confirm) a new, unique PIN.
 173 .sp
 174 .LP
 175 The PIN provided for the \fBpktool\fR \fBsetpin\fR operation or by calling
 176 \fBC_Login()\fR and \fBC_SetPIN()\fR functions can be any string of characters
 177 with a length between 1 and 256 and no embedded nulls.
 178 .SS "Accessing the Token"
 179 .LP
 180 After a user initializes their token, they can begin using it with
 181 \fBpktool\fR(1) or by writing PKCS11 applications and locating the token using
 182 the name created above (\fBtpm/joeuser\fR in the examples above).
 183 .sp
 184 .LP
 185 Examples:
 186 .sp
 187 .in +2
 188 .nf
 189 $ \fBpktool gencert token=tpm/joeuser -i\fR
 190 $ \fBpktool list token=tpm/joeuser\fR
 191 .fi
 192 .in -2
 193 .sp
 194
 195 .SS "Notes"
 196 .LP
 197 \fBpkcs11_tpm.so\fR provides object storage in a filesystem-specific token
 198 object storage area. Private objects are protected by encryption with private
 199 keys and can only be decrypted by loading the token's private key into the TPM
 200 and performing the decryption entirely in the TPM. The user's private key is
 201 generated by the TPM when the user sets their personal PIN (see above). The
 202 keys for both the SO and users are stored in the TSS persistent storage
 203 database and are referenced by a unique UUID value. All user tokens have a
 204 unique SO key and unique user key so that the PINs for one user's token will
 205 not unlock private data in another user's token on the same machine.
 206 .sp
 207 .LP
 208 Each TPM is unique and the token keys created on one TPM may not be used on
 209 another TPM. The \fBpkcs11_tpm.so\fR token data is all managed on the system
 210 where the TPM resides and may not be moved to other systems. If the TPM is
 211 reset and the SRK (Storage Root Key) is changed, all of the keys previously
 212 generated for that TPM will no longer be valid.
 213 .sp
 214 .LP
 215 \fBpkcs11_tpm.so\fR creates a private workspace to manage administrative files
 216 for each token created. By default, this area is created as
 217 \fB/var/tpm/pkcs11/$USERNAME\fR. However, users may override this by setting
 218 the \fBPKCS11_TPM_DIR\fR environment variable prior to initializing or using
 219 the token.
 220 .SH RETURN VALUES
 221 .LP
 222 The return values for each of the implemented functions are defined and listed
 223 in the RSA PKCS#11 v2.20 specification. See \fBhttp://www.rsasecurity.com\fR.
 224 .SH FILES
 225 .ne 2
 226 .na
 227 \fB\fB/var/tpm/pkcs11/USERNAME\fR\fR
 228 .ad
 229 .sp .6
 230 .RS 4n
 231 User's default token object store.
 232 .RE
 233
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fB${PKCS11_TPM_DIR}\fR\fR
 238 .ad
 239 .sp .6
 240 .RS 4n
 241 Alternate token object store.
 242 .RE
 243
 244 .SH ATTRIBUTES
 245 .LP
 246 See \fBattributes\fR(5) for descriptions of the following attributes:
 247 .sp
 248
 249 .sp
 250 .TS
 251 box;
 252 c | c
 253 l | l .
 254 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 255 _
 256 Interface Stability     Committed
 257 _
 258 MT-Level        MT-Safe with Exceptions (see below)
 259 _
 260 Standard        PKCS#11 v2.20
 261 .TE
 262
 263 .sp
 264 .LP
 265 Exceptions to MT-Safe attribute are documented in section 6.5.2 of RSA PKCS#11
 266 v2.20.
 267 .SH SEE ALSO
 268 .LP
 269 \fBpktool\fR(1), \fBcryptoadm\fR(1M), \fBlibpkcs11\fR(3LIB),
 270 \fBattributes\fR(5)
 271 .sp
 272 .LP
 273 TCG Software Stack (TSS) Specifications: \fBhttps://www.trustedcomputinggroup.org/specs/TSS\fR (as of the date of publication)