blob: 9471099de9de6f1e30ebe019e944e3bcc85bbaa3 [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 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010031psa_status_t psa_driver_wrapper_init(void);
32void psa_driver_wrapper_free(void);
Ronald Cron088d5d02021-04-10 16:57:30 +020033
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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010046 size_t *signature_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +020047
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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010056 size_t signature_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +020057
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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010062 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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010068 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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010078 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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010083 uint8_t *data, size_t data_size, size_t *data_length);
Ronald Cron67227982020-11-26 15:16:05 +010084
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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010088 uint8_t *data, size_t data_size, size_t *data_length);
Ronald Cron84cc9942020-11-25 14:30:05 +010089
Ronald Cron9df74be2020-12-05 19:15:23 +010090psa_status_t psa_driver_wrapper_get_key_buffer_size(
91 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010092 size_t *key_buffer_size);
Ronald Cron9df74be2020-12-05 19:15:23 +010093
Ronald Cron84cc9942020-11-25 14:30:05 +010094psa_status_t psa_driver_wrapper_generate_key(
95 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010096 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,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100101 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length);
Steven Cooreman6801f082021-02-19 17:21:22 +0100102
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,
Ronald Crona8331692021-07-09 09:19:35 +0200111 const uint8_t *iv,
112 size_t iv_length,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200113 const uint8_t *input,
114 size_t input_length,
115 uint8_t *output,
116 size_t output_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100117 size_t *output_length);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200118
119psa_status_t psa_driver_wrapper_cipher_decrypt(
gabor-mezei-armfa990b52021-03-25 11:17:10 +0100120 const psa_key_attributes_t *attributes,
121 const uint8_t *key_buffer,
122 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200123 psa_algorithm_t alg,
124 const uint8_t *input,
125 size_t input_length,
126 uint8_t *output,
127 size_t output_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100128 size_t *output_length);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200129
130psa_status_t psa_driver_wrapper_cipher_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100131 psa_cipher_operation_t *operation,
132 const psa_key_attributes_t *attributes,
133 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100134 psa_algorithm_t alg);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200135
136psa_status_t psa_driver_wrapper_cipher_decrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100137 psa_cipher_operation_t *operation,
138 const psa_key_attributes_t *attributes,
139 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100140 psa_algorithm_t alg);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200141
Steven Cooreman37941cb2020-07-28 18:49:51 +0200142psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100143 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200144 const uint8_t *iv,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100145 size_t iv_length);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200146
147psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100148 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200149 const uint8_t *input,
150 size_t input_length,
151 uint8_t *output,
152 size_t output_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100153 size_t *output_length);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200154
155psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100156 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200157 uint8_t *output,
158 size_t output_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100159 size_t *output_length);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200160
161psa_status_t psa_driver_wrapper_cipher_abort(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100162 psa_cipher_operation_t *operation);
Steven Cooreman37941cb2020-07-28 18:49:51 +0200163
Steven Cooreman1e582352021-02-18 17:24:37 +0100164/*
165 * Hashing functions
166 */
167psa_status_t psa_driver_wrapper_hash_compute(
168 psa_algorithm_t alg,
169 const uint8_t *input,
170 size_t input_length,
171 uint8_t *hash,
172 size_t hash_size,
173 size_t *hash_length);
174
175psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100176 psa_hash_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100177 psa_algorithm_t alg);
Steven Cooreman1e582352021-02-18 17:24:37 +0100178
179psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100180 const psa_hash_operation_t *source_operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100181 psa_hash_operation_t *target_operation);
Steven Cooreman1e582352021-02-18 17:24:37 +0100182
183psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100184 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100185 const uint8_t *input,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100186 size_t input_length);
Steven Cooreman1e582352021-02-18 17:24:37 +0100187
188psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100189 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100190 uint8_t *hash,
191 size_t hash_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100192 size_t *hash_length);
Steven Cooreman1e582352021-02-18 17:24:37 +0100193
194psa_status_t psa_driver_wrapper_hash_abort(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100195 psa_hash_operation_t *operation);
Steven Cooreman1e582352021-02-18 17:24:37 +0100196
Ronald Cronde822812021-03-17 16:08:20 +0100197/*
198 * AEAD functions
199 */
200
201psa_status_t psa_driver_wrapper_aead_encrypt(
202 const psa_key_attributes_t *attributes,
203 const uint8_t *key_buffer, size_t key_buffer_size,
204 psa_algorithm_t alg,
205 const uint8_t *nonce, size_t nonce_length,
206 const uint8_t *additional_data, size_t additional_data_length,
207 const uint8_t *plaintext, size_t plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100208 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length);
Ronald Cronde822812021-03-17 16:08:20 +0100209
210psa_status_t psa_driver_wrapper_aead_decrypt(
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 *ciphertext, size_t ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100217 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length);
Ronald Cronde822812021-03-17 16:08:20 +0100218
Steven Cooreman896d51e2021-03-19 15:24:23 +0100219/*
220 * MAC functions
221 */
222psa_status_t psa_driver_wrapper_mac_compute(
223 const psa_key_attributes_t *attributes,
224 const uint8_t *key_buffer,
225 size_t key_buffer_size,
226 psa_algorithm_t alg,
227 const uint8_t *input,
228 size_t input_length,
229 uint8_t *mac,
230 size_t mac_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100231 size_t *mac_length);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100232
233psa_status_t psa_driver_wrapper_mac_sign_setup(
234 psa_mac_operation_t *operation,
235 const psa_key_attributes_t *attributes,
236 const uint8_t *key_buffer,
237 size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100238 psa_algorithm_t alg);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100239
240psa_status_t psa_driver_wrapper_mac_verify_setup(
241 psa_mac_operation_t *operation,
242 const psa_key_attributes_t *attributes,
243 const uint8_t *key_buffer,
244 size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100245 psa_algorithm_t alg);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100246
247psa_status_t psa_driver_wrapper_mac_update(
248 psa_mac_operation_t *operation,
249 const uint8_t *input,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100250 size_t input_length);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100251
252psa_status_t psa_driver_wrapper_mac_sign_finish(
253 psa_mac_operation_t *operation,
254 uint8_t *mac,
255 size_t mac_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100256 size_t *mac_length);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100257
258psa_status_t psa_driver_wrapper_mac_verify_finish(
259 psa_mac_operation_t *operation,
260 const uint8_t *mac,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100261 size_t mac_length);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100262
263psa_status_t psa_driver_wrapper_mac_abort(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100264 psa_mac_operation_t *operation);
Steven Cooreman896d51e2021-03-19 15:24:23 +0100265
Steven Cooremancd84cb42020-07-16 20:28:36 +0200266#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
267
268/* End of automatically generated file. */