/* hmac.h
 *
 * Copyright (C) 2006-2017 wolfSSL Inc.
 *
 * This file is part of wolfSSL.
 *
 * wolfSSL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * wolfSSL is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
 */


#ifndef NO_HMAC

# ifndef WOLF_CRYPT_HMAC_H
#  define WOLF_CRYPT_HMAC_H

#  include "types.h"

#  ifndef NO_MD5
#   include "md5.h"
#  endif

#  ifndef NO_SHA
#   include "sha.h"
#  endif

#  if !defined(NO_SHA256) || defined(WOLFSSL_SHA224)
#   include "sha256.h"
#  endif

#  ifdef WOLFSSL_SHA512
#   include "sha512.h"
#  endif

#  ifdef HAVE_BLAKE2
#   include "blake2.h"
#  endif

#  ifdef HAVE_FIPS
/* for fips */
#   include <cyassl/ctaocrypt/hmac.h>
#  endif


#  ifdef __cplusplus
extern "C" {
#  endif
#  ifndef HAVE_FIPS

#   ifdef WOLFSSL_ASYNC_CRYPT
#    include "async.h"
#   endif

enum {
    HMAC_FIPS_MIN_KEY = 14, /* 112 bit key length minimum */

    IPAD              = 0x36,
    OPAD              = 0x5C,

    /* If any hash is not enabled, add the ID here. */
    #   ifdef NO_MD5
    WC_MD5     = 0,
    #   endif
    #   ifdef NO_SHA
    WC_SHA     = 1,
    #   endif
    #   ifdef NO_SHA256
    WC_SHA256  = 2,
    #   endif
    #   ifndef WOLFSSL_SHA512
    WC_SHA512  = 4,
    #   endif
    #   ifndef WOLFSSL_SHA384
    WC_SHA384  = 5,
    #   endif
    #   ifndef HAVE_BLAKE2
    BLAKE2B_ID = 7,
    #   endif
    #   ifndef WOLFSSL_SHA224
    WC_SHA224  = 8,
    #   endif


    /* Select the largest available hash for the buffer size. */
    #   if defined(WOLFSSL_SHA512)
    MAX_DIGEST_SIZE = WC_SHA512_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_SHA512_BLOCK_SIZE,
    #   elif defined(HAVE_BLAKE2)
    MAX_DIGEST_SIZE = BLAKE2B_OUTBYTES,
    HMAC_BLOCK_SIZE = BLAKE2B_BLOCKBYTES,
    #   elif defined(WOLFSSL_SHA384)
    MAX_DIGEST_SIZE = WC_SHA384_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_SHA384_BLOCK_SIZE
    #   elif !defined(NO_SHA256)
    MAX_DIGEST_SIZE = WC_SHA256_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_SHA256_BLOCK_SIZE
    #   elif defined(WOLFSSL_SHA224)
    MAX_DIGEST_SIZE = WC_SHA224_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_SHA224_BLOCK_SIZE
    #   elif !defined(NO_SHA)
    MAX_DIGEST_SIZE = WC_SHA_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_SHA_BLOCK_SIZE,
    #   elif !defined(NO_MD5)
    MAX_DIGEST_SIZE = WC_MD5_DIGEST_SIZE,
    HMAC_BLOCK_SIZE = WC_MD5_BLOCK_SIZE,
    #   else // if defined(WOLFSSL_SHA512)
    #    error "You have to have some kind of hash if you want to use HMAC."
    #   endif // if defined(WOLFSSL_SHA512)
};


/* hash union */
typedef union {
    #   ifndef NO_MD5
    wc_Md5    md5;
    #   endif
    #   ifndef NO_SHA
    wc_Sha    sha;
    #   endif
    #   ifdef WOLFSSL_SHA224
    wc_Sha224 sha224;
    #   endif
    #   ifndef NO_SHA256
    wc_Sha256 sha256;
    #   endif
    #   ifdef WOLFSSL_SHA512
    #    ifdef WOLFSSL_SHA384
    wc_Sha384 sha384;
    #    endif
    wc_Sha512 sha512;
    #   endif
    #   ifdef HAVE_BLAKE2
    Blake2b   blake2b;
    #   endif
} Hash;

/* Hmac digest */
typedef struct Hmac {
    Hash         hash;
    word32       ipad[HMAC_BLOCK_SIZE / sizeof(word32)]; /* same block size all*/
    word32       opad[HMAC_BLOCK_SIZE / sizeof(word32)];
    word32       innerHash[MAX_DIGEST_SIZE / sizeof(word32)];
    void *       heap;           /* heap hint */
    byte         macType;        /* md5 sha or sha256 */
    byte         innerHashKeyed; /* keyed flag */

    #   ifdef WOLFSSL_ASYNC_CRYPT
    WC_ASYNC_DEV asyncDev;
    word16       keyLen; /* hmac key length (key in ipad) */
    #    ifdef HAVE_CAVIUM
    byte *       data; /* buffered input data for one call */
    word16       dataLen;
    #    endif /* HAVE_CAVIUM */
    #   endif  /* WOLFSSL_ASYNC_CRYPT */
} Hmac;

#  endif /* HAVE_FIPS */

/* does init */
WOLFSSL_API int
wc_HmacSetKey(Hmac *, int type, const byte * key, word32 keySz);
WOLFSSL_API int wc_HmacUpdate(Hmac *, const byte *, word32);
WOLFSSL_API int
wc_HmacFinal(Hmac *, byte *);
WOLFSSL_API int
wc_HmacSizeByType(int type);

WOLFSSL_API int
wc_HmacInit(Hmac * hmac, void * heap, int devId);
WOLFSSL_API void
wc_HmacFree(Hmac *);

WOLFSSL_API int
wolfSSL_GetHmacMaxSize(void);

#  ifdef HAVE_HKDF

WOLFSSL_API int
wc_HKDF_Extract(int type, const byte * salt, word32 saltSz,
  const byte * inKey, word32 inKeySz, byte * out);
WOLFSSL_API int
wc_HKDF_Expand(int type, const byte * inKey, word32 inKeySz,
  const byte * info, word32 infoSz,
  byte * out, word32 outSz);

WOLFSSL_API int
wc_HKDF(int type, const byte * inKey, word32 inKeySz,
  const byte * salt, word32 saltSz,
  const byte * info, word32 infoSz,
  byte * out, word32 outSz);

#  endif /* HAVE_HKDF */

#  ifdef __cplusplus
} /* extern "C" */
#  endif

# endif /* WOLF_CRYPT_HMAC_H */

#endif /* NO_HMAC */
