Outline ![]()
Files ![]()
loading...
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Crypto Component */
/** */
/** Elliptic-curve Diffie-Hellman (ECDH) */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* APPLICATION INTERFACE DEFINITION RELEASE */
/* */
/* nx_crypto_ecdh.h PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file defines the basic Application Interface (API) to the */
/* NetX Crypto ECDH module. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
#ifndef NX_CRYPTO_ECDH_H
#define NX_CRYPTO_ECDH_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
#include "nx_crypto_ec.h"
/* Max Elliptic-curve Diffie-Hellman key size. Buffer size for calculations is 4X the key size */
#define NX_CRYPTO_ECDH_MAX_KEY_SIZE (68)
#ifndef NX_CRYPTO_ECDH_SCRATCH_BUFFER_SIZE
#define NX_CRYPTO_ECDH_SCRATCH_BUFFER_SIZE 2464
#endif /* NX_CRYPTO_ECDSA_SCRATCH_BUFFER_SIZE */
/* Diffie-Hellman Key-exchange control structure. */
typedef struct NX_CRYPTO_ECDH_STRUCT
{
/* The size of the key being used. This is primarily for testing, but also allows for future expansion.
The value is assigned in _nx_crypto_dh_setup depending on the chosen group. */
UINT nx_crypto_ecdh_key_size;
/* The private key is generated by nx_crypto_dh_setup and is a random number.
Make the array in units of UINT to make sure the starting address is 4-byte aligned. */
HN_UBASE nx_crypto_ecdh_private_key_buffer[NX_CRYPTO_ECDH_MAX_KEY_SIZE >> HN_SIZE_SHIFT];
/* The elliptic curve selected in the call to nx_crypto_ecdh_setup. */
NX_CRYPTO_EC *nx_crypto_ecdh_curve;
HN_UBASE nx_crypto_ecdh_scratch_buffer[NX_CRYPTO_ECDH_SCRATCH_BUFFER_SIZE >> HN_SIZE_SHIFT];
} NX_CRYPTO_ECDH;
/* Function prototypes */
UINT _nx_crypto_ecdh_key_pair_import(NX_CRYPTO_ECDH *ecdh_ptr,
NX_CRYPTO_EC *curve,
UCHAR *local_private_key_ptr,
ULONG local_private_key_len,
UCHAR *local_public_key_ptr,
ULONG local_public_key_len);
UINT _nx_crypto_ecdh_private_key_export(NX_CRYPTO_ECDH *ecdh_ptr,
UCHAR *local_private_key_ptr,
ULONG local_private_key_len,
ULONG *actual_local_private_key_len);
UINT _nx_crypto_ecdh_setup(NX_CRYPTO_ECDH *ecdh_ptr,
UCHAR *local_public_key_ptr,
ULONG local_public_key_len_ptr,
ULONG *actual_local_public_key_len,
NX_CRYPTO_EC *curve,
HN_UBASE *scratch_buf_ptr);
UINT _nx_crypto_ecdh_compute_secret(NX_CRYPTO_ECDH *ecdh_ptr,
UCHAR *share_secret_key_ptr,
ULONG share_secret_key_len_ptr,
ULONG *actual_share_secret_key_len,
UCHAR *remote_public_key,
ULONG remote_public_key_len,
HN_UBASE *scratch_buf_ptr);
UINT _nx_crypto_method_ecdh_init(struct NX_CRYPTO_METHOD_STRUCT *method,
UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
VOID **handle,
VOID *crypto_metadata,
ULONG crypto_metadata_size);
UINT _nx_crypto_method_ecdh_cleanup(VOID *crypto_metadata);
UINT _nx_crypto_method_ecdh_operation(UINT op,
VOID *handle,
struct NX_CRYPTO_METHOD_STRUCT *method,
UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
UCHAR *input, ULONG input_length_in_byte,
UCHAR *iv_ptr,
UCHAR *output, ULONG output_length_in_byte,
VOID *crypto_metadata, ULONG crypto_metadata_size,
VOID *packet_ptr,
VOID (*nx_crypto_hw_process_callback)(VOID *, UINT));
#ifdef __cplusplus
}
#endif
#endif /* NX_CRYPTO_ECDH_H */