lcx_sha3.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_SHA3_H
#define LCX_SHA3_H
 
#ifdef HAVE_SHA3
 
#include "lcx_common.h"
#include "lcx_hash.h"
#include <stddef.h>
 
#define CX_SHA3_224_SIZE 28
 
#define CX_SHA3_256_SIZE 32
 
#define CX_SHA3_384_SIZE 48
 
#define CX_SHA3_512_SIZE 64
 
#define CX_KECCAK_224_SIZE 28
 
#define CX_KECCAK_256_SIZE 32
 
#define CX_KECCAK_384_SIZE 48
 
#define CX_KECCAK_512_SIZE 64
 
struct cx_sha3_s {
    struct cx_hash_header_s header;       
    size_t                  output_size;  
    size_t                  block_size;   
    size_t                  blen;         
    uint8_t                 block[200];   
    uint64bits_t            acc[25];      
};
typedef struct cx_sha3_s cx_sha3_t;
 
WARN_UNUSED_RESULT cx_err_t cx_sha3_init_no_throw(cx_sha3_t *hash, size_t size);
 
DEPRECATED static inline int cx_sha3_init(cx_sha3_t *hash, size_t size)
{
    CX_THROW(cx_sha3_init_no_throw(hash, size));
    return CX_SHA3;
}
 
cx_err_t cx_sha3_224_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t           digest[static CX_SHA3_224_SIZE]);
 
static inline cx_err_t cx_sha3_224_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t        digest[static CX_SHA3_224_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_sha3_224_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_sha3_256_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t           digest[static CX_SHA3_256_SIZE]);
 
static inline cx_err_t cx_sha3_256_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t        digest[static CX_SHA3_256_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_sha3_256_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_sha3_384_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t           digest[static CX_SHA3_384_SIZE]);
 
static inline cx_err_t cx_sha3_384_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t        digest[static CX_SHA3_384_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_sha3_384_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_sha3_512_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t           digest[static CX_SHA3_512_SIZE]);
 
static inline cx_err_t cx_sha3_512_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t        digest[static CX_SHA3_512_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_sha3_512_hash_iovec(&iovec, 1, digest);
}
 
WARN_UNUSED_RESULT cx_err_t cx_keccak_init_no_throw(cx_sha3_t *hash, size_t size);
 
DEPRECATED static inline int cx_keccak_init(cx_sha3_t *hash, size_t size)
{
    CX_THROW(cx_keccak_init_no_throw(hash, size));
    return CX_KECCAK;
}
 
cx_err_t cx_keccak_224_hash_iovec(const cx_iovec_t *iovec,
                                  size_t            iovec_len,
                                  uint8_t           digest[static CX_KECCAK_224_SIZE]);
 
static inline cx_err_t cx_keccak_224_hash(const uint8_t *in,
                                          size_t         in_len,
                                          uint8_t        digest[static CX_KECCAK_224_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_keccak_224_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_keccak_256_hash_iovec(const cx_iovec_t *iovec,
                                  size_t            iovec_len,
                                  uint8_t           digest[static CX_KECCAK_256_SIZE]);
 
static inline cx_err_t cx_keccak_256_hash(const uint8_t *in,
                                          size_t         in_len,
                                          uint8_t        digest[static CX_KECCAK_256_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_keccak_256_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_keccak_384_hash_iovec(const cx_iovec_t *iovec,
                                  size_t            iovec_len,
                                  uint8_t           digest[static CX_KECCAK_384_SIZE]);
 
static inline cx_err_t cx_keccak_384_hash(const uint8_t *in,
                                          size_t         in_len,
                                          uint8_t        digest[static CX_KECCAK_384_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_keccak_384_hash_iovec(&iovec, 1, digest);
}
 
cx_err_t cx_keccak_512_hash_iovec(const cx_iovec_t *iovec,
                                  size_t            iovec_len,
                                  uint8_t           digest[static CX_KECCAK_512_SIZE]);
 
static inline cx_err_t cx_keccak_512_hash(const uint8_t *in,
                                          size_t         in_len,
                                          uint8_t        digest[static CX_KECCAK_512_SIZE])
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_keccak_512_hash_iovec(&iovec, 1, digest);
}
 
WARN_UNUSED_RESULT cx_err_t cx_shake128_init_no_throw(cx_sha3_t *hash, size_t out_size);
 
DEPRECATED static inline int cx_shake128_init(cx_sha3_t *hash, unsigned int out_size)
{
    CX_THROW(cx_shake128_init_no_throw(hash, out_size));
    return CX_SHAKE128;
}
 
cx_err_t cx_shake128_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t          *digest,
                                size_t            out_length);
 
static inline cx_err_t cx_shake128_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t       *digest,
                                        size_t         out_length)
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_shake128_hash_iovec(&iovec, 1, digest, out_length);
}
 
WARN_UNUSED_RESULT cx_err_t cx_shake256_init_no_throw(cx_sha3_t *hash, size_t out_size);
 
DEPRECATED static inline int cx_shake256_init(cx_sha3_t *hash, unsigned int out_length)
{
    CX_THROW(cx_shake256_init_no_throw(hash, out_length));
    return CX_SHAKE256;
}
cx_err_t cx_shake256_hash_iovec(const cx_iovec_t *iovec,
                                size_t            iovec_len,
                                uint8_t          *digest,
                                size_t            out_length);
 
static inline cx_err_t cx_shake256_hash(const uint8_t *in,
                                        size_t         in_len,
                                        uint8_t       *digest,
                                        size_t         out_length)
{
    const cx_iovec_t iovec = {.iov_base = in, .iov_len = in_len};
 
    return cx_shake256_hash_iovec(&iovec, 1, digest, out_length);
}
 
WARN_UNUSED_RESULT cx_err_t cx_sha3_xof_init_no_throw(cx_sha3_t *hash,
                                                      size_t     size,
                                                      size_t     out_length);
 
DEPRECATED static inline int cx_sha3_xof_init(cx_sha3_t   *hash,
                                              unsigned int size,
                                              unsigned int out_length)
{
    CX_THROW(cx_sha3_xof_init_no_throw(hash, size, out_length));
 
    if (size == 128) {
        return CX_SHAKE128;
    }
    else {
        return CX_SHAKE256;
    }
}
 
#endif  // HAVE_SHA3
 
#endif  // LCX_SHA3_H