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