secapi-sys 0.3.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
90
91
92
93
94
95
96

/*
 * 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 dh.h
 *
 * This file contains the functions and structures implementing Diffie-Hellman key exchange
 * protocol.
 */

#ifndef DH_H
#define DH_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

/**
 * Get public DH key.
 *
 * @param[out] out public key.
 * @param[in/out] out_length public key length. Set to bytes written on completion.
 * @param[in] stored_key private key.
 * @return status of the operation.
 */
sa_status dh_get_public(
        void* out,
        size_t* out_length,
        const stored_key_t* stored_key);

/**
 * Compute the DH shared secret.
 *
 * @param[out] stored_key_shared_secret shared secret
 * @param[in] rights the rights for the shared secret.
 * @param[in] other_public other party's public key
 * @param[in] other_public_length other party's public key length
 * @param[in] stored_key the stored private key
 * @return status of the operation
 */
sa_status dh_compute_shared_secret(
        stored_key_t** stored_key_shared_secret,
        const sa_rights* rights,
        const void* other_public,
        size_t other_public_length,
        const stored_key_t* stored_key);

/**
 * Generate the private/public key pair for the given DH parameters.
 *
 * @param[out] stored_key the generated key
 * @param[out] rights the rights for the key.
 * @param[in] p prime
 * @param[in] p_length the length of p
 * @param[in] g generator
 * @param[in] g_length the length of g
 * @return status of the operation
 */
sa_status dh_generate_key(
        stored_key_t** stored_key,
        const sa_rights* rights,
        const void* p,
        size_t p_length,
        const void* g,
        size_t g_length);

#ifdef __cplusplus
}
#endif

#endif // DH_H