Update from 0.9.8 stable. Eliminate duplicate error codes.
[openssl.git] / crypto / md32_common.h
1 /* crypto/md32_common.h */
2 /* ====================================================================
3  * Copyright (c) 1999-2006 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    licensing@OpenSSL.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  */
51
52 /*
53  * This is a generic 32 bit "collector" for message digest algorithms.
54  * Whenever needed it collects input character stream into chunks of
55  * 32 bit values and invokes a block function that performs actual hash
56  * calculations.
57  *
58  * Porting guide.
59  *
60  * Obligatory macros:
61  *
62  * DATA_ORDER_IS_BIG_ENDIAN or DATA_ORDER_IS_LITTLE_ENDIAN
63  *      this macro defines byte order of input stream.
64  * HASH_CBLOCK
65  *      size of a unit chunk HASH_BLOCK operates on.
66  * HASH_LONG
67  *      has to be at lest 32 bit wide, if it's wider, then
68  *      HASH_LONG_LOG2 *has to* be defined along
69  * HASH_CTX
70  *      context structure that at least contains following
71  *      members:
72  *              typedef struct {
73  *                      ...
74  *                      HASH_LONG       Nl,Nh;
75  *                      either {
76  *                      HASH_LONG       data[HASH_LBLOCK];
77  *                      unsigned char   data[HASH_CBLOCK];
78  *                      };
79  *                      unsigned int    num;
80  *                      ...
81  *                      } HASH_CTX;
82  *      data[] vector is expected to be zeroed upon first call to
83  *      HASH_UPDATE.
84  * HASH_UPDATE
85  *      name of "Update" function, implemented here.
86  * HASH_TRANSFORM
87  *      name of "Transform" function, implemented here.
88  * HASH_FINAL
89  *      name of "Final" function, implemented here.
90  * HASH_BLOCK_DATA_ORDER
91  *      name of "block" function capable of treating *unaligned* input
92  *      message in original (data) byte order, implemented externally.
93  * HASH_MAKE_STRING
94  *      macro convering context variables to an ASCII hash string.
95  *
96  * MD5 example:
97  *
98  *      #define DATA_ORDER_IS_LITTLE_ENDIAN
99  *
100  *      #define HASH_LONG               MD5_LONG
101  *      #define HASH_LONG_LOG2          MD5_LONG_LOG2
102  *      #define HASH_CTX                MD5_CTX
103  *      #define HASH_CBLOCK             MD5_CBLOCK
104  *      #define HASH_UPDATE             MD5_Update
105  *      #define HASH_TRANSFORM          MD5_Transform
106  *      #define HASH_FINAL              MD5_Final
107  *      #define HASH_BLOCK_DATA_ORDER   md5_block_data_order
108  *
109  *                                      <appro@fy.chalmers.se>
110  */
111
112 #if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
113 #error "DATA_ORDER must be defined!"
114 #endif
115
116 #ifndef HASH_CBLOCK
117 #error "HASH_CBLOCK must be defined!"
118 #endif
119 #ifndef HASH_LONG
120 #error "HASH_LONG must be defined!"
121 #endif
122 #ifndef HASH_CTX
123 #error "HASH_CTX must be defined!"
124 #endif
125
126 #ifndef HASH_UPDATE
127 #error "HASH_UPDATE must be defined!"
128 #endif
129 #ifndef HASH_TRANSFORM
130 #error "HASH_TRANSFORM must be defined!"
131 #endif
132 #ifndef HASH_FINAL
133 #error "HASH_FINAL must be defined!"
134 #endif
135
136 #ifndef HASH_BLOCK_DATA_ORDER
137 #error "HASH_BLOCK_DATA_ORDER must be defined!"
138 #endif
139
140 /*
141  * Engage compiler specific rotate intrinsic function if available.
142  */
143 #undef ROTATE
144 #ifndef PEDANTIC
145 # if defined(_MSC_VER) || defined(__ICC)
146 #  define ROTATE(a,n)   _lrotl(a,n)
147 # elif defined(__MWERKS__)
148 #  if defined(__POWERPC__)
149 #   define ROTATE(a,n)  __rlwinm(a,n,0,31)
150 #  elif defined(__MC68K__)
151     /* Motorola specific tweak. <appro@fy.chalmers.se> */
152 #   define ROTATE(a,n)  ( n<24 ? __rol(a,n) : __ror(a,32-n) )
153 #  else
154 #   define ROTATE(a,n)  __rol(a,n)
155 #  endif
156 # elif defined(__GNUC__) && __GNUC__>=2 && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
157   /*
158    * Some GNU C inline assembler templates. Note that these are
159    * rotates by *constant* number of bits! But that's exactly
160    * what we need here...
161    *                                    <appro@fy.chalmers.se>
162    */
163 #  if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
164 #   define ROTATE(a,n)  ({ register unsigned int ret;   \
165                                 asm (                   \
166                                 "roll %1,%0"            \
167                                 : "=r"(ret)             \
168                                 : "I"(n), "0"(a)        \
169                                 : "cc");                \
170                            ret;                         \
171                         })
172 #  elif defined(_ARCH_PPC) || defined(_ARCH_PPC64) || \
173         defined(__powerpc) || defined(__ppc__) || defined(__powerpc64__)
174 #   define ROTATE(a,n)  ({ register unsigned int ret;   \
175                                 asm (                   \
176                                 "rlwinm %0,%1,%2,0,31"  \
177                                 : "=r"(ret)             \
178                                 : "r"(a), "I"(n));      \
179                            ret;                         \
180                         })
181 #  endif
182 # endif
183 #endif /* PEDANTIC */
184
185 #ifndef ROTATE
186 #define ROTATE(a,n)     (((a)<<(n))|(((a)&0xffffffff)>>(32-(n))))
187 #endif
188
189 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
190
191 #ifndef PEDANTIC
192 # if defined(__GNUC__) && __GNUC__>=2 && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
193 #  if ((defined(__i386) || defined(__i386__)) && !defined(I386_ONLY)) || \
194       (defined(__x86_64) || defined(__x86_64__))
195 #   if !defined(B_ENDIAN)
196     /*
197      * This gives ~30-40% performance improvement in SHA-256 compiled
198      * with gcc [on P4]. Well, first macro to be frank. We can pull
199      * this trick on x86* platforms only, because these CPUs can fetch
200      * unaligned data without raising an exception.
201      */
202 #   define HOST_c2l(c,l)        ({ unsigned int r=*((const unsigned int *)(c)); \
203                                    asm ("bswapl %0":"=r"(r):"0"(r));    \
204                                    (c)+=4; (l)=r;                       })
205 #   define HOST_l2c(l,c)        ({ unsigned int r=(l);                  \
206                                    asm ("bswapl %0":"=r"(r):"0"(r));    \
207                                    *((unsigned int *)(c))=r; (c)+=4; r; })
208 #   endif
209 #  endif
210 # endif
211 #endif
212
213 #ifndef HOST_c2l
214 #define HOST_c2l(c,l)   (l =(((unsigned long)(*((c)++)))<<24),          \
215                          l|=(((unsigned long)(*((c)++)))<<16),          \
216                          l|=(((unsigned long)(*((c)++)))<< 8),          \
217                          l|=(((unsigned long)(*((c)++)))    ),          \
218                          l)
219 #endif
220 #ifndef HOST_l2c
221 #define HOST_l2c(l,c)   (*((c)++)=(unsigned char)(((l)>>24)&0xff),      \
222                          *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
223                          *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
224                          *((c)++)=(unsigned char)(((l)    )&0xff),      \
225                          l)
226 #endif
227
228 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
229
230 #if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
231 # ifndef B_ENDIAN
232    /* See comment in DATA_ORDER_IS_BIG_ENDIAN section. */
233 #  define HOST_c2l(c,l) ((l)=*((const unsigned int *)(c)), (c)+=4, l)
234 #  define HOST_l2c(l,c) (*((unsigned int *)(c))=(l), (c)+=4, l)
235 # endif
236 #endif
237
238 #ifndef HOST_c2l
239 #define HOST_c2l(c,l)   (l =(((unsigned long)(*((c)++)))    ),          \
240                          l|=(((unsigned long)(*((c)++)))<< 8),          \
241                          l|=(((unsigned long)(*((c)++)))<<16),          \
242                          l|=(((unsigned long)(*((c)++)))<<24),          \
243                          l)
244 #endif
245 #ifndef HOST_l2c
246 #define HOST_l2c(l,c)   (*((c)++)=(unsigned char)(((l)    )&0xff),      \
247                          *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
248                          *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
249                          *((c)++)=(unsigned char)(((l)>>24)&0xff),      \
250                          l)
251 #endif
252
253 #endif
254
255 /*
256  * Time for some action:-)
257  */
258
259 int HASH_UPDATE (HASH_CTX *c, const void *data_, size_t len)
260         {
261         const unsigned char *data=data_;
262         unsigned char *p;
263         HASH_LONG l;
264         size_t n;
265
266         if (len==0) return 1;
267
268         l=(c->Nl+(((HASH_LONG)len)<<3))&0xffffffffUL;
269         /* 95-05-24 eay Fixed a bug with the overflow handling, thanks to
270          * Wei Dai <weidai@eskimo.com> for pointing it out. */
271         if (l < c->Nl) /* overflow */
272                 c->Nh++;
273         c->Nh+=(len>>29);       /* might cause compiler warning on 16-bit */
274         c->Nl=l;
275
276         n = c->num;
277         if (n != 0)
278                 {
279                 p=(unsigned char *)c->data;
280
281                 if ((n+len) >= HASH_CBLOCK)
282                         {
283                         memcpy (p+n,data,HASH_CBLOCK-n);
284                         HASH_BLOCK_DATA_ORDER (c,p,1);
285                         n      = HASH_CBLOCK-n;
286                         data  += n;
287                         len   -= n;
288                         c->num = 0;
289                         memset (p,0,HASH_CBLOCK);       /* keep it zeroed */
290                         }
291                 else
292                         {
293                         memcpy (p+n,data,len);
294                         c->num += (unsigned int)len;
295                         return 1;
296                         }
297                 }
298
299         n = len/HASH_CBLOCK;
300         if (n > 0)
301                 {
302                 HASH_BLOCK_DATA_ORDER (c,data,n);
303                 n    *= HASH_CBLOCK;
304                 data += n;
305                 len  -= n;
306                 }
307
308         if (len != 0)
309                 {
310                 p = (unsigned char *)c->data;
311                 c->num = len;
312                 memcpy (p,data,len);
313                 }
314         return 1;
315         }
316
317
318 void HASH_TRANSFORM (HASH_CTX *c, const unsigned char *data)
319         {
320         HASH_BLOCK_DATA_ORDER (c,data,1);
321         }
322
323
324 int HASH_FINAL (unsigned char *md, HASH_CTX *c)
325         {
326         unsigned char *p = (unsigned char *)c->data;
327         size_t n = c->num;
328
329         p[n] = 0x80; /* there is always room for one */
330         n++;
331
332         if (n > (HASH_CBLOCK-8))
333                 {
334                 HASH_BLOCK_DATA_ORDER (c,p,1);
335                 memset (p,0,HASH_CBLOCK);
336                 }
337
338         p += HASH_CBLOCK-8;
339 #if   defined(DATA_ORDER_IS_BIG_ENDIAN)
340         (void)HOST_l2c(c->Nh,p);
341         (void)HOST_l2c(c->Nl,p);
342 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
343         (void)HOST_l2c(c->Nl,p);
344         (void)HOST_l2c(c->Nh,p);
345 #endif
346         p -= HASH_CBLOCK;
347         HASH_BLOCK_DATA_ORDER (c,p,1);
348         c->num=0;
349         memset (p,0,HASH_CBLOCK);
350
351 #ifndef HASH_MAKE_STRING
352 #error "HASH_MAKE_STRING must be defined!"
353 #else
354         HASH_MAKE_STRING(c,md);
355 #endif
356
357         return 1;
358         }
359
360 #ifndef MD32_REG_T
361 #define MD32_REG_T long
362 /*
363  * This comment was originaly written for MD5, which is why it
364  * discusses A-D. But it basically applies to all 32-bit digests,
365  * which is why it was moved to common header file.
366  *
367  * In case you wonder why A-D are declared as long and not
368  * as MD5_LONG. Doing so results in slight performance
369  * boost on LP64 architectures. The catch is we don't
370  * really care if 32 MSBs of a 64-bit register get polluted
371  * with eventual overflows as we *save* only 32 LSBs in
372  * *either* case. Now declaring 'em long excuses the compiler
373  * from keeping 32 MSBs zeroed resulting in 13% performance
374  * improvement under SPARC Solaris7/64 and 5% under AlphaLinux.
375  * Well, to be honest it should say that this *prevents* 
376  * performance degradation.
377  *                              <appro@fy.chalmers.se>
378  * Apparently there're LP64 compilers that generate better
379  * code if A-D are declared int. Most notably GCC-x86_64
380  * generates better code.
381  *                              <appro@fy.chalmers.se>
382  */
383 #endif