blob: c6e3d51a39781c1b9ac1d5e2c90d4bf1559d2593 [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 */
gabor-mezei-arm50eac352021-04-22 11:32:19 +020031psa_status_t psa_driver_wrapper_sign_message(
32 const psa_key_attributes_t *attributes,
33 const uint8_t *key_buffer,
34 size_t key_buffer_size,
35 psa_algorithm_t alg,
36 const uint8_t *input,
37 size_t input_length,
38 uint8_t *signature,
39 size_t signature_size,
40 size_t *signature_length );
41
42psa_status_t psa_driver_wrapper_verify_message(
43 const psa_key_attributes_t *attributes,
44 const uint8_t *key_buffer,
45 size_t key_buffer_size,
46 psa_algorithm_t alg,
47 const uint8_t *input,
48 size_t input_length,
49 const uint8_t *signature,
50 size_t signature_length );
51
Ronald Cron9f17aa42020-12-08 17:07:25 +010052psa_status_t psa_driver_wrapper_sign_hash(
53 const psa_key_attributes_t *attributes,
54 const uint8_t *key_buffer, size_t key_buffer_size,
55 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
56 uint8_t *signature, size_t signature_size, size_t *signature_length );
Steven Cooremancd84cb42020-07-16 20:28:36 +020057
Ronald Cron9f17aa42020-12-08 17:07:25 +010058psa_status_t psa_driver_wrapper_verify_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 const uint8_t *signature, size_t signature_length );
Steven Cooreman55ae2172020-07-17 19:46:15 +020063
Steven Cooreman04524762020-10-13 17:43:44 +020064/*
65 * Key handling functions
66 */
67
Ronald Cron83282872020-11-22 14:02:39 +010068psa_status_t psa_driver_wrapper_import_key(
69 const psa_key_attributes_t *attributes,
70 const uint8_t *data, size_t data_length,
71 uint8_t *key_buffer, size_t key_buffer_size,
72 size_t *key_buffer_length, size_t *bits );
Steven Cooreman04524762020-10-13 17:43:44 +020073
Ronald Cron67227982020-11-26 15:16:05 +010074psa_status_t psa_driver_wrapper_export_key(
75 const psa_key_attributes_t *attributes,
76 const uint8_t *key_buffer, size_t key_buffer_size,
77 uint8_t *data, size_t data_size, size_t *data_length );
78
Ronald Cron84cc9942020-11-25 14:30:05 +010079psa_status_t psa_driver_wrapper_export_public_key(
80 const psa_key_attributes_t *attributes,
81 const uint8_t *key_buffer, size_t key_buffer_size,
82 uint8_t *data, size_t data_size, size_t *data_length );
83
Ronald Cron9df74be2020-12-05 19:15:23 +010084psa_status_t psa_driver_wrapper_get_key_buffer_size(
85 const psa_key_attributes_t *attributes,
86 size_t *key_buffer_size );
87
Archanad8a83dc2021-06-14 10:04:16 +053088psa_status_t psa_driver_wrapper_get_key_buffer_size_from_key_data(
89 const psa_key_attributes_t *attributes,
90 const uint8_t *data,
91 size_t data_length,
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
Archana8a180362021-07-05 02:18:48 +0530103psa_status_t psa_driver_wrapper_copy_key(
104 psa_key_attributes_t *attributes,
Archana9d17bf42021-09-10 06:22:44 +0530105 const uint8_t *source_key, size_t source_key_length,
Archana449608b2021-09-08 15:36:05 +0530106 uint8_t *target_key_buffer, size_t target_key_buffer_size,
107 size_t *target_key_buffer_length );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200108/*
109 * Cipher functions
110 */
111psa_status_t psa_driver_wrapper_cipher_encrypt(
gabor-mezei-arma9449a02021-03-25 11:17:10 +0100112 const psa_key_attributes_t *attributes,
113 const uint8_t *key_buffer,
114 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200115 psa_algorithm_t alg,
116 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_decrypt(
gabor-mezei-arma9449a02021-03-25 11:17:10 +0100123 const psa_key_attributes_t *attributes,
124 const uint8_t *key_buffer,
125 size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200126 psa_algorithm_t alg,
127 const uint8_t *input,
128 size_t input_length,
129 uint8_t *output,
130 size_t output_size,
131 size_t *output_length );
132
133psa_status_t psa_driver_wrapper_cipher_encrypt_setup(
Ronald Crona4af55f2020-12-14 14:36:06 +0100134 psa_cipher_operation_t *operation,
135 const psa_key_attributes_t *attributes,
136 const uint8_t *key_buffer, size_t key_buffer_size,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200137 psa_algorithm_t alg );
138
139psa_status_t psa_driver_wrapper_cipher_decrypt_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
Steven Cooreman37941cb2020-07-28 18:49:51 +0200145psa_status_t psa_driver_wrapper_cipher_set_iv(
Ronald Cron6056fe82020-12-15 13:58:07 +0100146 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200147 const uint8_t *iv,
148 size_t iv_length );
149
150psa_status_t psa_driver_wrapper_cipher_update(
Ronald Cron6056fe82020-12-15 13:58:07 +0100151 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200152 const uint8_t *input,
153 size_t input_length,
154 uint8_t *output,
155 size_t output_size,
156 size_t *output_length );
157
158psa_status_t psa_driver_wrapper_cipher_finish(
Ronald Cron6056fe82020-12-15 13:58:07 +0100159 psa_cipher_operation_t *operation,
Steven Cooreman37941cb2020-07-28 18:49:51 +0200160 uint8_t *output,
161 size_t output_size,
162 size_t *output_length );
163
164psa_status_t psa_driver_wrapper_cipher_abort(
Ronald Cron6056fe82020-12-15 13:58:07 +0100165 psa_cipher_operation_t *operation );
Steven Cooreman37941cb2020-07-28 18:49:51 +0200166
Steven Cooreman1e582352021-02-18 17:24:37 +0100167/*
168 * Hashing functions
169 */
170psa_status_t psa_driver_wrapper_hash_compute(
171 psa_algorithm_t alg,
172 const uint8_t *input,
173 size_t input_length,
174 uint8_t *hash,
175 size_t hash_size,
176 size_t *hash_length);
177
178psa_status_t psa_driver_wrapper_hash_setup(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100179 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100180 psa_algorithm_t alg );
181
182psa_status_t psa_driver_wrapper_hash_clone(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100183 const psa_hash_operation_t *source_operation,
184 psa_hash_operation_t *target_operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100185
186psa_status_t psa_driver_wrapper_hash_update(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100187 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100188 const uint8_t *input,
189 size_t input_length );
190
191psa_status_t psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100192 psa_hash_operation_t *operation,
Steven Cooreman1e582352021-02-18 17:24:37 +0100193 uint8_t *hash,
194 size_t hash_size,
195 size_t *hash_length );
196
197psa_status_t psa_driver_wrapper_hash_abort(
Steven Cooremandbf8ced2021-03-04 13:01:18 +0100198 psa_hash_operation_t *operation );
Steven Cooreman1e582352021-02-18 17:24:37 +0100199
Ronald Cronde822812021-03-17 16:08:20 +0100200/*
201 * AEAD functions
202 */
203
204psa_status_t psa_driver_wrapper_aead_encrypt(
205 const psa_key_attributes_t *attributes,
206 const uint8_t *key_buffer, size_t key_buffer_size,
207 psa_algorithm_t alg,
208 const uint8_t *nonce, size_t nonce_length,
209 const uint8_t *additional_data, size_t additional_data_length,
210 const uint8_t *plaintext, size_t plaintext_length,
211 uint8_t *ciphertext, size_t ciphertext_size, size_t *ciphertext_length );
212
213psa_status_t psa_driver_wrapper_aead_decrypt(
214 const psa_key_attributes_t *attributes,
215 const uint8_t *key_buffer, size_t key_buffer_size,
216 psa_algorithm_t alg,
217 const uint8_t *nonce, size_t nonce_length,
218 const uint8_t *additional_data, size_t additional_data_length,
219 const uint8_t *ciphertext, size_t ciphertext_length,
220 uint8_t *plaintext, size_t plaintext_size, size_t *plaintext_length );
221
Steven Cooremand13a70f2021-03-19 15:24:23 +0100222/*
223 * MAC functions
224 */
225psa_status_t psa_driver_wrapper_mac_compute(
226 const psa_key_attributes_t *attributes,
227 const uint8_t *key_buffer,
228 size_t key_buffer_size,
229 psa_algorithm_t alg,
230 const uint8_t *input,
231 size_t input_length,
232 uint8_t *mac,
233 size_t mac_size,
234 size_t *mac_length );
235
236psa_status_t psa_driver_wrapper_mac_sign_setup(
237 psa_mac_operation_t *operation,
238 const psa_key_attributes_t *attributes,
239 const uint8_t *key_buffer,
240 size_t key_buffer_size,
241 psa_algorithm_t alg );
242
243psa_status_t psa_driver_wrapper_mac_verify_setup(
244 psa_mac_operation_t *operation,
245 const psa_key_attributes_t *attributes,
246 const uint8_t *key_buffer,
247 size_t key_buffer_size,
248 psa_algorithm_t alg );
249
250psa_status_t psa_driver_wrapper_mac_update(
251 psa_mac_operation_t *operation,
252 const uint8_t *input,
253 size_t input_length );
254
255psa_status_t psa_driver_wrapper_mac_sign_finish(
256 psa_mac_operation_t *operation,
257 uint8_t *mac,
258 size_t mac_size,
259 size_t *mac_length );
260
261psa_status_t psa_driver_wrapper_mac_verify_finish(
262 psa_mac_operation_t *operation,
263 const uint8_t *mac,
264 size_t mac_length );
265
266psa_status_t psa_driver_wrapper_mac_abort(
267 psa_mac_operation_t *operation );
268
Steven Cooremancd84cb42020-07-16 20:28:36 +0200269#endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */
270
271/* End of automatically generated file. */