blob: bdb2eba16ad1b2269c1428e932715b4ebe39e856 [file] [log] [blame]
Steven Cooremancd84cb42020-07-16 20:28:36 +02001/*
2 * Function signatures for functionality that can be provided by
3 * cryptographic accelerators.
Steven Cooreman56250fd2020-09-04 13:07:15 +02004 * Warning: This file will be auto-generated in the future.
Steven Cooremancd84cb42020-07-16 20:28:36 +02005 */
Steven Cooreman2c7b2f82020-09-02 13:43:46 +02006/* Copyright The Mbed TLS Contributors
Steven Cooremancd84cb42020-07-16 20:28:36 +02007 * SPDX-License-Identifier: Apache-2.0
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
Steven Cooremancd84cb42020-07-16 20:28:36 +020020 */
21
22#ifndef PSA_CRYPTO_DRIVER_WRAPPERS_H
23#define PSA_CRYPTO_DRIVER_WRAPPERS_H
24
25#include "psa/crypto.h"
26#include "psa/crypto_driver_common.h"
27
Steven Cooreman37941cb2020-07-28 18:49:51 +020028/*
29 * Signature functions
30 */
Ronald Cron9f17aa42020-12-08 17:07:25 +010031psa_status_t psa_driver_wrapper_sign_hash(
32 const psa_key_attributes_t *attributes,
33 const uint8_t *key_buffer, size_t key_buffer_size,
34 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
35 uint8_t *signature, size_t signature_size, size_t *signature_length );
Steven Cooremancd84cb42020-07-16 20:28:36 +020036
Ronald Cron9f17aa42020-12-08 17:07:25 +010037psa_status_t psa_driver_wrapper_verify_hash(
38 const psa_key_attributes_t *attributes,
39 const uint8_t *key_buffer, size_t key_buffer_size,
40 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
41 const uint8_t *signature, size_t signature_length );
Steven Cooreman55ae2172020-07-17 19:46:15 +020042
Steven Cooreman04524762020-10-13 17:43:44 +020043/*
44 * Key handling functions
45 */
46
Ronald Cron83282872020-11-22 14:02:39 +010047psa_status_t psa_driver_wrapper_import_key(
48 const psa_key_attributes_t *attributes,
49 const uint8_t *data, size_t data_length,
50 uint8_t *key_buffer, size_t key_buffer_size,
51 size_t *key_buffer_length, size_t *bits );
Steven Cooreman04524762020-10-13 17:43:44 +020052
Ronald Cron67227982020-11-26 15:16:05 +010053psa_status_t psa_driver_wrapper_export_key(
54 const psa_key_attributes_t *attributes,
55 const uint8_t *key_buffer, size_t key_buffer_size,
56 uint8_t *data, size_t data_size, size_t *data_length );
57
Ronald Cron84cc9942020-11-25 14:30:05 +010058psa_status_t psa_driver_wrapper_export_public_key(
59 const psa_key_attributes_t *attributes,
60 const uint8_t *key_buffer, size_t key_buffer_size,
61 uint8_t *data, size_t data_size, size_t *data_length );
62
Ronald Cron9df74be2020-12-05 19:15:23 +010063psa_status_t psa_driver_wrapper_get_key_buffer_size(
64 const psa_key_attributes_t *attributes,
65 size_t *key_buffer_size );
66
Ronald Cron84cc9942020-11-25 14:30:05 +010067psa_status_t psa_driver_wrapper_generate_key(
68 const psa_key_attributes_t *attributes,
Ronald Cron977c2472020-10-13 08:32:21 +020069 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
Steven Cooremanb9b84422020-10-14 14:39:20 +020070
Steven Cooreman6801f082021-02-19 17:21:22 +010071psa_status_t psa_driver_wrapper_get_builtin_key(
72 psa_drv_slot_number_t slot_number,
73 psa_key_attributes_t *attributes,
74 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
75
Steven Cooreman37941cb2020-07-28 18:49:51 +020076/*
77 * Cipher functions
78 */
79psa_status_t psa_driver_wrapper_cipher_encrypt(
80 psa_key_slot_t *slot,
81 psa_algorithm_t alg,
82 const uint8_t *input,
83 size_t input_length,
84 uint8_t *output,
85 size_t output_size,
86 size_t *output_length );
87
88psa_status_t psa_driver_wrapper_cipher_decrypt(
89 psa_key_slot_t *slot,
90 psa_algorithm_t alg,
91 const uint8_t *input,
92 size_t input_length,
93 uint8_t *output,
94 size_t output_size,
95 size_t *output_length );
96
97psa_status_t psa_driver_wrapper_cipher_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +010098 psa_cipher_operation_t *operation,
99 const psa_key_attributes_t *attributes,
100 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200101 psa_algorithm_t alg );
102
103psa_status_t psa_driver_wrapper_cipher_decrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100104 psa_cipher_operation_t *operation,
105 const psa_key_attributes_t *attributes,
106 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200107 psa_algorithm_t alg );
108
Steven Cooreman37941cb2020-07-28 18:49:51 +0200109psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100110 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200111 const uint8_t *iv,
112 size_t iv_length );
113
114psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100115 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200116 const uint8_t *input,
117 size_t input_length,
118 uint8_t *output,
119 size_t output_size,
120 size_t *output_length );
121
122psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100123 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200124 uint8_t *output,
125 size_t output_size,
126 size_t *output_length );
127
128psa_status_t psa_driver_wrapper_cipher_abort(
Ronald Cron6056fe82020-12-15 13:58:07 +0100129 psa_cipher_operation_t *operation );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200130
Steven Cooreman1e582352021-02-18 17:24:37 +0100131/*
132 * Hashing functions
133 */
134psa_status_t psa_driver_wrapper_hash_compute(
135 psa_algorithm_t alg,
136 const uint8_t *input,
137 size_t input_length,
138 uint8_t *hash,
139 size_t hash_size,
140 size_t *hash_length);
141
142psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100143 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100144 psa_algorithm_t alg );
145
146psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100147 const psa_hash_operation_t *source_operation,
148 psa_hash_operation_t *target_operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100149
150psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100151 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100152 const uint8_t *input,
153 size_t input_length );
154
155psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100156 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100157 uint8_t *hash,
158 size_t hash_size,
159 size_t *hash_length );
160
161psa_status_t psa_driver_wrapper_hash_abort(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100162 psa_hash_operation_t *operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100163
Ronald Cronde822812021-03-17 16:08:20 +0100164/*
165 * AEAD functions
166 */
167
168psa_status_t psa_driver_wrapper_aead_encrypt(
169 const psa_key_attributes_t *attributes,
170 const uint8_t *key_buffer, size_t key_buffer_size,
171 psa_algorithm_t alg,
172 const uint8_t *nonce, size_t nonce_length,
173 const uint8_t *additional_data, size_t additional_data_length,
174 const uint8_t *plaintext, size_t plaintext_length,
175 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length );
176
177psa_status_t psa_driver_wrapper_aead_decrypt(
178 const psa_key_attributes_t *attributes,
179 const uint8_t *key_buffer, size_t key_buffer_size,
180 psa_algorithm_t alg,
181 const uint8_t *nonce, size_t nonce_length,
182 const uint8_t *additional_data, size_t additional_data_length,
183 const uint8_t *ciphertext, size_t ciphertext_length,
184 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length );
185
Paul Elliott6504aa62021-04-20 17:09:36 +0100186psa_status_t psa_driver_wrapper_aead_encrypt_setup(
187 psa_aead_operation_t *operation,
188 const psa_key_attributes_t *attributes,
189 const uint8_t *key_buffer, size_t key_buffer_size,
190 psa_algorithm_t alg );
191
192psa_status_t psa_driver_wrapper_aead_decrypt_setup(
193 psa_aead_operation_t *operation,
194 const psa_key_attributes_t *attributes,
195 const uint8_t *key_buffer, size_t key_buffer_size,
196 psa_algorithm_t alg );
197
198psa_status_t psa_driver_wrapper_aead_generate_nonce(
199 psa_aead_operation_t *operation,
200 uint8_t *nonce,
201 size_t nonce_size,
202 size_t *nonce_length );
203
204psa_status_t psa_driver_wrapper_aead_set_nonce(
205 psa_aead_operation_t *operation,
206 const uint8_t *nonce,
207 size_t nonce_length );
208
209psa_status_t psa_driver_wrapper_aead_set_lengths(
210 psa_aead_operation_t *operation,
211 size_t ad_length,
212 size_t plaintext_length );
213
214psa_status_t psa_driver_wrapper_aead_update_ad(
215 psa_aead_operation_t *operation,
216 const uint8_t *input,
217 size_t input_length );
218
219psa_status_t psa_driver_wrapper_aead_update(
220 psa_aead_operation_t *operation,
221 const uint8_t *input,
222 size_t input_length,
223 uint8_t *output,
224 size_t output_size,
225 size_t *output_length );
226
227psa_status_t psa_driver_wrapper_aead_finish(
228 psa_aead_operation_t *operation,
229 uint8_t *ciphertext,
230 size_t ciphertext_size,
231 size_t *ciphertext_length,
232 uint8_t *tag,
233 size_t tag_size,
234 size_t *tag_length );
235
236psa_status_t psa_driver_wrapper_aead_verify(
237 psa_aead_operation_t *operation,
238 uint8_t *plaintext,
239 size_t plaintext_size,
240 size_t *plaintext_length,
241 const uint8_t *tag,
242 size_t tag_length );
243
244psa_status_t psa_driver_wrapper_aead_abort(
245 psa_aead_operation_t *operation );
246
Steven Cooremand13a70f2021-03-19 15:24:23 +0100247/*
248 * MAC functions
249 */
250psa_status_t psa_driver_wrapper_mac_compute(
251 const psa_key_attributes_t *attributes,
252 const uint8_t *key_buffer,
253 size_t key_buffer_size,
254 psa_algorithm_t alg,
255 const uint8_t *input,
256 size_t input_length,
257 uint8_t *mac,
258 size_t mac_size,
259 size_t *mac_length );
260
261psa_status_t psa_driver_wrapper_mac_sign_setup(
262 psa_mac_operation_t *operation,
263 const psa_key_attributes_t *attributes,
264 const uint8_t *key_buffer,
265 size_t key_buffer_size,
266 psa_algorithm_t alg );
267
268psa_status_t psa_driver_wrapper_mac_verify_setup(
269 psa_mac_operation_t *operation,
270 const psa_key_attributes_t *attributes,
271 const uint8_t *key_buffer,
272 size_t key_buffer_size,
273 psa_algorithm_t alg );
274
275psa_status_t psa_driver_wrapper_mac_update(
276 psa_mac_operation_t *operation,
277 const uint8_t *input,
278 size_t input_length );
279
280psa_status_t psa_driver_wrapper_mac_sign_finish(
281 psa_mac_operation_t *operation,
282 uint8_t *mac,
283 size_t mac_size,
284 size_t *mac_length );
285
286psa_status_t psa_driver_wrapper_mac_verify_finish(
287 psa_mac_operation_t *operation,
288 const uint8_t *mac,
289 size_t mac_length );
290
291psa_status_t psa_driver_wrapper_mac_abort(
292 psa_mac_operation_t *operation );
293
Steven Cooremancd84cb42020-07-16 20:28:36 +0200294#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
295
296/* End of automatically generated file. */