1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
* Copyright 2019-2023 Comcast Cable Communications Management, LLC
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
*/
/** @section Description
* @file kdf.h
*
* This file contains the functions and structures implementing key derivation algorithms.
*/
#ifndef KDF_H
#define KDF_H
#include "sa_types.h"
#include "stored_key.h"
#ifdef __cplusplus
#include <cstdbool>
#include <cstddef>
extern "C" {
#else
#include <stdbool.h>
#include <stddef.h>
#endif
/**
* Derive a key using HKDF HMAC derivation.
*
* @param[out] stored_key_derived the derived key.
* @param[in] rights rights for the derived key.
* @param[in] parameters HKDF derivation parameters.
* @param[in] stored_key_parent the parent key.
* @return status of the operation
*/
sa_status kdf_hkdf_hmac(
stored_key_t** stored_key_derived,
const sa_rights* rights,
sa_kdf_parameters_hkdf* parameters,
const stored_key_t* stored_key_parent);
/**
* Derive a key using Concat KDF derivation.
*
* @param[out] stored_key_derived the derived key.
* @param[in] rights rights for the derived key.
* @param[in] parameters concat derivation parameters.
* @param[in] stored_key_parent the parent key.
* @return status of the operation
*/
sa_status kdf_concat_kdf(
stored_key_t** stored_key_derived,
const sa_rights* rights,
sa_kdf_parameters_concat* parameters,
const stored_key_t* stored_key_parent);
/**
* Derive a key using the ANSI X9.63 derivation.
*
* @param[out] stored_key_derived the derived key.
* @param[in] rights rights for the derived key.
* @param[in] parameters ANSI X9.63 derivation parameters.
* @param[in] stored_key_parent the parent key.
* @return status of the operation
*/
sa_status kdf_ansi_x963(
stored_key_t** stored_key_derived,
const sa_rights* rights,
sa_kdf_parameters_ansi_x963* parameters,
const stored_key_t* stored_key_parent);
/**
* Derive a key using the NIST 800-108 KDF in counter mode.
*
* @param[out] stored_key_derived the derived key.
* @param[in] rights rights for the derived key.
* @param[in] parameters CMAC derivation parameters.
* @param[in] stored_key_parent the parent key.
* @return status of the operation
*/
sa_status kdf_ctr_cmac(
stored_key_t** stored_key_derived,
const sa_rights* rights,
sa_kdf_parameters_cmac* parameters,
const stored_key_t* stored_key_parent);
#ifdef __cplusplus
}
#endif
#endif // KDF_H