119 lines
4.1 KiB
C
119 lines
4.1 KiB
C
/**
|
|
* Copyright (c) 2019 - 2020, Nordic Semiconductor ASA
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form, except as embedded into a Nordic
|
|
* Semiconductor ASA integrated circuit in a product or a software update for
|
|
* such product, must reproduce the above copyright notice, this list of
|
|
* conditions and the following disclaimer in the documentation and/or other
|
|
* materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* 4. This software, with or without modification, must only be used with a
|
|
* Nordic Semiconductor ASA integrated circuit.
|
|
*
|
|
* 5. Any software provided in binary form under this license must not be reverse
|
|
* engineered, decompiled, modified and/or disassembled.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
|
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
|
|
/**@file
|
|
* @defgroup nrf_oberon_hmac_1 HMAC APIs using SHA-1
|
|
* @ingroup nrf_oberon_hmac
|
|
* @{
|
|
* @brief Type declarations and APIs for the HMAC-SHA1 algorithm.
|
|
*
|
|
* HMAC-SHA1 is an algorithm for message authentication using the
|
|
* cryptographic hash function SHA-1 and a reusable secret key. Users in
|
|
* possession of the key can verify the integrity and authenticity of the
|
|
* message.
|
|
*
|
|
* @see [RFC 2104 - HMAC: Keyed-Hashing for Message Authentication](http://tools.ietf.org/html/rfc2104)
|
|
*/
|
|
|
|
#ifndef OCRYPTO_HMAC_SHA1_H
|
|
#define OCRYPTO_HMAC_SHA1_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Maximum key length.
|
|
*/
|
|
#define ocrypto_hmac_sha1_KEY_BYTES_MAX (64)
|
|
|
|
/**
|
|
* Length of the authenticator.
|
|
*/
|
|
#define ocrypto_hmac_sha1_BYTES (20)
|
|
|
|
|
|
/**
|
|
* HMAC-SHA1 algorithm.
|
|
*
|
|
* The input message @p in is authenticated using the key @p k. The computed
|
|
* authenticator is put into @p r. To verify the authenticator, the recipient
|
|
* needs to recompute the HMAC authenticator and can then compare it with the
|
|
* received authenticator.
|
|
*
|
|
* @param[out] r HMAC output.
|
|
* @param key HMAC key.
|
|
* @param key_len Length of @p key. 0 <= @p key_len <= @c ocrypto_hmac_sha1_KEY_BYTES_MAX.
|
|
* @param in Input data.
|
|
* @param in_len Length of @p in.
|
|
*/
|
|
void ocrypto_hmac_sha1(
|
|
uint8_t r[ocrypto_hmac_sha1_BYTES],
|
|
const uint8_t* key, size_t key_len,
|
|
const uint8_t* in, size_t in_len);
|
|
|
|
/**
|
|
* HMAC-SHA1 algorithm with AAD.
|
|
*
|
|
* @param[out] r HMAC output
|
|
* @param key HMAC key.
|
|
* @param key_len Length of @p key. 0 <= @p key_len <= @c ocrypto_hmac_sha1_KEY_BYTES_MAX.
|
|
* @param in Input data.
|
|
* @param in_len Length of @p in.
|
|
* @param aad Additional authentication data. May be NULL.
|
|
* @param aad_len Length of @p aad.
|
|
*/
|
|
void ocrypto_hmac_sha1_aad(
|
|
uint8_t r[20],
|
|
const uint8_t* key, size_t key_len,
|
|
const uint8_t* in, size_t in_len,
|
|
const uint8_t* aad, size_t aad_len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* #ifndef OCRYPTO_HMAC_SHA1_H */
|
|
|
|
/** @} */
|