aboutsummaryrefslogtreecommitdiffstats
path: root/ibm-tss.h
blob: d7502ab3cd61dc55f1a3cba99bddfcb7cf707f74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
#define TSSINCLUDE(x) < TSS_INCLUDE/x >
#include TSSINCLUDE(tss.h)
#include TSSINCLUDE(tssresponsecode.h)
#include TSSINCLUDE(tssutils.h)
#include TSSINCLUDE(tssmarshal.h)
#include TSSINCLUDE(Unmarshal_fp.h)
#include TSSINCLUDE(tsscrypto.h)
#include TSSINCLUDE(tsscryptoh.h)

#define EXT_TPM_RH_OWNER	TPM_RH_OWNER
#define EXT_TPM_RH_PLATFORM	TPM_RH_PLATFORM
#define EXT_TPM_RH_ENDORSEMENT	TPM_RH_ENDORSEMENT
#define EXT_TPM_RH_NULL		TPM_RH_NULL
#define INT_TPM_RH_NULL		TPM_RH_NULL

#define VAL(X)			X.val
#define VAL_2B(X, MEMBER)	X.b.MEMBER
#define VAL_2B_P(X, MEMBER)	X->b.MEMBER

static inline void
tpm2_error(TPM_RC rc, const char *reason)
{
	const char *msg, *submsg, *num;

	fprintf(stderr, "%s failed with %d\n", reason, rc);
	TSS_ResponseCode_toString(&msg, &submsg, &num, rc);
	fprintf(stderr, "%s%s%s\n", msg, submsg, num);
}


static inline TPM_RC
tpm2_GetCapability(TSS_CONTEXT *tssContext, TPM_CAP capability,
		   UINT32 property, UINT32 propertyCount,
		   TPMI_YES_NO *moreData, TPMS_CAPABILITY_DATA *capabilityData)
{
	GetCapability_In in;
	GetCapability_Out out;
	TPM_RC rc;

	in.capability = capability;
	in.property = property;
	in.propertyCount = propertyCount;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_GetCapability,
			 TPM_RH_NULL, NULL, 0);

	if (moreData)
		*moreData = out.moreData;
	if (capabilityData)
		*capabilityData = out.capabilityData;

	return rc;
}

static inline TPM_RC
tpm2_Import(TSS_CONTEXT *tssContext, TPM_HANDLE parentHandle,
	    DATA_2B *encryptionKey, TPM2B_PUBLIC *objectPublic,
	    PRIVATE_2B *duplicate, ENCRYPTED_SECRET_2B *inSymSeed,
	    TPMT_SYM_DEF_OBJECT *symmetricAlg, PRIVATE_2B *outPrivate,
	    TPM_HANDLE auth, const char *authVal)
{
	Import_In iin;
	Import_Out iout;
	TPM_RC rc;

	iin.parentHandle = parentHandle;
	iin.encryptionKey.t = *encryptionKey;
	iin.objectPublic = *objectPublic;
	iin.duplicate.t = *duplicate;
	iin.inSymSeed.t = *inSymSeed;
	iin.symmetricAlg = *symmetricAlg;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&iout,
			 (COMMAND_PARAMETERS *)&iin,
			 NULL,
			 TPM_CC_Import,
			 auth, authVal, TPMA_SESSION_DECRYPT,
			 TPM_RH_NULL, NULL, 0);

	*outPrivate = iout.outPrivate.t;

	return rc;
}

static inline TPM_RC
tpm2_Create(TSS_CONTEXT *tssContext, TPM_HANDLE parentHandle,
	    TPM2B_SENSITIVE_CREATE *inSensitive, TPM2B_PUBLIC *inPublic,
	    PRIVATE_2B *outPrivate, TPM2B_PUBLIC *outPublic,
	    TPM_HANDLE auth, const char *authVal)
{
	Create_In cin;
	Create_Out cout;
	TPM_RC rc;

	cin.parentHandle = parentHandle;
	cin.inSensitive = *inSensitive;
	cin.inPublic = *inPublic;
	cin.outsideInfo.t.size = 0;
	cin.creationPCR.count = 0;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&cout,
			 (COMMAND_PARAMETERS *)&cin,
			 NULL,
			 TPM_CC_Create,
			 auth, authVal, TPMA_SESSION_DECRYPT,
			 TPM_RH_NULL, NULL, 0);

	*outPrivate = cout.outPrivate.t;
	*outPublic = cout.outPublic;

	return rc;
}

static inline TPM_RC
tpm2_Unseal(TSS_CONTEXT *tssContext, TPM_HANDLE itemHandle,
	    SENSITIVE_DATA_2B *outData, TPM_HANDLE auth,
	    const char *authVal)
{
	Unseal_In uin;
	Unseal_Out uout;
	TPM_RC rc;

	uin.itemHandle = itemHandle;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&uout,
			 (COMMAND_PARAMETERS *)&uin,
			 NULL,
			 TPM_CC_Unseal,
			 auth, authVal, TPMA_SESSION_ENCRYPT,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_EvictControl(TSS_CONTEXT *tssContext, TPM_HANDLE objectHandle,
		  TPM_HANDLE persistentHandle)
{
	EvictControl_In ein;
	TPM_RC rc;

	ein.auth = TPM_RH_OWNER;
	ein.objectHandle = objectHandle;
	ein.persistentHandle = persistentHandle;

	rc = TSS_Execute(tssContext,
			 NULL,
			 (COMMAND_PARAMETERS *)&ein,
			 NULL,
			 TPM_CC_EvictControl,
			 TPM_RS_PW, NULL, 0,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_ReadPublic(TSS_CONTEXT *tssContext, TPM_HANDLE objectHandle,
		TPMT_PUBLIC *pub, TPM_HANDLE auth)
{
	ReadPublic_In rin;
	ReadPublic_Out rout;
	TPM_RC rc;
	UINT32 flags = 0;

	if (auth != TPM_RH_NULL)
		flags = TPMA_SESSION_ENCRYPT;

	rin.objectHandle = objectHandle;

	rc = TSS_Execute (tssContext,
			  (RESPONSE_PARAMETERS *)&rout,
			  (COMMAND_PARAMETERS *)&rin,
			  NULL,
			  TPM_CC_ReadPublic,
			  auth, NULL, flags,
			  TPM_RH_NULL, NULL, 0);

	if (rc) {
		tpm2_error(rc, "TPM2_ReadPublic");
		return rc;
	}

	if (pub)
		*pub = rout.outPublic.publicArea;

	return rc;
}

static inline TPM_RC
tpm2_RSA_Decrypt(TSS_CONTEXT *tssContext, TPM_HANDLE keyHandle,
		 PUBLIC_KEY_RSA_2B *cipherText, TPMT_RSA_DECRYPT *inScheme,
		 PUBLIC_KEY_RSA_2B *message,
		 TPM_HANDLE auth, const char *authVal, int flags)
{
	RSA_Decrypt_In in;
	RSA_Decrypt_Out out;
	TPM_RC rc;

	in.keyHandle = keyHandle;
	in.inScheme = *inScheme;
	in.cipherText.t = *cipherText;
	in.label.t.size = 0;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_RSA_Decrypt,
			 auth, authVal, flags,
			 TPM_RH_NULL, NULL, 0);

	*message = out.message.t;

	return rc;
}

static inline TPM_RC
tpm2_Sign(TSS_CONTEXT *tssContext, TPM_HANDLE keyHandle, DIGEST_2B *digest,
	  TPMT_SIG_SCHEME *inScheme, TPMT_SIGNATURE *signature,
	  TPM_HANDLE auth, const char *authVal)
{
	Sign_In in;
	Sign_Out out;
	TPM_RC rc;

	in.keyHandle = keyHandle;
	in.digest.t = *digest;
	in.inScheme = *inScheme;
	in.validation.tag = TPM_ST_HASHCHECK;
	in.validation.hierarchy = TPM_RH_NULL;
	in.validation.digest.t.size = 0;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_Sign,
			 auth, authVal, 0,
			 TPM_RH_NULL, NULL, 0);

	*signature = out.signature;

	return rc;
}

static inline TPM_RC
tpm2_ECDH_ZGen(TSS_CONTEXT *tssContext, TPM_HANDLE keyHandle,
	       TPM2B_ECC_POINT *inPoint, TPM2B_ECC_POINT *outPoint,
	       TPM_HANDLE auth, const char *authVal)
{
	ECDH_ZGen_In in;
	ECDH_ZGen_Out out;
	TPM_RC rc;

	in.keyHandle = keyHandle;
	in.inPoint = *inPoint;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_ECDH_ZGen,
			 auth, authVal, TPMA_SESSION_ENCRYPT,
			 TPM_RH_NULL, NULL, 0);

	*outPoint = out.outPoint;

	return rc;
}

static inline TPM_RC
tpm2_CreatePrimary(TSS_CONTEXT *tssContext, TPM_HANDLE primaryHandle,
		   TPM2B_SENSITIVE_CREATE *inSensitive,
		   TPM2B_PUBLIC *inPublic, TPM_HANDLE *objectHandle,
		   TPM2B_PUBLIC *outPublic,
		   TPM_HANDLE auth, const char *authVal)
{
	CreatePrimary_In in;
	CreatePrimary_Out out;
	TPM_RC rc;

	in.primaryHandle = primaryHandle;
	in.inSensitive = *inSensitive;
	in.inPublic = *inPublic;
	/* no outside info */
	in.outsideInfo.t.size = 0;
	/* no PCR state */
	in.creationPCR.count = 0;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_CreatePrimary,
			 auth, authVal, TPMA_SESSION_DECRYPT,
			 TPM_RH_NULL, NULL, 0);

	*objectHandle = out.objectHandle;
	if (outPublic)
		*outPublic = out.outPublic;

	return rc;
}

static inline TPM_RC
tpm2_FlushContext(TSS_CONTEXT *tssContext, TPM_HANDLE flushHandle)
{
	FlushContext_In in;
	TPM_RC rc;

	in.flushHandle = flushHandle;

	rc = TSS_Execute(tssContext,
			 NULL,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_FlushContext,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_ECC_Parameters(TSS_CONTEXT *tssContext, TPMI_ECC_CURVE curveID,
		    TPMS_ALGORITHM_DETAIL_ECC *parameters)
{
	ECC_Parameters_In in;
	ECC_Parameters_Out out;
	TPM_RC rc;

	in.curveID = curveID;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_ECC_Parameters,
			 TPM_RH_NULL, NULL, 0);

	if (parameters)
		*parameters = out.parameters;

	return rc;
}

static inline TPM_RC
tpm2_StartAuthSession(TSS_CONTEXT *tssContext, TPM_HANDLE tpmKey,
		      TPM_HANDLE bind, TPM_SE sessionType,
		      TPMT_SYM_DEF *symmetric, TPMI_ALG_HASH authHash,
		      TPM_HANDLE *sessionHandle,
		      const char *bindPassword)
{
	StartAuthSession_In in;
	StartAuthSession_Out out;
	StartAuthSession_Extra extra;
	TPM_RC rc;

	memset(&in, 0, sizeof(in));
	memset(&extra, 0 , sizeof(extra));

	extra.bindPassword = bindPassword;

	in.tpmKey = tpmKey;
	in.bind = bind;
	in.sessionType = sessionType;
	in.symmetric = *symmetric;
	in.authHash = authHash;

	if (tpmKey != TPM_RH_NULL) {
		/* For the TSS to use a key as salt, it must have
		 * access to the public part.  It does this by keeping
		 * key files, but request the public part just to make
		 * sure*/
		tpm2_ReadPublic(tssContext, tpmKey,  NULL, TPM_RH_NULL);
		/* don't care what rout returns, the purpose of the
		 * operation was to get the public key parameters into
		 * the tss so it can construct the salt */
	}

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 (EXTRA_PARAMETERS *)&extra,
			 TPM_CC_StartAuthSession,
			 TPM_RH_NULL, NULL, 0);

	*sessionHandle = out.sessionHandle;

	return rc;
}

static inline TPM_RC
tpm2_Load(TSS_CONTEXT *tssContext, TPM_HANDLE parentHandle,
	  PRIVATE_2B *inPrivate, TPM2B_PUBLIC *inPublic,
	  TPM_HANDLE *objectHandle,
	  TPM_HANDLE auth, const char *authVal)
{
	Load_In in;
	Load_Out out;
	TPM_RC rc;

	in.parentHandle = parentHandle;
	in.inPrivate.t = *inPrivate;
	in.inPublic = *inPublic;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_Load,
			 auth, authVal, 0,
			 TPM_RH_NULL, NULL, 0);

	if (rc == TPM_RC_SUCCESS)
		*objectHandle = out.objectHandle;

	return rc;
}

static inline TPM_RC
tpm2_PolicyPCR(TSS_CONTEXT *tssContext, TPM_HANDLE policySession,
	       DIGEST_2B *pcrDigest, TPML_PCR_SELECTION *pcrs)
{
	PolicyPCR_In in;
	TPM_RC rc;

	in.policySession = policySession;
	in.pcrDigest.t = *pcrDigest;
	in.pcrs = *pcrs;

	rc = TSS_Execute(tssContext,
			 NULL,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_PolicyPCR,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_PolicyAuthValue(TSS_CONTEXT *tssContext, TPM_HANDLE policySession)
{
	PolicyAuthValue_In in;
	TPM_RC rc;

	in.policySession = policySession;

	rc = TSS_Execute(tssContext,
			 NULL,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_PolicyAuthValue,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_PolicyCounterTimer(TSS_CONTEXT *tssContext, TPM_HANDLE policySession,
			DIGEST_2B *operandB, UINT16 offset,
			TPM_EO operation)
{
	PolicyCounterTimer_In in;
	TPM_RC rc;

	in.policySession = policySession;
	in.operandB.t = *operandB;
	in.offset = offset;
	in.operation = operation;

	rc = TSS_Execute(tssContext,
			 NULL,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_PolicyCounterTimer,
			 TPM_RH_NULL, NULL, 0);

	return rc;
}

static inline TPM_RC
tpm2_PCR_Read(TSS_CONTEXT *tssContext, TPML_PCR_SELECTION *pcrSelectionIn,
	      TPML_PCR_SELECTION *pcrSelectionOut, TPML_DIGEST *pcrValues)
{
	PCR_Read_In in;
	PCR_Read_Out out;
	TPM_RC rc;

	in.pcrSelectionIn = *pcrSelectionIn;

	rc = TSS_Execute(tssContext,
			 (RESPONSE_PARAMETERS *)&out,
			 (COMMAND_PARAMETERS *)&in,
			 NULL,
			 TPM_CC_PCR_Read,
			 TPM_RH_NULL, NULL, 0);

	if (rc)
		return rc;

	*pcrSelectionOut = out.pcrSelectionOut;
	*pcrValues = out.pcrValues;

	return rc;
}

static inline TPM_HANDLE
tpm2_handle_int(TSS_CONTEXT *tssContext, TPM_HANDLE h)
{
	return h;
}

static inline TPM_HANDLE
tpm2_handle_ext(TSS_CONTEXT *tssContext, TPM_HANDLE h)
{
	return h;
}

static inline int
tpm2_handle_mso(TSS_CONTEXT *tssContext, TPM_HANDLE h, UINT32 mso)
{
	return (h >> 24) == mso;
}