blob: 6026b8220668f10effaca2dfbaf314b7c3e300cb [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/*
Ronald Cron9ba76912021-04-10 16:57:30 +020029 * Initialization and termination functions
30 */
31psa_status_t psa_driver_wrapper_init( void );
32void psa_driver_wrapper_free( void );
33
34/*
Steven Cooreman37941cb2020-07-28 18:49:51 +020035 * Signature functions
36 */
gabor-mezei-arm50eac352021-04-22 11:32:19 +020037psa_status_t psa_driver_wrapper_sign_message(
38 const psa_key_attributes_t *attributes,
39 const uint8_t *key_buffer,
40 size_t key_buffer_size,
41 psa_algorithm_t alg,
42 const uint8_t *input,
43 size_t input_length,
44 uint8_t *signature,
45 size_t signature_size,
46 size_t *signature_length );
47
48psa_status_t psa_driver_wrapper_verify_message(
49 const psa_key_attributes_t *attributes,
50 const uint8_t *key_buffer,
51 size_t key_buffer_size,
52 psa_algorithm_t alg,
53 const uint8_t *input,
54 size_t input_length,
55 const uint8_t *signature,
56 size_t signature_length );
57
Ronald Cron9f17aa42020-12-08 17:07:25 +010058psa_status_t psa_driver_wrapper_sign_hash(
59 const psa_key_attributes_t *attributes,
60 const uint8_t *key_buffer, size_t key_buffer_size,
61 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
62 uint8_t *signature, size_t signature_size, size_t *signature_length );
Steven Cooremancd84cb42020-07-16 20:28:36 +020063
Ronald Cron9f17aa42020-12-08 17:07:25 +010064psa_status_t psa_driver_wrapper_verify_hash(
65 const psa_key_attributes_t *attributes,
66 const uint8_t *key_buffer, size_t key_buffer_size,
67 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
68 const uint8_t *signature, size_t signature_length );
Steven Cooreman55ae2172020-07-17 19:46:15 +020069
Steven Cooreman04524762020-10-13 17:43:44 +020070/*
71 * Key handling functions
72 */
73
Ronald Cron83282872020-11-22 14:02:39 +010074psa_status_t psa_driver_wrapper_import_key(
75 const psa_key_attributes_t *attributes,
76 const uint8_t *data, size_t data_length,
77 uint8_t *key_buffer, size_t key_buffer_size,
78 size_t *key_buffer_length, size_t *bits );
Steven Cooreman04524762020-10-13 17:43:44 +020079
Ronald Cron67227982020-11-26 15:16:05 +010080psa_status_t psa_driver_wrapper_export_key(
81 const psa_key_attributes_t *attributes,
82 const uint8_t *key_buffer, size_t key_buffer_size,
83 uint8_t *data, size_t data_size, size_t *data_length );
84
Ronald Cron84cc9942020-11-25 14:30:05 +010085psa_status_t psa_driver_wrapper_export_public_key(
86 const psa_key_attributes_t *attributes,
87 const uint8_t *key_buffer, size_t key_buffer_size,
88 uint8_t *data, size_t data_size, size_t *data_length );
89
Ronald Cron9df74be2020-12-05 19:15:23 +010090psa_status_t psa_driver_wrapper_get_key_buffer_size(
91 const psa_key_attributes_t *attributes,
92 size_t *key_buffer_size );
93
Archanad8a83dc2021-06-14 10:04:16 +053094psa_status_t psa_driver_wrapper_get_key_buffer_size_from_key_data(
95 const psa_key_attributes_t *attributes,
96 const uint8_t *data,
97 size_t data_length,
98 size_t *key_buffer_size );
99
Ronald Cron84cc9942020-11-25 14:30:05 +0100100psa_status_t psa_driver_wrapper_generate_key(
101 const psa_key_attributes_t *attributes,
Ronald Cron977c2472020-10-13 08:32:21 +0200102 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
Steven Cooremanb9b84422020-10-14 14:39:20 +0200103
Steven Cooreman6801f082021-02-19 17:21:22 +0100104psa_status_t psa_driver_wrapper_get_builtin_key(
105 psa_drv_slot_number_t slot_number,
106 psa_key_attributes_t *attributes,
107 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
108
Archana8a180362021-07-05 02:18:48 +0530109psa_status_t psa_driver_wrapper_copy_key(
110 psa_key_attributes_t *attributes,
Archana9d17bf42021-09-10 06:22:44 +0530111 const uint8_t *source_key, size_t source_key_length,
Archana449608b2021-09-08 15:36:05 +0530112 uint8_t *target_key_buffer, size_t target_key_buffer_size,
113 size_t *target_key_buffer_length );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200114/*
115 * Cipher functions
116 */
117psa_status_t psa_driver_wrapper_cipher_encrypt(
gabor-mezei-arma9449a02021-03-25 11:17:10 +0100118 const psa_key_attributes_t *attributes,
119 const uint8_t *key_buffer,
120 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200121 psa_algorithm_t alg,
122 const uint8_t *input,
123 size_t input_length,
124 uint8_t *output,
125 size_t output_size,
126 size_t *output_length );
127
128psa_status_t psa_driver_wrapper_cipher_decrypt(
gabor-mezei-arma9449a02021-03-25 11:17:10 +0100129 const psa_key_attributes_t *attributes,
130 const uint8_t *key_buffer,
131 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200132 psa_algorithm_t alg,
133 const uint8_t *input,
134 size_t input_length,
135 uint8_t *output,
136 size_t output_size,
137 size_t *output_length );
138
139psa_status_t psa_driver_wrapper_cipher_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100140 psa_cipher_operation_t *operation,
141 const psa_key_attributes_t *attributes,
142 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200143 psa_algorithm_t alg );
144
145psa_status_t psa_driver_wrapper_cipher_decrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100146 psa_cipher_operation_t *operation,
147 const psa_key_attributes_t *attributes,
148 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200149 psa_algorithm_t alg );
150
Steven Cooreman37941cb2020-07-28 18:49:51 +0200151psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100152 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200153 const uint8_t *iv,
154 size_t iv_length );
155
156psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100157 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200158 const uint8_t *input,
159 size_t input_length,
160 uint8_t *output,
161 size_t output_size,
162 size_t *output_length );
163
164psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100165 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200166 uint8_t *output,
167 size_t output_size,
168 size_t *output_length );
169
170psa_status_t psa_driver_wrapper_cipher_abort(
Ronald Cron6056fe82020-12-15 13:58:07 +0100171 psa_cipher_operation_t *operation );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200172
Steven Cooreman1e582352021-02-18 17:24:37 +0100173/*
174 * Hashing functions
175 */
176psa_status_t psa_driver_wrapper_hash_compute(
177 psa_algorithm_t alg,
178 const uint8_t *input,
179 size_t input_length,
180 uint8_t *hash,
181 size_t hash_size,
182 size_t *hash_length);
183
184psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100185 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100186 psa_algorithm_t alg );
187
188psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100189 const psa_hash_operation_t *source_operation,
190 psa_hash_operation_t *target_operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100191
192psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100193 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100194 const uint8_t *input,
195 size_t input_length );
196
197psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100198 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100199 uint8_t *hash,
200 size_t hash_size,
201 size_t *hash_length );
202
203psa_status_t psa_driver_wrapper_hash_abort(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100204 psa_hash_operation_t *operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100205
Ronald Cronde822812021-03-17 16:08:20 +0100206/*
207 * AEAD functions
208 */
209
210psa_status_t psa_driver_wrapper_aead_encrypt(
211 const psa_key_attributes_t *attributes,
212 const uint8_t *key_buffer, size_t key_buffer_size,
213 psa_algorithm_t alg,
214 const uint8_t *nonce, size_t nonce_length,
215 const uint8_t *additional_data, size_t additional_data_length,
216 const uint8_t *plaintext, size_t plaintext_length,
217 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length );
218
219psa_status_t psa_driver_wrapper_aead_decrypt(
220 const psa_key_attributes_t *attributes,
221 const uint8_t *key_buffer, size_t key_buffer_size,
222 psa_algorithm_t alg,
223 const uint8_t *nonce, size_t nonce_length,
224 const uint8_t *additional_data, size_t additional_data_length,
225 const uint8_t *ciphertext, size_t ciphertext_length,
226 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length );
227
Paul Elliott6504aa62021-04-20 17:09:36 +0100228psa_status_t psa_driver_wrapper_aead_encrypt_setup(
229 psa_aead_operation_t *operation,
230 const psa_key_attributes_t *attributes,
231 const uint8_t *key_buffer, size_t key_buffer_size,
232 psa_algorithm_t alg );
233
234psa_status_t psa_driver_wrapper_aead_decrypt_setup(
235 psa_aead_operation_t *operation,
236 const psa_key_attributes_t *attributes,
237 const uint8_t *key_buffer, size_t key_buffer_size,
238 psa_algorithm_t alg );
239
Paul Elliott6504aa62021-04-20 17:09:36 +0100240psa_status_t psa_driver_wrapper_aead_set_nonce(
241 psa_aead_operation_t *operation,
242 const uint8_t *nonce,
243 size_t nonce_length );
244
245psa_status_t psa_driver_wrapper_aead_set_lengths(
246 psa_aead_operation_t *operation,
247 size_t ad_length,
248 size_t plaintext_length );
249
250psa_status_t psa_driver_wrapper_aead_update_ad(
251 psa_aead_operation_t *operation,
252 const uint8_t *input,
253 size_t input_length );
254
255psa_status_t psa_driver_wrapper_aead_update(
256 psa_aead_operation_t *operation,
257 const uint8_t *input,
258 size_t input_length,
259 uint8_t *output,
260 size_t output_size,
261 size_t *output_length );
262
263psa_status_t psa_driver_wrapper_aead_finish(
264 psa_aead_operation_t *operation,
265 uint8_t *ciphertext,
266 size_t ciphertext_size,
267 size_t *ciphertext_length,
268 uint8_t *tag,
269 size_t tag_size,
270 size_t *tag_length );
271
272psa_status_t psa_driver_wrapper_aead_verify(
273 psa_aead_operation_t *operation,
274 uint8_t *plaintext,
275 size_t plaintext_size,
276 size_t *plaintext_length,
277 const uint8_t *tag,
278 size_t tag_length );
279
280psa_status_t psa_driver_wrapper_aead_abort(
281 psa_aead_operation_t *operation );
282
Steven Cooremand13a70f2021-03-19 15:24:23 +0100283/*
284 * MAC functions
285 */
286psa_status_t psa_driver_wrapper_mac_compute(
287 const psa_key_attributes_t *attributes,
288 const uint8_t *key_buffer,
289 size_t key_buffer_size,
290 psa_algorithm_t alg,
291 const uint8_t *input,
292 size_t input_length,
293 uint8_t *mac,
294 size_t mac_size,
295 size_t *mac_length );
296
297psa_status_t psa_driver_wrapper_mac_sign_setup(
298 psa_mac_operation_t *operation,
299 const psa_key_attributes_t *attributes,
300 const uint8_t *key_buffer,
301 size_t key_buffer_size,
302 psa_algorithm_t alg );
303
304psa_status_t psa_driver_wrapper_mac_verify_setup(
305 psa_mac_operation_t *operation,
306 const psa_key_attributes_t *attributes,
307 const uint8_t *key_buffer,
308 size_t key_buffer_size,
309 psa_algorithm_t alg );
310
311psa_status_t psa_driver_wrapper_mac_update(
312 psa_mac_operation_t *operation,
313 const uint8_t *input,
314 size_t input_length );
315
316psa_status_t psa_driver_wrapper_mac_sign_finish(
317 psa_mac_operation_t *operation,
318 uint8_t *mac,
319 size_t mac_size,
320 size_t *mac_length );
321
322psa_status_t psa_driver_wrapper_mac_verify_finish(
323 psa_mac_operation_t *operation,
324 const uint8_t *mac,
325 size_t mac_length );
326
327psa_status_t psa_driver_wrapper_mac_abort(
328 psa_mac_operation_t *operation );
329
Steven Cooremancd84cb42020-07-16 20:28:36 +0200330#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
331
332/* End of automatically generated file. */