1 /** \file psa_crypto_helpers.c
2 *
3 * \brief Helper functions to test PSA crypto functionality.
4 */
5
6 /*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22
23 #include <test/helpers.h>
24 #include <test/macros.h>
25 #include <psa_crypto_slot_management.h>
26 #include <test/psa_crypto_helpers.h>
27
28 #if defined(MBEDTLS_PSA_CRYPTO_C)
29
30 #include <psa/crypto.h>
31
32 #if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
33
34 #include <psa_crypto_storage.h>
35
36 static mbedtls_svc_key_id_t key_ids_used_in_test[9];
37 static size_t num_key_ids_used;
38
mbedtls_test_uses_key_id(mbedtls_svc_key_id_t key_id)39 int mbedtls_test_uses_key_id( mbedtls_svc_key_id_t key_id )
40 {
41 size_t i;
42 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key_id ) >
43 PSA_MAX_PERSISTENT_KEY_IDENTIFIER )
44 {
45 /* Don't touch key id values that designate non-key files. */
46 return( 1 );
47 }
48 for( i = 0; i < num_key_ids_used ; i++ )
49 {
50 if( mbedtls_svc_key_id_equal( key_id, key_ids_used_in_test[i] ) )
51 return( 1 );
52 }
53 if( num_key_ids_used == ARRAY_LENGTH( key_ids_used_in_test ) )
54 return( 0 );
55 key_ids_used_in_test[num_key_ids_used] = key_id;
56 ++num_key_ids_used;
57 return( 1 );
58 }
59
mbedtls_test_psa_purge_key_storage(void)60 void mbedtls_test_psa_purge_key_storage( void )
61 {
62 size_t i;
63 for( i = 0; i < num_key_ids_used; i++ )
64 psa_destroy_persistent_key( key_ids_used_in_test[i] );
65 num_key_ids_used = 0;
66 }
67
mbedtls_test_psa_purge_key_cache(void)68 void mbedtls_test_psa_purge_key_cache( void )
69 {
70 size_t i;
71 for( i = 0; i < num_key_ids_used; i++ )
72 psa_purge_key( key_ids_used_in_test[i] );
73 }
74
75 #endif /* MBEDTLS_PSA_CRYPTO_STORAGE_C */
76
mbedtls_test_helper_is_psa_leaking(void)77 const char *mbedtls_test_helper_is_psa_leaking( void )
78 {
79 mbedtls_psa_stats_t stats;
80
81 mbedtls_psa_get_stats( &stats );
82
83 if( stats.volatile_slots != 0 )
84 return( "A volatile slot has not been closed properly." );
85 if( stats.persistent_slots != 0 )
86 return( "A persistent slot has not been closed properly." );
87 if( stats.external_slots != 0 )
88 return( "An external slot has not been closed properly." );
89 if( stats.half_filled_slots != 0 )
90 return( "A half-filled slot has not been cleared properly." );
91 if( stats.locked_slots != 0 )
92 return( "Some slots are still marked as locked." );
93
94 return( NULL );
95 }
96
97 #if defined(RECORD_PSA_STATUS_COVERAGE_LOG)
98 /** Name of the file where return statuses are logged by #RECORD_STATUS. */
99 #define STATUS_LOG_FILE_NAME "statuses.log"
100
mbedtls_test_record_status(psa_status_t status,const char * func,const char * file,int line,const char * expr)101 psa_status_t mbedtls_test_record_status( psa_status_t status,
102 const char *func,
103 const char *file, int line,
104 const char *expr )
105 {
106 /* We open the log file on first use.
107 * We never close the log file, so the record_status feature is not
108 * compatible with resource leak detectors such as Asan.
109 */
110 static FILE *log;
111 if( log == NULL )
112 log = fopen( STATUS_LOG_FILE_NAME, "a" );
113 fprintf( log, "%d:%s:%s:%d:%s\n", (int) status, func, file, line, expr );
114 return( status );
115 }
116 #endif /* defined(RECORD_PSA_STATUS_COVERAGE_LOG) */
117
mbedtls_test_update_key_usage_flags(psa_key_usage_t usage_flags)118 psa_key_usage_t mbedtls_test_update_key_usage_flags( psa_key_usage_t usage_flags )
119 {
120 psa_key_usage_t updated_usage = usage_flags;
121
122 if( usage_flags & PSA_KEY_USAGE_SIGN_HASH )
123 updated_usage |= PSA_KEY_USAGE_SIGN_MESSAGE;
124
125 if( usage_flags & PSA_KEY_USAGE_VERIFY_HASH )
126 updated_usage |= PSA_KEY_USAGE_VERIFY_MESSAGE;
127
128 return( updated_usage );
129 }
130
131 #endif /* MBEDTLS_PSA_CRYPTO_C */
132
