Bug 6322 - Implementation of SHA1 in Asterisk (plus dialplan function to use it)
[asterisk/asterisk.git] / sha1.c
1 /*\r
2  *\r
3  * Based on the RFC 3174\r
4  * \r
5  * Full Copyright Statement\r
6  *\r
7  *  Copyright (C) The Internet Society (2001).  All Rights Reserved.\r
8  *\r
9  *  This document and translations of it may be copied and furnished to\r
10  *  others, and derivative works that comment on or otherwise explain it\r
11  *  or assist in its implementation may be prepared, copied, published\r
12  *  and distributed, in whole or in part, without restriction of any\r
13  *  kind, provided that the above copyright notice and this paragraph are\r
14  *  included on all such copies and derivative works.  However, this\r
15  *  document itself may not be modified in any way, such as by removing\r
16  *  the copyright notice or references to the Internet Society or other\r
17  *  Internet organizations, except as needed for the purpose of\r
18  *  developing Internet standards in which case the procedures for\r
19  *  copyrights defined in the Internet Standards process must be\r
20  *  followed, or as required to translate it into languages other than\r
21  *  English.\r
22  *\r
23  *  The limited permissions granted above are perpetual and will not be\r
24  *  revoked by the Internet Society or its successors or assigns.\r
25 \r
26  *  This document and the information contained herein is provided on an\r
27  *  "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING\r
28  *  TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING\r
29  *  BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION\r
30  *  HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF\r
31  *  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.\r
32  *\r
33  *\r
34  * \r
35  *  Description:\r
36  *        This file implements the Secure Hashing Algorithm 1 as\r
37  *        defined in FIPS PUB 180-1 published April 17, 1995.\r
38  *\r
39  *        The SHA-1, produces a 160-bit message digest for a given\r
40  *        data stream.  It should take about 2**n steps to find a\r
41  *        message with the same digest as a given message and\r
42  *        2**(n/2) to find any two messages with the same digest,\r
43  *        when n is the digest size in bits.  Therefore, this\r
44  *        algorithm can serve as a means of providing a\r
45  *        "fingerprint" for a message.\r
46  *\r
47  *  Portability Issues:\r
48  *        SHA-1 is defined in terms of 32-bit "words".  This code\r
49  *        uses <stdint.h> (included via "sha1.h" to define 32 and 8\r
50  *        bit unsigned integer types.  If your C compiler does not\r
51  *        support 32 bit unsigned integers, this code is not\r
52  *        appropriate.\r
53  *\r
54  *  Caveats:\r
55  *        SHA-1 is designed to work with messages less than 2^64 bits\r
56  *        long.  Although SHA-1 allows a message digest to be generated\r
57  *        for messages of any number of bits less than 2^64, this\r
58  *        implementation only works with messages with a length that is\r
59  *        a multiple of the size of an 8-bit character.\r
60  *\r
61  */\r
62 \r
63 \r
64 #include "asterisk/sha1.h"\r
65 \r
66 /*\r
67  *  Define the SHA1 circular left shift macro\r
68  */\r
69 #define SHA1CircularShift(bits,word) \\r
70                          (((word) << (bits)) | ((word) >> (32-(bits))))\r
71 \r
72 /* Local Function Prototyptes */\r
73 void SHA1PadMessage(SHA1Context *);\r
74 void SHA1ProcessMessageBlock(SHA1Context *);\r
75 \r
76 /*\r
77  *  SHA1Reset\r
78  *\r
79  *  Description:\r
80  *        This function will initialize the SHA1Context in preparation\r
81  *        for computing a new SHA1 message digest.\r
82  *\r
83  *  Parameters:\r
84  *        context: [in/out]\r
85  *                 The context to reset.\r
86  *\r
87  *  Returns:\r
88  *        sha Error Code.\r
89  *\r
90  */\r
91 int SHA1Reset(SHA1Context *context)\r
92 {\r
93         if (!context)\r
94         {\r
95                  return shaNull;\r
96         }\r
97 \r
98         context->Length_Low               = 0;\r
99         context->Length_High             = 0;\r
100         context->Message_Block_Index     = 0;\r
101 \r
102         context->Intermediate_Hash[0]   = 0x67452301;\r
103         context->Intermediate_Hash[1]   = 0xEFCDAB89;\r
104         context->Intermediate_Hash[2]   = 0x98BADCFE;\r
105         context->Intermediate_Hash[3]   = 0x10325476;\r
106         context->Intermediate_Hash[4]   = 0xC3D2E1F0;\r
107 \r
108         context->Computed       = 0;\r
109         context->Corrupted  = 0;\r
110 \r
111         return shaSuccess;\r
112 }\r
113 \r
114 /*\r
115  *  SHA1Result\r
116  *\r
117  *  Description:\r
118  *        This function will return the 160-bit message digest into the\r
119  *        Message_Digest array  provided by the caller.\r
120  *        NOTE: The first octet of hash is stored in the 0th element,\r
121  *                   the last octet of hash in the 19th element.\r
122  *\r
123  *  Parameters:\r
124  *        context: [in/out]\r
125  *                 The context to use to calculate the SHA-1 hash.\r
126  *        Message_Digest: [out]\r
127  *                 Where the digest is returned.\r
128  *\r
129  *  Returns:\r
130  *        sha Error Code.\r
131  *\r
132  */\r
133 int SHA1Result( SHA1Context *context,\r
134                          uint8_t Message_Digest[SHA1HashSize])\r
135 {\r
136         int i;\r
137 \r
138         if (!context || !Message_Digest)\r
139         {\r
140                  return shaNull;\r
141         }\r
142 \r
143         if (context->Corrupted)\r
144         {\r
145                  return context->Corrupted;\r
146         }\r
147 \r
148         if (!context->Computed)\r
149         {\r
150                  SHA1PadMessage(context);\r
151                  for(i=0; i<64; ++i)\r
152                  {\r
153                      /* message may be sensitive, clear it out */\r
154                      context->Message_Block[i] = 0;\r
155                  }\r
156                  context->Length_Low = 0;    /* and clear length */\r
157                  context->Length_High = 0;\r
158                  context->Computed = 1;\r
159 \r
160         }\r
161 \r
162         for(i = 0; i < SHA1HashSize; ++i)\r
163         {\r
164                  Message_Digest[i] = context->Intermediate_Hash[i>>2]\r
165                                      >> 8 * ( 3 - ( i & 0x03 ) );\r
166         }\r
167 \r
168         return shaSuccess;\r
169 }\r
170 \r
171 /*\r
172  *  SHA1Input\r
173  *\r
174  *  Description:\r
175  *        This function accepts an array of octets as the next portion\r
176  *        of the message.\r
177  *\r
178  *  Parameters:\r
179  *        context: [in/out]\r
180  *                 The SHA context to update\r
181  *        message_array: [in]\r
182  *                 An array of characters representing the next portion of\r
183  *                 the message.\r
184  *        length: [in]\r
185  *                 The length of the message in message_array\r
186  *\r
187  *  Returns:\r
188  *        sha Error Code.\r
189  *\r
190  */\r
191 int SHA1Input(  SHA1Context      *context,\r
192                            const uint8_t  *message_array,\r
193                            unsigned       length)\r
194 {\r
195         if (!length)\r
196         {\r
197                  return shaSuccess;\r
198         }\r
199 \r
200         if (!context || !message_array)\r
201         {\r
202                  return shaNull;\r
203         }\r
204 \r
205         if (context->Computed)\r
206         {\r
207                  context->Corrupted = shaStateError;\r
208                  return shaStateError;\r
209         }\r
210 \r
211         if (context->Corrupted)\r
212         {\r
213                   return context->Corrupted;\r
214         }\r
215         while(length-- && !context->Corrupted)\r
216         {\r
217         context->Message_Block[context->Message_Block_Index++] =\r
218                              (*message_array & 0xFF);\r
219 \r
220         context->Length_Low += 8;\r
221         if (context->Length_Low == 0)\r
222         {\r
223                  context->Length_High++;\r
224                  if (context->Length_High == 0)\r
225                  {\r
226                      /* Message is too long */\r
227                      context->Corrupted = 1;\r
228                  }\r
229         }\r
230 \r
231         if (context->Message_Block_Index == 64)\r
232         {\r
233                  SHA1ProcessMessageBlock(context);\r
234         }\r
235 \r
236         message_array++;\r
237         }\r
238 \r
239         return shaSuccess;\r
240 }\r
241 \r
242 /*\r
243  *  SHA1ProcessMessageBlock\r
244  *\r
245  *  Description:\r
246  *        This function will process the next 512 bits of the message\r
247  *        stored in the Message_Block array.\r
248  *\r
249  *  Parameters:\r
250  *        None.\r
251  *\r
252  *  Returns:\r
253  *        Nothing.\r
254  *\r
255  *  Comments:\r
256  *        Many of the variable names in this code, especially the\r
257  *        single character names, were used because those were the\r
258  *        names used in the publication.\r
259  *\r
260  *\r
261  */\r
262 void SHA1ProcessMessageBlock(SHA1Context *context)\r
263 {\r
264         const uint32_t K[] =     {       /* Constants defined in SHA-1   */\r
265                                      0x5A827999,\r
266                                      0x6ED9EBA1,\r
267                                      0x8F1BBCDC,\r
268                                      0xCA62C1D6\r
269                                      };\r
270         int             t;                 /* Loop counter                */\r
271         uint32_t           temp;              /* Temporary word value        */\r
272         uint32_t           W[80];             /* Word sequence               */\r
273         uint32_t           A, B, C, D, E;     /* Word buffers                */\r
274 \r
275         /*\r
276          *  Initialize the first 16 words in the array W\r
277          */\r
278         for(t = 0; t < 16; t++)\r
279         {\r
280                  W[t] = context->Message_Block[t * 4] << 24;\r
281                  W[t] |= context->Message_Block[t * 4 + 1] << 16;\r
282                  W[t] |= context->Message_Block[t * 4 + 2] << 8;\r
283                  W[t] |= context->Message_Block[t * 4 + 3];\r
284         }\r
285 \r
286         for(t = 16; t < 80; t++)\r
287         {\r
288                 W[t] = SHA1CircularShift(1,W[t-3] ^ W[t-8] ^ W[t-14] ^ W[t-16]);\r
289         }\r
290 \r
291         A = context->Intermediate_Hash[0];\r
292         B = context->Intermediate_Hash[1];\r
293         C = context->Intermediate_Hash[2];\r
294         D = context->Intermediate_Hash[3];\r
295         E = context->Intermediate_Hash[4];\r
296 \r
297         for(t = 0; t < 20; t++)\r
298         {\r
299                  temp =  SHA1CircularShift(5,A) +\r
300                          ((B & C) | ((~B) & D)) + E + W[t] + K[0];\r
301                  E = D;\r
302                  D = C;\r
303                  C = SHA1CircularShift(30,B);\r
304                  B = A;\r
305                  A = temp;\r
306         }\r
307 \r
308         for(t = 20; t < 40; t++)\r
309         {\r
310                  temp = SHA1CircularShift(5,A) + (B ^ C ^ D) + E + W[t] + K[1];\r
311                  E = D;\r
312                  D = C;\r
313                  C = SHA1CircularShift(30,B);\r
314                  B = A;\r
315                  A = temp;\r
316         }\r
317 \r
318         for(t = 40; t < 60; t++)\r
319         {\r
320                  temp = SHA1CircularShift(5,A) +\r
321                         ((B & C) | (B & D) | (C & D)) + E + W[t] + K[2];\r
322                  E = D;\r
323                  D = C;\r
324                  C = SHA1CircularShift(30,B);\r
325                  B = A;\r
326                  A = temp;\r
327         }\r
328 \r
329         for(t = 60; t < 80; t++)\r
330         {\r
331                  temp = SHA1CircularShift(5,A) + (B ^ C ^ D) + E + W[t] + K[3];\r
332                  E = D;\r
333                  D = C;\r
334                  C = SHA1CircularShift(30,B);\r
335                  B = A;\r
336                  A = temp;\r
337         }\r
338 \r
339         context->Intermediate_Hash[0] += A;\r
340         context->Intermediate_Hash[1] += B;\r
341         context->Intermediate_Hash[2] += C;\r
342         context->Intermediate_Hash[3] += D;\r
343         context->Intermediate_Hash[4] += E;\r
344 \r
345         context->Message_Block_Index = 0;\r
346 }\r
347 \r
348 \r
349 /*\r
350  *  SHA1PadMessage\r
351  *\r
352  *  Description:\r
353  *        According to the standard, the message must be padded to an even\r
354  *        512 bits.  The first padding bit must be a '1'.  The last 64\r
355  *        bits represent the length of the original message.  All bits in\r
356  *        between should be 0.  This function will pad the message\r
357  *        according to those rules by filling the Message_Block array\r
358  *        accordingly.  It will also call the ProcessMessageBlock function\r
359  *        provided appropriately.  When it returns, it can be assumed that\r
360  *        the message digest has been computed.\r
361  *\r
362  *  Parameters:\r
363  *        context: [in/out]\r
364  *                 The context to pad\r
365  *        ProcessMessageBlock: [in]\r
366  *                 The appropriate SHA*ProcessMessageBlock function\r
367  *  Returns:\r
368  *        Nothing.\r
369  *\r
370  */\r
371 \r
372 void SHA1PadMessage(SHA1Context *context)\r
373 {\r
374         /*\r
375          *  Check to see if the current message block is too small to hold\r
376          *  the initial padding bits and length.  If so, we will pad the\r
377          *  block, process it, and then continue padding into a second\r
378          *  block.\r
379          */\r
380         if (context->Message_Block_Index > 55)\r
381         {\r
382                  context->Message_Block[context->Message_Block_Index++] = 0x80;\r
383                  while(context->Message_Block_Index < 64)\r
384                  {\r
385                      context->Message_Block[context->Message_Block_Index++] = 0;\r
386                  }\r
387 \r
388                  SHA1ProcessMessageBlock(context);\r
389 \r
390                  while(context->Message_Block_Index < 56)\r
391                  {\r
392                      context->Message_Block[context->Message_Block_Index++] = 0;\r
393                  }\r
394         }\r
395         else\r
396         {\r
397                  context->Message_Block[context->Message_Block_Index++] = 0x80;\r
398                  while(context->Message_Block_Index < 56)\r
399                  {\r
400                      context->Message_Block[context->Message_Block_Index++] = 0;\r
401                  }\r
402         }\r
403 \r
404         /*\r
405          *  Store the message length as the last 8 octets\r
406          */\r
407         context->Message_Block[56] = context->Length_High >> 24;\r
408         context->Message_Block[57] = context->Length_High >> 16;\r
409         context->Message_Block[58] = context->Length_High >> 8;\r
410         context->Message_Block[59] = context->Length_High;\r
411         context->Message_Block[60] = context->Length_Low >> 24;\r
412         context->Message_Block[61] = context->Length_Low >> 16;\r
413         context->Message_Block[62] = context->Length_Low >> 8;\r
414         context->Message_Block[63] = context->Length_Low;\r
415 \r
416         SHA1ProcessMessageBlock(context);\r
417 }\r