TPM2-Plugin/lib/include/tpm2_hash.h

   1 //**********************************************************************;
   2 // Copyright (c) 2017, Intel Corporation
   3 // All rights reserved.
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are met:
   7 //
   8 // 1. Redistributions of source code must retain the above copyright notice,
   9 // this list of conditions and the following disclaimer.
  10 //
  11 // 2. Redistributions in binary form must reproduce the above copyright notice,
  12 // this list of conditions and the following disclaimer in the documentation
  13 // and/or other materials provided with the distribution.
  14 //
  15 // 3. Neither the name of Intel Corporation nor the names of its contributors
  16 // may be used to endorse or promote products derived from this software without
  17 // specific prior written permission.
  18 //
  19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  23 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 // THE POSSIBILITY OF SUCH DAMAGE.
  30 //**********************************************************************;
  31 #ifndef SRC_TPM_HASH_H_
  32 #define SRC_TPM_HASH_H_
  33
  34 #include <stdbool.h>
  35
  36 #include <tss2/tss2_sys.h>
  37
  38 /**
  39  * Hashes a BYTE array via the tpm.
  40  * @param sapi_context
  41  *  The system api context.
  42  * @param hash_alg
  43  *  The hashing algorithm to use.
  44  * @param hierarchy
  45  *  The hierarchy.
  46  * @param buffer
  47  *  The data to hash.
  48  * @param length
  49  *  The length of the data.
  50  * @param result
  51  *  The digest result.
  52  * @param validation
  53  *  The validation ticket. Note that some hierarchies don't produce a
  54  *  validation ticket and thus size will be 0.
  55  * @return
  56  *  True on success, false otherwise.
  57  */
  58 bool tpm2_hash_compute_data(TSS2_SYS_CONTEXT *sapi_context, TPMI_ALG_HASH halg,
  59         TPMI_RH_HIERARCHY hierarchy, BYTE *buffer, UINT16 length,
  60         TPM2B_DIGEST *result, TPMT_TK_HASHCHECK *validation);
  61
  62 /**
  63  * Hashes a FILE * object via the tpm.
  64  * @param sapi_context
  65  *  The system api context.
  66  * @param hash_alg
  67  *  The hashing algorithm to use.
  68  * @param hierarchy
  69  *  The hierarchy.
  70  * @param input
  71  *  The FILE object to hash.
  72  * @param result
  73  *  The digest result.
  74  * @param validation
  75  *  The validation ticket. Note that some hierarchies don't produce a
  76  *  validation ticket and thus size will be 0.
  77  * @return
  78  *  True on success, false otherwise.
  79  */
  80 bool tpm2_hash_file(TSS2_SYS_CONTEXT *sapi_context, TPMI_ALG_HASH halg,
  81         TPMI_RH_HIERARCHY hierarchy, FILE *input, TPM2B_DIGEST *result,
  82         TPMT_TK_HASHCHECK *validation);
  83
  84 #endif /* SRC_TPM_HASH_H_ */