ndn-lite-hmac.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2019 Zhiyi Zhang, Tianyuan Yu, Edward Lu
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v3.0. See the file LICENSE in the top level
 * directory for more details.
 */

#ifndef NDN_SECURITY_HMAC_H_
#define NDN_SECURITY_HMAC_H_

#include "../ndn-error-code.h"
#include "ndn-lite-sec-config.h"
#include <inttypes.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct abstract_hmac_key abstract_hmac_key_t;

typedef uint32_t (*ndn_hmac_get_key_size_impl)(const abstract_hmac_key_t* hmac_key);
typedef const uint8_t* (*ndn_hmac_get_key_value_impl)(const abstract_hmac_key_t* hmac_key);
typedef int (*ndn_hmac_load_key_impl)(abstract_hmac_key_t* hmac_key,
                                      const uint8_t* key_value, uint32_t key_size);
typedef int (*ndn_hmac_sha256_impl)(const void* payload, uint32_t payload_length,
                                    const abstract_hmac_key_t* hmac_key,
                                    uint8_t* hmac_result);
typedef int (*ndn_hmac_make_key_impl)(abstract_hmac_key_t* key,
                                      const uint8_t* input_value, uint32_t input_size,
                                      const uint8_t* personalization, uint32_t personalization_size,
                                      const uint8_t* seed_value, uint32_t seed_size,
                                      const uint8_t* additional_value, uint32_t additional_size,
                                      uint32_t salt_size);
typedef int (*ndn_hkdf_impl)(const uint8_t* input_value, uint32_t input_size,
                             uint8_t* output_value, uint32_t output_size,
                             const uint8_t* seed_value, uint32_t seed_size);
typedef int (*ndn_hmacprng_impl)(const uint8_t* input_value, uint32_t input_size,
                                 uint8_t* output_value, uint32_t output_size,
                                 const uint8_t* seed_value, uint32_t seed_size,
                                 const uint8_t* additional_value, uint32_t additional_size);

typedef struct ndn_hmac_backend {
  ndn_hmac_get_key_size_impl get_key_size;
  ndn_hmac_get_key_value_impl get_key_value;
  ndn_hmac_load_key_impl load_key;
  ndn_hmac_sha256_impl hmac_sha256;
  ndn_hmac_make_key_impl make_key;
  ndn_hkdf_impl hkdf;
  ndn_hmacprng_impl hmacprng;
} ndn_hmac_backend_t;

typedef struct ndn_hmac_key {
  abstract_hmac_key_t abs_key;
  uint32_t key_id;
} ndn_hmac_key_t;

ndn_hmac_backend_t*
ndn_hmac_get_backend(void);

uint32_t
ndn_hmac_get_key_size(const ndn_hmac_key_t* hmac_key);

const uint8_t*
ndn_hmac_get_key_value(const ndn_hmac_key_t* hmac_key);

int
ndn_hmac_load_key(ndn_hmac_key_t* hmac_key,
                  const uint8_t* key_value, uint32_t key_size);

static inline int
ndn_hmac_key_init(ndn_hmac_key_t* hmac_key, const uint8_t* key_value,
                  uint32_t key_size, uint32_t key_id)
{
  ndn_hmac_load_key(hmac_key, key_value, key_size);
  hmac_key->key_id = key_id;
  return 0;
}

int
ndn_hmac_sha256(const void* payload, uint32_t payload_length,
                const ndn_hmac_key_t* hmac_key,
                uint8_t* hmac_result);

int
ndn_hmac_sign(const uint8_t* input_value, uint32_t input_size,
              uint8_t* output_value, uint32_t output_max_size,
              const ndn_hmac_key_t* hmac_key,
              uint32_t* output_used_size);

int
ndn_hmac_verify(const uint8_t* input_value, uint32_t input_size,
                const uint8_t* sig_value, uint32_t sig_size,
                const ndn_hmac_key_t* hmac_key);

int
ndn_hmac_make_key(ndn_hmac_key_t* key, uint32_t key_id,
                  const uint8_t* input_value, uint32_t input_size,
                  const uint8_t* personalization, uint32_t personalization_size,
                  const uint8_t* seed_value, uint32_t seed_size,
                  const uint8_t* additional_value, uint32_t additional_size,
                  uint32_t salt_size);

int
ndn_hkdf(const uint8_t* input_value, uint32_t input_size,
         uint8_t* output_value, uint32_t output_size,
         const uint8_t* seed_value, uint32_t seed_size);

int
ndn_hmacprng(const uint8_t* input_value, uint32_t input_size,
             uint8_t* output_value, uint32_t output_size,
             const uint8_t* seed_value, uint32_t seed_size,
             const uint8_t* additional_value, uint32_t additional_size);

#ifdef __cplusplus
}
#endif

#endif // NDN_SECURITY_HMAC_H_