lcx_hmac.h

Go to the documentation of this file.

 
/*******************************************************************************
 *   Ledger Nano S - Secure firmware
 *   (c) 2022 Ledger
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 ********************************************************************************/
 
#ifndef LCX_HMAC_H
#define LCX_HMAC_H
 
#ifdef HAVE_HMAC
 
#include "lcx_wrappers.h"
#include "lcx_hash.h"
#include "lcx_ripemd160.h"
#include "lcx_sha256.h"
#include "lcx_sha512.h"
#include <stdbool.h>
#include <stdint.h>
 
typedef struct {
    uint8_t   key[128];  
    cx_hash_t hash_ctx;  
} cx_hmac_t;
 
#ifdef HAVE_RIPEMD160
 
typedef struct {
    uint8_t        key[128];  
    cx_ripemd160_t hash_ctx;  
} cx_hmac_ripemd160_t;
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_ripemd160_init_no_throw(cx_hmac_ripemd160_t *hmac,
                                                            const uint8_t       *key,
                                                            size_t               key_len);
 
DEPRECATED static inline int cx_hmac_ripemd160_init(cx_hmac_ripemd160_t *hmac,
                                                    const unsigned char *key,
                                                    unsigned int         key_len)
{
    CX_THROW(cx_hmac_ripemd160_init_no_throw(hmac, key, key_len));
    return CX_RIPEMD160;
}
#endif
 
#if defined(HAVE_SHA224) || defined(HAVE_SHA256)
typedef struct {
    uint8_t     key[128];  
    cx_sha256_t hash_ctx;  
} cx_hmac_sha256_t;
#endif
 
#ifdef HAVE_SHA224
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_sha224_init(cx_hmac_sha256_t *hmac,
                                                const uint8_t    *key,
                                                unsigned int      key_len);
#endif
 
#ifdef HAVE_SHA256
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_sha256_init_no_throw(cx_hmac_sha256_t *hmac,
                                                         const uint8_t    *key,
                                                         size_t            key_len);
 
DEPRECATED static inline int cx_hmac_sha256_init(cx_hmac_sha256_t    *hmac,
                                                 const unsigned char *key,
                                                 unsigned int         key_len)
{
    CX_THROW(cx_hmac_sha256_init_no_throw(hmac, key, key_len));
    return CX_SHA256;
}
 
size_t cx_hmac_sha256(const uint8_t *key,
                      size_t         key_len,
                      const uint8_t *in,
                      size_t         len,
                      uint8_t       *mac,
                      size_t         mac_len);
 
#endif
 
#if defined(HAVE_SHA384) || defined(HAVE_SHA512)
typedef struct {
    uint8_t     key[128];  
    cx_sha512_t hash_ctx;  
} cx_hmac_sha512_t;
#endif
 
#ifdef HAVE_SHA384
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_sha384_init(cx_hmac_sha512_t *hmac,
                                                const uint8_t    *key,
                                                unsigned int      key_len);
#endif
 
#ifdef HAVE_SHA512
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_sha512_init_no_throw(cx_hmac_sha512_t *hmac,
                                                         const uint8_t    *key,
                                                         size_t            key_len);
 
DEPRECATED static inline int cx_hmac_sha512_init(cx_hmac_sha512_t    *hmac,
                                                 const unsigned char *key,
                                                 unsigned int         key_len)
{
    CX_THROW(cx_hmac_sha512_init_no_throw(hmac, key, key_len));
    return CX_SHA512;
}
 
size_t cx_hmac_sha512(const uint8_t *key,
                      size_t         key_len,
                      const uint8_t *in,
                      size_t         len,
                      uint8_t       *mac,
                      size_t         mac_len);
 
#endif
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_no_throw(cx_hmac_t     *hmac,
                                             uint32_t       mode,
                                             const uint8_t *in,
                                             size_t         len,
                                             uint8_t       *mac,
                                             size_t         mac_len);
 
DEPRECATED static inline int cx_hmac(cx_hmac_t           *hmac,
                                     uint32_t             mode,
                                     const unsigned char *in,
                                     unsigned int         len,
                                     unsigned char       *mac,
                                     unsigned int         mac_len)
{
    CX_THROW(cx_hmac_no_throw(hmac, mode, in, len, mac, mac_len));
 
    switch (hmac->hash_ctx.info->md_type) {
#ifdef HAVE_SHA224
        case CX_SHA224:
            return CX_SHA224_SIZE;
#endif
#ifdef HAVE_SHA256
        case CX_SHA256:
            return CX_SHA256_SIZE;
#endif
#ifdef HAVE_SHA384
        case CX_SHA384:
            return CX_SHA384_SIZE;
#endif
#ifdef HAVE_SHA512
        case CX_SHA512:
            return CX_SHA512_SIZE;
#endif
#ifdef HAVE_RIPEMD160
        case CX_RIPEMD160:
            return CX_RIPEMD160_SIZE;
#endif
        default:
            CX_THROW(CX_INVALID_PARAMETER);
            return 0;
    }
}
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_init(cx_hmac_t     *hmac,
                                         cx_md_t        hash_id,
                                         const uint8_t *key,
                                         size_t         key_len);
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_update(cx_hmac_t *hmac, const uint8_t *in, size_t in_len);
 
WARN_UNUSED_RESULT cx_err_t cx_hmac_final(cx_hmac_t *ctx, uint8_t *out, size_t *out_len);
 
#endif  // HAVE_HMAC
 
#endif  // LCX_HMAC_H