Steven Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Function signatures for functionality that can be provided by |
| 3 | * cryptographic accelerators. |
Steven Cooreman | 56250fd | 2020-09-04 13:07:15 +0200 | [diff] [blame] | 4 | * Warning: This file will be auto-generated in the future. |
Steven Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 5 | */ |
Steven Cooreman | 2c7b2f8 | 2020-09-02 13:43:46 +0200 | [diff] [blame] | 6 | /* Copyright The Mbed TLS Contributors |
Steven Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 7 | * 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 Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 20 | */ |
| 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 Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 28 | /* |
Ronald Cron | 9ba7691 | 2021-04-10 16:57:30 +0200 | [diff] [blame^] | 29 | * Initialization and termination functions |
| 30 | */ |
| 31 | psa_status_t psa_driver_wrapper_init( void ); |
| 32 | void psa_driver_wrapper_free( void ); |
| 33 | |
| 34 | /* |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 35 | * Signature functions |
| 36 | */ |
gabor-mezei-arm | 50eac35 | 2021-04-22 11:32:19 +0200 | [diff] [blame] | 37 | psa_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 | |
| 48 | psa_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 Cron | 9f17aa4 | 2020-12-08 17:07:25 +0100 | [diff] [blame] | 58 | psa_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 Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 63 | |
Ronald Cron | 9f17aa4 | 2020-12-08 17:07:25 +0100 | [diff] [blame] | 64 | psa_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 Cooreman | 55ae217 | 2020-07-17 19:46:15 +0200 | [diff] [blame] | 69 | |
Steven Cooreman | 0452476 | 2020-10-13 17:43:44 +0200 | [diff] [blame] | 70 | /* |
| 71 | * Key handling functions |
| 72 | */ |
| 73 | |
Ronald Cron | 8328287 | 2020-11-22 14:02:39 +0100 | [diff] [blame] | 74 | psa_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 Cooreman | 0452476 | 2020-10-13 17:43:44 +0200 | [diff] [blame] | 79 | |
Ronald Cron | 6722798 | 2020-11-26 15:16:05 +0100 | [diff] [blame] | 80 | psa_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 Cron | 84cc994 | 2020-11-25 14:30:05 +0100 | [diff] [blame] | 85 | psa_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 Cron | 9df74be | 2020-12-05 19:15:23 +0100 | [diff] [blame] | 90 | psa_status_t psa_driver_wrapper_get_key_buffer_size( |
| 91 | const psa_key_attributes_t *attributes, |
| 92 | size_t *key_buffer_size ); |
| 93 | |
Archana | d8a83dc | 2021-06-14 10:04:16 +0530 | [diff] [blame] | 94 | psa_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 Cron | 84cc994 | 2020-11-25 14:30:05 +0100 | [diff] [blame] | 100 | psa_status_t psa_driver_wrapper_generate_key( |
| 101 | const psa_key_attributes_t *attributes, |
Ronald Cron | 977c247 | 2020-10-13 08:32:21 +0200 | [diff] [blame] | 102 | uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length ); |
Steven Cooreman | b9b8442 | 2020-10-14 14:39:20 +0200 | [diff] [blame] | 103 | |
Steven Cooreman | 6801f08 | 2021-02-19 17:21:22 +0100 | [diff] [blame] | 104 | psa_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 | |
Archana | 8a18036 | 2021-07-05 02:18:48 +0530 | [diff] [blame] | 109 | psa_status_t psa_driver_wrapper_copy_key( |
| 110 | psa_key_attributes_t *attributes, |
Archana | 9d17bf4 | 2021-09-10 06:22:44 +0530 | [diff] [blame] | 111 | const uint8_t *source_key, size_t source_key_length, |
Archana | 449608b | 2021-09-08 15:36:05 +0530 | [diff] [blame] | 112 | uint8_t *target_key_buffer, size_t target_key_buffer_size, |
| 113 | size_t *target_key_buffer_length ); |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 114 | /* |
| 115 | * Cipher functions |
| 116 | */ |
| 117 | psa_status_t psa_driver_wrapper_cipher_encrypt( |
gabor-mezei-arm | a9449a0 | 2021-03-25 11:17:10 +0100 | [diff] [blame] | 118 | const psa_key_attributes_t *attributes, |
| 119 | const uint8_t *key_buffer, |
| 120 | size_t key_buffer_size, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 121 | 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 | |
| 128 | psa_status_t psa_driver_wrapper_cipher_decrypt( |
gabor-mezei-arm | a9449a0 | 2021-03-25 11:17:10 +0100 | [diff] [blame] | 129 | const psa_key_attributes_t *attributes, |
| 130 | const uint8_t *key_buffer, |
| 131 | size_t key_buffer_size, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 132 | 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 | |
| 139 | psa_status_t psa_driver_wrapper_cipher_encrypt_setup( |
Ronald Cron | a4af55f | 2020-12-14 14:36:06 +0100 | [diff] [blame] | 140 | psa_cipher_operation_t *operation, |
| 141 | const psa_key_attributes_t *attributes, |
| 142 | const uint8_t *key_buffer, size_t key_buffer_size, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 143 | psa_algorithm_t alg ); |
| 144 | |
| 145 | psa_status_t psa_driver_wrapper_cipher_decrypt_setup( |
Ronald Cron | a4af55f | 2020-12-14 14:36:06 +0100 | [diff] [blame] | 146 | psa_cipher_operation_t *operation, |
| 147 | const psa_key_attributes_t *attributes, |
| 148 | const uint8_t *key_buffer, size_t key_buffer_size, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 149 | psa_algorithm_t alg ); |
| 150 | |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 151 | psa_status_t psa_driver_wrapper_cipher_set_iv( |
Ronald Cron | 6056fe8 | 2020-12-15 13:58:07 +0100 | [diff] [blame] | 152 | psa_cipher_operation_t *operation, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 153 | const uint8_t *iv, |
| 154 | size_t iv_length ); |
| 155 | |
| 156 | psa_status_t psa_driver_wrapper_cipher_update( |
Ronald Cron | 6056fe8 | 2020-12-15 13:58:07 +0100 | [diff] [blame] | 157 | psa_cipher_operation_t *operation, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 158 | const uint8_t *input, |
| 159 | size_t input_length, |
| 160 | uint8_t *output, |
| 161 | size_t output_size, |
| 162 | size_t *output_length ); |
| 163 | |
| 164 | psa_status_t psa_driver_wrapper_cipher_finish( |
Ronald Cron | 6056fe8 | 2020-12-15 13:58:07 +0100 | [diff] [blame] | 165 | psa_cipher_operation_t *operation, |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 166 | uint8_t *output, |
| 167 | size_t output_size, |
| 168 | size_t *output_length ); |
| 169 | |
| 170 | psa_status_t psa_driver_wrapper_cipher_abort( |
Ronald Cron | 6056fe8 | 2020-12-15 13:58:07 +0100 | [diff] [blame] | 171 | psa_cipher_operation_t *operation ); |
Steven Cooreman | 37941cb | 2020-07-28 18:49:51 +0200 | [diff] [blame] | 172 | |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 173 | /* |
| 174 | * Hashing functions |
| 175 | */ |
| 176 | psa_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 | |
| 184 | psa_status_t psa_driver_wrapper_hash_setup( |
Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 185 | psa_hash_operation_t *operation, |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 186 | psa_algorithm_t alg ); |
| 187 | |
| 188 | psa_status_t psa_driver_wrapper_hash_clone( |
Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 189 | const psa_hash_operation_t *source_operation, |
| 190 | psa_hash_operation_t *target_operation ); |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 191 | |
| 192 | psa_status_t psa_driver_wrapper_hash_update( |
Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 193 | psa_hash_operation_t *operation, |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 194 | const uint8_t *input, |
| 195 | size_t input_length ); |
| 196 | |
| 197 | psa_status_t psa_driver_wrapper_hash_finish( |
Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 198 | psa_hash_operation_t *operation, |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 199 | uint8_t *hash, |
| 200 | size_t hash_size, |
| 201 | size_t *hash_length ); |
| 202 | |
| 203 | psa_status_t psa_driver_wrapper_hash_abort( |
Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 204 | psa_hash_operation_t *operation ); |
Steven Cooreman | 1e58235 | 2021-02-18 17:24:37 +0100 | [diff] [blame] | 205 | |
Ronald Cron | de82281 | 2021-03-17 16:08:20 +0100 | [diff] [blame] | 206 | /* |
| 207 | * AEAD functions |
| 208 | */ |
| 209 | |
| 210 | psa_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 | |
| 219 | psa_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 Elliott | 6504aa6 | 2021-04-20 17:09:36 +0100 | [diff] [blame] | 228 | psa_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 | |
| 234 | psa_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 Elliott | 6504aa6 | 2021-04-20 17:09:36 +0100 | [diff] [blame] | 240 | psa_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 | |
| 245 | psa_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 | |
| 250 | psa_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 | |
| 255 | psa_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 | |
| 263 | psa_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 | |
| 272 | psa_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 | |
| 280 | psa_status_t psa_driver_wrapper_aead_abort( |
| 281 | psa_aead_operation_t *operation ); |
| 282 | |
Steven Cooreman | d13a70f | 2021-03-19 15:24:23 +0100 | [diff] [blame] | 283 | /* |
| 284 | * MAC functions |
| 285 | */ |
| 286 | psa_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 | |
| 297 | psa_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 | |
| 304 | psa_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 | |
| 311 | psa_status_t psa_driver_wrapper_mac_update( |
| 312 | psa_mac_operation_t *operation, |
| 313 | const uint8_t *input, |
| 314 | size_t input_length ); |
| 315 | |
| 316 | psa_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 | |
| 322 | psa_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 | |
| 327 | psa_status_t psa_driver_wrapper_mac_abort( |
| 328 | psa_mac_operation_t *operation ); |
| 329 | |
Steven Cooreman | cd84cb4 | 2020-07-16 20:28:36 +0200 | [diff] [blame] | 330 | #endif /* PSA_CRYPTO_DRIVER_WRAPPERS_H */ |
| 331 | |
| 332 | /* End of automatically generated file. */ |