1/* BEGIN_HEADER */
2
3#include <mbedtls/constant_time.h>
4#include <mbedtls/md.h>
5#include <constant_time_internal.h>
6#include "mbedtls/psa_util.h"
7#include <ssl_misc.h>
8
9#include <test/constant_flow.h>
10/* END_HEADER */
11
12/* BEGIN_CASE depends_on:MBEDTLS_SSL_SOME_SUITES_USE_MAC:MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC:MBEDTLS_TEST_HOOKS */
13void ssl_cf_hmac(int hash)
14{
15    /*
16     * Test the function mbedtls_ct_hmac() against a reference
17     * implementation.
18     */
19#if defined(MBEDTLS_USE_PSA_CRYPTO)
20    mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
21    psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
22    psa_algorithm_t alg;
23    psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
24#else
25    mbedtls_md_context_t ctx, ref_ctx;
26    const mbedtls_md_info_t *md_info;
27#endif /* MBEDTLS_USE_PSA_CRYPTO */
28    size_t out_len, block_size;
29    size_t min_in_len, in_len, max_in_len, i;
30    /* TLS additional data is 13 bytes (hence the "lucky 13" name) */
31    unsigned char add_data[13];
32    unsigned char ref_out[MBEDTLS_MD_MAX_SIZE];
33    unsigned char *data = NULL;
34    unsigned char *out = NULL;
35    unsigned char rec_num = 0;
36
37    USE_PSA_INIT();
38
39#if defined(MBEDTLS_USE_PSA_CRYPTO)
40    alg = PSA_ALG_HMAC(mbedtls_md_psa_alg_from_type(hash));
41
42    out_len = PSA_HASH_LENGTH(alg);
43    block_size = PSA_HASH_BLOCK_LENGTH(alg);
44
45    /* mbedtls_ct_hmac() requires the key to be exportable */
46    psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
47                            PSA_KEY_USAGE_VERIFY_HASH);
48    psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
49    psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
50#else
51    mbedtls_md_init(&ctx);
52    mbedtls_md_init(&ref_ctx);
53
54    md_info = mbedtls_md_info_from_type(hash);
55    TEST_ASSERT(md_info != NULL);
56    out_len = mbedtls_md_get_size(md_info);
57    TEST_ASSERT(out_len != 0);
58    block_size = hash == MBEDTLS_MD_SHA384 ? 128 : 64;
59#endif /* MBEDTLS_USE_PSA_CRYPTO */
60
61    /* Use allocated out buffer to catch overwrites */
62    TEST_CALLOC(out, out_len);
63
64#if defined(MBEDTLS_USE_PSA_CRYPTO)
65    /* Set up dummy key */
66    memset(ref_out, 42, sizeof(ref_out));
67    TEST_EQUAL(PSA_SUCCESS, psa_import_key(&attributes,
68                                           ref_out, out_len,
69                                           &key));
70#else
71    /* Set up contexts with the given hash and a dummy key */
72    TEST_EQUAL(0, mbedtls_md_setup(&ctx, md_info, 1));
73    TEST_EQUAL(0, mbedtls_md_setup(&ref_ctx, md_info, 1));
74    memset(ref_out, 42, sizeof(ref_out));
75    TEST_EQUAL(0, mbedtls_md_hmac_starts(&ctx, ref_out, out_len));
76    TEST_EQUAL(0, mbedtls_md_hmac_starts(&ref_ctx, ref_out, out_len));
77    memset(ref_out, 0, sizeof(ref_out));
78#endif
79
80    /*
81     * Test all possible lengths up to a point. The difference between
82     * max_in_len and min_in_len is at most 255, and make sure they both vary
83     * by at least one block size.
84     */
85    for (max_in_len = 0; max_in_len <= 255 + block_size; max_in_len++) {
86        mbedtls_test_set_step(max_in_len * 10000);
87
88        /* Use allocated in buffer to catch overreads */
89        TEST_CALLOC(data, max_in_len);
90
91        min_in_len = max_in_len > 255 ? max_in_len - 255 : 0;
92        for (in_len = min_in_len; in_len <= max_in_len; in_len++) {
93            mbedtls_test_set_step(max_in_len * 10000 + in_len);
94
95            /* Set up dummy data and add_data */
96            rec_num++;
97            memset(add_data, rec_num, sizeof(add_data));
98            for (i = 0; i < in_len; i++) {
99                data[i] = (i & 0xff) ^ rec_num;
100            }
101
102            /* Get the function's result */
103            TEST_CF_SECRET(&in_len, sizeof(in_len));
104#if defined(MBEDTLS_USE_PSA_CRYPTO)
105            TEST_EQUAL(0, mbedtls_ct_hmac(key, PSA_ALG_HMAC(alg),
106                                          add_data, sizeof(add_data),
107                                          data, in_len,
108                                          min_in_len, max_in_len,
109                                          out));
110#else
111            TEST_EQUAL(0, mbedtls_ct_hmac(&ctx, add_data, sizeof(add_data),
112                                          data, in_len,
113                                          min_in_len, max_in_len,
114                                          out));
115#endif /* MBEDTLS_USE_PSA_CRYPTO */
116            TEST_CF_PUBLIC(&in_len, sizeof(in_len));
117            TEST_CF_PUBLIC(out, out_len);
118
119#if defined(MBEDTLS_USE_PSA_CRYPTO)
120            TEST_EQUAL(PSA_SUCCESS, psa_mac_verify_setup(&operation,
121                                                         key, alg));
122            TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data,
123                                                   sizeof(add_data)));
124            TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
125                                                   data, in_len));
126            TEST_EQUAL(PSA_SUCCESS, psa_mac_verify_finish(&operation,
127                                                          out, out_len));
128#else
129            /* Compute the reference result */
130            TEST_EQUAL(0, mbedtls_md_hmac_update(&ref_ctx, add_data,
131                                                 sizeof(add_data)));
132            TEST_EQUAL(0, mbedtls_md_hmac_update(&ref_ctx, data, in_len));
133            TEST_EQUAL(0, mbedtls_md_hmac_finish(&ref_ctx, ref_out));
134            TEST_EQUAL(0, mbedtls_md_hmac_reset(&ref_ctx));
135
136            /* Compare */
137            TEST_MEMORY_COMPARE(out, out_len, ref_out, out_len);
138#endif /* MBEDTLS_USE_PSA_CRYPTO */
139        }
140
141        mbedtls_free(data);
142        data = NULL;
143    }
144
145exit:
146#if defined(MBEDTLS_USE_PSA_CRYPTO)
147    psa_mac_abort(&operation);
148    psa_destroy_key(key);
149#else
150    mbedtls_md_free(&ref_ctx);
151    mbedtls_md_free(&ctx);
152#endif /* MBEDTLS_USE_PSA_CRYPTO */
153
154    mbedtls_free(data);
155    mbedtls_free(out);
156
157    USE_PSA_DONE();
158}
159/* END_CASE */
160