.links: Drop obsolete `lib-config.in' file.
[u/mdw/catacomb] / mars.h
1 /* -*-c-*-
2 *
3 * $Id: mars.h,v 1.2 2004/04/08 01:36:15 mdw Exp $
4 *
5 * The MARS block cipher
6 *
7 * (c) 2001 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 /*----- Notes on the MARS block cipher ------------------------------------*
31 *
32 * MARS was IBM's submission to the AES contest. It was designed by a number
33 * of clever people at the T. J. Watson labs, and made it to the second round
34 * of the contest. Unfortunately, MARS is rather messy. There are some
35 * awkward corner cases in the key schedule algorithm, for example, that show
36 * up very rarely.
37 */
38
39 #ifndef CATACOMB_MARS_H
40 #define CATACOMB_MARS_H
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /*----- Header files ------------------------------------------------------*/
47
48 #include <stddef.h>
49
50 #include <mLib/bits.h>
51
52 /*----- Magical numbers ---------------------------------------------------*/
53
54 #define MARS_BLKSZ 16
55 #define MARS_KEYSZ 32
56 #define MARS_CLASS (N, L, 128)
57
58 extern const octet mars_keysz[];
59
60 /*----- Data structures ---------------------------------------------------*/
61
62 typedef struct mars_ctx {
63 uint32 k[40];
64 } mars_ctx;
65
66 /*----- Functions provided ------------------------------------------------*/
67
68 /* --- @mars_init@ --- *
69 *
70 * Arguments: @mars_ctx *k@ = pointer to key block to fill in
71 * @const void *buf@ = pointer to buffer of key material
72 * @size_t sz@ = size of key material
73 *
74 * Returns: ---
75 *
76 * Use: Initializes a MARS key buffer. MARS accepts key sizes
77 * between 128 and 448 bits which are a multiple of 32 bits.
78 */
79
80 extern void mars_init(mars_ctx */*k*/,
81 const void */*buf*/, size_t /*sz*/);
82
83 /* --- @mars_eblk@, @mars_dblk@ --- *
84 *
85 * Arguments: @const mars_ctx *k@ = pointer to key block
86 * @const uint32 s[4]@ = pointer to source block
87 * @uint32 d[4]@ = pointer to destination block
88 *
89 * Returns: ---
90 *
91 * Use: Low-level block encryption and decryption.
92 */
93
94 extern void mars_eblk(const mars_ctx */*k*/,
95 const uint32 */*s*/, uint32 */*d*/);
96
97 extern void mars_dblk(const mars_ctx */*k*/,
98 const uint32 */*s*/, uint32 */*d*/);
99
100 /*----- That's all, folks -------------------------------------------------*/
101
102 #ifdef __cplusplus
103 }
104 #endif
105
106 #endif