blob: e09e4ed70eac7ebeaf0ac668b49005a216196c0f [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,
Ronald Cron9b674282021-07-09 09:19:35 +0200122 const uint8_t *iv,
123 size_t iv_length,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200124 const uint8_t *input,
125 size_t input_length,
126 uint8_t *output,
127 size_t output_size,
128 size_t *output_length );
129
130psa_status_t psa_driver_wrapper_cipher_decrypt(
gabor-mezei-arma9449a02021-03-25 11:17:10 +0100131 const psa_key_attributes_t *attributes,
132 const uint8_t *key_buffer,
133 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200134 psa_algorithm_t alg,
135 const uint8_t *input,
136 size_t input_length,
137 uint8_t *output,
138 size_t output_size,
139 size_t *output_length );
140
141psa_status_t psa_driver_wrapper_cipher_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100142 psa_cipher_operation_t *operation,
143 const psa_key_attributes_t *attributes,
144 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200145 psa_algorithm_t alg );
146
147psa_status_t psa_driver_wrapper_cipher_decrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100148 psa_cipher_operation_t *operation,
149 const psa_key_attributes_t *attributes,
150 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200151 psa_algorithm_t alg );
152
Steven Cooreman37941cb2020-07-28 18:49:51 +0200153psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100154 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200155 const uint8_t *iv,
156 size_t iv_length );
157
158psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100159 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200160 const uint8_t *input,
161 size_t input_length,
162 uint8_t *output,
163 size_t output_size,
164 size_t *output_length );
165
166psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100167 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200168 uint8_t *output,
169 size_t output_size,
170 size_t *output_length );
171
172psa_status_t psa_driver_wrapper_cipher_abort(
Ronald Cron6056fe82020-12-15 13:58:07 +0100173 psa_cipher_operation_t *operation );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200174
Steven Cooreman1e582352021-02-18 17:24:37 +0100175/*
176 * Hashing functions
177 */
178psa_status_t psa_driver_wrapper_hash_compute(
179 psa_algorithm_t alg,
180 const uint8_t *input,
181 size_t input_length,
182 uint8_t *hash,
183 size_t hash_size,
184 size_t *hash_length);
185
186psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100187 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100188 psa_algorithm_t alg );
189
190psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100191 const psa_hash_operation_t *source_operation,
192 psa_hash_operation_t *target_operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100193
194psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100195 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100196 const uint8_t *input,
197 size_t input_length );
198
199psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100200 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100201 uint8_t *hash,
202 size_t hash_size,
203 size_t *hash_length );
204
205psa_status_t psa_driver_wrapper_hash_abort(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100206 psa_hash_operation_t *operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100207
Ronald Cronde822812021-03-17 16:08:20 +0100208/*
209 * AEAD functions
210 */
211
212psa_status_t psa_driver_wrapper_aead_encrypt(
213 const psa_key_attributes_t *attributes,
214 const uint8_t *key_buffer, size_t key_buffer_size,
215 psa_algorithm_t alg,
216 const uint8_t *nonce, size_t nonce_length,
217 const uint8_t *additional_data, size_t additional_data_length,
218 const uint8_t *plaintext, size_t plaintext_length,
219 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length );
220
221psa_status_t psa_driver_wrapper_aead_decrypt(
222 const psa_key_attributes_t *attributes,
223 const uint8_t *key_buffer, size_t key_buffer_size,
224 psa_algorithm_t alg,
225 const uint8_t *nonce, size_t nonce_length,
226 const uint8_t *additional_data, size_t additional_data_length,
227 const uint8_t *ciphertext, size_t ciphertext_length,
228 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length );
229
Paul Elliott6504aa62021-04-20 17:09:36 +0100230psa_status_t psa_driver_wrapper_aead_encrypt_setup(
231 psa_aead_operation_t *operation,
232 const psa_key_attributes_t *attributes,
233 const uint8_t *key_buffer, size_t key_buffer_size,
234 psa_algorithm_t alg );
235
236psa_status_t psa_driver_wrapper_aead_decrypt_setup(
237 psa_aead_operation_t *operation,
238 const psa_key_attributes_t *attributes,
239 const uint8_t *key_buffer, size_t key_buffer_size,
240 psa_algorithm_t alg );
241
Paul Elliott6504aa62021-04-20 17:09:36 +0100242psa_status_t psa_driver_wrapper_aead_set_nonce(
243 psa_aead_operation_t *operation,
244 const uint8_t *nonce,
245 size_t nonce_length );
246
247psa_status_t psa_driver_wrapper_aead_set_lengths(
248 psa_aead_operation_t *operation,
249 size_t ad_length,
250 size_t plaintext_length );
251
252psa_status_t psa_driver_wrapper_aead_update_ad(
253 psa_aead_operation_t *operation,
254 const uint8_t *input,
255 size_t input_length );
256
257psa_status_t psa_driver_wrapper_aead_update(
258 psa_aead_operation_t *operation,
259 const uint8_t *input,
260 size_t input_length,
261 uint8_t *output,
262 size_t output_size,
263 size_t *output_length );
264
265psa_status_t psa_driver_wrapper_aead_finish(
266 psa_aead_operation_t *operation,
267 uint8_t *ciphertext,
268 size_t ciphertext_size,
269 size_t *ciphertext_length,
270 uint8_t *tag,
271 size_t tag_size,
272 size_t *tag_length );
273
274psa_status_t psa_driver_wrapper_aead_verify(
275 psa_aead_operation_t *operation,
276 uint8_t *plaintext,
277 size_t plaintext_size,
278 size_t *plaintext_length,
279 const uint8_t *tag,
280 size_t tag_length );
281
282psa_status_t psa_driver_wrapper_aead_abort(
283 psa_aead_operation_t *operation );
284
Steven Cooremand13a70f2021-03-19 15:24:23 +0100285/*
286 * MAC functions
287 */
288psa_status_t psa_driver_wrapper_mac_compute(
289 const psa_key_attributes_t *attributes,
290 const uint8_t *key_buffer,
291 size_t key_buffer_size,
292 psa_algorithm_t alg,
293 const uint8_t *input,
294 size_t input_length,
295 uint8_t *mac,
296 size_t mac_size,
297 size_t *mac_length );
298
299psa_status_t psa_driver_wrapper_mac_sign_setup(
300 psa_mac_operation_t *operation,
301 const psa_key_attributes_t *attributes,
302 const uint8_t *key_buffer,
303 size_t key_buffer_size,
304 psa_algorithm_t alg );
305
306psa_status_t psa_driver_wrapper_mac_verify_setup(
307 psa_mac_operation_t *operation,
308 const psa_key_attributes_t *attributes,
309 const uint8_t *key_buffer,
310 size_t key_buffer_size,
311 psa_algorithm_t alg );
312
313psa_status_t psa_driver_wrapper_mac_update(
314 psa_mac_operation_t *operation,
315 const uint8_t *input,
316 size_t input_length );
317
318psa_status_t psa_driver_wrapper_mac_sign_finish(
319 psa_mac_operation_t *operation,
320 uint8_t *mac,
321 size_t mac_size,
322 size_t *mac_length );
323
324psa_status_t psa_driver_wrapper_mac_verify_finish(
325 psa_mac_operation_t *operation,
326 const uint8_t *mac,
327 size_t mac_length );
328
329psa_status_t psa_driver_wrapper_mac_abort(
330 psa_mac_operation_t *operation );
331
Steven Cooremancd84cb42020-07-16 20:28:36 +0200332#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
333
334/* End of automatically generated file. */