mark all block comments that need format preserving so that
[openssl.git] / crypto / des / des_locl.h
1 /* crypto/des/des_locl.h */
2 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_DES_LOCL_H
60 #define HEADER_DES_LOCL_H
61
62 #include <openssl/e_os2.h>
63
64 #if defined(OPENSSL_SYS_WIN32)
65 #ifndef OPENSSL_SYS_MSDOS
66 #define OPENSSL_SYS_MSDOS
67 #endif
68 #endif
69
70 #include <stdio.h>
71 #include <stdlib.h>
72
73 #ifndef OPENSSL_SYS_MSDOS
74 #if !defined(OPENSSL_SYS_VMS) || defined(__DECC)
75 #ifdef OPENSSL_UNISTD
76 # include OPENSSL_UNISTD
77 #else
78 # include <unistd.h>
79 #endif
80 #include <math.h>
81 #endif
82 #endif
83 #include <openssl/des.h>
84
85 #ifdef OPENSSL_SYS_MSDOS                /* Visual C++ 2.1 (Windows NT/95) */
86 #include <stdlib.h>
87 #include <errno.h>
88 #include <time.h>
89 #include <io.h>
90 #endif
91
92 #if defined(__STDC__) || defined(OPENSSL_SYS_VMS) || defined(M_XENIX) || defined(OPENSSL_SYS_MSDOS)
93 #include <string.h>
94 #endif
95
96 #ifdef OPENSSL_BUILD_SHLIBCRYPTO
97 # undef OPENSSL_EXTERN
98 # define OPENSSL_EXTERN OPENSSL_EXPORT
99 #endif
100
101 #define ITERATIONS 16
102 #define HALF_ITERATIONS 8
103
104 /* used in des_read and des_write */
105 #define MAXWRITE        (1024*16)
106 #define BSIZE           (MAXWRITE+4)
107
108 #define c2l(c,l)        (l =((DES_LONG)(*((c)++)))    , \
109                          l|=((DES_LONG)(*((c)++)))<< 8L, \
110                          l|=((DES_LONG)(*((c)++)))<<16L, \
111                          l|=((DES_LONG)(*((c)++)))<<24L)
112
113 /* NOTE - c is not incremented as per c2l */
114 #define c2ln(c,l1,l2,n) { \
115                         c+=n; \
116                         l1=l2=0; \
117                         switch (n) { \
118                         case 8: l2 =((DES_LONG)(*(--(c))))<<24L; \
119                         case 7: l2|=((DES_LONG)(*(--(c))))<<16L; \
120                         case 6: l2|=((DES_LONG)(*(--(c))))<< 8L; \
121                         case 5: l2|=((DES_LONG)(*(--(c))));     \
122                         case 4: l1 =((DES_LONG)(*(--(c))))<<24L; \
123                         case 3: l1|=((DES_LONG)(*(--(c))))<<16L; \
124                         case 2: l1|=((DES_LONG)(*(--(c))))<< 8L; \
125                         case 1: l1|=((DES_LONG)(*(--(c))));     \
126                                 } \
127                         }
128
129 #define l2c(l,c)        (*((c)++)=(unsigned char)(((l)     )&0xff), \
130                          *((c)++)=(unsigned char)(((l)>> 8L)&0xff), \
131                          *((c)++)=(unsigned char)(((l)>>16L)&0xff), \
132                          *((c)++)=(unsigned char)(((l)>>24L)&0xff))
133
134 /* replacements for htonl and ntohl since I have no idea what to do
135  * when faced with machines with 8 byte longs. */
136 #define HDRSIZE 4
137
138 #define n2l(c,l)        (l =((DES_LONG)(*((c)++)))<<24L, \
139                          l|=((DES_LONG)(*((c)++)))<<16L, \
140                          l|=((DES_LONG)(*((c)++)))<< 8L, \
141                          l|=((DES_LONG)(*((c)++))))
142
143 #define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24L)&0xff), \
144                          *((c)++)=(unsigned char)(((l)>>16L)&0xff), \
145                          *((c)++)=(unsigned char)(((l)>> 8L)&0xff), \
146                          *((c)++)=(unsigned char)(((l)     )&0xff))
147
148 /* NOTE - c is not incremented as per l2c */
149 #define l2cn(l1,l2,c,n) { \
150                         c+=n; \
151                         switch (n) { \
152                         case 8: *(--(c))=(unsigned char)(((l2)>>24L)&0xff); \
153                         case 7: *(--(c))=(unsigned char)(((l2)>>16L)&0xff); \
154                         case 6: *(--(c))=(unsigned char)(((l2)>> 8L)&0xff); \
155                         case 5: *(--(c))=(unsigned char)(((l2)     )&0xff); \
156                         case 4: *(--(c))=(unsigned char)(((l1)>>24L)&0xff); \
157                         case 3: *(--(c))=(unsigned char)(((l1)>>16L)&0xff); \
158                         case 2: *(--(c))=(unsigned char)(((l1)>> 8L)&0xff); \
159                         case 1: *(--(c))=(unsigned char)(((l1)     )&0xff); \
160                                 } \
161                         }
162
163 #if (defined(OPENSSL_SYS_WIN32) && defined(_MSC_VER))
164 #define ROTATE(a,n)     (_lrotr(a,n))
165 #elif defined(__ICC)
166 #define ROTATE(a,n)     (_rotr(a,n))
167 #elif defined(__GNUC__) && __GNUC__>=2 && !defined(__STRICT_ANSI__) && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM) && !defined(PEDANTIC)
168 # if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
169 #  define ROTATE(a,n)   ({ register unsigned int ret;   \
170                                 asm ("rorl %1,%0"       \
171                                         : "=r"(ret)     \
172                                         : "I"(n),"0"(a) \
173                                         : "cc");        \
174                            ret;                         \
175                         })
176 # endif
177 #endif
178 #ifndef ROTATE
179 #define ROTATE(a,n)     (((a)>>(n))+((a)<<(32-(n))))
180 #endif
181
182 /* Don't worry about the LOAD_DATA() stuff, that is used by
183  * fcrypt() to add it's little bit to the front */
184
185 #ifdef DES_FCRYPT
186
187 #define LOAD_DATA_tmp(R,S,u,t,E0,E1) \
188         { DES_LONG tmp; LOAD_DATA(R,S,u,t,E0,E1,tmp); }
189
190 #define LOAD_DATA(R,S,u,t,E0,E1,tmp) \
191         t=R^(R>>16L); \
192         u=t&E0; t&=E1; \
193         tmp=(u<<16); u^=R^s[S  ]; u^=tmp; \
194         tmp=(t<<16); t^=R^s[S+1]; t^=tmp
195 #else
196 #define LOAD_DATA_tmp(a,b,c,d,e,f) LOAD_DATA(a,b,c,d,e,f,g)
197 #define LOAD_DATA(R,S,u,t,E0,E1,tmp) \
198         u=R^s[S  ]; \
199         t=R^s[S+1]
200 #endif
201
202 /* The changes to this macro may help or hinder, depending on the
203  * compiler and the architecture.  gcc2 always seems to do well :-).
204  * Inspired by Dana How <how@isl.stanford.edu>
205  * DO NOT use the alternative version on machines with 8 byte longs.
206  * It does not seem to work on the Alpha, even when DES_LONG is 4
207  * bytes, probably an issue of accessing non-word aligned objects :-( */
208 #ifdef DES_PTR
209
210 /* It recently occurred to me that 0^0^0^0^0^0^0 == 0, so there
211  * is no reason to not xor all the sub items together.  This potentially
212  * saves a register since things can be xored directly into L */
213
214 #if defined(DES_RISC1) || defined(DES_RISC2)
215 #ifdef DES_RISC1
216 #define D_ENCRYPT(LL,R,S) { \
217         unsigned int u1,u2,u3; \
218         LOAD_DATA(R,S,u,t,E0,E1,u1); \
219         u2=(int)u>>8L; \
220         u1=(int)u&0xfc; \
221         u2&=0xfc; \
222         t=ROTATE(t,4); \
223         u>>=16L; \
224         LL^= *(const DES_LONG *)(des_SP      +u1); \
225         LL^= *(const DES_LONG *)(des_SP+0x200+u2); \
226         u3=(int)(u>>8L); \
227         u1=(int)u&0xfc; \
228         u3&=0xfc; \
229         LL^= *(const DES_LONG *)(des_SP+0x400+u1); \
230         LL^= *(const DES_LONG *)(des_SP+0x600+u3); \
231         u2=(int)t>>8L; \
232         u1=(int)t&0xfc; \
233         u2&=0xfc; \
234         t>>=16L; \
235         LL^= *(const DES_LONG *)(des_SP+0x100+u1); \
236         LL^= *(const DES_LONG *)(des_SP+0x300+u2); \
237         u3=(int)t>>8L; \
238         u1=(int)t&0xfc; \
239         u3&=0xfc; \
240         LL^= *(const DES_LONG *)(des_SP+0x500+u1); \
241         LL^= *(const DES_LONG *)(des_SP+0x700+u3); }
242 #endif
243 #ifdef DES_RISC2
244 #define D_ENCRYPT(LL,R,S) { \
245         unsigned int u1,u2,s1,s2; \
246         LOAD_DATA(R,S,u,t,E0,E1,u1); \
247         u2=(int)u>>8L; \
248         u1=(int)u&0xfc; \
249         u2&=0xfc; \
250         t=ROTATE(t,4); \
251         LL^= *(const DES_LONG *)(des_SP      +u1); \
252         LL^= *(const DES_LONG *)(des_SP+0x200+u2); \
253         s1=(int)(u>>16L); \
254         s2=(int)(u>>24L); \
255         s1&=0xfc; \
256         s2&=0xfc; \
257         LL^= *(const DES_LONG *)(des_SP+0x400+s1); \
258         LL^= *(const DES_LONG *)(des_SP+0x600+s2); \
259         u2=(int)t>>8L; \
260         u1=(int)t&0xfc; \
261         u2&=0xfc; \
262         LL^= *(const DES_LONG *)(des_SP+0x100+u1); \
263         LL^= *(const DES_LONG *)(des_SP+0x300+u2); \
264         s1=(int)(t>>16L); \
265         s2=(int)(t>>24L); \
266         s1&=0xfc; \
267         s2&=0xfc; \
268         LL^= *(const DES_LONG *)(des_SP+0x500+s1); \
269         LL^= *(const DES_LONG *)(des_SP+0x700+s2); }
270 #endif
271 #else
272 #define D_ENCRYPT(LL,R,S) { \
273         LOAD_DATA_tmp(R,S,u,t,E0,E1); \
274         t=ROTATE(t,4); \
275         LL^= \
276         *(const DES_LONG *)(des_SP      +((u     )&0xfc))^ \
277         *(const DES_LONG *)(des_SP+0x200+((u>> 8L)&0xfc))^ \
278         *(const DES_LONG *)(des_SP+0x400+((u>>16L)&0xfc))^ \
279         *(const DES_LONG *)(des_SP+0x600+((u>>24L)&0xfc))^ \
280         *(const DES_LONG *)(des_SP+0x100+((t     )&0xfc))^ \
281         *(const DES_LONG *)(des_SP+0x300+((t>> 8L)&0xfc))^ \
282         *(const DES_LONG *)(des_SP+0x500+((t>>16L)&0xfc))^ \
283         *(const DES_LONG *)(des_SP+0x700+((t>>24L)&0xfc)); }
284 #endif
285
286 #else /* original version */
287
288 #if defined(DES_RISC1) || defined(DES_RISC2)
289 #ifdef DES_RISC1
290 #define D_ENCRYPT(LL,R,S) {\
291         unsigned int u1,u2,u3; \
292         LOAD_DATA(R,S,u,t,E0,E1,u1); \
293         u>>=2L; \
294         t=ROTATE(t,6); \
295         u2=(int)u>>8L; \
296         u1=(int)u&0x3f; \
297         u2&=0x3f; \
298         u>>=16L; \
299         LL^=DES_SPtrans[0][u1]; \
300         LL^=DES_SPtrans[2][u2]; \
301         u3=(int)u>>8L; \
302         u1=(int)u&0x3f; \
303         u3&=0x3f; \
304         LL^=DES_SPtrans[4][u1]; \
305         LL^=DES_SPtrans[6][u3]; \
306         u2=(int)t>>8L; \
307         u1=(int)t&0x3f; \
308         u2&=0x3f; \
309         t>>=16L; \
310         LL^=DES_SPtrans[1][u1]; \
311         LL^=DES_SPtrans[3][u2]; \
312         u3=(int)t>>8L; \
313         u1=(int)t&0x3f; \
314         u3&=0x3f; \
315         LL^=DES_SPtrans[5][u1]; \
316         LL^=DES_SPtrans[7][u3]; }
317 #endif
318 #ifdef DES_RISC2
319 #define D_ENCRYPT(LL,R,S) {\
320         unsigned int u1,u2,s1,s2; \
321         LOAD_DATA(R,S,u,t,E0,E1,u1); \
322         u>>=2L; \
323         t=ROTATE(t,6); \
324         u2=(int)u>>8L; \
325         u1=(int)u&0x3f; \
326         u2&=0x3f; \
327         LL^=DES_SPtrans[0][u1]; \
328         LL^=DES_SPtrans[2][u2]; \
329         s1=(int)u>>16L; \
330         s2=(int)u>>24L; \
331         s1&=0x3f; \
332         s2&=0x3f; \
333         LL^=DES_SPtrans[4][s1]; \
334         LL^=DES_SPtrans[6][s2]; \
335         u2=(int)t>>8L; \
336         u1=(int)t&0x3f; \
337         u2&=0x3f; \
338         LL^=DES_SPtrans[1][u1]; \
339         LL^=DES_SPtrans[3][u2]; \
340         s1=(int)t>>16; \
341         s2=(int)t>>24L; \
342         s1&=0x3f; \
343         s2&=0x3f; \
344         LL^=DES_SPtrans[5][s1]; \
345         LL^=DES_SPtrans[7][s2]; }
346 #endif
347
348 #else
349
350 #define D_ENCRYPT(LL,R,S) {\
351         LOAD_DATA_tmp(R,S,u,t,E0,E1); \
352         t=ROTATE(t,4); \
353         LL^=\
354                 DES_SPtrans[0][(u>> 2L)&0x3f]^ \
355                 DES_SPtrans[2][(u>>10L)&0x3f]^ \
356                 DES_SPtrans[4][(u>>18L)&0x3f]^ \
357                 DES_SPtrans[6][(u>>26L)&0x3f]^ \
358                 DES_SPtrans[1][(t>> 2L)&0x3f]^ \
359                 DES_SPtrans[3][(t>>10L)&0x3f]^ \
360                 DES_SPtrans[5][(t>>18L)&0x3f]^ \
361                 DES_SPtrans[7][(t>>26L)&0x3f]; }
362 #endif
363 #endif
364
365         /*-
366          * IP and FP
367          * The problem is more of a geometric problem that random bit fiddling.
368          0  1  2  3  4  5  6  7      62 54 46 38 30 22 14  6
369          8  9 10 11 12 13 14 15      60 52 44 36 28 20 12  4
370         16 17 18 19 20 21 22 23      58 50 42 34 26 18 10  2
371         24 25 26 27 28 29 30 31  to  56 48 40 32 24 16  8  0
372
373         32 33 34 35 36 37 38 39      63 55 47 39 31 23 15  7
374         40 41 42 43 44 45 46 47      61 53 45 37 29 21 13  5
375         48 49 50 51 52 53 54 55      59 51 43 35 27 19 11  3
376         56 57 58 59 60 61 62 63      57 49 41 33 25 17  9  1
377
378         The output has been subject to swaps of the form
379         0 1 -> 3 1 but the odd and even bits have been put into
380         2 3    2 0
381         different words.  The main trick is to remember that
382         t=((l>>size)^r)&(mask);
383         r^=t;
384         l^=(t<<size);
385         can be used to swap and move bits between words.
386
387         So l =  0  1  2  3  r = 16 17 18 19
388                 4  5  6  7      20 21 22 23
389                 8  9 10 11      24 25 26 27
390                12 13 14 15      28 29 30 31
391         becomes (for size == 2 and mask == 0x3333)
392            t =   2^16  3^17 -- --   l =  0  1 16 17  r =  2  3 18 19
393                  6^20  7^21 -- --        4  5 20 21       6  7 22 23
394                 10^24 11^25 -- --        8  9 24 25      10 11 24 25
395                 14^28 15^29 -- --       12 13 28 29      14 15 28 29
396
397         Thanks for hints from Richard Outerbridge - he told me IP&FP
398         could be done in 15 xor, 10 shifts and 5 ands.
399         When I finally started to think of the problem in 2D
400         I first got ~42 operations without xors.  When I remembered
401         how to use xors :-) I got it to its final state.
402         */
403 #define PERM_OP(a,b,t,n,m) ((t)=((((a)>>(n))^(b))&(m)),\
404         (b)^=(t),\
405         (a)^=((t)<<(n)))
406
407 #define IP(l,r) \
408         { \
409         register DES_LONG tt; \
410         PERM_OP(r,l,tt, 4,0x0f0f0f0fL); \
411         PERM_OP(l,r,tt,16,0x0000ffffL); \
412         PERM_OP(r,l,tt, 2,0x33333333L); \
413         PERM_OP(l,r,tt, 8,0x00ff00ffL); \
414         PERM_OP(r,l,tt, 1,0x55555555L); \
415         }
416
417 #define FP(l,r) \
418         { \
419         register DES_LONG tt; \
420         PERM_OP(l,r,tt, 1,0x55555555L); \
421         PERM_OP(r,l,tt, 8,0x00ff00ffL); \
422         PERM_OP(l,r,tt, 2,0x33333333L); \
423         PERM_OP(r,l,tt,16,0x0000ffffL); \
424         PERM_OP(l,r,tt, 4,0x0f0f0f0fL); \
425         }
426
427 extern const DES_LONG DES_SPtrans[8][64];
428
429 void fcrypt_body(DES_LONG *out,DES_key_schedule *ks,
430                  DES_LONG Eswap0, DES_LONG Eswap1);
431
432 #ifdef OPENSSL_SMALL_FOOTPRINT
433 #undef DES_UNROLL
434 #endif
435 #endif