blob: 3ba96d9a583149a65900ca9f597d6ee5e8edbeee [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 Cron088d5d02021-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-armc53f4f62021-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
Ronald Cron84cc9942020-11-25 14:30:05 +010094psa_status_t psa_driver_wrapper_generate_key(
95 const psa_key_attributes_t *attributes,
Ronald Cron977c2472020-10-13 08:32:21 +020096 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
Steven Cooremanb9b84422020-10-14 14:39:20 +020097
Steven Cooreman6801f082021-02-19 17:21:22 +010098psa_status_t psa_driver_wrapper_get_builtin_key(
99 psa_drv_slot_number_t slot_number,
100 psa_key_attributes_t *attributes,
101 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length );
102
Steven Cooreman37941cb2020-07-28 18:49:51 +0200103/*
104 * Cipher functions
105 */
106psa_status_t psa_driver_wrapper_cipher_encrypt(
gabor-mezei-armfa990b52021-03-25 11:17:10 +0100107 const psa_key_attributes_t *attributes,
108 const uint8_t *key_buffer,
109 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200110 psa_algorithm_t alg,
111 const uint8_t *input,
112 size_t input_length,
113 uint8_t *output,
114 size_t output_size,
115 size_t *output_length );
116
117psa_status_t psa_driver_wrapper_cipher_decrypt(
gabor-mezei-armfa990b52021-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_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100129 psa_cipher_operation_t *operation,
130 const psa_key_attributes_t *attributes,
131 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200132 psa_algorithm_t alg );
133
134psa_status_t psa_driver_wrapper_cipher_decrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100135 psa_cipher_operation_t *operation,
136 const psa_key_attributes_t *attributes,
137 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200138 psa_algorithm_t alg );
139
Steven Cooreman37941cb2020-07-28 18:49:51 +0200140psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100141 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200142 const uint8_t *iv,
143 size_t iv_length );
144
145psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100146 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200147 const uint8_t *input,
148 size_t input_length,
149 uint8_t *output,
150 size_t output_size,
151 size_t *output_length );
152
153psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100154 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200155 uint8_t *output,
156 size_t output_size,
157 size_t *output_length );
158
159psa_status_t psa_driver_wrapper_cipher_abort(
Ronald Cron6056fe82020-12-15 13:58:07 +0100160 psa_cipher_operation_t *operation );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200161
Steven Cooreman1e582352021-02-18 17:24:37 +0100162/*
163 * Hashing functions
164 */
165psa_status_t psa_driver_wrapper_hash_compute(
166 psa_algorithm_t alg,
167 const uint8_t *input,
168 size_t input_length,
169 uint8_t *hash,
170 size_t hash_size,
171 size_t *hash_length);
172
173psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100174 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100175 psa_algorithm_t alg );
176
177psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100178 const psa_hash_operation_t *source_operation,
179 psa_hash_operation_t *target_operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100180
181psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100182 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100183 const uint8_t *input,
184 size_t input_length );
185
186psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100187 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100188 uint8_t *hash,
189 size_t hash_size,
190 size_t *hash_length );
191
192psa_status_t psa_driver_wrapper_hash_abort(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100193 psa_hash_operation_t *operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100194
Ronald Cronde822812021-03-17 16:08:20 +0100195/*
196 * AEAD functions
197 */
198
199psa_status_t psa_driver_wrapper_aead_encrypt(
200 const psa_key_attributes_t *attributes,
201 const uint8_t *key_buffer, size_t key_buffer_size,
202 psa_algorithm_t alg,
203 const uint8_t *nonce, size_t nonce_length,
204 const uint8_t *additional_data, size_t additional_data_length,
205 const uint8_t *plaintext, size_t plaintext_length,
206 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length );
207
208psa_status_t psa_driver_wrapper_aead_decrypt(
209 const psa_key_attributes_t *attributes,
210 const uint8_t *key_buffer, size_t key_buffer_size,
211 psa_algorithm_t alg,
212 const uint8_t *nonce, size_t nonce_length,
213 const uint8_t *additional_data, size_t additional_data_length,
214 const uint8_t *ciphertext, size_t ciphertext_length,
215 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length );
216
Steven Cooreman896d51e2021-03-19 15:24:23 +0100217/*
218 * MAC functions
219 */
220psa_status_t psa_driver_wrapper_mac_compute(
221 const psa_key_attributes_t *attributes,
222 const uint8_t *key_buffer,
223 size_t key_buffer_size,
224 psa_algorithm_t alg,
225 const uint8_t *input,
226 size_t input_length,
227 uint8_t *mac,
228 size_t mac_size,
229 size_t *mac_length );
230
231psa_status_t psa_driver_wrapper_mac_sign_setup(
232 psa_mac_operation_t *operation,
233 const psa_key_attributes_t *attributes,
234 const uint8_t *key_buffer,
235 size_t key_buffer_size,
236 psa_algorithm_t alg );
237
238psa_status_t psa_driver_wrapper_mac_verify_setup(
239 psa_mac_operation_t *operation,
240 const psa_key_attributes_t *attributes,
241 const uint8_t *key_buffer,
242 size_t key_buffer_size,
243 psa_algorithm_t alg );
244
245psa_status_t psa_driver_wrapper_mac_update(
246 psa_mac_operation_t *operation,
247 const uint8_t *input,
248 size_t input_length );
249
250psa_status_t psa_driver_wrapper_mac_sign_finish(
251 psa_mac_operation_t *operation,
252 uint8_t *mac,
253 size_t mac_size,
254 size_t *mac_length );
255
256psa_status_t psa_driver_wrapper_mac_verify_finish(
257 psa_mac_operation_t *operation,
258 const uint8_t *mac,
259 size_t mac_length );
260
261psa_status_t psa_driver_wrapper_mac_abort(
262 psa_mac_operation_t *operation );
263
Steven Cooremancd84cb42020-07-16 20:28:36 +0200264#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
265
266/* End of automatically generated file. */