summaryrefslogtreecommitdiff
path: root/test/regression/nx_secure_test/nx_secure_hmac_sha256_test.c
blob: 24653d63f6f6f8949710ee715dd4b657bc4a85fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation                                */
/* Copyright (c) 2026 Eclipse ThreadX contributors                         */
/*                                                                         */
/* This program and the accompanying materials are made available under    */
/* the terms of the MIT License which is available at                      */
/* https://opensource.org/licenses/MIT.                                    */
/*                                                                         */
/* SPDX-License-Identifier: MIT                                            */
/***************************************************************************/


#include <stdio.h>
#include "nx_crypto_hmac_sha2.h"

#include "tls_test_utility.h"

#define MAXIMUM_PLAIN_BYTES 256

#include "nx_secure_hmac_sha256_test_data.c"

/* Define software SHA256 method. */
static NX_CRYPTO_METHOD test_crypto_method_hmac_sha256 =
{
    NX_CRYPTO_AUTHENTICATION_HMAC_SHA2_256,   /* SHA crypto algorithm                   */
    0,                                        /* Key size in bits                       */
    0,                                        /* IV size in bits                        */
    256,                                      /* ICV size in bits, not used.            */
    0,                                        /* Block size in bytes.                   */
    sizeof(NX_SHA256_HMAC),                   /* Metadata size in bytes                 */
    NX_CRYPTO_NULL,                           /* SHA initialization routine.            */
    NX_CRYPTO_NULL,                           /* SHA cleanup routine, not used.         */
    _nx_crypto_method_hmac_sha256_operation,  /* SHA operation                          */
};

/* SHA context. */
static NX_SHA256_HMAC hmac_sha256_ctx;

/* Output. */
static ULONG output[8];

#ifndef NX_CRYPTO_STANDALONE_ENABLE
static TX_THREAD thread_0;
#endif

static VOID thread_0_entry(ULONG thread_input);

#ifdef CTEST
void test_application_define(void *first_unused_memory);
void test_application_define(void *first_unused_memory)
#else
void nx_secure_hmac_sha256_test_application_define(void *first_unused_memory)
#endif
{
#ifndef NX_CRYPTO_STANDALONE_ENABLE
    tx_thread_create(&thread_0, "Thread 0", thread_0_entry, 0,
                     first_unused_memory, 4096,
                     16, 16, 4, TX_AUTO_START);
#else
    thread_0_entry(0);
#endif
}

static VOID thread_0_entry(ULONG thread_input)
{
UINT i, status, backup;
NX_CRYPTO_METHOD test_method;

    /* Print out test information banner.  */
    printf("NetX Secure Test:   HMAC SHA256 Test...................................");

    for (i = 0; i < sizeof(hmac_sha256_data) / sizeof(HMAC_SHA256_DATA); i++)
    {

        /* Authentication. */
        memset(output, 0xFF, sizeof(output));

        test_crypto_method_hmac_sha256.nx_crypto_operation(NX_CRYPTO_AUTHENTICATE,
                                                           NX_CRYPTO_NULL,
                                                           &test_crypto_method_hmac_sha256,
                                                           hmac_sha256_data[i].key,
                                                           (hmac_sha256_data[i].key_len << 3),
                                                           hmac_sha256_data[i].plain,
                                                           hmac_sha256_data[i].plain_len,
                                                           NX_CRYPTO_NULL,
                                                           (UCHAR *)output,
                                                           sizeof(output),
                                                           &hmac_sha256_ctx,
                                                           sizeof(hmac_sha256_ctx),
                                                           NX_CRYPTO_NULL, NX_CRYPTO_NULL);

        EXPECT_EQ(0, memcmp(output, hmac_sha256_data[i].secret, sizeof(output)));

        memset(output, 0xFF, sizeof(output));

        /* Test HMAC SHA256 with Initialize, Update and Calculate operation.  */
        test_crypto_method_hmac_sha256.nx_crypto_operation(NX_CRYPTO_HASH_INITIALIZE,
                                                           NX_CRYPTO_NULL,
                                                           &test_crypto_method_hmac_sha256,
                                                           hmac_sha256_data[i].key,
                                                           (hmac_sha256_data[i].key_len << 3),
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           NX_CRYPTO_NULL,
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           &hmac_sha256_ctx,
                                                           sizeof(hmac_sha256_ctx),
                                                           NX_CRYPTO_NULL, NX_CRYPTO_NULL);

        test_crypto_method_hmac_sha256.nx_crypto_operation(NX_CRYPTO_HASH_UPDATE,
                                                           NX_CRYPTO_NULL,
                                                           &test_crypto_method_hmac_sha256,
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           hmac_sha256_data[i].plain,
                                                           hmac_sha256_data[i].plain_len,
                                                           NX_CRYPTO_NULL,
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           &hmac_sha256_ctx,
                                                           sizeof(hmac_sha256_ctx),
                                                           NX_CRYPTO_NULL, NX_CRYPTO_NULL);

        test_crypto_method_hmac_sha256.nx_crypto_operation(NX_CRYPTO_HASH_CALCULATE,
                                                           NX_CRYPTO_NULL,
                                                           &test_crypto_method_hmac_sha256,
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           NX_CRYPTO_NULL,
                                                           0,
                                                           NX_CRYPTO_NULL,
                                                           (UCHAR *)output,
                                                           sizeof(output),
                                                           &hmac_sha256_ctx,
                                                           sizeof(hmac_sha256_ctx),
                                                           NX_CRYPTO_NULL, NX_CRYPTO_NULL);

        EXPECT_EQ(0, memcmp(output, hmac_sha256_data[i].secret, sizeof(output)));
    }

    /* NULL method pointer. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     NX_CRYPTO_NULL, 0, /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* NULL metadata pointer. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     NX_CRYPTO_NULL, 0, /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Metadata address is not 4-byte aligned. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     (VOID *)0x03, 0, /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Metadata size is not enough. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, 0, /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* NULL key pointer. */
    status = _nx_crypto_method_hmac_sha256_operation(NX_CRYPTO_HASH_INITIALIZE, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, sizeof(hmac_sha256_ctx), /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Output buffer size is not enough. */
    status = _nx_crypto_method_hmac_sha256_operation(NX_CRYPTO_HASH_CALCULATE, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, sizeof(hmac_sha256_ctx), /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_INVALID_BUFFER_SIZE, status);

    /* NULL key pointer. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, sizeof(hmac_sha256_ctx), /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Output buffer size is not enough. */
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     (VOID *)0x04, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, sizeof(hmac_sha256_ctx), /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_INVALID_BUFFER_SIZE, status);

    /* Invalid algorithm id. */
    test_crypto_method_hmac_sha256.nx_crypto_algorithm = 0;
    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     &test_crypto_method_hmac_sha256, /* method */
                                                     (VOID *)0x04, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     &hmac_sha256_ctx, sizeof(hmac_sha256_ctx), /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_NOT_SUCCESSFUL, status);

    /* NULL method pointer. */
    status = _nx_crypto_method_hmac_sha256_init(NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0, NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* NULL key pointer. */
    status = _nx_crypto_method_hmac_sha256_init(&test_crypto_method_hmac_sha256, NX_CRYPTO_NULL, 0, NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* NULL metadata pointer. */
    status = _nx_crypto_method_hmac_sha256_init(&test_crypto_method_hmac_sha256, (VOID *)0x04, 0, NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Metadata address is not 4-byte aligned. */
    status = _nx_crypto_method_hmac_sha256_init(&test_crypto_method_hmac_sha256, (VOID *)0x04, 0, NX_CRYPTO_NULL, (VOID *)0x03, 0);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* Metadata size is not enough. */
    status = _nx_crypto_method_hmac_sha256_init(&test_crypto_method_hmac_sha256, (VOID *)0x04, 0, NX_CRYPTO_NULL, (VOID *)0x04, 0);
    EXPECT_EQ(NX_CRYPTO_PTR_ERROR, status);

    /* NULL metadata pointer. */
    status = _nx_crypto_method_hmac_sha256_cleanup(NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_SUCCESS, status);

/* For NX_CRYPTO_STATE_CHECK. */
#ifdef NX_CRYPTO_SELF_TEST
    backup = _nx_crypto_library_state;
    _nx_crypto_library_state = 0;

    status = _nx_crypto_method_hmac_sha256_init(NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0, NX_CRYPTO_NULL, NX_CRYPTO_NULL, 0);
    EXPECT_EQ(NX_CRYPTO_INVALID_LIBRARY, status);

    status = _nx_crypto_method_hmac_sha256_cleanup(NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_INVALID_LIBRARY, status);

    status = _nx_crypto_method_hmac_sha256_operation(0, NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, /* method */
                                                     NX_CRYPTO_NULL, 0, /* key */
                                                     NX_CRYPTO_NULL, 0, /* input */
                                                     NX_CRYPTO_NULL,
                                                     NX_CRYPTO_NULL, 0, /* output */
                                                     NX_CRYPTO_NULL, 0, /* metadata */
                                                     NX_CRYPTO_NULL, NX_CRYPTO_NULL);
    EXPECT_EQ(NX_CRYPTO_INVALID_LIBRARY, status);

    _nx_crypto_library_state = backup;
#endif /* NX_CRYPTO_SELF_TEST */

    printf("SUCCESS!\n");
    test_control_return(0);
}