1 /*
2  * Test driver for cipher functions
3  */
4 /*  Copyright The Mbed TLS Contributors
5  *  SPDX-License-Identifier: Apache-2.0
6  *
7  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
8  *  not use this file except in compliance with the License.
9  *  You may obtain a copy of the License at
10  *
11  *  http://www.apache.org/licenses/LICENSE-2.0
12  *
13  *  Unless required by applicable law or agreed to in writing, software
14  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  *  See the License for the specific language governing permissions and
17  *  limitations under the License.
18  */
19 
20 #ifndef PSA_CRYPTO_TEST_DRIVERS_CIPHER_H
21 #define PSA_CRYPTO_TEST_DRIVERS_CIPHER_H
22 
23 #include "mbedtls/build_info.h"
24 
25 #if defined(PSA_CRYPTO_DRIVER_TEST)
26 #include <psa/crypto_driver_common.h>
27 #include <psa/crypto.h>
28 
29 #include "mbedtls/cipher.h"
30 
31 typedef struct {
32     /* If non-null, on success, copy this to the output. */
33     void *forced_output;
34     size_t forced_output_length;
35     /* If not PSA_SUCCESS, return this error code instead of processing the
36      * function call. */
37     psa_status_t forced_status;
38     /* Count the amount of times one of the cipher driver functions is called. */
39     unsigned long hits;
40 } mbedtls_test_driver_cipher_hooks_t;
41 
42 #define MBEDTLS_TEST_DRIVER_CIPHER_INIT { NULL, 0, PSA_SUCCESS, 0 }
43 static inline mbedtls_test_driver_cipher_hooks_t
mbedtls_test_driver_cipher_hooks_init(void)44      mbedtls_test_driver_cipher_hooks_init( void )
45 {
46     const mbedtls_test_driver_cipher_hooks_t v = MBEDTLS_TEST_DRIVER_CIPHER_INIT;
47     return( v );
48 }
49 
50 extern mbedtls_test_driver_cipher_hooks_t mbedtls_test_driver_cipher_hooks;
51 
52 psa_status_t mbedtls_test_transparent_cipher_encrypt(
53     const psa_key_attributes_t *attributes,
54     const uint8_t *key, size_t key_length,
55     psa_algorithm_t alg,
56     const uint8_t *input, size_t input_length,
57     uint8_t *output, size_t output_size, size_t *output_length);
58 
59 psa_status_t mbedtls_test_transparent_cipher_decrypt(
60     const psa_key_attributes_t *attributes,
61     const uint8_t *key, size_t key_length,
62     psa_algorithm_t alg,
63     const uint8_t *input, size_t input_length,
64     uint8_t *output, size_t output_size, size_t *output_length);
65 
66 psa_status_t mbedtls_test_transparent_cipher_encrypt_setup(
67     mbedtls_transparent_test_driver_cipher_operation_t *operation,
68     const psa_key_attributes_t *attributes,
69     const uint8_t *key, size_t key_length,
70     psa_algorithm_t alg);
71 
72 psa_status_t mbedtls_test_transparent_cipher_decrypt_setup(
73     mbedtls_transparent_test_driver_cipher_operation_t *operation,
74     const psa_key_attributes_t *attributes,
75     const uint8_t *key, size_t key_length,
76     psa_algorithm_t alg);
77 
78 psa_status_t mbedtls_test_transparent_cipher_abort(
79     mbedtls_transparent_test_driver_cipher_operation_t *operation );
80 
81 psa_status_t mbedtls_test_transparent_cipher_set_iv(
82     mbedtls_transparent_test_driver_cipher_operation_t *operation,
83     const uint8_t *iv, size_t iv_length);
84 
85 psa_status_t mbedtls_test_transparent_cipher_update(
86     mbedtls_transparent_test_driver_cipher_operation_t *operation,
87     const uint8_t *input, size_t input_length,
88     uint8_t *output, size_t output_size, size_t *output_length);
89 
90 psa_status_t mbedtls_test_transparent_cipher_finish(
91     mbedtls_transparent_test_driver_cipher_operation_t *operation,
92     uint8_t *output, size_t output_size, size_t *output_length);
93 
94 /*
95  * opaque versions
96  */
97 psa_status_t mbedtls_test_opaque_cipher_encrypt(
98     const psa_key_attributes_t *attributes,
99     const uint8_t *key, size_t key_length,
100     psa_algorithm_t alg,
101     const uint8_t *input, size_t input_length,
102     uint8_t *output, size_t output_size, size_t *output_length);
103 
104 psa_status_t mbedtls_test_opaque_cipher_decrypt(
105     const psa_key_attributes_t *attributes,
106     const uint8_t *key, size_t key_length,
107     psa_algorithm_t alg,
108     const uint8_t *input, size_t input_length,
109     uint8_t *output, size_t output_size, size_t *output_length);
110 
111 psa_status_t mbedtls_test_opaque_cipher_encrypt_setup(
112     mbedtls_opaque_test_driver_cipher_operation_t *operation,
113     const psa_key_attributes_t *attributes,
114     const uint8_t *key, size_t key_length,
115     psa_algorithm_t alg);
116 
117 psa_status_t mbedtls_test_opaque_cipher_decrypt_setup(
118     mbedtls_opaque_test_driver_cipher_operation_t *operation,
119     const psa_key_attributes_t *attributes,
120     const uint8_t *key, size_t key_length,
121     psa_algorithm_t alg);
122 
123 psa_status_t mbedtls_test_opaque_cipher_abort(
124     mbedtls_opaque_test_driver_cipher_operation_t *operation);
125 
126 psa_status_t mbedtls_test_opaque_cipher_set_iv(
127     mbedtls_opaque_test_driver_cipher_operation_t *operation,
128     const uint8_t *iv, size_t iv_length);
129 
130 psa_status_t mbedtls_test_opaque_cipher_update(
131     mbedtls_opaque_test_driver_cipher_operation_t *operation,
132     const uint8_t *input, size_t input_length,
133     uint8_t *output, size_t output_size, size_t *output_length);
134 
135 psa_status_t mbedtls_test_opaque_cipher_finish(
136     mbedtls_opaque_test_driver_cipher_operation_t *operation,
137     uint8_t *output, size_t output_size, size_t *output_length);
138 
139 #endif /* PSA_CRYPTO_DRIVER_TEST */
140 #endif /* PSA_CRYPTO_TEST_DRIVERS_CIPHER_H */
141