Setup TPM2-Plugin build environment

Add initial codes to build TPM2-plugin shared lib

Issue-ID: AAF-94
Change-Id: I96dee3699aa250b69350d6f01401f3831cf515f7
Signed-off-by: NingSun <ning.sun@intel.com>

1 files changed, 437 insertions, 0 deletions

diff --git a/TPM2-Plugin/lib/tpm2_alg_util.c b/TPM2-Plugin/lib/tpm2_alg_util.c
new file mode 100644
index 0000000..975f4ae
--- /dev/null
+++ b/TPM2-Plugin/lib/tpm2_alg_util.c
@@ -0,0 +1,437 @@
+//**********************************************************************;
+// Copyright (c) 2017, Intel Corporation
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+// this list of conditions and the following disclaimer in the documentation
+// and/or other materials provided with the distribution.
+//
+// 3. Neither the name of Intel Corporation nor the names of its contributors
+// may be used to endorse or promote products derived from this software without
+// specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+// THE POSSIBILITY OF SUCH DAMAGE.
+//**********************************************************************;
+#include <stdbool.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <sapi/tpm20.h>
+
+#include "files.h"
+#include "log.h"
+#include "tpm2_hash.h"
+#include "tpm2_alg_util.h"
+#include "tpm2_util.h"
+
+typedef struct alg_pair alg_pair;
+struct alg_pair {
+    const char *name;
+    TPM2_ALG_ID id;
+};
+
+void tpm2_alg_util_for_each_alg(tpm2_alg_util_alg_iteraror iterator, void *userdata) {
+
+    static const alg_pair algs[] = {
+        { .name = "rsa", .id = TPM2_ALG_RSA },
+        { .name = "sha1", .id = TPM2_ALG_SHA1 },
+        { .name = "hmac", .id = TPM2_ALG_HMAC },
+        { .name = "aes", .id = TPM2_ALG_AES },
+        { .name = "mgf1", .id = TPM2_ALG_MGF1 },
+        { .name = "keyedhash", .id = TPM2_ALG_KEYEDHASH },
+        { .name = "xor", .id = TPM2_ALG_XOR },
+        { .name = "sha256", .id = TPM2_ALG_SHA256 },
+        { .name = "sha384", .id = TPM2_ALG_SHA384 },
+        { .name = "sha512", .id = TPM2_ALG_SHA512 },
+        { .name = "null", .id = TPM2_ALG_NULL },
+        { .name = "sm3_256", .id = TPM2_ALG_SM3_256 },
+        { .name = "sm4", .id = TPM2_ALG_SM4 },
+        { .name = "rsassa", .id = TPM2_ALG_RSASSA },
+        { .name = "rsaes", .id = TPM2_ALG_RSAES },
+        { .name = "rsapss", .id = TPM2_ALG_RSAPSS },
+        { .name = "oaep", .id = TPM2_ALG_OAEP },
+        { .name = "ecdsa", .id = TPM2_ALG_ECDSA },
+        { .name = "ecdh", .id = TPM2_ALG_ECDH },
+        { .name = "ecdaa", .id = TPM2_ALG_ECDAA },
+        { .name = "sm2", .id = TPM2_ALG_SM2 },
+        { .name = "ecschnorr", .id = TPM2_ALG_ECSCHNORR },
+        { .name = "ecmqv", .id = TPM2_ALG_ECMQV },
+        { .name = "kdf1_sp800_56a", .id = TPM2_ALG_KDF1_SP800_56A },
+        { .name = "kdf2", .id = TPM2_ALG_KDF2 },
+        { .name = "kdf1_sp800_108", .id = TPM2_ALG_KDF1_SP800_108 },
+        { .name = "ecc", .id = TPM2_ALG_ECC },
+        { .name = "symcipher", .id = TPM2_ALG_SYMCIPHER },
+        { .name = "camellia", .id = TPM2_ALG_CAMELLIA },
+        { .name = "sha3_256", .id = TPM2_ALG_SHA3_256 },
+        { .name = "sha3_384", .id = TPM2_ALG_SHA3_384 },
+        { .name = "sha3_512", .id = TPM2_ALG_SHA3_512 },
+        { .name = "ctr", .id = TPM2_ALG_CTR },
+        { .name = "ofb", .id = TPM2_ALG_OFB },
+        { .name = "cbc", .id = TPM2_ALG_CBC },
+        { .name = "cfb", .id = TPM2_ALG_CFB },
+        { .name = "ecb", .id = TPM2_ALG_ECB },
+    };
+
+    size_t i;
+    for (i=0; i < ARRAY_LEN(algs); i++) {
+        const alg_pair *alg = &algs[i];
+        bool result = iterator(alg->id, alg->name, userdata);
+        if (result) {
+            return;
+        }
+    }
+}
+
+static bool find_match(TPM2_ALG_ID id, const char *name, void *userdata) {
+
+    alg_pair *search_data = (alg_pair *)userdata;
+
+    /*
+     * if name, then search on name, else
+     * search by id.
+     */
+    if (search_data->name && !strcmp(search_data->name, name)) {
+        search_data->id = id;
+        return true;
+    } else if (search_data->id == id) {
+        search_data->name = name;
+        return true;
+    }
+
+    return false;
+}
+
+TPM2_ALG_ID tpm2_alg_util_strtoalg(const char *name) {
+
+    alg_pair userdata = {
+        .name = name,
+        .id = TPM2_ALG_ERROR
+    };
+
+    if (name) {
+        tpm2_alg_util_for_each_alg(find_match, &userdata);
+    }
+
+    return userdata.id;
+}
+
+const char *tpm2_alg_util_algtostr(TPM2_ALG_ID id) {
+
+    alg_pair userdata = {
+        .name = NULL,
+        .id = id
+    };
+
+    tpm2_alg_util_for_each_alg(find_match, &userdata);
+
+    return userdata.name;
+}
+
+TPM2_ALG_ID tpm2_alg_util_from_optarg(char *optarg) {
+
+    TPM2_ALG_ID halg;
+    bool res = tpm2_util_string_to_uint16(optarg, &halg);
+    if (!res) {
+        halg = tpm2_alg_util_strtoalg(optarg);
+    }
+    return halg;
+}
+
+bool tpm2_alg_util_is_hash_alg(TPM2_ALG_ID id) {
+
+    switch (id) {
+    case TPM2_ALG_SHA1 :
+        /* fallsthrough */
+    case TPM2_ALG_SHA256 :
+        /* fallsthrough */
+    case TPM2_ALG_SHA384 :
+        /* fallsthrough */
+    case TPM2_ALG_SHA512 :
+        /* fallsthrough */
+    case TPM2_ALG_SM3_256 :
+        return true;
+        /* no default */
+    }
+
+    return false;
+}
+
+UINT16 tpm2_alg_util_get_hash_size(TPMI_ALG_HASH id) {
+
+    switch (id) {
+    case TPM2_ALG_SHA1 :
+        return TPM2_SHA1_DIGEST_SIZE;
+    case TPM2_ALG_SHA256 :
+        return TPM2_SHA256_DIGEST_SIZE;
+    case TPM2_ALG_SHA384 :
+        return TPM2_SHA384_DIGEST_SIZE;
+    case TPM2_ALG_SHA512 :
+        return TPM2_SHA512_DIGEST_SIZE;
+    case TPM2_ALG_SM3_256 :
+        return TPM2_SM3_256_DIGEST_SIZE;
+        /* no default */
+    }
+
+    return 0;
+}
+
+static const char *hex_to_byte_err(int rc) {
+
+    switch (rc) {
+    case -2:
+        return "String not even in length";
+    case -3:
+        return "Non hex digit found";
+    case -4:
+        return "Hex value too big for digest";
+    }
+    return "unknown";
+}
+
+bool pcr_parse_digest_list(char **argv, int len,
+        tpm2_pcr_digest_spec *digest_spec) {
+
+    /*
+     * int is chosen because of what is passed in from main, avoids
+     * sign differences.
+     * */
+    int i;
+    for (i = 0; i < len; i++) {
+        tpm2_pcr_digest_spec *dspec = &digest_spec[i];
+
+        UINT32 count = 0;
+
+        /*
+         * Split <pcr index>:<hash alg>=<hash value>,... on : and separate with null byte, ie:
+         * <pce index> '\0' <hash alg>'\0'<data>
+         *
+         * Start by splitting out the pcr index, and validating it.
+         */
+        char *spec_str = argv[i];
+        char *pcr_index_str = spec_str;
+        char *digest_spec_str = strchr(spec_str, ':');
+        if (!digest_spec_str) {
+            LOG_ERR("Expecting : in digest spec, not found, got: \"%s\"", spec_str);
+            return false;
+        }
+
+        *digest_spec_str = '\0';
+        digest_spec_str++;
+
+        bool result = tpm2_util_string_to_uint32(pcr_index_str, &dspec->pcr_index);
+        if (!result) {
+            LOG_ERR("Got invalid PCR Index: \"%s\", in digest spec: \"%s\"",
+                    pcr_index_str, spec_str);
+            return false;
+        }
+
+        /* now that the pcr_index is removed, parse the remaining <hash_name>=<hash_value>,.. */
+        char *digest_hash_tok;
+        char *save_ptr = NULL;
+
+        /* keep track of digests we have seen */
+
+        while ((digest_hash_tok = strtok_r(digest_spec_str, ",", &save_ptr))) {
+            digest_spec_str = NULL;
+
+            if (count >= ARRAY_LEN(dspec->digests.digests)) {
+                LOG_ERR("Specified too many digests per spec, max is: %zu",
+                        ARRAY_LEN(dspec->digests.digests));
+                return false;
+            }
+
+            TPMT_HA *d = &dspec->digests.digests[count];
+
+            char *stralg = digest_hash_tok;
+            char *split = strchr(digest_hash_tok, '=');
+            if (!split) {
+                LOG_ERR("Expecting = in <hash alg>=<hash value> spec, got: "
+                        "\"%s\"", digest_hash_tok);
+                return false;
+            }
+            *split = '\0';
+            split++;
+
+            char *data = split;
+
+            /*
+             * Convert and validate the hash algorithm. It should be a hash algorithm
+             */
+            TPM2_ALG_ID alg = tpm2_alg_util_from_optarg(stralg);
+            if (alg == TPM2_ALG_ERROR) {
+                LOG_ERR("Could not convert algorithm, got: \"%s\"", stralg);
+                return false;
+            }
+
+            bool is_hash_alg = tpm2_alg_util_is_hash_alg(alg);
+            if (!is_hash_alg) {
+                LOG_ERR("Algorithm is not a hash algorithm, got: \"%s\"",
+                        stralg);
+                return false;
+            }
+
+            d->hashAlg = alg;
+
+            /* fill up the TPMT_HA structure with algorithm and digest */
+            BYTE *digest_data = (BYTE *) &d->digest;
+
+            UINT16 expected_hash_size = tpm2_alg_util_get_hash_size(alg);
+            /* strip any preceding hex on the data as tpm2_util_hex_to_byte_structure doesn't support it */
+            bool is_hex = !strncmp("0x", data, 2);
+            if (is_hex) {
+                data += 2;
+            }
+
+            UINT16 size =  expected_hash_size;
+            int rc = tpm2_util_hex_to_byte_structure(data, &size,
+                    digest_data);
+            if (rc) {
+                LOG_ERR("Error \"%s\" converting hex string as data, got:"
+                    " \"%s\"", hex_to_byte_err(rc), data);
+                return false;
+            }
+
+            if (expected_hash_size != size) {
+                LOG_ERR(
+                        "Algorithm \"%s\" expects a size of %u bytes, got: %u",
+                        stralg, expected_hash_size, size);
+                return false;
+            }
+
+            count++;
+        }
+
+        if (!count) {
+            LOG_ERR("Missing or invalid <hash alg>=<hash value> spec for pcr:"
+                    " \"%s\"", pcr_index_str);
+            return false;
+        }
+
+        /* assign count at the end, so count is 0 on error */
+        dspec->digests.count = count;
+    }
+
+    return true;
+}
+
+UINT8* tpm2_extract_plain_signature(UINT16 *size, TPMT_SIGNATURE *signature) {
+
+    UINT8 *buffer = NULL;
+    *size = 0;
+
+    switch (signature->sigAlg) {
+    case TPM2_ALG_RSASSA:
+        *size = sizeof(signature->signature.rsassa.sig.buffer);
+        buffer = malloc(*size);
+        if (!buffer) {
+            goto nomem;
+        }
+        memcpy(buffer, signature->signature.rsassa.sig.buffer, *size);
+        break;
+    case TPM2_ALG_HMAC: {
+        TPMU_HA *hmac_sig = &(signature->signature.hmac.digest);
+        *size = tpm2_alg_util_get_hash_size(signature->signature.hmac.hashAlg);
+        buffer = malloc(*size);
+        if (!buffer) {
+            goto nomem;
+        }
+        memcpy(buffer, hmac_sig, *size);
+        break;
+    }
+    case TPM2_ALG_ECDSA: {
+        const size_t ECC_PAR_LEN = sizeof(TPM2B_ECC_PARAMETER);
+        *size = ECC_PAR_LEN * 2;
+        buffer = malloc(*size);
+        if (!buffer) {
+            goto nomem;
+        }
+        memcpy(buffer,
+            (UINT8*)&(signature->signature.ecdsa.signatureR),
+            ECC_PAR_LEN
+        );
+        memcpy(buffer + ECC_PAR_LEN,
+            (UINT8*)&(signature->signature.ecdsa.signatureS),
+            ECC_PAR_LEN
+        );
+        break;
+    }
+    default:
+        LOG_ERR("%s: unknown signature scheme: 0x%x", __func__,
+            signature->sigAlg);
+        return NULL;
+    }
+
+    return buffer;
+nomem:
+    LOG_ERR("%s: couldn't allocate memory", __func__);
+    return NULL;
+}
+
+static bool get_key_type(TSS2_SYS_CONTEXT *sapi_context, TPMI_DH_OBJECT objectHandle,
+        TPMI_ALG_PUBLIC *type) {
+
+    TSS2L_SYS_AUTH_RESPONSE sessions_data_out;
+
+    TPM2B_PUBLIC out_public = TPM2B_EMPTY_INIT;
+
+    TPM2B_NAME name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
+
+    TPM2B_NAME qaulified_name = TPM2B_TYPE_INIT(TPM2B_NAME, name);
+
+    TSS2_RC rval = Tss2_Sys_ReadPublic(sapi_context, objectHandle, 0, &out_public, &name,
+            &qaulified_name, &sessions_data_out);
+    if (rval != TPM2_RC_SUCCESS) {
+        LOG_ERR("Sys_ReadPublic failed, error code: 0x%x", rval);
+        return false;
+    }
+    *type = out_public.publicArea.type;
+    return true;
+}
+
+bool get_signature_scheme(TSS2_SYS_CONTEXT *sapi_context,
+        TPMI_DH_OBJECT keyHandle, TPMI_ALG_HASH halg,
+        TPMT_SIG_SCHEME *scheme) {
+
+    TPM2_ALG_ID type;
+    bool result = get_key_type(sapi_context, keyHandle, &type);
+    if (!result) {
+        return false;
+    }
+
+    switch (type) {
+    case TPM2_ALG_RSA :
+        scheme->scheme = TPM2_ALG_RSASSA;
+        scheme->details.rsassa.hashAlg = halg;
+        break;
+    case TPM2_ALG_KEYEDHASH :
+        scheme->scheme = TPM2_ALG_HMAC;
+        scheme->details.hmac.hashAlg = halg;
+        break;
+    case TPM2_ALG_ECC :
+        scheme->scheme = TPM2_ALG_ECDSA;
+        scheme->details.ecdsa.hashAlg = halg;
+        break;
+    case TPM2_ALG_SYMCIPHER :
+    default:
+        LOG_ERR("Unknown key type, got: 0x%x", type);
+        return false;
+    }
+
+    return true;
+}