/********************************************************************************/
/*										*/
/*						*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/*										*/
/*  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, 2023				  	*/
/*										*/
/********************************************************************************/

//** Introduction
//
// This header file is used to 'splice' the OpenSSL hash code into the TPM code.
//
#ifndef HASH_LIB_DEFINED
#define HASH_LIB_DEFINED

#define HASH_LIB_OSSL

#include <openssl/evp.h>
#include <openssl/sha.h>

#if ALG_SM3_256
#  if defined(OPENSSL_NO_SM3) || OPENSSL_VERSION_NUMBER < 0x10101010L
#    error "Current version of OpenSSL doesn't support SM3"
#  elif OPENSSL_VERSION_NUMBER >= 0x10200000L
#    include <openssl/sm3.h>
#  else
// OpenSSL 1.1.1 keeps smX.h headers in the include/crypto directory,
// and they do not get installed as part of the libssl package
#    define SM3_LBLOCK (64 / 4)

typedef struct SM3state_st
{
    unsigned int A, B, C, D, E, F, G, H;
    unsigned int Nl, Nh;
    unsigned int data[SM3_LBLOCK];
    unsigned int num;
} SM3_CTX;

int sm3_init(SM3_CTX* c);
int sm3_update(SM3_CTX* c, const void* data, size_t len);
int sm3_final(unsigned char* md, SM3_CTX* c);
#  endif  // OpenSSL < 1.2
#endif    // ALG_SM3_256

#include <openssl/ossl_typ.h>

#if defined(VBOX)
/*
 * Our openssl symbol mangling clashes with teh defines below prefixing them with VBox_
 * which of course breaks everything else... Lets just hope libtpms doesn't call SHA512(), etc.
 */
# undef SHA1
# undef SHA256
# undef SHA384
# undef SHA512
# undef HMAC
#endif

//***************************************************************
//** Links to the OpenSSL HASH code
//***************************************************************

// Redefine the internal name used for each of the hash state structures to the
// name used by the library.
// These defines need to be known in all parts of the TPM so that the structure
// sizes can be properly computed when needed.
#define tpmHashStateSHA1_t    SHA_CTX
#define tpmHashStateSHA256_t  SHA256_CTX
#define tpmHashStateSHA384_t  SHA512_CTX
#define tpmHashStateSHA512_t  SHA512_CTX
#define tpmHashStateSM3_256_t SM3_CTX

// The defines below are only needed when compiling CryptHash.c or CryptSmac.c.
// This isolation is primarily to avoid name space collision. However, if there
// is a real collision, it will likely show up when the linker tries to put things
// together.

#ifdef _CRYPT_HASH_C_

typedef BYTE*       PBYTE;
typedef const BYTE* PCBYTE;

// Define the interface between CryptHash.c to the functions provided by the
// library. For each method, define the calling parameters of the method and then
// define how the method is invoked in CryptHash.c.
//
// All hashes are required to have the same calling sequence. If they don't, create
// a simple adaptation function that converts from the "standard" form of the call
// to the form used by the specific hash (and then send a nasty letter to the
// person who wrote the hash function for the library).
//
// The macro that calls the method also defines how the
// parameters get swizzled between the default form (in CryptHash.c)and the
// library form.
//
// Initialize the hash context
#  define HASH_START_METHOD_DEF void(HASH_START_METHOD)(PANY_HASH_STATE state)
#  define HASH_START(hashState) ((hashState)->def->method.start)(&(hashState)->state);

// Add data to the hash
#  define HASH_DATA_METHOD_DEF						\
    void(HASH_DATA_METHOD)(PANY_HASH_STATE state, PCBYTE buffer, size_t size)
#  define HASH_DATA(hashState, dInSize, dIn)				\
    ((hashState)->def->method.data)(&(hashState)->state, dIn, dInSize)

// Finalize the hash and get the digest
#  define HASH_END_METHOD_DEF						\
    void(HASH_END_METHOD)(BYTE * buffer, PANY_HASH_STATE state)
#  define HASH_END(hashState, buffer)					\
    ((hashState)->def->method.end)(buffer, &(hashState)->state)

// Copy the hash context
// Note: For import, export, and copy, memcpy() is used since there is no
// reformatting necessary between the internal and external forms.
#  define HASH_STATE_COPY_METHOD_DEF	     \
    void(HASH_STATE_COPY_METHOD)(					\
									PANY_HASH_STATE to, PCANY_HASH_STATE from, size_t size)
#  define HASH_STATE_COPY(hashStateOut, hashStateIn)		      \
    ((hashStateIn)->def->method.copy)(&(hashStateOut)->state,		\
				      &(hashStateIn)->state,		\
				      (hashStateIn)->def->contextSize)

// Copy (with reformatting when necessary) an internal hash structure to an
// external blob
#  define HASH_STATE_EXPORT_METHOD_DEF					\
    void(HASH_STATE_EXPORT_METHOD)(BYTE * to, PCANY_HASH_STATE from, size_t size)
#  define HASH_STATE_EXPORT(to, hashStateFrom)		       \
    ((hashStateFrom)->def->method.copyOut)(				\
									&(((BYTE*)(to))[offsetof(HASH_STATE, state)]), \
									&(hashStateFrom)->state, \
									(hashStateFrom)->def->contextSize)

// Copy from an external blob to an internal formate (with reformatting when
// necessary
#  define HASH_STATE_IMPORT_METHOD_DEF					\
    void(HASH_STATE_IMPORT_METHOD)(PANY_HASH_STATE to, const BYTE* from, size_t size)
#  define HASH_STATE_IMPORT(hashStateTo, from)			       \
    ((hashStateTo)->def->method.copyIn)(				\
									&(hashStateTo)->state, \
									&(((const BYTE*)(from))[offsetof(HASH_STATE, state)]), \
									(hashStateTo)->def->contextSize)

// Function aliases. The code in CryptHash.c uses the internal designation for the
// functions. These need to be translated to the function names of the library.
#  define tpmHashStart_SHA1          SHA1_Init
#  define tpmHashData_SHA1           SHA1_Update
#  define tpmHashEnd_SHA1            SHA1_Final
#  define tpmHashStateCopy_SHA1      memcpy
#  define tpmHashStateExport_SHA1    memcpy
#  define tpmHashStateImport_SHA1    memcpy
#  define tpmHashStart_SHA256        SHA256_Init
#  define tpmHashData_SHA256         SHA256_Update
#  define tpmHashEnd_SHA256          SHA256_Final
#  define tpmHashStateCopy_SHA256    memcpy
#  define tpmHashStateExport_SHA256  memcpy
#  define tpmHashStateImport_SHA256  memcpy
#  define tpmHashStart_SHA384        SHA384_Init
#  define tpmHashData_SHA384         SHA384_Update
#  define tpmHashEnd_SHA384          SHA384_Final
#  define tpmHashStateCopy_SHA384    memcpy
#  define tpmHashStateExport_SHA384  memcpy
#  define tpmHashStateImport_SHA384  memcpy
#  define tpmHashStart_SHA512        SHA512_Init
#  define tpmHashData_SHA512         SHA512_Update
#  define tpmHashEnd_SHA512          SHA512_Final
#  define tpmHashStateCopy_SHA512    memcpy
#  define tpmHashStateExport_SHA512  memcpy
#  define tpmHashStateImport_SHA512  memcpy
#  define tpmHashStart_SM3_256       sm3_init
#  define tpmHashData_SM3_256        sm3_update
#  define tpmHashEnd_SM3_256         sm3_final
#  define tpmHashStateCopy_SM3_256   memcpy
#  define tpmHashStateExport_SM3_256 memcpy
#  define tpmHashStateImport_SM3_256 memcpy

#endif  // _CRYPT_HASH_C_

#define LibHashInit()
// This definition would change if there were something to report
#define HashLibSimulationEnd()

#endif  // HASH_LIB_DEFINED
