secapi-sys 0.2.0

FFI bindings to SecAPI
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

/*
 * 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 otp.h
 *
 * This file contains the functions and structures simulating reading of OTP data as well as
 * performing the OTP rooted key ladder operations. Implementors shall replace this functionality
 * with hardened hardware based implementation.
 */

#ifndef OTP_H
#define OTP_H

#include "sa_types.h"
#include "stored_key.h"

#ifdef __cplusplus

#include <cstdbool>
#include <cstddef>
#include <cstdint>

extern "C" {
#else
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#endif

/**
 * Identifies the type of root key to use.
 */
typedef enum {
    UNDEFINED = 0,
    UNIQUE,
    COMMON
} sa_root_key_type;

/**
 * Obtain the 8 byte unique device id.
 *
 * @param[out] id device id.
 * @return true if the call succeeded, false otherwise.
 */
sa_status otp_device_id(uint64_t* id);

/**
 * Derive a key from OTP based root key using a 4 stage key ladder. First 3 stages will be performed
 * in a hardware key ladder.
 *
 * @param[out] stored_key_derived the derived 16 byte key.
 * @param[in] rights rights for the derived key.
 * @param[in] root_key_type the type of the root key to use.
 * @param[in] c1 16 byte input for the first stage of the key ladder.
 * @param[in] c2 16 byte input for the second stage of the key ladder.
 * @param[in] c3 16 byte input for the third stage of the key ladder.
 * @param[in] c4 16 byte input for the fourth stage of the key ladder.
 * @return SA_STATUS_OK if the call succeeded.
 */
sa_status otp_root_key_ladder(
        stored_key_t** stored_key_derived,
        const sa_rights* rights,
        sa_root_key_type root_key_type,
        const void* c1,
        const void* c2,
        const void* c3,
        const void* c4);

#ifdef __cplusplus
}
#endif

#endif // OTP_H