]> git.cworth.org Git - notmuch/blob - lib/libsha1.c
python: update the docstring of class Filenames
[notmuch] / lib / libsha1.c
1 /*
2  ---------------------------------------------------------------------------
3  Copyright (c) 2002, Dr Brian Gladman, Worcester, UK.   All rights reserved.
4
5  LICENSE TERMS
6
7  The free distribution and use of this software in both source and binary
8  form is allowed (with or without changes) provided that:
9
10    1. distributions of this source code include the above copyright
11       notice, this list of conditions and the following disclaimer;
12
13    2. distributions in binary form include the above copyright
14       notice, this list of conditions and the following disclaimer
15       in the documentation and/or other associated materials;
16
17    3. the copyright holder's name is not used to endorse products
18       built using this software without specific written permission.
19
20  ALTERNATIVELY, provided that this notice is retained in full, this product
21  may be distributed under the terms of the GNU General Public License (GPL),
22  in which case the provisions of the GPL apply INSTEAD OF those given above.
23
24  DISCLAIMER
25
26  This software is provided 'as is' with no explicit or implied warranties
27  in respect of its properties, including, but not limited to, correctness
28  and/or fitness for purpose.
29  ---------------------------------------------------------------------------
30  Issue Date: 01/08/2005
31
32  This is a byte oriented version of SHA1 that operates on arrays of bytes
33  stored in memory.
34 */
35
36 #include <string.h>     /* for memcpy() etc.        */
37
38 #include "libsha1.h"
39
40 #if defined(__cplusplus)
41 extern "C"
42 {
43 #endif
44
45 #define SHA1_BLOCK_SIZE  64
46
47 #define rotl32(x,n)   (((x) << n) | ((x) >> (32 - n)))
48 #define rotr32(x,n)   (((x) >> n) | ((x) << (32 - n)))
49
50 #define bswap_32(x) ((rotr32((x), 24) & 0x00ff00ff) | (rotr32((x), 8) & 0xff00ff00))
51
52 #if (PLATFORM_BYTE_ORDER == IS_LITTLE_ENDIAN)
53 #define bsw_32(p,n) \
54     { int _i = (n); while(_i--) ((uint32_t*)p)[_i] = bswap_32(((uint32_t*)p)[_i]); }
55 #else
56 #define bsw_32(p,n)
57 #endif
58
59 #define SHA1_MASK   (SHA1_BLOCK_SIZE - 1)
60
61 #if 0
62
63 #define ch(x,y,z)       (((x) & (y)) ^ (~(x) & (z)))
64 #define parity(x,y,z)   ((x) ^ (y) ^ (z))
65 #define maj(x,y,z)      (((x) & (y)) ^ ((x) & (z)) ^ ((y) & (z)))
66
67 #else   /* Discovered by Rich Schroeppel and Colin Plumb   */
68
69 #define ch(x,y,z)       ((z) ^ ((x) & ((y) ^ (z))))
70 #define parity(x,y,z)   ((x) ^ (y) ^ (z))
71 #define maj(x,y,z)      (((x) & (y)) | ((z) & ((x) ^ (y))))
72
73 #endif
74
75 /* Compile 64 bytes of hash data into SHA1 context. Note    */
76 /* that this routine assumes that the byte order in the     */
77 /* ctx->wbuf[] at this point is in such an order that low   */
78 /* address bytes in the ORIGINAL byte stream will go in     */
79 /* this buffer to the high end of 32-bit words on BOTH big  */
80 /* and little endian systems                                */
81
82 #ifdef ARRAY
83 #define q(v,n)  v[n]
84 #else
85 #define q(v,n)  v##n
86 #endif
87
88 #define one_cycle(v,a,b,c,d,e,f,k,h)            \
89     q(v,e) += rotr32(q(v,a),27) +               \
90               f(q(v,b),q(v,c),q(v,d)) + k + h;  \
91     q(v,b)  = rotr32(q(v,b), 2)
92
93 #define five_cycle(v,f,k,i)                 \
94     one_cycle(v, 0,1,2,3,4, f,k,hf(i  ));   \
95     one_cycle(v, 4,0,1,2,3, f,k,hf(i+1));   \
96     one_cycle(v, 3,4,0,1,2, f,k,hf(i+2));   \
97     one_cycle(v, 2,3,4,0,1, f,k,hf(i+3));   \
98     one_cycle(v, 1,2,3,4,0, f,k,hf(i+4))
99
100 static void sha1_compile(sha1_ctx ctx[1])
101 {   uint32_t    *w = ctx->wbuf;
102
103 #ifdef ARRAY
104     uint32_t    v[5];
105     memcpy(v, ctx->hash, 5 * sizeof(uint32_t));
106 #else
107     uint32_t    v0, v1, v2, v3, v4;
108     v0 = ctx->hash[0]; v1 = ctx->hash[1];
109     v2 = ctx->hash[2]; v3 = ctx->hash[3];
110     v4 = ctx->hash[4];
111 #endif
112
113 #define hf(i)   w[i]
114
115     five_cycle(v, ch, 0x5a827999,  0);
116     five_cycle(v, ch, 0x5a827999,  5);
117     five_cycle(v, ch, 0x5a827999, 10);
118     one_cycle(v,0,1,2,3,4, ch, 0x5a827999, hf(15)); \
119
120 #undef  hf
121 #define hf(i) (w[(i) & 15] = rotl32(                    \
122                  w[((i) + 13) & 15] ^ w[((i) + 8) & 15] \
123                ^ w[((i) +  2) & 15] ^ w[(i) & 15], 1))
124
125     one_cycle(v,4,0,1,2,3, ch, 0x5a827999, hf(16));
126     one_cycle(v,3,4,0,1,2, ch, 0x5a827999, hf(17));
127     one_cycle(v,2,3,4,0,1, ch, 0x5a827999, hf(18));
128     one_cycle(v,1,2,3,4,0, ch, 0x5a827999, hf(19));
129
130     five_cycle(v, parity, 0x6ed9eba1,  20);
131     five_cycle(v, parity, 0x6ed9eba1,  25);
132     five_cycle(v, parity, 0x6ed9eba1,  30);
133     five_cycle(v, parity, 0x6ed9eba1,  35);
134
135     five_cycle(v, maj, 0x8f1bbcdc,  40);
136     five_cycle(v, maj, 0x8f1bbcdc,  45);
137     five_cycle(v, maj, 0x8f1bbcdc,  50);
138     five_cycle(v, maj, 0x8f1bbcdc,  55);
139
140     five_cycle(v, parity, 0xca62c1d6,  60);
141     five_cycle(v, parity, 0xca62c1d6,  65);
142     five_cycle(v, parity, 0xca62c1d6,  70);
143     five_cycle(v, parity, 0xca62c1d6,  75);
144
145 #ifdef ARRAY
146     ctx->hash[0] += v[0]; ctx->hash[1] += v[1];
147     ctx->hash[2] += v[2]; ctx->hash[3] += v[3];
148     ctx->hash[4] += v[4];
149 #else
150     ctx->hash[0] += v0; ctx->hash[1] += v1;
151     ctx->hash[2] += v2; ctx->hash[3] += v3;
152     ctx->hash[4] += v4;
153 #endif
154 }
155
156 void sha1_begin(sha1_ctx ctx[1])
157 {
158     ctx->count[0] = ctx->count[1] = 0;
159     ctx->hash[0] = 0x67452301;
160     ctx->hash[1] = 0xefcdab89;
161     ctx->hash[2] = 0x98badcfe;
162     ctx->hash[3] = 0x10325476;
163     ctx->hash[4] = 0xc3d2e1f0;
164 }
165
166 /* SHA1 hash data in an array of bytes into hash buffer and */
167 /* call the hash_compile function as required.              */
168
169 void sha1_hash(const unsigned char data[], unsigned long len, sha1_ctx ctx[1])
170 {   uint32_t pos = (uint32_t)(ctx->count[0] & SHA1_MASK),
171             space = SHA1_BLOCK_SIZE - pos;
172     const unsigned char *sp = data;
173
174     if((ctx->count[0] += len) < len)
175         ++(ctx->count[1]);
176
177     while(len >= space)     /* transfer whole blocks if possible  */
178     {
179         memcpy(((unsigned char*)ctx->wbuf) + pos, sp, space);
180         sp += space; len -= space; space = SHA1_BLOCK_SIZE; pos = 0;
181         bsw_32(ctx->wbuf, SHA1_BLOCK_SIZE >> 2);
182         sha1_compile(ctx);
183     }
184
185     memcpy(((unsigned char*)ctx->wbuf) + pos, sp, len);
186 }
187
188 /* SHA1 final padding and digest calculation  */
189
190 void sha1_end(unsigned char hval[], sha1_ctx ctx[1])
191 {   uint32_t    i = (uint32_t)(ctx->count[0] & SHA1_MASK);
192
193     /* put bytes in the buffer in an order in which references to   */
194     /* 32-bit words will put bytes with lower addresses into the    */
195     /* top of 32 bit words on BOTH big and little endian machines   */
196     bsw_32(ctx->wbuf, (i + 3) >> 2);
197
198     /* we now need to mask valid bytes and add the padding which is */
199     /* a single 1 bit and as many zero bits as necessary. Note that */
200     /* we can always add the first padding byte here because the    */
201     /* buffer always has at least one empty slot                    */
202     ctx->wbuf[i >> 2] &= 0xffffff80 << 8 * (~i & 3);
203     ctx->wbuf[i >> 2] |= 0x00000080 << 8 * (~i & 3);
204
205     /* we need 9 or more empty positions, one for the padding byte  */
206     /* (above) and eight for the length count. If there is not      */
207     /* enough space, pad and empty the buffer                       */
208     if(i > SHA1_BLOCK_SIZE - 9)
209     {
210         if(i < 60) ctx->wbuf[15] = 0;
211         sha1_compile(ctx);
212         i = 0;
213     }
214     else    /* compute a word index for the empty buffer positions  */
215         i = (i >> 2) + 1;
216
217     while(i < 14) /* and zero pad all but last two positions        */
218         ctx->wbuf[i++] = 0;
219
220     /* the following 32-bit length fields are assembled in the      */
221     /* wrong byte order on little endian machines but this is       */
222     /* corrected later since they are only ever used as 32-bit      */
223     /* word values.                                                 */
224     ctx->wbuf[14] = (ctx->count[1] << 3) | (ctx->count[0] >> 29);
225     ctx->wbuf[15] = ctx->count[0] << 3;
226     sha1_compile(ctx);
227
228     /* extract the hash value as bytes in case the hash buffer is   */
229     /* misaligned for 32-bit words                                  */
230     for(i = 0; i < SHA1_DIGEST_SIZE; ++i)
231         hval[i] = (unsigned char)(ctx->hash[i >> 2] >> (8 * (~i & 3)));
232 }
233
234 void sha1(unsigned char hval[], const unsigned char data[], unsigned long len)
235 {   sha1_ctx    cx[1];
236
237     sha1_begin(cx); sha1_hash(data, len, cx); sha1_end(hval, cx);
238 }
239
240 #if defined(__cplusplus)
241 }
242 #endif