Added some missing ChangeLog entries.
[libgcrypt.git] / cipher / crc.c
1 /* crc.c - Cyclic redundancy checks.
2  * Copyright (C) 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  *
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27 #include "g10lib.h"
28 #include "memory.h"
29 #include "dynload.h"
30
31 #include "bithelp.h"
32
33 /* Table of CRCs of all 8-bit messages.  Generated by running code
34    from RFC 1952 modified to print out the table. */
35 static u32 crc32_table[256] = {
36   0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
37   0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
38   0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
39   0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
40   0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
41   0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
42   0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
43   0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
44   0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
45   0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
46   0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
47   0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
48   0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
49   0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
50   0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
51   0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
52   0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
53   0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
54   0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
55   0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
56   0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
57   0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
58   0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
59   0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
60   0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
61   0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
62   0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
63   0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
64   0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
65   0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
66   0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
67   0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
68   0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
69   0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
70   0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
71   0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
72   0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
73   0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
74   0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
75   0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
76   0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
77   0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
78   0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
79 };
80
81 /*
82  * The following function was extracted from RFC 1952 by Simon
83  * Josefsson, for the Shishi project, and modified to be compatible
84  * with the modified CRC-32 used by RFC 1510, and subsequently
85  * modified for GNU Libgcrypt to allow it to be used for calculating
86  * both unmodified CRC-32 and modified CRC-32 values.  Original
87  * copyright and notice from the document follows:
88  *
89  *    Copyright (c) 1996 L. Peter Deutsch
90  *
91  *    Permission is granted to copy and distribute this document for
92  *    any purpose and without charge, including translations into
93  *    other languages and incorporation into compilations, provided
94  *    that the copyright notice and this notice are preserved, and
95  *    that any substantive changes or deletions from the original are
96  *    clearly marked.
97  *
98  * The copyright on RFCs, and consequently the function below, are
99  * supposedly also retroactively claimed by the Internet Society
100  * (according to rfc-editor@rfc-editor.org), with the following
101  * copyright notice:
102  *
103  *    Copyright (C) The Internet Society.  All Rights Reserved.
104  *
105  *    This document and translations of it may be copied and furnished
106  *    to others, and derivative works that comment on or otherwise
107  *    explain it or assist in its implementation may be prepared,
108  *    copied, published and distributed, in whole or in part, without
109  *    restriction of any kind, provided that the above copyright
110  *    notice and this paragraph are included on all such copies and
111  *    derivative works.  However, this document itself may not be
112  *    modified in any way, such as by removing the copyright notice or
113  *    references to the Internet Society or other Internet
114  *    organizations, except as needed for the purpose of developing
115  *    Internet standards in which case the procedures for copyrights
116  *    defined in the Internet Standards process must be followed, or
117  *    as required to translate it into languages other than English.
118  *
119  *    The limited permissions granted above are perpetual and will not be
120  *    revoked by the Internet Society or its successors or assigns.
121  *
122  *    This document and the information contained herein is provided
123  *    on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
124  *    ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR
125  *    IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE
126  *    OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
127  *    IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
128  *    PARTICULAR PURPOSE.
129  *
130  */
131 static u32
132 update_crc32 (u32 crc, char *buf, size_t len)
133 {
134   size_t n;
135
136   for (n = 0; n < len; n++)
137     crc = crc32_table[(crc ^ buf[n]) & 0xff] ^ (crc >> 8);
138
139   return crc;
140 }
141
142 typedef struct
143 {
144   u32 CRC;
145   byte buf[4];
146 }
147 CRC_CONTEXT;
148
149 /* CRC32 */
150
151 static void
152 crc32_init (CRC_CONTEXT * ctx)
153 {
154   ctx->CRC = 0 ^ 0xffffffffL;
155 }
156
157 static void
158 crc32_write (CRC_CONTEXT * ctx, byte * inbuf, size_t inlen)
159 {
160   if (!inbuf)
161     return;
162   ctx->CRC = update_crc32 (ctx->CRC, inbuf, inlen);
163 }
164
165 static byte *
166 crc32_read (CRC_CONTEXT * ctx)
167 {
168   return ctx->buf;
169 }
170
171 static void
172 crc32_final (CRC_CONTEXT * ctx)
173 {
174   ctx->CRC ^= 0xffffffffL;
175   ctx->buf[0] = (ctx->CRC >> 24) & 0xFF;
176   ctx->buf[1] = (ctx->CRC >> 16) & 0xFF;
177   ctx->buf[2] = (ctx->CRC >>  8) & 0xFF;
178   ctx->buf[3] = (ctx->CRC      ) & 0xFF;
179 }
180
181 /* CRC32 a'la RFC 1510 */
182 static void
183 crc32rfc1510_init (CRC_CONTEXT * ctx)
184 {
185   ctx->CRC = 0;
186 }
187
188 static void
189 crc32rfc1510_final (CRC_CONTEXT * ctx)
190 {
191   ctx->buf[0] = (ctx->CRC >> 24) & 0xFF;
192   ctx->buf[1] = (ctx->CRC >> 16) & 0xFF;
193   ctx->buf[2] = (ctx->CRC >>  8) & 0xFF;
194   ctx->buf[3] = (ctx->CRC      ) & 0xFF;
195 }
196
197 /* CRC24 a'la RFC 2440 */
198 /*
199  * The following CRC 24 routines are adapted from RFC 2440, which has
200  * the following copyright notice:
201  *
202  *   Copyright (C) The Internet Society (1998).  All Rights Reserved.
203  *
204  *   This document and translations of it may be copied and furnished
205  *   to others, and derivative works that comment on or otherwise
206  *   explain it or assist in its implementation may be prepared,
207  *   copied, published and distributed, in whole or in part, without
208  *   restriction of any kind, provided that the above copyright notice
209  *   and this paragraph are included on all such copies and derivative
210  *   works.  However, this document itself may not be modified in any
211  *   way, such as by removing the copyright notice or references to
212  *   the Internet Society or other Internet organizations, except as
213  *   needed for the purpose of developing Internet standards in which
214  *   case the procedures for copyrights defined in the Internet
215  *   Standards process must be followed, or as required to translate
216  *   it into languages other than English.
217  *
218  *   The limited permissions granted above are perpetual and will not be
219  *   revoked by the Internet Society or its successors or assigns.
220  *
221  *   This document and the information contained herein is provided on
222  *   an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
223  *   ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR
224  *   IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE
225  *   OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
226  *   IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
227  *   PURPOSE.
228  */
229
230 #define CRC24_INIT 0xb704ceL
231 #define CRC24_POLY 0x1864cfbL
232
233 static void
234 crc24rfc2440_init (CRC_CONTEXT * ctx)
235 {
236   ctx->CRC = CRC24_INIT;
237 }
238
239 static void
240 crc24rfc2440_write (CRC_CONTEXT * ctx, byte * inbuf, size_t inlen)
241 {
242   int i;
243
244   if (!inbuf)
245     return;
246
247   while (inlen--) {
248     ctx->CRC ^= (*inbuf++) << 16;
249     for (i = 0; i < 8; i++) {
250       ctx->CRC <<= 1;
251       if (ctx->CRC & 0x1000000)
252         ctx->CRC ^= CRC24_POLY;
253     }
254   }
255 }
256
257 static void
258 crc24rfc2440_final (CRC_CONTEXT * ctx)
259 {
260   ctx->buf[0] = (ctx->CRC >> 16) & 0xFF;
261   ctx->buf[1] = (ctx->CRC >>  8) & 0xFF;
262   ctx->buf[2] = (ctx->CRC      ) & 0xFF;
263 }
264
265 static const char *
266 crc_get_info (int algo, size_t * contextsize,
267               byte ** r_asnoid, int *r_asnlen, int *r_mdlen,
268               void (**r_init) (void *c),
269               void (**r_write) (void *c, byte * buf, size_t nbytes),
270               void (**r_final) (void *c), byte * (**r_read) (void *c))
271 {
272   *contextsize = sizeof (CRC_CONTEXT);
273   *r_asnoid = NULL;
274   *r_asnlen = 0;
275
276   switch (algo)
277     {
278     case 302:
279       *r_mdlen = 4;
280       *(void (**)(CRC_CONTEXT *)) r_init = crc32_init;
281       *(void (**)(CRC_CONTEXT *)) r_final = crc32_final;
282       *(void (**)(CRC_CONTEXT *, byte *, size_t)) r_write = crc32_write;
283       *(byte * (**)(CRC_CONTEXT *)) r_read = crc32_read;
284       return "CRC32";
285
286     case 303:
287       *r_mdlen = 4;
288       *(void (**)(CRC_CONTEXT *)) r_init = crc32rfc1510_init;
289       *(void (**)(CRC_CONTEXT *)) r_final = crc32rfc1510_final;
290       *(void (**)(CRC_CONTEXT *, byte *, size_t)) r_write = crc32_write;
291       *(byte * (**)(CRC_CONTEXT *)) r_read = crc32_read;
292       return "CRC32RFC1510";
293
294     case 304:
295       *r_mdlen = 3;
296       *(void (**)(CRC_CONTEXT *)) r_init = crc24rfc2440_init;
297       *(void (**)(CRC_CONTEXT *)) r_final = crc24rfc2440_final;
298       *(void (**)(CRC_CONTEXT *, byte *, size_t)) r_write = crc24rfc2440_write;
299       *(byte * (**)(CRC_CONTEXT *)) r_read = crc32_read;
300       return "CRC24RFC2440";
301
302     default:
303       return NULL;
304     }
305
306   return NULL;
307 }
308
309
310 #ifndef IS_MODULE
311 static
312 #endif
313 const char *const gnupgext_version = "CRC ($Revision$)";
314
315 static struct
316 {
317   int class;
318   int version;
319   int value;
320   void (*func) (void);
321 } func_table[] = {
322   { 10, 1, 0, (void (*)(void)) crc_get_info },
323   { 11, 1, 302 },
324   { 11, 1, 303 },
325   { 11, 1, 304 },
326 };
327
328 #ifndef IS_MODULE
329 static
330 #endif
331 void *
332 gnupgext_enum_func (int what, int *sequence, int *class, int *vers)
333 {
334   void *ret;
335   int i = *sequence;
336
337   do
338     {
339       if (i >= DIM (func_table) || i < 0)
340         return NULL;
341       *class = func_table[i].class;
342       *vers = func_table[i].version;
343       switch (*class)
344         {
345         case 11:
346         case 21:
347         case 31:
348           ret = &func_table[i].value;
349           break;
350         default:
351           ret = func_table[i].func;
352           break;
353         }
354       i++;
355     }
356   while (what && what != *class);
357
358   *sequence = i;
359   return ret;
360 }
361
362 #ifndef IS_MODULE
363 void
364 _gcry_crc_constructor (void)
365 {
366   _gcry_register_internal_cipher_extension (gnupgext_version,
367                                             gnupgext_enum_func);
368 }
369 #endif
370
371 /* end of file */