1 /* 2 * Copyright (c) 2013 The Chromium OS Authors. 3 * Coypright (c) 2013 Guntermann & Drunck GmbH 4 * 5 * See file CREDITS for list of people who contributed to this 6 * project. 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License as 10 * published by the Free Software Foundation; either version 2 of 11 * the License, or (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21 * MA 02111-1307 USA 22 */ 23 24 #ifndef __TPM_H 25 #define __TPM_H 26 27 #include <tis.h> 28 29 /* 30 * Here is a partial implementation of TPM commands. Please consult TCG Main 31 * Specification for definitions of TPM commands. 32 */ 33 34 enum tpm_startup_type { 35 TPM_ST_CLEAR = 0x0001, 36 TPM_ST_STATE = 0x0002, 37 TPM_ST_DEACTIVATED = 0x0003, 38 }; 39 40 enum tpm_physical_presence { 41 TPM_PHYSICAL_PRESENCE_HW_DISABLE = 0x0200, 42 TPM_PHYSICAL_PRESENCE_CMD_DISABLE = 0x0100, 43 TPM_PHYSICAL_PRESENCE_LIFETIME_LOCK = 0x0080, 44 TPM_PHYSICAL_PRESENCE_HW_ENABLE = 0x0040, 45 TPM_PHYSICAL_PRESENCE_CMD_ENABLE = 0x0020, 46 TPM_PHYSICAL_PRESENCE_NOTPRESENT = 0x0010, 47 TPM_PHYSICAL_PRESENCE_PRESENT = 0x0008, 48 TPM_PHYSICAL_PRESENCE_LOCK = 0x0004, 49 }; 50 51 enum tpm_nv_index { 52 TPM_NV_INDEX_LOCK = 0xffffffff, 53 TPM_NV_INDEX_0 = 0x00000000, 54 TPM_NV_INDEX_DIR = 0x10000001, 55 }; 56 57 /** 58 * TPM return codes as defined in the TCG Main specification 59 * (TPM Main Part 2 Structures; Specification version 1.2) 60 */ 61 enum tpm_return_code { 62 TPM_BASE = 0x00000000, 63 TPM_NON_FATAL = 0x00000800, 64 TPM_SUCCESS = TPM_BASE, 65 /* TPM-defined fatal error codes */ 66 TPM_AUTHFAIL = TPM_BASE + 1, 67 TPM_BADINDEX = TPM_BASE + 2, 68 TPM_BAD_PARAMETER = TPM_BASE + 3, 69 TPM_AUDITFAILURE = TPM_BASE + 4, 70 TPM_CLEAR_DISABLED = TPM_BASE + 5, 71 TPM_DEACTIVATED = TPM_BASE + 6, 72 TPM_DISABLED = TPM_BASE + 7, 73 TPM_DISABLED_CMD = TPM_BASE + 8, 74 TPM_FAIL = TPM_BASE + 9, 75 TPM_BAD_ORDINAL = TPM_BASE + 10, 76 TPM_INSTALL_DISABLED = TPM_BASE + 11, 77 TPM_INVALID_KEYHANDLE = TPM_BASE + 12, 78 TPM_KEYNOTFOUND = TPM_BASE + 13, 79 TPM_INAPPROPRIATE_ENC = TPM_BASE + 14, 80 TPM_MIGRATE_FAIL = TPM_BASE + 15, 81 TPM_INVALID_PCR_INFO = TPM_BASE + 16, 82 TPM_NOSPACE = TPM_BASE + 17, 83 TPM_NOSRK = TPM_BASE + 18, 84 TPM_NOTSEALED_BLOB = TPM_BASE + 19, 85 TPM_OWNER_SET = TPM_BASE + 20, 86 TPM_RESOURCES = TPM_BASE + 21, 87 TPM_SHORTRANDOM = TPM_BASE + 22, 88 TPM_SIZE = TPM_BASE + 23, 89 TPM_WRONGPCRVAL = TPM_BASE + 24, 90 TPM_BAD_PARAM_SIZE = TPM_BASE + 25, 91 TPM_SHA_THREAD = TPM_BASE + 26, 92 TPM_SHA_ERROR = TPM_BASE + 27, 93 TPM_FAILEDSELFTEST = TPM_BASE + 28, 94 TPM_AUTH2FAIL = TPM_BASE + 29, 95 TPM_BADTAG = TPM_BASE + 30, 96 TPM_IOERROR = TPM_BASE + 31, 97 TPM_ENCRYPT_ERROR = TPM_BASE + 32, 98 TPM_DECRYPT_ERROR = TPM_BASE + 33, 99 TPM_INVALID_AUTHHANDLE = TPM_BASE + 34, 100 TPM_NO_ENDORSEMENT = TPM_BASE + 35, 101 TPM_INVALID_KEYUSAGE = TPM_BASE + 36, 102 TPM_WRONG_ENTITYTYPE = TPM_BASE + 37, 103 TPM_INVALID_POSTINIT = TPM_BASE + 38, 104 TPM_INAPPROPRIATE_SIG = TPM_BASE + 39, 105 TPM_BAD_KEY_PROPERTY = TPM_BASE + 40, 106 TPM_BAD_MIGRATION = TPM_BASE + 41, 107 TPM_BAD_SCHEME = TPM_BASE + 42, 108 TPM_BAD_DATASIZE = TPM_BASE + 43, 109 TPM_BAD_MODE = TPM_BASE + 44, 110 TPM_BAD_PRESENCE = TPM_BASE + 45, 111 TPM_BAD_VERSION = TPM_BASE + 46, 112 TPM_NO_WRAP_TRANSPORT = TPM_BASE + 47, 113 TPM_AUDITFAIL_UNSUCCESSFUL = TPM_BASE + 48, 114 TPM_AUDITFAIL_SUCCESSFUL = TPM_BASE + 49, 115 TPM_NOTRESETABLE = TPM_BASE + 50, 116 TPM_NOTLOCAL = TPM_BASE + 51, 117 TPM_BAD_TYPE = TPM_BASE + 52, 118 TPM_INVALID_RESOURCE = TPM_BASE + 53, 119 TPM_NOTFIPS = TPM_BASE + 54, 120 TPM_INVALID_FAMILY = TPM_BASE + 55, 121 TPM_NO_NV_PERMISSION = TPM_BASE + 56, 122 TPM_REQUIRES_SIGN = TPM_BASE + 57, 123 TPM_KEY_NOTSUPPORTED = TPM_BASE + 58, 124 TPM_AUTH_CONFLICT = TPM_BASE + 59, 125 TPM_AREA_LOCKED = TPM_BASE + 60, 126 TPM_BAD_LOCALITY = TPM_BASE + 61, 127 TPM_READ_ONLY = TPM_BASE + 62, 128 TPM_PER_NOWRITE = TPM_BASE + 63, 129 TPM_FAMILY_COUNT = TPM_BASE + 64, 130 TPM_WRITE_LOCKED = TPM_BASE + 65, 131 TPM_BAD_ATTRIBUTES = TPM_BASE + 66, 132 TPM_INVALID_STRUCTURE = TPM_BASE + 67, 133 TPM_KEY_OWNER_CONTROL = TPM_BASE + 68, 134 TPM_BAD_COUNTER = TPM_BASE + 69, 135 TPM_NOT_FULLWRITE = TPM_BASE + 70, 136 TPM_CONTEXT_GAP = TPM_BASE + 71, 137 TPM_MAXNVWRITES = TPM_BASE + 72, 138 TPM_NOOPERATOR = TPM_BASE + 73, 139 TPM_RESOURCEMISSING = TPM_BASE + 74, 140 TPM_DELEGATE_LOCK = TPM_BASE + 75, 141 TPM_DELEGATE_FAMILY = TPM_BASE + 76, 142 TPM_DELEGATE_ADMIN = TPM_BASE + 77, 143 TPM_TRANSPORT_NOTEXCLUSIVE = TPM_BASE + 78, 144 TPM_OWNER_CONTROL = TPM_BASE + 79, 145 TPM_DAA_RESOURCES = TPM_BASE + 80, 146 TPM_DAA_INPUT_DATA0 = TPM_BASE + 81, 147 TPM_DAA_INPUT_DATA1 = TPM_BASE + 82, 148 TPM_DAA_ISSUER_SETTINGS = TPM_BASE + 83, 149 TPM_DAA_TPM_SETTINGS = TPM_BASE + 84, 150 TPM_DAA_STAGE = TPM_BASE + 85, 151 TPM_DAA_ISSUER_VALIDITY = TPM_BASE + 86, 152 TPM_DAA_WRONG_W = TPM_BASE + 87, 153 TPM_BAD_HANDLE = TPM_BASE + 88, 154 TPM_BAD_DELEGATE = TPM_BASE + 89, 155 TPM_BADCONTEXT = TPM_BASE + 90, 156 TPM_TOOMANYCONTEXTS = TPM_BASE + 91, 157 TPM_MA_TICKET_SIGNATURE = TPM_BASE + 92, 158 TPM_MA_DESTINATION = TPM_BASE + 93, 159 TPM_MA_SOURCE = TPM_BASE + 94, 160 TPM_MA_AUTHORITY = TPM_BASE + 95, 161 TPM_PERMANENTEK = TPM_BASE + 97, 162 TPM_BAD_SIGNATURE = TPM_BASE + 98, 163 TPM_NOCONTEXTSPACE = TPM_BASE + 99, 164 /* TPM-defined non-fatal errors */ 165 TPM_RETRY = TPM_BASE + TPM_NON_FATAL, 166 TPM_NEEDS_SELFTEST = TPM_BASE + TPM_NON_FATAL + 1, 167 TPM_DOING_SELFTEST = TPM_BASE + TPM_NON_FATAL + 2, 168 TPM_DEFEND_LOCK_RUNNING = TPM_BASE + TPM_NON_FATAL + 3, 169 }; 170 171 /** 172 * Initialize TPM device. It must be called before any TPM commands. 173 * 174 * @return 0 on success, non-0 on error. 175 */ 176 uint32_t tpm_init(void); 177 178 /** 179 * Issue a TPM_Startup command. 180 * 181 * @param mode TPM startup mode 182 * @return return code of the operation 183 */ 184 uint32_t tpm_startup(enum tpm_startup_type mode); 185 186 /** 187 * Issue a TPM_SelfTestFull command. 188 * 189 * @return return code of the operation 190 */ 191 uint32_t tpm_self_test_full(void); 192 193 /** 194 * Issue a TPM_ContinueSelfTest command. 195 * 196 * @return return code of the operation 197 */ 198 uint32_t tpm_continue_self_test(void); 199 200 /** 201 * Issue a TPM_NV_DefineSpace command. The implementation is limited 202 * to specify TPM_NV_ATTRIBUTES and size of the area. The area index 203 * could be one of the special value listed in enum tpm_nv_index. 204 * 205 * @param index index of the area 206 * @param perm TPM_NV_ATTRIBUTES of the area 207 * @param size size of the area 208 * @return return code of the operation 209 */ 210 uint32_t tpm_nv_define_space(uint32_t index, uint32_t perm, uint32_t size); 211 212 /** 213 * Issue a TPM_NV_ReadValue command. This implementation is limited 214 * to read the area from offset 0. The area index could be one of 215 * the special value listed in enum tpm_nv_index. 216 * 217 * @param index index of the area 218 * @param data output buffer of the area contents 219 * @param count size of output buffer 220 * @return return code of the operation 221 */ 222 uint32_t tpm_nv_read_value(uint32_t index, void *data, uint32_t count); 223 224 /** 225 * Issue a TPM_NV_WriteValue command. This implementation is limited 226 * to write the area from offset 0. The area index could be one of 227 * the special value listed in enum tpm_nv_index. 228 * 229 * @param index index of the area 230 * @param data input buffer to be wrote to the area 231 * @param length length of data bytes of input buffer 232 * @return return code of the operation 233 */ 234 uint32_t tpm_nv_write_value(uint32_t index, const void *data, uint32_t length); 235 236 /** 237 * Issue a TPM_Extend command. 238 * 239 * @param index index of the PCR 240 * @param in_digest 160-bit value representing the event to be 241 * recorded 242 * @param out_digest 160-bit PCR value after execution of the 243 * command 244 * @return return code of the operation 245 */ 246 uint32_t tpm_extend(uint32_t index, const void *in_digest, void *out_digest); 247 248 /** 249 * Issue a TPM_PCRRead command. 250 * 251 * @param index index of the PCR 252 * @param data output buffer for contents of the named PCR 253 * @param count size of output buffer 254 * @return return code of the operation 255 */ 256 uint32_t tpm_pcr_read(uint32_t index, void *data, size_t count); 257 258 /** 259 * Issue a TSC_PhysicalPresence command. TPM physical presence flag 260 * is bit-wise OR'ed of flags listed in enum tpm_physical_presence. 261 * 262 * @param presence TPM physical presence flag 263 * @return return code of the operation 264 */ 265 uint32_t tpm_tsc_physical_presence(uint16_t presence); 266 267 /** 268 * Issue a TPM_ReadPubek command. 269 * 270 * @param data output buffer for the public endorsement key 271 * @param count size of ouput buffer 272 * @return return code of the operation 273 */ 274 uint32_t tpm_read_pubek(void *data, size_t count); 275 276 /** 277 * Issue a TPM_ForceClear command. 278 * 279 * @return return code of the operation 280 */ 281 uint32_t tpm_force_clear(void); 282 283 /** 284 * Issue a TPM_PhysicalEnable command. 285 * 286 * @return return code of the operation 287 */ 288 uint32_t tpm_physical_enable(void); 289 290 /** 291 * Issue a TPM_PhysicalDisable command. 292 * 293 * @return return code of the operation 294 */ 295 uint32_t tpm_physical_disable(void); 296 297 /** 298 * Issue a TPM_PhysicalSetDeactivated command. 299 * 300 * @param state boolean state of the deactivated flag 301 * @return return code of the operation 302 */ 303 uint32_t tpm_physical_set_deactivated(uint8_t state); 304 305 /** 306 * Issue a TPM_GetCapability command. This implementation is limited 307 * to query sub_cap index that is 4-byte wide. 308 * 309 * @param cap_area partition of capabilities 310 * @param sub_cap further definition of capability, which is 311 * limited to be 4-byte wide 312 * @param cap output buffer for capability information 313 * @param count size of ouput buffer 314 * @return return code of the operation 315 */ 316 uint32_t tpm_get_capability(uint32_t cap_area, uint32_t sub_cap, 317 void *cap, size_t count); 318 319 /** 320 * Issue a TPM_FlushSpecific command for a AUTH ressource. 321 * 322 * @param auth_handle handle of the auth session 323 * @return return code of the operation 324 */ 325 uint32_t tpm_terminate_auth_session(uint32_t auth_handle); 326 327 /** 328 * Issue a TPM_OIAP command to setup an object independant authorization 329 * session. 330 * Information about the session is stored internally. 331 * If there was already an OIAP session active it is terminated and a new 332 * session is set up. 333 * 334 * @param auth_handle pointer to the (new) auth handle or NULL. 335 * @return return code of the operation 336 */ 337 uint32_t tpm_oiap(uint32_t *auth_handle); 338 339 /** 340 * Ends an active OIAP session. 341 * 342 * @return return code of the operation 343 */ 344 uint32_t tpm_end_oiap(void); 345 346 /** 347 * Issue a TPM_LoadKey2 (Auth1) command using an OIAP session for authenticating 348 * the usage of the parent key. 349 * 350 * @param parent_handle handle of the parent key. 351 * @param key pointer to the key structure (TPM_KEY or TPM_KEY12). 352 * @param key_length size of the key structure 353 * @param parent_key_usage_auth usage auth for the parent key 354 * @param key_handle pointer to the key handle 355 * @return return code of the operation 356 */ 357 uint32_t tpm_load_key2_oiap(uint32_t parent_handle, 358 const void *key, size_t key_length, 359 const void *parent_key_usage_auth, 360 uint32_t *key_handle); 361 362 /** 363 * Issue a TPM_GetPubKey (Auth1) command using an OIAP session for 364 * authenticating the usage of the key. 365 * 366 * @param key_handle handle of the key 367 * @param usage_auth usage auth for the key 368 * @param pubkey pointer to the pub key buffer; may be NULL if the pubkey 369 * should not be stored. 370 * @param pubkey_len pointer to the pub key buffer len. On entry: the size of 371 * the provided pubkey buffer. On successful exit: the size 372 * of the stored TPM_PUBKEY structure (iff pubkey != NULL). 373 * @return return code of the operation 374 */ 375 uint32_t tpm_get_pub_key_oiap(uint32_t key_handle, const void *usage_auth, 376 void *pubkey, size_t *pubkey_len); 377 378 #endif /* __TPM_H */ 379