From c61ee18cea55601bfe24e88dbb3a4ddf43fd6844 Mon Sep 17 00:00:00 2001 From: Mark Wooding Date: Mon, 19 Feb 2007 13:07:38 +0000 Subject: [PATCH] keysz.h: Extract key-size stuff into a separate header file. This is going to grow later; for now, just move the stuff from gcipher. Include keysz.h in gcipher.h for backwards compatibility, even though it's not strictly necessary. --- Makefile.m4 | 2 +- gcipher.h | 49 +++----------------------------- keysz.h | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 99 insertions(+), 46 deletions(-) create mode 100644 keysz.h diff --git a/Makefile.m4 b/Makefile.m4 index 5a31b5b..fccb60d 100644 --- a/Makefile.m4 +++ b/Makefile.m4 @@ -160,7 +160,7 @@ libcatacomb_la_LDFLAGS = -version-info 3:0:1 ## difference between the first and last numbers is major version. pkginclude_HEADERS = \ - arena.h paranoia.h buf.h qdparse.h \ + arena.h paranoia.h buf.h qdparse.h keysz.h \ blkc.h hash.h gcipher.h ghash.h gmac.h grand.h ghash-def.h \ lcrand.h fibrand.h rc4.h seal.h rand.h noise.h fipstest.h maurer.h \ key.h key-error.h key-data.h passphrase.h pixie.h lmem.h \ diff --git a/gcipher.h b/gcipher.h index 42faad4..5682738 100644 --- a/gcipher.h +++ b/gcipher.h @@ -40,6 +40,10 @@ #include +#ifndef CATACOMB_KEYSZ_H +# include "keysz.h" +#endif + /*----- Generic symmetric cipher interface --------------------------------*/ typedef struct gcipher { @@ -72,51 +76,6 @@ typedef struct gccipher { #define GC_SETIV(c, iv) (c)->ops->setiv((c), (iv)) #define GC_BDRY(c) (c)->ops->bdry((c)) -/*----- Key size management -----------------------------------------------*/ - -/* --- Key size type constants --- * - * - * A key size limitation is an array of bytes. The first byte describes the - * kind of limitation on the key size %$k$%; the rest are argument bytes - * %$a_i$%, for %$i \ge 0$%. In all cases, %$a_0$% is the `recommended' key - * size. - * - * * @KSZ_ANY@ means there is no restriction. - * - * * @KSZ_RANGE@ requires that %$k \ge a_1$%, %$k \equiv 0 \pmod{a_3}$%, - * and, if %$a_2 \ne 0$%, %$k \le a_2$%. - * - * * @KSZ_SET@ requires that %$k \in {\,a_i\,}$%. - */ - -enum { - KSZ_ANY, /* Allows any key at all */ - KSZ_RANGE, /* Allows keys within a range */ - KSZ_SET /* Allows specific sizes of keys */ -}; - -/* --- @keysz@ --- * - * - * Arguments: @size_t sz@ = a proposed key size, or zero - * @const octet *ksz@ = pointer to key size table - * - * Returns: See below. - * - * Use: Returns a sensible key size. If @sz@ is nonzero, it is - * interpreted as an amount (in bytes) of key material which the - * caller has available, and the return value is either the - * largest allowable key size less than or equal to the caller's - * size, or zero if there is no valid key length small enough. - * If @sz@ is zero, the function returns a `recommended' key - * size. - */ - -extern size_t keysz(size_t /*sz*/, const octet */*ksz*/); - -#define KSZ_CHECK(pre, sz) (keysz((sz), pre##_keysz) == (sz)) -#define KSZ_ASSERT(pre, sz) \ - assert(((void)"Bad key size for " #pre, KSZ_CHECK(pre, sz))) - /*----- Tables ------------------------------------------------------------*/ extern const gccipher *const gciphertab[]; diff --git a/keysz.h b/keysz.h new file mode 100644 index 0000000..5a49740 --- /dev/null +++ b/keysz.h @@ -0,0 +1,94 @@ +/* -*-c-*- + * + * Key size management + * + * (c) 2007 Straylight/Edgeware + */ + +/*----- Licensing notice --------------------------------------------------* + * + * This file is part of Catacomb. + * + * Catacomb is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * Catacomb is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with Catacomb; if not, write to the Free + * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, + * MA 02111-1307, USA. + */ + +#ifndef CATACOMB_KEYSZ_H +#define CATACOMB_KEYSZ_H + +#ifdef __cplusplus + extern "C" { +#endif + +/*----- Header files ------------------------------------------------------*/ + +#include + +#include + +/*----- Data structures ---------------------------------------------------*/ + +/* --- Key size type constants --- * + * + * A key size limitation is an array of bytes. The first byte describes the + * kind of limitation on the key size %$k$%; the rest are argument bytes + * %$a_i$%, for %$i \ge 0$%. In all cases, %$a_0$% is the `recommended' key + * size. + * + * * @KSZ_ANY@ means there is no restriction. + * + * * @KSZ_RANGE@ requires that %$k \ge a_1$%, %$k \equiv 0 \pmod{a_3}$%, + * and, if %$a_2 \ne 0$%, %$k \le a_2$%. + * + * * @KSZ_SET@ requires that %$k \in {\,a_i\,}$%. + */ + +enum { + KSZ_ANY, /* Allows any key at all */ + KSZ_RANGE, /* Allows keys within a range */ + KSZ_SET /* Allows specific sizes of keys */ +}; + +/*----- Key sizes for symmetric algorithms --------------------------------*/ + +/* --- @keysz@ --- * + * + * Arguments: @size_t sz@ = a proposed key size, or zero + * @const octet *ksz@ = pointer to key size table + * + * Returns: See below. + * + * Use: Returns a sensible key size. If @sz@ is nonzero, it is + * interpreted as an amount (in bytes) of key material which the + * caller has available, and the return value is either the + * largest allowable key size less than or equal to the caller's + * size, or zero if there is no valid key length small enough. + * If @sz@ is zero, the function returns a `recommended' key + * size. + */ + +extern size_t keysz(size_t /*sz*/, const octet */*ksz*/); + +#define KSZ_CHECK(pre, sz) (keysz((sz), pre##_keysz) == (sz)) +#define KSZ_ASSERT(pre, sz) \ + assert(((void)"Bad key size for " #pre, KSZ_CHECK(pre, sz))) + +/*----- That's all, folks -------------------------------------------------*/ + +#ifdef __cplusplus + } +#endif + +#endif -- 2.11.0