stefanberger / libtpms / #1996

/********************************************************************************/

/*                                                                                */

/*                          Code to perform the various self-test functions.        */

/*                             Written by Ken Goldman                                */

/*                       IBM Thomas J. Watson Research Center                        */

/*            $Id: AlgorithmTests.c 1594 2020-03-26 22:15:48Z kgoldman $        */

/*                                                                                */

/*  Licenses and Notices                                                        */

/*                                                                                */

/*  1. Copyright Licenses:                                                        */

/*                                                                                */

/*  - Trusted Computing Group (TCG) grants to the user of the source code in        */

/*    this specification (the "Source Code") a worldwide, irrevocable,                 */

/*    nonexclusive, royalty free, copyright license to reproduce, create         */

/*    derivative works, distribute, display and perform the Source Code and        */

/*    derivative works thereof, and to grant others the rights granted herein.        */

/*                                                                                */

/*  - The TCG grants to the user of the other parts of the specification         */

/*    (other than the Source Code) the rights to reproduce, distribute,         */

/*    display, and perform the specification solely for the purpose of                 */

/*    developing products based on such documents.                                */

/*                                                                                */

/*  2. Source Code Distribution Conditions:                                        */

/*                                                                                */

/*  - Redistributions of Source Code must retain the above copyright licenses,         */

/*    this list of conditions and the following disclaimers.                        */

/*                                                                                */

/*  - Redistributions in binary form must reproduce the above copyright         */

/*    licenses, this list of conditions        and the following disclaimers in the         */

/*    documentation and/or other materials provided with the distribution.        */

/*                                                                                */

/*  3. Disclaimers:                                                                */

/*                                                                                */

/*  - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF        */

/*  LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH        */

/*  RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES)        */

/*  THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE.                */

/*  Contact TCG Administration (admin@trustedcomputinggroup.org) for                 */

/*  information on specification licensing rights available through TCG         */

/*  membership agreements.                                                        */

/*                                                                                */

/*  - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED         */

/*    WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR         */

/*    FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR                 */

/*    NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY                 */

/*    OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE.                */

/*                                                                                */

/*  - Without limitation, TCG and its members and licensors disclaim all         */

/*    liability, including liability for infringement of any proprietary         */

/*    rights, relating to use of information in this specification and to the        */

/*    implementation of this specification, and TCG disclaims all liability for        */

/*    cost of procurement of substitute goods or services, lost profits, loss         */

/*    of use, loss of data or any incidental, consequential, direct, indirect,         */

/*    or special damages, whether under contract, tort, warranty or otherwise,         */

/*    arising in any way out of use or reliance upon this specification or any         */

/*    information herein.                                                        */

/*                                                                                */

/*  (c) Copyright IBM Corp. and others, 2016 - 2020                                */

/*                                                                                */

/********************************************************************************/

/* 10.2.1 AlgorithmTests.c */

/* 10.2.1.1 Introduction */

/* This file contains the code to perform the various self-test functions. */

/* 10.2.1.2 Includes and Defines */

#include    "Tpm.h"

#define     SELF_TEST_DATA

#if SELF_TEST

/* These includes pull in the data structures. They contain data definitions for the various

   tests. */

#include    "SelfTest.h"

#include    "SymmetricTest.h"

#include    "RsaTestData.h"

#include    "EccTestData.h"

#include    "HashTestData.h"

#include    "KdfTestData.h"

#define TEST_DEFAULT_TEST_HASH(vector)                                        \

    if(TEST_BIT(DEFAULT_TEST_HASH, g_toTest))                                \

        TestHash(DEFAULT_TEST_HASH, vector);

/* Make sure that the algorithm has been tested */

#define CLEAR_BOTH(alg)     {   CLEAR_BIT(alg, *toTest);                \

        if(toTest != &g_toTest)                                                \

            CLEAR_BIT(alg, g_toTest); }

#define SET_BOTH(alg)     {   SET_BIT(alg, *toTest);                        \

        if(toTest != &g_toTest)                                                \

            SET_BIT(alg, g_toTest); }

#define TEST_BOTH(alg)       ((toTest != &g_toTest)                        \

                              ? TEST_BIT(alg, *toTest) || TEST_BIT(alg, g_toTest) \

                              : TEST_BIT(alg, *toTest))

/* Can only cancel if doing a list. */

#define CHECK_CANCELED                                                        \

    if(_plat__IsCanceled() && toTest != &g_toTest)                        \

        return TPM_RC_CANCELED;

/* 10.2.1.3 Hash Tests */

/* 10.2.1.3.1 Description */

/* The hash test does a known-value HMAC using the specified hash algorithm. */

/* 10.2.1.3.2 TestHash() */

/* The hash test function. */

static TPM_RC

         TPM_ALG_ID          hashAlg,

         ALGORITHM_VECTOR    *toTest

         )

{

    //    TPM2B_TYPE(HMAC_BLOCK, DEFAULT_TEST_HASH_BLOCK_SIZE);

        {

#if ALG_SHA1

          case ALG_SHA1_VALUE:

            testDigest = &c_SHA1_digest.b;

            break;

#endif

#if ALG_SHA256

#endif

#if ALG_SHA384

#endif

#if ALG_SHA512

#endif

#if ALG_SM3_256

          case ALG_SM3_256_VALUE:

#error Missing test case for SM3  // libtpms added

            // There are currently no test vectors for SM3

            //            testDigest = &c_SM3_256_digest.b;

            testDigest = NULL;

            break;

#endif

        }

    // Clear the to-test bits

    // If there is an algorithm without test vectors, then assume that things are OK.

        return TPM_RC_SUCCESS;

    // Set the HMAC key to twice the digest size

                   (BYTE *)c_hashTestKey.t.buffer);

                      (BYTE *)c_hashTestData.t.buffer);

    }

    return TPM_RC_SUCCESS;

}

// libtpms added begin

#if SMAC_IMPLEMENTED && ALG_CMAC

static TPM_RC

         ALGORITHM_VECTOR    *toTest

         )

{

    // initializing this statically seems impossible with gcc...

        {

                                      TPM_ALG_CMAC, CMACTests[i].key);

            }

        }

}

#endif

// libtpms added end

/* 10.2.1.4 Symmetric Test Functions */

/* 10.2.1.4.1 MakeIv() */

/* Internal function to make the appropriate IV depending on the mode. */

static UINT32

       TPM_ALG_ID    mode,     // IN: symmetric mode

       UINT32        size,     // IN: block size of the algorithm

       BYTE         *iv        // OUT: IV to fill in

       )

{

        return 0;

        {

            // The test uses an IV that has 0xff in the last byte

        }

    else

        {

        }

    return size;

}

/* 10.2.1.4.2 TestSymmetricAlgorithm() */

/* Function to test a specific algorithm, key size, and mode. */

static void

                       const SYMMETRIC_TEST_VECTOR     *test,          //

                       TPM_ALG_ID                       mode           //

                       )

{

    // libtpms added beging

    // libtpms added end

    //

    // Get the appropriate IV

    // Encrypt known data

    // Check that it matches the expected value

    }

    // Reinitialize the iv for decryption

    // Make sure that it matches what we started with

    }

}

/* 10.2.1.4.3 AllSymsAreDone() */

/* Checks if both symmetric algorithms have been tested. This is put here so that addition of a

   symmetric algorithm will be relatively easy to handle */

/* Return Value        Meaning */

/* TRUE(1)        all symmetric algorithms tested */

/* FALSE(0)        not all symmetric algorithms tested */

static BOOL

               ALGORITHM_VECTOR        *toTest

               )

{

}

/* 10.2.1.4.4 AllModesAreDone() */

/* Checks if all the modes have been tested */

/* Return Value        Meaning */

/* TRUE(1)        all modes tested */

/* FALSE(0)        all modes not tested */

static BOOL

                ALGORITHM_VECTOR            *toTest

                )

{

            return FALSE;

    return TRUE;

}

/* 10.2.1.4.5 TestSymmetric() */

/* If alg is a symmetric block cipher, then all of the modes that are selected are tested. If alg is

   a mode, then all algorithms of that mode are tested. */

static TPM_RC

              TPM_ALG_ID                   alg,

              ALGORITHM_VECTOR            *toTest

              )

{

    //

        return TPM_RC_SUCCESS;

        {

            // Will test the algorithm for all modes and key sizes

            // A test this algorithm for all modes

                {

                        {

                            for(mode = SYM_MODE_FIRST;

                                {

                                }

                        }

                }

            // if all the symmetric tests are done

                {

                    // all symmetric algorithms tested so no modes should be set

                }

        }

    else if(SYM_MODE_FIRST <= alg && alg <= SYM_MODE_LAST)

        {

            // Test this mode for all key sizes and algorithms

                {

                    // The mode testing only comes into play when doing self tests

                    // by command. When doing self tests by command, the block ciphers are

                    // tested first. That means that all of their modes would have been

                    // tested for all key sizes. If there is no block cipher left to

                    // test, then clear this mode bit.

                        {

                        }

                    else

                        {

                                {

                                }

                            // have tested this mode for all algorithms

                        }

                }

                {

                }

        }

    else

    return TPM_RC_SUCCESS;

}

/* 10.2.1.5 RSA Tests */

#if ALG_RSA

/* 10.2.1.5.1 Introduction */

/* The tests are for public key only operations and for private key operations. Signature

   verification and encryption are public key operations. They are tested by using a KVT. For

   signature verification, this means that a known good signature is checked by

   CryptRsaValidateSignature(). If it fails, then the TPM enters failure mode. For encryption, the

   TPM encrypts known values using the selected scheme and checks that the returned value matches

   the expected value. */

/* For private key operations, a full scheme check is used. For a signing key, a known key is used

   to sign a known message. Then that signature is verified. since the signature may involve use of

   random values, the signature will be different each time and we can't always check that the

   signature matches a known value. The same technique is used for decryption (RSADP/RSAEP). */

/* When an operation uses the public key and the verification has not been tested, the TPM will do a

   KVT. */

/* The test for the signing algorithm is built into the call for the algorithm */

/* 10.2.1.5.2 RsaKeyInitialize() */

/* The test key is defined by a public modulus and a private prime. The TPM's RSA code computes the

   second prime and the private exponent. */

static void

                 OBJECT          *testObject

                 )

{

                 sizeof(c_rsaPublicModulus));

                 sizeof(testObject->sensitive.sensitive.rsa.t.buffer));

    // Use the default exponent

/* 10.2.1.5.3 TestRsaEncryptDecrypt() */

/* These tests are for a public key encryption that uses a random value. */

static TPM_RC

                      TPM_ALG_ID           scheme,            // IN: the scheme

                      ALGORITHM_VECTOR    *toTest             //

                      )

{

    //

    // Don't need to initialize much of the test object but do need to initialize

    // the flag indicating that the private exponent has been computed.

        {

            // This is an encryption scheme using the private key without any encoding.

                                                 &testObject, &rsaScheme, NULL, NULL)) {

            }

            }

                                                 &testObject, &rsaScheme, NULL)) {

            }

                            sizeof(c_RsaTestValue))) {

            }

        }

    else

        {

            // ALG_RSAES_VALUE:

            // This is an decryption scheme using padding according to

            // PKCS#1v2.1, 7.2. This padding uses random bits. To test a public

            // key encryption that uses random data, encrypt a value and then

            // decrypt the value and see that we get the encrypted data back.

            // The hash is not used by this encryption so it can be TMP_ALG_NULL

            // ALG_OAEP_VALUE:

            // This is also an decryption scheme and it also uses a

            // pseudo-random

            // value. However, this also uses a hash algorithm. So, we may need

            // to test that algorithm before use.

                {

                }

                {

                    kvtValue = &c_RsaesKvt;

                    testLabel = NULL;

                }

            else {

            }

            // Only use a digest-size portion of the test value

            // See if the encryption works

                                                 &testObject, &rsaScheme, testLabel,

                                                 NULL)) {

            }

            // see if we can decrypt this value and get the original data back

                                                 &testObject, &rsaScheme, testLabel)) {

            }

            // See if the results compare

                               DEFAULT_TEST_DIGEST_SIZE)) {

            }

            // Now check that the decryption works on a known value

                         sizeof(testInput.t.buffer));

                                                 &testObject, &rsaScheme, testLabel)) {

            }

                               DEFAULT_TEST_DIGEST_SIZE)) {

            }

        }

}

/* 10.2.1.5.4 TestRsaSignAndVerify() */

/* This function does the testing of the RSA sign and verification functions. This test does a

   KVT. */

static TPM_RC

                     TPM_ALG_ID               scheme,

                     ALGORITHM_VECTOR        *toTest

                     )

{

    // Do a sign and signature verification.

    // RSASSA:

    // This is a signing scheme according to PKCS#1-v2.1 8.2. It does not

    // use random data so there is a KVT for the signing operation. On

    // first use of the scheme for signing, use the TPM's RSA key to

    // sign a portion of c_RsaTestData and compare the results to c_RsassaKvt. Then

    // decrypt the data to see that it matches the starting value. This verifies

    // the signature with a KVT

    // Clear the bits indicating that the function has not been checked. This is to

    // prevent looping

    // RSAPSS:

    // This is a signing scheme a according to PKCS#1-v2.2 8.1 it uses

    // random data in the signature so there is no KVT for the signing

    // operation. To test signing, the TPM will use the TPM's RSA key

    // to sign a portion of c_RsaTestValue and then it will verify the

    // signature. For verification, c_RsapssKvt is verified before the

    // user signature blob is verified. The worst case for testing of this

    // algorithm is two private and one public key operation.

    // The process is to sign known data. If RSASSA is being done, verify that the

    // signature matches the precomputed value. For both, use the signed value and

    // see that the verification says that it is a good signature. Then

    // if testing RSAPSS, do a verify of a known good signature. This ensures that

    // the validation function works.

    }

    // For RSASSA, make sure the results is what we are looking for

        {

                               testSig.signature.rsassa.sig.t.buffer,

                               RSA_TEST_KEY_SIZE)) {

            }

        }

    // See if the TPM will validate its own signatures

                                                   &testDigest)) {

    }

    // If this is RSAPSS, check the verification with known signature

    // Have to copy because  CrytpRsaValidateSignature() eats the signature

        {

                         sizeof(testSig.signature.rsapss.sig.t.buffer));

                                                           &testDigest)) {

            }

        }

}

/* 10.2.1.5.5 TestRSA() */

/* Function uses the provided vector to indicate which tests to run. It will clear the vector after

   each test is run and also clear g_toTest */

static TPM_RC

        TPM_ALG_ID               alg,

        ALGORITHM_VECTOR        *toTest

        )

{

    //

        {

            // This is the RSAEP/RSADP function. If we are processing a list, don't

            // need to test these now because any other test will validate

            // RSAEP/RSADP. Can tell this is list of test by checking to see if

            // 'toTest' is pointing at g_toTest. If so, this is an isolated test

            // an need to go ahead and do the test;

                // Not running a list of tests or no other tests on the list

                // so run the test now

            // if not running the test now, leave the bit on, just in case things

            // get interrupted

            break;

          case ALG_RSAES_VALUE:

          case ALG_RSASSA_VALUE:

        }

}

#endif // TPM_ALG_RSA

/* 10.2.1.6 ECC Tests */

#if ALG_ECC

/* 10.2.1.6.1 LoadEccParameter() */

/* This function is mostly for readability and type checking */

static void

                 TPM2B_ECC_PARAMETER          *to,       // target

                 const TPM2B_EC_TEST          *from      // source

                 )

{

/* 10.2.1.6.2 LoadEccPoint() */

static void

             TPMS_ECC_POINT               *point,       // target

             const TPM2B_EC_TEST          *x,             // source

             const TPM2B_EC_TEST           *y

             )

{

/* 10.2.1.6.3 TestECDH() */

/* This test does a KVT on a point multiply. */

static TPM_RC

         TPM_ALG_ID          scheme,         // IN: for consistency

         ALGORITHM_VECTOR    *toTest         // IN/OUT: modified after test is run

         )

{

    //

                                               NULL, NULL)) {

    }

    }

}

/* 10.2.1.6.4        TestEccSignAndVerify() */

static TPM_RC

                     TPM_ALG_ID                   scheme,

                     ALGORITHM_VECTOR            *toTest

                     )

{

    // ECC signature verification testing uses a KVT.

        {

          case ALG_ECDSA_VALUE:

            break;

          case ALG_ECSCHNORR_VALUE:

                             &c_TestEcSchnorr_r);

                             &c_TestEcSchnorr_s);

            break;

          case ALG_SM2_VALUE:

            // don't have a test for SM2

            return TPM_RC_SUCCESS;

        }

    // Have to copy the key. This is because the size used in the test vectors

    // is the size of the ECC parameter for the test key while the size of a point

    // is TPM dependent

                 sizeof(testObject.sensitive.sensitive.ecc.t.buffer));

                 &c_ecTestKey_QsY);

                                                   (TPM2B_DIGEST *)&c_ecTestValue.b))

        {

        }

    // Now sign and verify some data

                                      (TPM2B_DIGEST *)&c_ecTestValue,

                                      &eccScheme, NULL)) {

    }

                                                   (TPM2B_DIGEST *)&c_ecTestValue)) {

    }

    return TPM_RC_SUCCESS;

}

/* 10.2.1.6.5        TestKDFa() */

static TPM_RC

         ALGORITHM_VECTOR        *toTest

         )

{

    //

                              &c_kdfTestContextU.b, &c_kdfTestContextV.b,

                              TEST_KDF_KEY_SIZE * 8, keyOut.t.buffer,

                              &counter, FALSE);

                           TEST_KDF_KEY_SIZE))

}

/* 10.2.1.6.6        TestEcc() */

static TPM_RC

        TPM_ALG_ID              alg,

        ALGORITHM_VECTOR        *toTest

        )

{

        {

          case ALG_ECDH_VALUE:

            // If this is in a loop then see if another test is going to deal with

            // this.

            // If toTest is not a self-test list

               // or this is the only ECC test in the list

                {

                }

            break;

          case ALG_ECSCHNORR_VALUE:

          case ALG_SM2_VALUE:

        }

}

#endif // TPM_ALG_ECC

/* 10.2.1.6.4 TestAlgorithm() */

/* Dispatches to the correct test function for the algorithm or gets a list of testable

   algorithms. */

/* If toTest is not NULL, then the test decisions are based on the algorithm selections in

   toTest. Otherwise, g_toTest is used. When bits are clear in g_toTest they will also be cleared

   toTest. */

/* If there doesn't happen to be a test for the algorithm, its associated bit is quietly cleared. */

/* If alg is zero (TPM_ALG_ERROR), then the toTest vector is cleared of any bits for which there is

   no test (i.e. no tests are actually run but the vector is cleared). */

/* NOTE: toTest will only ever have bits set for implemented algorithms but alg can be anything. */

/* Error Returns Meaning */

/* TPM_RC_CANCELED test was canceled */

LIB_EXPORT

TPM_RC

              TPM_ALG_ID               alg,

              ALGORITHM_VECTOR        *toTest

              )

{

    // This is kind of strange. This function will either run a test of the selected

    // algorithm or just clear a bit if there is no test for the algorithm. So,

    // either this loop will be executed once for the selected algorithm or once for

    // each of the possible algorithms. If it is executed more than once ('alg' ==

    // TPM_ALG_ERROR), then no test will be run but bits will be cleared for

    // unimplemented algorithms. This was done this way so that there is only one

    // case statement with all of the algorithms. It was easier to have one case

    // statement than to have multiple ones to manage whenever an algorithm ID is

    // added.

        {

            // if 'alg' was TPM_ALG_ERROR, then we will be cycling through

            // values, some of which may not be implemented. If the bit in toTest

            // happens to be set, then we could either generated an assert, or just

            // silently CLEAR it. Decided to just clear.

                {

                }

            // Process whatever is left.

            // NOTE: since this switch will only be called if the algorithm is

            // implemented, it is not necessary to modify this list except to comment

            // out the algorithms for which there is no test

                {

                    // Symmetric block ciphers

#if ALG_AES

// libtpms added begin

#if SMAC_IMPLEMENTED && ALG_CMAC

                             break;

                    }

#endif

// libtpms added end

#endif

#if ALG_SM4

                    // if SM4 is implemented, its test is like other block ciphers but there

                    // aren't any test vectors for it yet

                    //            case ALG_SM4_VALUE:

#endif

#if ALG_CAMELLIA

                  case ALG_CAMELLIA_VALUE:  // libtpms activated

#endif

#if ALG_TDES

                  case ALG_TDES_VALUE:      // libtpms added

#endif

                    // Symmetric modes

#if !ALG_CFB

#   error   CFB is required in all TPM implementations

#endif // !TPM_ALG_CFB

                  case ALG_CFB_VALUE:

                    break;

#if ALG_CTR

#endif // TPM_ALG_CRT

#if ALG_OFB

                  case ALG_OFB_VALUE:

#endif // TPM_ALG_OFB

#if ALG_CBC

                  case ALG_CBC_VALUE:

#endif // TPM_ALG_CBC

#if ALG_ECB

                  case ALG_ECB_VALUE:

#endif

                    else

                        // If doing the initialization of g_toTest vector, only need

                        // to test one of the modes for the symmetric algorithms. If

                        // initializing for a SelfTest(FULL_TEST), allow all the modes.

                    break;

#if !ALG_HMAC

#   error   HMAC is required in all TPM implementations

#endif

                    // Clear the bit that indicates that HMAC is required because

                    // HMAC is used as the basic test for all hash algorithms.

                    // Testing HMAC means test the default hash

                    else

                        // If not testing, then indicate that the hash needs to be

                        // tested because this uses HMAC

                    break;

#if ALG_SHA1

#endif // TPM_ALG_SHA1

#if ALG_SHA256

                  case ALG_SHA256_VALUE:

#endif // TPM_ALG_SHA256

#if ALG_SHA384

                  case ALG_SHA384_VALUE:

#endif // TPM_ALG_SHA384

#if ALG_SHA512

                  case ALG_SHA512_VALUE:

#endif // TPM_ALG_SHA512

                    // if SM3 is implemented its test is like any other hash, but there

                    // aren't any test vectors yet.

#if ALG_SM3_256

                    //            case ALG_SM3_256_VALUE:

#endif // TPM_ALG_SM3_256

                    break;

                    // RSA-dependent

#if ALG_RSA

                    else

                    break;

                  case ALG_RSAES_VALUE:

                  case ALG_RSAPSS_VALUE:

                  case ALG_OAEP_VALUE:

                  case ALG_NULL_VALUE:    // used or RSADP

                    break;

#endif // ALG_RSA_VALUE

#if ALG_KDF1_SP800_108

                    break;

#endif // ALG_KDF1_SP800_108_VALUE

#if ALG_ECC

                    // ECC dependent but no tests

                    //        case ALG_ECDAA_VALUE:

                    //        case ALG_ECMQV_VALUE:

                    //        case ALG_KDF1_SP800_56a_VALUE:

                    //        case ALG_KDF2_VALUE:

                    //        case ALG_MGF1_VALUE:

                    else

                    break;

                  case ALG_ECDH_VALUE:

                  case ALG_ECSCHNORR_VALUE:

                    //            case ALG_SM2_VALUE:

                    break;

#endif // ALG_ECC_VALUE

                }

                break;