Update comments now that AES has been chosen.
[u/mdw/catacomb] / rijndael.h
1 /* -*-c-*-
2 *
3 * $Id: rijndael.h,v 1.2 2000/10/08 15:48:58 mdw Exp $
4 *
5 * The Rijndael block cipher
6 *
7 * (c) 2000 Straylight/Edgeware
8 */
9
10 /*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of Catacomb.
13 *
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
18 *
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA.
28 */
29
30 /*----- Revision history --------------------------------------------------*
31 *
32 * $Log: rijndael.h,v $
33 * Revision 1.2 2000/10/08 15:48:58 mdw
34 * Update comments now that AES has been chosen.
35 *
36 * Revision 1.1 2000/06/17 11:56:07 mdw
37 * New cipher.
38 *
39 */
40
41 /*----- Notes on the Rijndael block cipher --------------------------------*
42 *
43 * Invented by Joan Daemen and Vincent Rijmen, Rijndael is a fast, elegant
44 * and relatively simple 128-bit block cipher. It was chosen by NIST to be
45 * the new Advanced Encryption Standard (AES) algorithm.
46 *
47 * Rijnadel appears to have a low security margin. I recommend waiting
48 * before using Rijndael for any sensitive applications.
49 */
50
51 #ifndef CATACOMB_RIJNDAEL_H
52 #define CATACOMB_RIJNDAEL_H
53
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57
58 /*----- Header files ------------------------------------------------------*/
59
60 #include <stddef.h>
61
62 #include <mLib/bits.h>
63
64 /*----- Magical numbers ---------------------------------------------------*/
65
66 #define RIJNDAEL_BLKSZ 16
67 #define RIJNDAEL_KEYSZ 32
68 #define RIJNDAEL_CLASS (N, L, 128)
69
70 extern const octet rijndael_keysz[];
71
72 /*----- Data structures ---------------------------------------------------*/
73
74 #define RIJNDAEL_MAXROUNDS 32
75 #define RIJNDAEL_KWORDS ((RIJNDAEL_MAXROUNDS + 1) * (RIJNDAEL_BLKSZ / 4))
76
77 typedef struct rijndael_ctx {
78 unsigned nr;
79 uint32 w[RIJNDAEL_KWORDS];
80 uint32 wi[RIJNDAEL_KWORDS];
81 } rijndael_ctx;
82
83 /*----- Functions provided ------------------------------------------------*/
84
85 /* --- @rijndael_init@ --- *
86 *
87 * Arguments: @rijndael_ctx *k@ = pointer to context to initialize
88 * @const void *buf@ = pointer to buffer of key material
89 * @size_t sz@ = size of the key material
90 *
91 * Returns: ---
92 *
93 * Use: Initializes a Rijndael context with a particular key. This
94 * implementation of Rijndael doesn't impose any particular
95 * limits on the key size except that it must be multiple of 4
96 * bytes long. 256 bits seems sensible, though.
97 */
98
99 extern void rijndael_init(rijndael_ctx */*k*/,
100 const void */*buf*/, size_t /*sz*/);
101
102 /* --- @rijndael_eblk@, @rijndael_dblk@ --- *
103 *
104 * Arguments: @const rijndael_ctx *k@ = pointer to Rijndael context
105 * @const uint32 s[4]@ = pointer to source block
106 * @uint32 d[4]@ = pointer to destination block
107 *
108 * Returns: ---
109 *
110 * Use: Low-level block encryption and decryption.
111 */
112
113 extern void rijndael_eblk(const rijndael_ctx */*k*/,
114 const uint32 */*s*/, uint32 */*dst*/);
115 extern void rijndael_dblk(const rijndael_ctx */*k*/,
116 const uint32 */*s*/, uint32 */*dst*/);
117
118 /*----- That's all, folks -------------------------------------------------*/
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif