1 /* Copyright 2018 Intel Corporation, Inc
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <sapi/tpm20.h>
20 #include "tpm2_plugin_api.h"
22 #include <tcti/tcti_device.h>
25 #include <tcti/tcti_socket.h>
27 #ifdef HAVE_TCTI_TABRMD
28 #include <tcti/tcti-tabrmd.h>
30 #define ARRAY_LEN(x) (sizeof(x)/sizeof(x[0]))
32 bool output_enabled = true;
33 bool hexPasswd = false;
34 TPM_HANDLE handle2048rsa;
35 const char *tcti_path="libtss2-tcti-device.so";
37 static void tcti_teardown(TSS2_TCTI_CONTEXT *tcti_context)
39 if (tcti_context == NULL)
41 tss2_tcti_finalize (tcti_context);
45 static void sapi_teardown(TSS2_SYS_CONTEXT *sapi_context)
47 if (sapi_context == NULL)
49 Tss2_Sys_Finalize (sapi_context);
53 static void sapi_teardown_full (TSS2_SYS_CONTEXT *sapi_context)
55 TSS2_TCTI_CONTEXT *tcti_context = NULL;
58 rc = Tss2_Sys_GetTctiContext (sapi_context, &tcti_context);
59 if (rc != TSS2_RC_SUCCESS)
61 sapi_teardown (sapi_context);
62 tcti_teardown (tcti_context);
65 int tpm2_plugin_init()
67 printf("Init API done for TPM plugin ! \n");
71 int tpm2_plugin_uninit()
73 printf("UnInit API done for TPM plugin ! \n");
77 TPM_HANDLE srk_handle;
78 int tpm2_plugin_activate(SSHSM_HW_PLUGIN_ACTIVATE_LOAD_IN_INFO_t *activate_in_info)
83 printf("number of buffers %d ! \n", activate_in_info->num_buffers);
84 if (activate_in_info->num_buffers!=1){
85 printf("activate failed ! \n");
88 printf("number of buffers %d ! \n", activate_in_info->num_buffers);
89 handle = malloc(activate_in_info->buffer_info[0]->length_of_buffer);
90 memcpy(handle, activate_in_info->buffer_info[0]->buffer, activate_in_info->buffer_info[0]->length_of_buffer);
91 srk_handle = strtol(handle, NULL, 16);
92 printf("Activate API done for TPM plugin ! \n");
96 TPMI_DH_OBJECT handle_load;
100 tcti_device_init (char const *device_file)
102 TCTI_DEVICE_CONF conf = {
103 .device_path = device_file,
109 TSS2_TCTI_CONTEXT *tcti_ctx;
111 rc = InitDeviceTcti (NULL, &size, 0);
112 if (rc != TSS2_RC_SUCCESS) {
114 "Failed to get allocation size for device tcti context: "
118 tcti_ctx = (TSS2_TCTI_CONTEXT*)calloc (1, size);
119 if (tcti_ctx == NULL) {
121 "Allocation for device TCTI context failed: %s\n",
125 rc = InitDeviceTcti (tcti_ctx, &size, &conf);
126 if (rc != TSS2_RC_SUCCESS) {
128 "Failed to initialize device TCTI context: 0x%x\n",
138 #ifdef HAVE_TCTI_SOCK
139 TSS2_TCTI_CONTEXT* tcti_socket_init (char const *address, uint16_t port)
141 TCTI_SOCKET_CONF conf = {
145 .logBufferCallback = NULL,
150 TSS2_TCTI_CONTEXT *tcti_ctx;
152 rc = InitSocketTcti (NULL, &size, &conf, 0);
153 if (rc != TSS2_RC_SUCCESS) {
154 fprintf (stderr, "Faled to get allocation size for tcti context: "
158 tcti_ctx = (TSS2_TCTI_CONTEXT*)calloc (1, size);
159 if (tcti_ctx == NULL) {
160 fprintf (stderr, "Allocation for tcti context failed: %s\n",
164 rc = InitSocketTcti (tcti_ctx, &size, &conf, 0);
165 if (rc != TSS2_RC_SUCCESS) {
166 fprintf (stderr, "Failed to initialize tcti context: 0x%x\n", rc);
173 #ifdef HAVE_TCTI_TABRMD
174 TSS2_TCTI_CONTEXT *tcti_tabrmd_init (void)
176 TSS2_TCTI_CONTEXT *tcti_ctx;
180 rc = tss2_tcti_tabrmd_init(NULL, &size);
181 if (rc != TSS2_RC_SUCCESS) {
182 printf("Failed to get size for TABRMD TCTI context: 0x%x", rc);
185 tcti_ctx = (TSS2_TCTI_CONTEXT*)calloc (1, size);
186 if (tcti_ctx == NULL) {
187 printf("Allocation for TABRMD TCTI context failed: %s", strerror (errno));
190 rc = tss2_tcti_tabrmd_init (tcti_ctx, &size);
191 if (rc != TSS2_RC_SUCCESS) {
192 printf("Failed to initialize TABRMD TCTI context: 0x%x", rc);
199 TSS2_TCTI_CONTEXT *tcti_init_from_options(common_opts_t *options)
201 switch (options->tcti_type) {
204 return tcti_device_init (options->device_file);
206 #ifdef HAVE_TCTI_SOCK
208 return tcti_socket_init (options->socket_address,
209 options->socket_port);
211 #ifdef HAVE_TCTI_TABRMD
213 return tcti_tabrmd_init ();
220 static TSS2_SYS_CONTEXT *sapi_ctx_init (TSS2_TCTI_CONTEXT *tcti_ctx)
222 TSS2_SYS_CONTEXT *sapi_ctx;
225 TSS2_ABI_VERSION abi_version = {
226 .tssCreator = TSSWG_INTEROP,
227 .tssFamily = TSS_SAPI_FIRST_FAMILY,
228 .tssLevel = TSS_SAPI_FIRST_LEVEL,
229 .tssVersion = TSS_SAPI_FIRST_VERSION,
232 size = Tss2_Sys_GetContextSize (0);
233 sapi_ctx = (TSS2_SYS_CONTEXT*)calloc (1, size);
234 if (sapi_ctx == NULL) {
236 "Failed to allocate 0x%zx bytes for the SAPI context\n",
240 rc = Tss2_Sys_Initialize (sapi_ctx, size, tcti_ctx, &abi_version);
241 if (rc != TSS2_RC_SUCCESS) {
242 fprintf (stderr, "Failed to initialize SAPI context: 0x%x\n", rc);
249 #define BUFFER_SIZE(type, field) (sizeof((((type *)NULL)->t.field)))
250 #define TPM2B_TYPE_INIT(type, field) { .t = { .size = BUFFER_SIZE(type, field), }, }
251 TPMS_AUTH_COMMAND sessionData;
252 int hex2ByteStructure(const char *inStr, UINT16 *byteLength, BYTE *byteBuffer)
254 int strLength;//if the inStr likes "1a2b...", no prefix "0x"
256 if(inStr == NULL || byteLength == NULL || byteBuffer == NULL)
258 strLength = strlen(inStr);
261 for(i = 0; i < strLength; i++)
263 if(!isxdigit(inStr[i]))
267 if(*byteLength < strLength/2)
270 *byteLength = strLength/2;
272 for(i = 0; i < *byteLength; i++)
274 char tmpStr[4] = {0};
275 tmpStr[0] = inStr[i*2];
276 tmpStr[1] = inStr[i*2+1];
277 byteBuffer[i] = strtol(tmpStr, NULL, 16);
281 int load_key(TSS2_SYS_CONTEXT *sapi_context,
282 TPMI_DH_OBJECT parentHandle,
283 TPM2B_PUBLIC *inPublic,
284 TPM2B_PRIVATE *inPrivate,
288 TPMS_AUTH_RESPONSE sessionDataOut;
289 TSS2_SYS_CMD_AUTHS sessionsData;
290 TSS2_SYS_RSP_AUTHS sessionsDataOut;
291 TPMS_AUTH_COMMAND *sessionDataArray[1];
292 TPMS_AUTH_RESPONSE *sessionDataOutArray[1];
294 TPM2B_NAME nameExt = TPM2B_TYPE_INIT(TPM2B_NAME, name);
296 sessionDataArray[0] = &sessionData;
297 sessionDataOutArray[0] = &sessionDataOut;
299 sessionsDataOut.rspAuths = &sessionDataOutArray[0];
300 sessionsData.cmdAuths = &sessionDataArray[0];
302 sessionsDataOut.rspAuthsCount = 1;
303 sessionsData.cmdAuthsCount = 1;
305 sessionData.sessionHandle = TPM_RS_PW;
306 sessionData.nonce.t.size = 0;
309 sessionData.hmac.t.size = 0;
311 *((UINT8 *)((void *)&sessionData.sessionAttributes)) = 0;
312 if (sessionData.hmac.t.size > 0 && hexPasswd)
314 sessionData.hmac.t.size = sizeof(sessionData.hmac) - 2;
315 if (hex2ByteStructure((char *)sessionData.hmac.t.buffer,
316 &sessionData.hmac.t.size,
317 sessionData.hmac.t.buffer) != 0)
319 printf( "Failed to convert Hex format password for parent Passwd.\n");
324 rval = Tss2_Sys_Load (sapi_context,
332 if(rval != TPM_RC_SUCCESS)
334 printf("\nLoad Object Failed ! ErrorCode: 0x%0x\n\n",rval);
337 printf("\nLoad succ.\nLoadedHandle: 0x%08x\n\n",handle2048rsa);
342 int read_public(TSS2_SYS_CONTEXT *sapi_context,
344 SSHSM_HW_PLUGIN_IMPORT_PUBLIC_KEY_INFO_t *importkey_info)
347 TPMS_AUTH_RESPONSE session_out_data;
348 TSS2_SYS_RSP_AUTHS sessions_out_data;
349 TPMS_AUTH_RESPONSE *session_out_data_array[1];
351 TPM2B_PUBLIC public = {
355 TPM2B_NAME name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
357 TPM2B_NAME qualified_name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
359 session_out_data_array[0] = &session_out_data;
360 sessions_out_data.rspAuths = &session_out_data_array[0];
361 sessions_out_data.rspAuthsCount = ARRAY_LEN(session_out_data_array);
363 TPM_RC rval = Tss2_Sys_ReadPublic(sapi_context, handle, 0,
364 &public, &name, &qualified_name, &sessions_out_data);
365 if (rval != TPM_RC_SUCCESS) {
366 printf("TPM2_ReadPublic error: rval = 0x%0x", rval);
370 printf("\nTPM2_ReadPublic OutPut: \n");
373 for (i = 0; i < name.t.size; i++)
374 printf("%02x ", name.t.name[i]);
377 printf("qualified_name: \n");
378 for (i = 0; i < qualified_name.t.size; i++)
379 printf("%02x ", qualified_name.t.name[i]);
382 printf("public.t.publicArea.parameters.rsaDetail.keyBits = %d \n", public.t.publicArea.parameters.rsaDetail.keyBits);
383 printf("public.t.publicArea.parameters.rsaDetail.exponent = %d \n", public.t.publicArea.parameters.rsaDetail.exponent);
385 importkey_info->modulus_size = public.t.publicArea.unique.rsa.t.size;
386 printf("importkey_info->modulus_size = %ld \n", importkey_info->modulus_size);
387 memcpy(importkey_info->modulus, &public.t.publicArea.unique.rsa.t.buffer, importkey_info->modulus_size);
389 importkey_info->exponent_size = sizeof(public.t.publicArea.parameters.rsaDetail.exponent);
390 printf("importkey_info->exponent_size = %ld \n", importkey_info->exponent_size);
391 memcpy(importkey_info->exponent, &public.t.publicArea.parameters.rsaDetail.exponent, importkey_info->exponent_size);
392 //*importkey_info->exponent = public.t.publicArea.parameters.rsaDetail.exponent;
397 TPMS_CONTEXT loaded_key_context;
399 int load_key_execute(SSHSM_HW_PLUGIN_ACTIVATE_LOAD_IN_INFO_t *loadkey_in_info,
400 void **keyHandle, TSS2_SYS_CONTEXT *sapi_context,
401 SSHSM_HW_PLUGIN_IMPORT_PUBLIC_KEY_INFO_t *importkey_info)
404 TPMI_DH_OBJECT parentHandle;
405 TPM2B_PUBLIC inPublic;
406 TPM2B_PRIVATE inPrivate;
410 memset(&inPublic,0,sizeof(TPM2B_PUBLIC));
411 memset(&inPrivate,0,sizeof(TPM2B_SENSITIVE));
413 setbuf(stdout, NULL);
414 setvbuf (stdout, NULL, _IONBF, BUFSIZ);
416 //parentHandle = 0x81000011;
417 parentHandle = srk_handle;
419 if (loadkey_in_info->num_buffers != 2)
421 memcpy(&inPublic, loadkey_in_info->buffer_info[0]->buffer,
422 loadkey_in_info->buffer_info[0]->length_of_buffer);
423 memcpy(&inPrivate, loadkey_in_info->buffer_info[1]->buffer,
424 loadkey_in_info->buffer_info[1]->length_of_buffer);
426 returnVal = load_key (sapi_context,
431 returnVal = read_public(sapi_context,
435 TPM_RC rval = Tss2_Sys_ContextSave(sapi_context, handle2048rsa, &loaded_key_context);
436 if (rval != TPM_RC_SUCCESS) {
437 printf("Tss2_Sys_ContextSave: Saving handle 0x%x context failed. TPM Error:0x%x", handle2048rsa, rval);
440 *keyHandle = &handle2048rsa;
444 int tpm2_plugin_load_key(SSHSM_HW_PLUGIN_ACTIVATE_LOAD_IN_INFO_t *loadkey_in_info,
446 SSHSM_HW_PLUGIN_IMPORT_PUBLIC_KEY_INFO_t *importkey_info)
449 common_opts_t opts = COMMON_OPTS_INITIALIZER;
450 TSS2_TCTI_CONTEXT *tcti_ctx;
451 tcti_ctx = tcti_init_from_options(&opts);
452 if (tcti_ctx == NULL)
455 TSS2_SYS_CONTEXT *sapi_context = NULL;
457 sapi_context = sapi_ctx_init(tcti_ctx);
464 ret = load_key_execute(loadkey_in_info, keyHandle, sapi_context, importkey_info);
466 printf("Load key API failed in TPM plugin ! \n");
468 sapi_teardown_full(sapi_context);
470 printf("Load key API successful in TPM plugin ! \n");
475 typedef struct tpm_sign_ctx tpm_sign_ctx;
476 struct tpm_sign_ctx {
477 TPMT_TK_HASHCHECK validation;
478 TPMS_AUTH_COMMAND sessionData;
479 TPMI_DH_OBJECT keyHandle;
481 char outFilePath[PATH_MAX];
484 TSS2_SYS_CONTEXT *sapi_context;
487 int tpm2_plugin_rsa_sign_init(
489 unsigned long mechanism,
493 printf("rsa_sign_init API mechanism is %lx \n", mechanism);
494 printf("rsa_sign_init API done for tpm2_plugin... \n");
498 UINT32 tpm_hash(TSS2_SYS_CONTEXT *sapi_context, TPMI_ALG_HASH hashAlg,
499 UINT16 size, BYTE *data, TPM2B_DIGEST *result) {
500 TPM2B_MAX_BUFFER dataSizedBuffer;
502 dataSizedBuffer.t.size = size;
503 memcpy(dataSizedBuffer.t.buffer, data, size);
504 return Tss2_Sys_Hash(sapi_context, 0, &dataSizedBuffer, hashAlg,
505 TPM_RH_NULL, result, 0, 0);
508 static TPM_RC hash_sequence_ex(TSS2_SYS_CONTEXT *sapi_context,
510 TPMI_ALG_HASH hashAlg, UINT32 numBuffers, TPM2B_MAX_BUFFER *bufferList,
511 TPM2B_DIGEST *result) {
514 TPMI_DH_OBJECT sequenceHandle;
516 TPMT_TK_HASHCHECK validation;
518 TPMS_AUTH_COMMAND cmdAuth;
519 TPMS_AUTH_COMMAND *cmdSessionArray[1] = { &cmdAuth };
520 TSS2_SYS_CMD_AUTHS cmdAuthArray = { 1, &cmdSessionArray[0] };
523 emptyBuffer.size = 0;
525 // Set result size to 0, in case any errors occur
528 // Init input sessions struct
529 cmdAuth.sessionHandle = TPM_RS_PW;
530 cmdAuth.nonce.t.size = 0;
531 *((UINT8 *) ((void *) &cmdAuth.sessionAttributes)) = 0;
532 cmdAuth.hmac.t.size = 0;
534 rval = Tss2_Sys_HashSequenceStart(sapi_context, 0, &nullAuth, hashAlg,
536 if (rval != TPM_RC_SUCCESS) {
541 for (i = 0; i < numBuffers; i++) {
542 rval = Tss2_Sys_SequenceUpdate(sapi_context, sequenceHandle,
543 &cmdAuthArray, &bufferList[i], 0);
545 if (rval != TPM_RC_SUCCESS) {
550 rval = Tss2_Sys_SequenceComplete(sapi_context, sequenceHandle,
551 &cmdAuthArray, (TPM2B_MAX_BUFFER *) &emptyBuffer,
552 TPM_RH_PLATFORM, result, &validation, 0);
554 if (rval != TPM_RC_SUCCESS) {
561 int tpm_hash_compute_data(TSS2_SYS_CONTEXT *sapi_context, BYTE *buffer,
562 UINT16 length, TPMI_ALG_HASH halg, TPM2B_DIGEST *result) {
564 if (length <= MAX_DIGEST_BUFFER) {
565 if (tpm_hash(sapi_context, halg, length, buffer,
566 result) == TPM_RC_SUCCESS)
572 UINT8 numBuffers = (length - 1) / MAX_DIGEST_BUFFER + 1;
574 TPM2B_MAX_BUFFER *bufferList = (TPM2B_MAX_BUFFER *) calloc(numBuffers,
575 sizeof(TPM2B_MAX_BUFFER));
576 if (bufferList == NULL)
580 for (i = 0; i < (UINT32)(numBuffers - 1); i++) {
581 bufferList[i].t.size = MAX_DIGEST_BUFFER;
582 memcpy(bufferList[i].t.buffer, buffer + i * MAX_DIGEST_BUFFER,
585 bufferList[i].t.size = length - i * MAX_DIGEST_BUFFER;
586 memcpy(bufferList[i].t.buffer, buffer + i * MAX_DIGEST_BUFFER,
587 bufferList[i].t.size);
589 TPM_RC rval = hash_sequence_ex(sapi_context, halg, numBuffers, bufferList, result);
591 return rval == TPM_RC_SUCCESS ? 0 : -3;
595 static bool get_key_type(TSS2_SYS_CONTEXT *sapi_context, TPMI_DH_OBJECT objectHandle,
596 TPMI_ALG_PUBLIC *type) {
598 TPMS_AUTH_RESPONSE session_data_out;
600 TPMS_AUTH_RESPONSE *session_data_out_array[1] = {
604 TSS2_SYS_RSP_AUTHS sessions_data_out = {
606 &session_data_out_array[0]
609 TPM2B_PUBLIC out_public = {
613 TPM2B_NAME name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
615 TPM2B_NAME qaulified_name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
617 TPM_RC rval = Tss2_Sys_ReadPublic(sapi_context, objectHandle, 0, &out_public, &name,
618 &qaulified_name, &sessions_data_out);
619 if (rval != TPM_RC_SUCCESS) {
620 printf("Sys_ReadPublic failed, error code: 0x%x", rval);
623 *type = out_public.t.publicArea.type;
627 static bool set_scheme(TSS2_SYS_CONTEXT *sapi_context, TPMI_DH_OBJECT keyHandle,
628 TPMI_ALG_HASH halg, TPMT_SIG_SCHEME *inScheme) {
631 bool result = get_key_type(sapi_context, keyHandle, &type);
638 inScheme->scheme = TPM_ALG_RSASSA;
639 inScheme->details.rsassa.hashAlg = halg;
641 case TPM_ALG_KEYEDHASH :
642 inScheme->scheme = TPM_ALG_HMAC;
643 inScheme->details.hmac.hashAlg = halg;
646 inScheme->scheme = TPM_ALG_ECDSA;
647 inScheme->details.ecdsa.hashAlg = halg;
649 case TPM_ALG_SYMCIPHER :
651 printf("Unknown key type, got: 0x%x", type);
657 static bool sign_and_save(tpm_sign_ctx *ctx, unsigned char *sig, int *sig_len) {
658 TPM2B_DIGEST digest = TPM2B_TYPE_INIT(TPM2B_DIGEST, buffer);
660 TPMT_SIG_SCHEME in_scheme;
661 TPMT_SIGNATURE signature;
663 TSS2_SYS_CMD_AUTHS sessions_data;
664 TPMS_AUTH_RESPONSE session_data_out;
665 TSS2_SYS_RSP_AUTHS sessions_data_out;
666 TPMS_AUTH_COMMAND *session_data_array[1];
667 TPMS_AUTH_RESPONSE *session_data_out_array[1];
669 session_data_array[0] = &ctx->sessionData;
670 sessions_data.cmdAuths = &session_data_array[0];
671 session_data_out_array[0] = &session_data_out;
672 sessions_data_out.rspAuths = &session_data_out_array[0];
673 sessions_data_out.rspAuthsCount = 1;
674 sessions_data.cmdAuthsCount = 1;
676 int rc = tpm_hash_compute_data(ctx->sapi_context, ctx->msg, ctx->length, ctx->halg, &digest);
678 printf("Compute message hash failed!");
682 bool result = set_scheme(ctx->sapi_context, ctx->keyHandle, ctx->halg, &in_scheme);
687 TPM_RC rval = Tss2_Sys_Sign(ctx->sapi_context, ctx->keyHandle,
688 &sessions_data, &digest, &in_scheme,
689 &ctx->validation, &signature,
692 if (rval != TPM_RC_SUCCESS) {
693 printf("Sys_Sign failed, error code: 0x%x", rval);
696 signature_len = sizeof(signature);
697 sig_len = &signature_len;
698 sig = (unsigned char *)&signature;
703 int tpm2_plugin_rsa_sign(
705 unsigned long mechanism,
712 common_opts_t opts = COMMON_OPTS_INITIALIZER;
713 TSS2_TCTI_CONTEXT *tcti_ctx;
714 tcti_ctx = tcti_init_from_options(&opts);
715 if (tcti_ctx == NULL)
718 TSS2_SYS_CONTEXT *sapi_context = NULL;
720 sapi_context = sapi_ctx_init(tcti_ctx);
729 .sessionData = { 0 },
733 .sapi_context = sapi_context
736 printf("rsa_sign API mechanism is %lx \n", mechanism);
737 ctx.sessionData.sessionHandle = TPM_RS_PW;
738 ctx.validation.tag = TPM_ST_HASHCHECK;
739 ctx.validation.hierarchy = TPM_RH_NULL;
740 ctx.halg = TPM_ALG_SHA256;
741 ctx.keyHandle = *(TPMI_DH_OBJECT *)keyHandle;
743 rval = Tss2_Sys_ContextLoad(ctx.sapi_context, &loaded_key_context, &ctx.keyHandle);
744 if (rval != TPM_RC_SUCCESS) {
745 printf("ContextLoad Error in RSA Sign API. TPM Error:0x%x", rval);
748 ctx.length = msg_len;
751 if (!sign_and_save(&ctx, sig, sig_len)){
752 printf("RSA sign failed\n");
756 printf("RSA sign API successful in TPM plugin ! \n");
759 sapi_teardown_full(sapi_context);