23ea9d32a7be5f1389c75c3dc49ae5c52ec80d75
[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 /*
135  * replacements for htonl and ntohl since I have no idea what to do when
136  * faced with machines with 8 byte longs.
137  */
138 # define HDRSIZE 4
139
140 # define n2l(c,l)        (l =((DES_LONG)(*((c)++)))<<24L, \
141                          l|=((DES_LONG)(*((c)++)))<<16L, \
142                          l|=((DES_LONG)(*((c)++)))<< 8L, \
143                          l|=((DES_LONG)(*((c)++))))
144
145 # define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24L)&0xff), \
146                          *((c)++)=(unsigned char)(((l)>>16L)&0xff), \
147                          *((c)++)=(unsigned char)(((l)>> 8L)&0xff), \
148                          *((c)++)=(unsigned char)(((l)     )&0xff))
149
150 /* NOTE - c is not incremented as per l2c */
151 # define l2cn(l1,l2,c,n) { \
152                         c+=n; \
153                         switch (n) { \
154                         case 8: *(--(c))=(unsigned char)(((l2)>>24L)&0xff); \
155                         case 7: *(--(c))=(unsigned char)(((l2)>>16L)&0xff); \
156                         case 6: *(--(c))=(unsigned char)(((l2)>> 8L)&0xff); \
157                         case 5: *(--(c))=(unsigned char)(((l2)     )&0xff); \
158                         case 4: *(--(c))=(unsigned char)(((l1)>>24L)&0xff); \
159                         case 3: *(--(c))=(unsigned char)(((l1)>>16L)&0xff); \
160                         case 2: *(--(c))=(unsigned char)(((l1)>> 8L)&0xff); \
161                         case 1: *(--(c))=(unsigned char)(((l1)     )&0xff); \
162                                 } \
163                         }
164
165 # if (defined(OPENSSL_SYS_WIN32) && defined(_MSC_VER))
166 #  define ROTATE(a,n)     (_lrotr(a,n))
167 # elif defined(__ICC)
168 #  define ROTATE(a,n)     (_rotr(a,n))
169 # elif defined(__GNUC__) && __GNUC__>=2 && !defined(__STRICT_ANSI__) && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM) && !defined(PEDANTIC)
170 #  if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
171 #   define ROTATE(a,n)   ({ register unsigned int ret;   \
172                                 asm ("rorl %1,%0"       \
173                                         : "=r"(ret)     \
174                                         : "I"(n),"0"(a) \
175                                         : "cc");        \
176                            ret;                         \
177                         })
178 #  endif
179 # endif
180 # ifndef ROTATE
181 #  define ROTATE(a,n)     (((a)>>(n))+((a)<<(32-(n))))
182 # endif
183
184 /*
185  * Don't worry about the LOAD_DATA() stuff, that is used by fcrypt() to add
186  * it's little bit to the front
187  */
188
189 # ifdef DES_FCRYPT
190
191 #  define LOAD_DATA_tmp(R,S,u,t,E0,E1) \
192         { DES_LONG tmp; LOAD_DATA(R,S,u,t,E0,E1,tmp); }
193
194 #  define LOAD_DATA(R,S,u,t,E0,E1,tmp) \
195         t=R^(R>>16L); \
196         u=t&E0; t&=E1; \
197         tmp=(u<<16); u^=R^s[S  ]; u^=tmp; \
198         tmp=(t<<16); t^=R^s[S+1]; t^=tmp
199 # else
200 #  define LOAD_DATA_tmp(a,b,c,d,e,f) LOAD_DATA(a,b,c,d,e,f,g)
201 #  define LOAD_DATA(R,S,u,t,E0,E1,tmp) \
202         u=R^s[S  ]; \
203         t=R^s[S+1]
204 # endif
205
206 /*
207  * The changes to this macro may help or hinder, depending on the compiler
208  * and the architecture.  gcc2 always seems to do well :-). Inspired by Dana
209  * How <how@isl.stanford.edu> DO NOT use the alternative version on machines
210  * with 8 byte longs. It does not seem to work on the Alpha, even when
211  * DES_LONG is 4 bytes, probably an issue of accessing non-word aligned
212  * objects :-(
213  */
214 # ifdef DES_PTR
215
216 /*
217  * It recently occurred to me that 0^0^0^0^0^0^0 == 0, so there is no reason
218  * to not xor all the sub items together.  This potentially saves a register
219  * since things can be xored directly into L
220  */
221
222 #  if defined(DES_RISC1) || defined(DES_RISC2)
223 #   ifdef DES_RISC1
224 #    define D_ENCRYPT(LL,R,S) { \
225         unsigned int u1,u2,u3; \
226         LOAD_DATA(R,S,u,t,E0,E1,u1); \
227         u2=(int)u>>8L; \
228         u1=(int)u&0xfc; \
229         u2&=0xfc; \
230         t=ROTATE(t,4); \
231         u>>=16L; \
232         LL^= *(const DES_LONG *)(des_SP      +u1); \
233         LL^= *(const DES_LONG *)(des_SP+0x200+u2); \
234         u3=(int)(u>>8L); \
235         u1=(int)u&0xfc; \
236         u3&=0xfc; \
237         LL^= *(const DES_LONG *)(des_SP+0x400+u1); \
238         LL^= *(const DES_LONG *)(des_SP+0x600+u3); \
239         u2=(int)t>>8L; \
240         u1=(int)t&0xfc; \
241         u2&=0xfc; \
242         t>>=16L; \
243         LL^= *(const DES_LONG *)(des_SP+0x100+u1); \
244         LL^= *(const DES_LONG *)(des_SP+0x300+u2); \
245         u3=(int)t>>8L; \
246         u1=(int)t&0xfc; \
247         u3&=0xfc; \
248         LL^= *(const DES_LONG *)(des_SP+0x500+u1); \
249         LL^= *(const DES_LONG *)(des_SP+0x700+u3); }
250 #   endif
251 #   ifdef DES_RISC2
252 #    define D_ENCRYPT(LL,R,S) { \
253         unsigned int u1,u2,s1,s2; \
254         LOAD_DATA(R,S,u,t,E0,E1,u1); \
255         u2=(int)u>>8L; \
256         u1=(int)u&0xfc; \
257         u2&=0xfc; \
258         t=ROTATE(t,4); \
259         LL^= *(const DES_LONG *)(des_SP      +u1); \
260         LL^= *(const DES_LONG *)(des_SP+0x200+u2); \
261         s1=(int)(u>>16L); \
262         s2=(int)(u>>24L); \
263         s1&=0xfc; \
264         s2&=0xfc; \
265         LL^= *(const DES_LONG *)(des_SP+0x400+s1); \
266         LL^= *(const DES_LONG *)(des_SP+0x600+s2); \
267         u2=(int)t>>8L; \
268         u1=(int)t&0xfc; \
269         u2&=0xfc; \
270         LL^= *(const DES_LONG *)(des_SP+0x100+u1); \
271         LL^= *(const DES_LONG *)(des_SP+0x300+u2); \
272         s1=(int)(t>>16L); \
273         s2=(int)(t>>24L); \
274         s1&=0xfc; \
275         s2&=0xfc; \
276         LL^= *(const DES_LONG *)(des_SP+0x500+s1); \
277         LL^= *(const DES_LONG *)(des_SP+0x700+s2); }
278 #   endif
279 #  else
280 #   define D_ENCRYPT(LL,R,S) { \
281         LOAD_DATA_tmp(R,S,u,t,E0,E1); \
282         t=ROTATE(t,4); \
283         LL^= \
284         *(const DES_LONG *)(des_SP      +((u     )&0xfc))^ \
285         *(const DES_LONG *)(des_SP+0x200+((u>> 8L)&0xfc))^ \
286         *(const DES_LONG *)(des_SP+0x400+((u>>16L)&0xfc))^ \
287         *(const DES_LONG *)(des_SP+0x600+((u>>24L)&0xfc))^ \
288         *(const DES_LONG *)(des_SP+0x100+((t     )&0xfc))^ \
289         *(const DES_LONG *)(des_SP+0x300+((t>> 8L)&0xfc))^ \
290         *(const DES_LONG *)(des_SP+0x500+((t>>16L)&0xfc))^ \
291         *(const DES_LONG *)(des_SP+0x700+((t>>24L)&0xfc)); }
292 #  endif
293
294 # else                          /* original version */
295
296 #  if defined(DES_RISC1) || defined(DES_RISC2)
297 #   ifdef DES_RISC1
298 #    define D_ENCRYPT(LL,R,S) {\
299         unsigned int u1,u2,u3; \
300         LOAD_DATA(R,S,u,t,E0,E1,u1); \
301         u>>=2L; \
302         t=ROTATE(t,6); \
303         u2=(int)u>>8L; \
304         u1=(int)u&0x3f; \
305         u2&=0x3f; \
306         u>>=16L; \
307         LL^=DES_SPtrans[0][u1]; \
308         LL^=DES_SPtrans[2][u2]; \
309         u3=(int)u>>8L; \
310         u1=(int)u&0x3f; \
311         u3&=0x3f; \
312         LL^=DES_SPtrans[4][u1]; \
313         LL^=DES_SPtrans[6][u3]; \
314         u2=(int)t>>8L; \
315         u1=(int)t&0x3f; \
316         u2&=0x3f; \
317         t>>=16L; \
318         LL^=DES_SPtrans[1][u1]; \
319         LL^=DES_SPtrans[3][u2]; \
320         u3=(int)t>>8L; \
321         u1=(int)t&0x3f; \
322         u3&=0x3f; \
323         LL^=DES_SPtrans[5][u1]; \
324         LL^=DES_SPtrans[7][u3]; }
325 #   endif
326 #   ifdef DES_RISC2
327 #    define D_ENCRYPT(LL,R,S) {\
328         unsigned int u1,u2,s1,s2; \
329         LOAD_DATA(R,S,u,t,E0,E1,u1); \
330         u>>=2L; \
331         t=ROTATE(t,6); \
332         u2=(int)u>>8L; \
333         u1=(int)u&0x3f; \
334         u2&=0x3f; \
335         LL^=DES_SPtrans[0][u1]; \
336         LL^=DES_SPtrans[2][u2]; \
337         s1=(int)u>>16L; \
338         s2=(int)u>>24L; \
339         s1&=0x3f; \
340         s2&=0x3f; \
341         LL^=DES_SPtrans[4][s1]; \
342         LL^=DES_SPtrans[6][s2]; \
343         u2=(int)t>>8L; \
344         u1=(int)t&0x3f; \
345         u2&=0x3f; \
346         LL^=DES_SPtrans[1][u1]; \
347         LL^=DES_SPtrans[3][u2]; \
348         s1=(int)t>>16; \
349         s2=(int)t>>24L; \
350         s1&=0x3f; \
351         s2&=0x3f; \
352         LL^=DES_SPtrans[5][s1]; \
353         LL^=DES_SPtrans[7][s2]; }
354 #   endif
355
356 #  else
357
358 #   define D_ENCRYPT(LL,R,S) {\
359         LOAD_DATA_tmp(R,S,u,t,E0,E1); \
360         t=ROTATE(t,4); \
361         LL^=\
362                 DES_SPtrans[0][(u>> 2L)&0x3f]^ \
363                 DES_SPtrans[2][(u>>10L)&0x3f]^ \
364                 DES_SPtrans[4][(u>>18L)&0x3f]^ \
365                 DES_SPtrans[6][(u>>26L)&0x3f]^ \
366                 DES_SPtrans[1][(t>> 2L)&0x3f]^ \
367                 DES_SPtrans[3][(t>>10L)&0x3f]^ \
368                 DES_SPtrans[5][(t>>18L)&0x3f]^ \
369                 DES_SPtrans[7][(t>>26L)&0x3f]; }
370 #  endif
371 # endif
372
373         /*-
374          * IP and FP
375          * The problem is more of a geometric problem that random bit fiddling.
376          0  1  2  3  4  5  6  7      62 54 46 38 30 22 14  6
377          8  9 10 11 12 13 14 15      60 52 44 36 28 20 12  4
378         16 17 18 19 20 21 22 23      58 50 42 34 26 18 10  2
379         24 25 26 27 28 29 30 31  to  56 48 40 32 24 16  8  0
380
381         32 33 34 35 36 37 38 39      63 55 47 39 31 23 15  7
382         40 41 42 43 44 45 46 47      61 53 45 37 29 21 13  5
383         48 49 50 51 52 53 54 55      59 51 43 35 27 19 11  3
384         56 57 58 59 60 61 62 63      57 49 41 33 25 17  9  1
385
386         The output has been subject to swaps of the form
387         0 1 -> 3 1 but the odd and even bits have been put into
388         2 3    2 0
389         different words.  The main trick is to remember that
390         t=((l>>size)^r)&(mask);
391         r^=t;
392         l^=(t<<size);
393         can be used to swap and move bits between words.
394
395         So l =  0  1  2  3  r = 16 17 18 19
396                 4  5  6  7      20 21 22 23
397                 8  9 10 11      24 25 26 27
398                12 13 14 15      28 29 30 31
399         becomes (for size == 2 and mask == 0x3333)
400            t =   2^16  3^17 -- --   l =  0  1 16 17  r =  2  3 18 19
401                  6^20  7^21 -- --        4  5 20 21       6  7 22 23
402                 10^24 11^25 -- --        8  9 24 25      10 11 24 25
403                 14^28 15^29 -- --       12 13 28 29      14 15 28 29
404
405         Thanks for hints from Richard Outerbridge - he told me IP&FP
406         could be done in 15 xor, 10 shifts and 5 ands.
407         When I finally started to think of the problem in 2D
408         I first got ~42 operations without xors.  When I remembered
409         how to use xors :-) I got it to its final state.
410         */
411 # define PERM_OP(a,b,t,n,m) ((t)=((((a)>>(n))^(b))&(m)),\
412         (b)^=(t),\
413         (a)^=((t)<<(n)))
414
415 # define IP(l,r) \
416         { \
417         register DES_LONG tt; \
418         PERM_OP(r,l,tt, 4,0x0f0f0f0fL); \
419         PERM_OP(l,r,tt,16,0x0000ffffL); \
420         PERM_OP(r,l,tt, 2,0x33333333L); \
421         PERM_OP(l,r,tt, 8,0x00ff00ffL); \
422         PERM_OP(r,l,tt, 1,0x55555555L); \
423         }
424
425 # define FP(l,r) \
426         { \
427         register DES_LONG tt; \
428         PERM_OP(l,r,tt, 1,0x55555555L); \
429         PERM_OP(r,l,tt, 8,0x00ff00ffL); \
430         PERM_OP(l,r,tt, 2,0x33333333L); \
431         PERM_OP(r,l,tt,16,0x0000ffffL); \
432         PERM_OP(l,r,tt, 4,0x0f0f0f0fL); \
433         }
434
435 extern const DES_LONG DES_SPtrans[8][64];
436
437 void fcrypt_body(DES_LONG *out, DES_key_schedule *ks,
438                  DES_LONG Eswap0, DES_LONG Eswap1);
439
440 # ifdef OPENSSL_SMALL_FOOTPRINT
441 #  undef DES_UNROLL
442 # endif
443 #endif