forked from u-blox/ubxlib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathu_port_crypto.h
177 lines (159 loc) · 7.39 KB
/
u_port_crypto.h
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
* Copyright 2019-2024 u-blox
*
* 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.
*/
#ifndef _U_PORT_CRYPTO_H_
#define _U_PORT_CRYPTO_H_
/* Only header files representing a direct and unavoidable
* dependency between the API of this module and the API
* of another module should be included here; otherwise
* please keep #includes to your .c files. */
/** \addtogroup __port
* @{
*/
/** @file
* @brief Porting layer for cryptographic functions, mapped to
* mbedTLS on most platforms. These functions are thread-safe.
*/
#ifdef __cplusplus
extern "C" {
#endif
/* ----------------------------------------------------------------
* COMPILE-TIME MACROS
* -------------------------------------------------------------- */
/** The size of output buffer required for a SHA256 calculation.
*/
#define U_PORT_CRYPTO_SHA256_OUTPUT_LENGTH_BYTES 32
/** The size of initialisation vector required for an AES 128
* calculation.
*/
#define U_PORT_CRYPTO_AES128_INITIALISATION_VECTOR_LENGTH_BYTES 16
/* ----------------------------------------------------------------
* TYPES
* -------------------------------------------------------------- */
/* ----------------------------------------------------------------
* FUNCTIONS
* -------------------------------------------------------------- */
/** Perform a SHA256 calculation on a block of data.
*
* Note: support for this API was required by a now removed
* feature of the cellular API (C2C encryption), hence there is
* currently no requirement to implement it.
*
* @param pInput a pointer to the input data; cannot be
* NULL unless inputLengthBytes is zero.
* @param inputLengthBytes the length of the input data.
* @param[out] pOutput a pointer to at least 32 bytes of space
* to which the output will be written.
* @return zero on success else negative error code;
* the error code is returned directly
* from the underlying cryptographic library,
* for the given platform, it is not one from
* the U_ERROR_COMMON_xxx enumeration.
*/
int32_t uPortCryptoSha256(const char *pInput,
size_t inputLengthBytes,
char *pOutput);
/** Perform a HMAC SHA256 calculation on a block of data.
*
* Note: support for this API was required by a now removed
* feature of the cellular API (C2C encryption), hence there is
* currently no requirement to implement it.
*
* @param pKey a pointer to the key; cannot be NULL.
* @param keyLengthBytes the length of the key.
* @param[in] pInput a pointer to the input data; cannot be
* NULL.
* @param inputLengthBytes the length of the input data.
* @param[out] pOutput a pointer to at least 32 bytes of space
* to which the output will be written.
* @return zero on success else negative error code;
* the error code is returned directly
* from the underlying cryptographic library,
* for the given platform, it is not one from
* the U_ERROR_COMMON_xxx enumeration.
*/
int32_t uPortCryptoHmacSha256(const char *pKey,
size_t keyLengthBytes,
const char *pInput,
size_t inputLengthBytes,
char *pOutput);
/** Perform AES 128 CBC encryption of a block of data.
*
* Note: support for this API was required by a now removed
* feature of the cellular API (C2C encryption), hence there is
* currently no requirement to implement it.
*
* @param pKey a pointer to the key; cannot be NULL.
* @param keyLengthBytes the length of the key; must be 16, 24
* or 32 bytes.
* @param[in,out] pInitVector a pointer to the 16 byte initialisation
* vector; cannot be NULL, must be writeable
* and WILL be modified by this function.
* @param[in] pInput a pointer to the input data; cannot be
* NULL.
* @param lengthBytes the length of the input data; must be
* a multiple of 16 bytes.
* @param[out] pOutput a pointer to at least lengthBytes
* bytes of space to which the output will
* be written.
* @return zero on success else negative error code;
* the error code is returned directly
* from the underlying cryptographic library,
* for the given platform, it is not one from
* the U_ERROR_COMMON_xxx enumeration.
*/
int32_t uPortCryptoAes128CbcEncrypt(const char *pKey,
size_t keyLengthBytes,
char *pInitVector,
const char *pInput,
size_t lengthBytes,
char *pOutput);
/** Perform AES 128 CBC decryption of a block of data.
*
* Note: support for this API was required by a now removed
* feature of the cellular API (C2C encryption), hence there is
* currently no requirement to implement it.
*
* @param pKey a pointer to the key; cannot be NULL.
* @param keyLengthBytes the length of the key; must be 16, 24
* or 32 bytes.
* @param[in,out] pInitVector a pointer to the 16 byte initialisation
* vector; cannot be NULL, must be writeable
* and WILL be modified by this function.
* @param[in] pInput a pointer to the input data; cannot be
* NULL.
* @param lengthBytes the length of the input data; must be
* a multiple of 16 bytes.
* @param[out] pOutput a pointer to at least lengthBytes
* bytes of space to which the output will
* be written.
* @return zero on success else negative error code;
* the error code is returned directly
* from the underlying cryptographic library,
* for the given platform, it is not one from
* the U_ERROR_COMMON_xxx enumeration.
*/
int32_t uPortCryptoAes128CbcDecrypt(const char *pKey,
size_t keyLengthBytes,
char *pInitVector,
const char *pInput,
size_t lengthBytes,
char *pOutput);
#ifdef __cplusplus
}
#endif
/** @}*/
#endif // _U_PORT_CRYPTO_H_
// End of file