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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present 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
**************************************************************************/
/**************************************************************************/
/*
Copyright (C) The Internet Society (2001). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an
""AS IS"" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
*/
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** SHA1 Digest Algorithm (SHA1) */
/** */
/**************************************************************************/
/**************************************************************************/
#include "nx_api.h"
#include "nx_sha1.h"
/* Define macros for the SHA1 transform function. */
/* Define the SHA1 basic F1, F2, F3, and F4 functions. */
#define F1(x, y, z) (((x) & (y)) | ((~x) & (z)))
#define F2(x, y, z) ((x) ^ (y) ^ (z))
#define F3(x, y, z) (((x) & (y)) | ((x) & (z)) | ((y) & (z)))
#define F4(x, y, z) ((x) ^ (y) ^ (z))
/* Define the SHA1 left shift circular function. */
#define LEFT_SHIFT_CIRCULAR(x, n) (((x) << (n)) | ((x) >> (32-(n))))
/* Define the padding array. This is used to pad the message such that its length is
64 bits shy of being a multiple of 512 bits long. */
static UCHAR _nx_sha1_padding[64] = {0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_sha1_initialize PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the SHA1 context. It must be called prior */
/* to creating the SHA1 digest. */
/* */
/* INPUT */
/* */
/* context SHA1 context pointer */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* NetX Applications */
/* */
/**************************************************************************/
UINT _nx_sha1_initialize(NX_SHA1 *context)
{
/* Determine if the context is non-null. */
if (context == NX_NULL)
return(NX_PTR_ERROR);
/* First, clear the bit count for this context. */
context -> nx_sha1_bit_count[0] = 0; /* Clear the lower 32-bits of the count */
context -> nx_sha1_bit_count[1] = 0; /* Clear the upper 32-bits of the count */
/* Finally, setup the context states. */
context -> nx_sha1_states[0] = 0x67452301UL; /* Setup state A */
context -> nx_sha1_states[1] = 0xEFCDAB89UL; /* Setup state B */
context -> nx_sha1_states[2] = 0x98BADCFEUL; /* Setup state C */
context -> nx_sha1_states[3] = 0x10325476UL; /* Setup state D */
context -> nx_sha1_states[4] = 0xC3D2E1F0UL; /* Setup state E */
/* Return success. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_sha1_update PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the digest calculation with new input from */
/* the caller. */
/* */
/* INPUT */
/* */
/* context SHA1 context pointer */
/* input_ptr Pointer to byte(s) of input */
/* input_length Length of bytes of input */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_sha1_process_buffer Process complete buffer, */
/* which is 64-bytes in size */
/* */
/* CALLED BY */
/* */
/* NetX Applications */
/* */
/**************************************************************************/
UINT _nx_sha1_update(NX_SHA1 *context, UCHAR *input_ptr, UINT input_length)
{
ULONG current_bytes;
ULONG needed_fill_bytes;
/* Determine if the context is non-null. */
if (context == NX_NULL)
return(NX_PTR_ERROR);
/* Determine if there is a length. */
if (input_length == 0)
return(NX_SUCCESS);
/* Calculate the current byte count mod 64. Note the reason for the
shift by 3 is to account for the 8 bits per byte. */
current_bytes = (context -> nx_sha1_bit_count[0] >> 3) & 0x3F;
/* Calculate the current number of bytes needed to be filled. */
needed_fill_bytes = 64 - current_bytes;
/* Update the total bit count based on the input length. */
context -> nx_sha1_bit_count[0] += (input_length << 3);
/* Determine if there is roll-over of the bit count into the MSW. */
if (context -> nx_sha1_bit_count[0] < (input_length << 3))
{
/* Yes, increment the MSW of the bit count. */
context -> nx_sha1_bit_count[1]++;
}
/* Update upper total bit count word. */
context -> nx_sha1_bit_count[1] += (input_length >> 29);
/* Check for a partial buffer that needs to be transformed. */
if ((current_bytes) && (input_length >= needed_fill_bytes))
{
/* Yes, we can complete the buffer and transform it. */
/* Copy the appropriate portion of the input buffer into the internal
buffer of the context. */
memcpy((void *) &(context -> nx_sha1_buffer[current_bytes]), (void *) input_ptr, needed_fill_bytes); /* Use case of memcpy is verified. */
/* Process the 64-byte (512 bit) buffer. */
_nx_sha1_process_buffer(context, context -> nx_sha1_buffer);
/* Adjust the pointers and length accordingly. */
input_length = input_length - needed_fill_bytes;
input_ptr = input_ptr + needed_fill_bytes;
/* Clear the remaining bits, since the buffer was processed. */
current_bytes = 0;
}
/* Process any and all whole blocks of input. */
while (input_length >= 64)
{
/* Process this 64-byte (512 bit) buffer. */
_nx_sha1_process_buffer(context, input_ptr);
/* Adjust the pointers and length accordingly. */
input_length = input_length - 64;
input_ptr = input_ptr + 64;
}
/* Determine if there is anything left. */
if (input_length)
{
/* Save the remaining bytes in the internal buffer after any remaining bytes
that it is processed later. */
memcpy((void *) &(context -> nx_sha1_buffer[current_bytes]), (void *) input_ptr, input_length); /* Use case of memcpy is verified. */
}
/* Return success. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_sha1_digest_calculate PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function finishes calculation of the SHA1 digest. It is called */
/* where there is no further input needed for the digest. The resulting*/
/* 20-byte (160-bit) SHA1 digest is returned to the caller. */
/* */
/* INPUT */
/* */
/* context SHA1 context pointer */
/* digest Pointer to return digest in */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_sha1_update Update the digest with padding*/
/* and length of digest */
/* */
/* CALLED BY */
/* */
/* NetX Applications */
/* */
/**************************************************************************/
UINT _nx_sha1_digest_calculate(NX_SHA1 *context, UCHAR digest[20])
{
UCHAR bit_count_string[8];
ULONG current_byte_count;
ULONG padding_bytes;
/* Move the lower portion of the bit count into the array. */
bit_count_string[0] = (UCHAR) (context -> nx_sha1_bit_count[1] >> 24);
bit_count_string[1] = (UCHAR) (context -> nx_sha1_bit_count[1] >> 16);
bit_count_string[2] = (UCHAR) (context -> nx_sha1_bit_count[1] >> 8);
bit_count_string[3] = (UCHAR) (context -> nx_sha1_bit_count[1]);
bit_count_string[4] = (UCHAR) (context -> nx_sha1_bit_count[0] >> 24);
bit_count_string[5] = (UCHAR) (context -> nx_sha1_bit_count[0] >> 16);
bit_count_string[6] = (UCHAR) (context -> nx_sha1_bit_count[0] >> 8);
bit_count_string[7] = (UCHAR) (context -> nx_sha1_bit_count[0]);
/* Calculate the current byte count. */
current_byte_count = (context -> nx_sha1_bit_count[0] >> 3) & 0x3F;
/* Calculate the padding bytes needed. */
padding_bytes = (current_byte_count < 56) ? (56 - current_byte_count) : (120 - current_byte_count);
/* Add any padding required. */
_nx_sha1_update(context, _nx_sha1_padding, padding_bytes);
/* Add the in the length. */
_nx_sha1_update(context, bit_count_string, 8);
/* Now store the digest in the caller specified destination. */
digest[ 0] = (UCHAR) (context -> nx_sha1_states[0] >> 24);
digest[ 1] = (UCHAR) (context -> nx_sha1_states[0] >> 16);
digest[ 2] = (UCHAR) (context -> nx_sha1_states[0] >> 8);
digest[ 3] = (UCHAR) (context -> nx_sha1_states[0]);
digest[ 4] = (UCHAR) (context -> nx_sha1_states[1] >> 24);
digest[ 5] = (UCHAR) (context -> nx_sha1_states[1] >> 16);
digest[ 6] = (UCHAR) (context -> nx_sha1_states[1] >> 8);
digest[ 7] = (UCHAR) (context -> nx_sha1_states[1]);
digest[ 8] = (UCHAR) (context -> nx_sha1_states[2] >> 24);
digest[ 9] = (UCHAR) (context -> nx_sha1_states[2] >> 16);
digest[10] = (UCHAR) (context -> nx_sha1_states[2] >> 8);
digest[11] = (UCHAR) (context -> nx_sha1_states[2]);
digest[12] = (UCHAR) (context -> nx_sha1_states[3] >> 24);
digest[13] = (UCHAR) (context -> nx_sha1_states[3] >> 16);
digest[14] = (UCHAR) (context -> nx_sha1_states[3] >> 8);
digest[15] = (UCHAR) (context -> nx_sha1_states[3]);
digest[16] = (UCHAR) (context -> nx_sha1_states[4] >> 24);
digest[17] = (UCHAR) (context -> nx_sha1_states[4] >> 16);
digest[18] = (UCHAR) (context -> nx_sha1_states[4] >> 8);
digest[19] = (UCHAR) (context -> nx_sha1_states[4]);
/* Return successful completion. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_sha1_process_buffer PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function actually uses the SHA1 algorithm to process a 64-byte */
/* (512 bit) buffer. */
/* */
/* INPUT */
/* */
/* context SHA1 context pointer */
/* buffer Pointer to 64-byte buffer */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* NetX Applications */
/* */
/**************************************************************************/
VOID _nx_sha1_process_buffer(NX_SHA1 *context, UCHAR buffer[64])
{
ULONG *w;
UINT t;
ULONG temp;
ULONG a, b, c, d, e;
/* Setup pointers to the word array. */
w = context -> nx_sha1_word_array;
/* Initialize the first 16 words of the word array, taking care of the
endian issues at the same time. */
for (t = 0; t < 16; t++)
{
/* Setup each entry. */
w[t] = (((ULONG) buffer[t * 4]) << 24) | (((ULONG) buffer[(t * 4) + 1]) << 16) | (((ULONG) buffer[(t * 4) + 2]) << 8) | ((ULONG) buffer[(t * 4) + 3]);
}
/* Setup the remaining entries of the word array. */
for (t = 16; t < 80; t++)
{
/* Setup each entry. */
w[t] = LEFT_SHIFT_CIRCULAR((w[t-3] ^ w[t-8] ^ w[t-14] ^ w[t-16]), 1);
}
/* Initialize the state variables. */
a = context -> nx_sha1_states[0];
b = context -> nx_sha1_states[1];
c = context -> nx_sha1_states[2];
d = context -> nx_sha1_states[3];
e = context -> nx_sha1_states[4];
/* Now, perform Round 1 operations. */
for (t = 0; t < 20; t++)
{
/* Compute round 1 (t = 0 through t = 19). */
temp = LEFT_SHIFT_CIRCULAR(a, 5) + F1(b, c, d) + e + w[t] + 0x5A827999UL;
e = d;
d = c;
c = LEFT_SHIFT_CIRCULAR(b, 30);
b = a;
a = temp;
}
/* Now, perform Round 2 operations. */
for (t = 20; t < 40; t++)
{
/* Compute round 2 (t = 20 through t = 39). */
temp = LEFT_SHIFT_CIRCULAR(a, 5) + F2(b, c, d) + e + w[t] + 0x6ED9EBA1UL;
e = d;
d = c;
c = LEFT_SHIFT_CIRCULAR(b, 30);
b = a;
a = temp;
}
/* Now, perform Round 3 operations. */
for (t = 40; t < 60; t++)
{
/* Compute round 3 (t = 40 through t = 59). */
temp = LEFT_SHIFT_CIRCULAR(a, 5) + F3(b, c, d) + e + w[t] + 0x8F1BBCDCUL;
e = d;
d = c;
c = LEFT_SHIFT_CIRCULAR(b, 30);
b = a;
a = temp;
}
/* Finally, perform Round 4 operations. */
for (t = 60; t < 80; t++)
{
/* Compute round 4 (t = 60 through t = 79). */
temp = LEFT_SHIFT_CIRCULAR(a, 5) + F4(b, c, d) + e + w[t] + 0xCA62C1D6UL;
e = d;
d = c;
c = LEFT_SHIFT_CIRCULAR(b, 30);
b = a;
a = temp;
}
/* Save the resulting in this SHA1 context. */
context -> nx_sha1_states[0] += a;
context -> nx_sha1_states[1] += b;
context -> nx_sha1_states[2] += c;
context -> nx_sha1_states[3] += d;
context -> nx_sha1_states[4] += e;
}
|
