lib/gc.h

   1 /* gc.h --- Header file for implementation agnostic crypto wrapper API.
   2  * Copyright (C) 2002, 2003, 2004, 2005  Simon Josefsson
   3  *
   4  * This file is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published
   6  * by the Free Software Foundation; either version 2, or (at your
   7  * option) any later version.
   8  *
   9  * This file is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this file; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA.
  18  *
  19  */
  20
  21 #ifndef GC_H
  22 # define GC_H
  23
  24 /* Get size_t. */
  25 # include <stddef.h>
  26
  27 enum Gc_rc
  28 {
  29   GC_OK = 0,
  30   GC_MALLOC_ERROR,
  31   GC_INIT_ERROR,
  32   GC_RANDOM_ERROR,
  33   GC_INVALID_CIPHER,
  34   GC_INVALID_HASH,
  35   GC_PKCS5_INVALID_ITERATION_COUNT,
  36   GC_PKCS5_INVALID_DERIVED_KEY_LENGTH,
  37   GC_PKCS5_DERIVED_KEY_TOO_LONG
  38 };
  39 typedef enum Gc_rc Gc_rc;
  40
  41 /* Hash types. */
  42 enum Gc_hash
  43 {
  44   GC_MD4,
  45   GC_MD5,
  46   GC_SHA1,
  47   GC_MD2,
  48   GC_RMD160
  49 };
  50 typedef enum Gc_hash Gc_hash;
  51
  52 enum Gc_hash_mode
  53 {
  54   GC_HMAC = 1
  55 };
  56 typedef enum Gc_hash_mode Gc_hash_mode;
  57
  58 typedef void *gc_hash_handle;
  59
  60 #define GC_MD4_DIGEST_SIZE 16
  61 #define GC_MD5_DIGEST_SIZE 16
  62 #define GC_SHA1_DIGEST_SIZE 20
  63
  64 /* Cipher types. */
  65 enum Gc_cipher
  66 {
  67   GC_AES128,
  68   GC_AES192,
  69   GC_AES256,
  70   GC_3DES,
  71   GC_DES,
  72   GC_ARCFOUR128,
  73   GC_ARCFOUR40,
  74   GC_ARCTWO40
  75 };
  76 typedef enum Gc_cipher Gc_cipher;
  77
  78 enum Gc_cipher_mode
  79 {
  80   GC_ECB,
  81   GC_CBC,
  82   GC_STREAM
  83 };
  84 typedef enum Gc_cipher_mode Gc_cipher_mode;
  85
  86 typedef void *gc_cipher_handle;
  87
  88 /* Call before respectively after any other functions. */
  89 extern Gc_rc gc_init (void);
  90 extern void gc_done (void);
  91
  92 /* Memory allocation (avoid). */
  93 typedef void *(*gc_malloc_t) (size_t n);
  94 typedef int (*gc_secure_check_t) (const void *);
  95 typedef void *(*gc_realloc_t) (void *p, size_t n);
  96 typedef void (*gc_free_t) (void *);
  97 extern void gc_set_allocators (gc_malloc_t func_malloc,
  98                                gc_malloc_t secure_malloc,
  99                                gc_secure_check_t secure_check,
 100                                gc_realloc_t func_realloc,
 101                                gc_free_t func_free);
 102
 103 /* Randomness. */
 104 extern Gc_rc gc_nonce (char *data, size_t datalen);
 105 extern Gc_rc gc_pseudo_random (char *data, size_t datalen);
 106 extern Gc_rc gc_random (char *data, size_t datalen);
 107
 108 /* Ciphers. */
 109 extern Gc_rc gc_cipher_open (Gc_cipher cipher, Gc_cipher_mode mode,
 110                              gc_cipher_handle *outhandle);
 111 extern Gc_rc gc_cipher_setkey (gc_cipher_handle handle,
 112                                size_t keylen, const char *key);
 113 extern Gc_rc gc_cipher_setiv (gc_cipher_handle handle,
 114                               size_t ivlen, const char *iv);
 115 extern Gc_rc gc_cipher_encrypt_inline (gc_cipher_handle handle,
 116                                        size_t len, char *data);
 117 extern Gc_rc gc_cipher_decrypt_inline (gc_cipher_handle handle,
 118                                        size_t len, char *data);
 119 extern Gc_rc gc_cipher_close (gc_cipher_handle handle);
 120
 121 /* Hashes. */
 122
 123 extern Gc_rc gc_hash_open (Gc_hash hash, Gc_hash_mode mode,
 124                            gc_hash_handle *outhandle);
 125 extern Gc_rc gc_hash_clone (gc_hash_handle handle, gc_hash_handle *outhandle);
 126 extern size_t gc_hash_digest_length (Gc_hash hash);
 127 extern void gc_hash_hmac_setkey (gc_hash_handle handle,
 128                                  size_t len, const char *key);
 129 extern void gc_hash_write (gc_hash_handle handle,
 130                            size_t len, const char *data);
 131 extern const char *gc_hash_read (gc_hash_handle handle);
 132 extern void gc_hash_close (gc_hash_handle handle);
 133
 134 /* Compute a hash value over buffer IN of INLEN bytes size using the
 135    algorithm HASH, placing the result in the pre-allocated buffer OUT.
 136    The required size of OUT depends on HASH, and is generally
 137    GC_<HASH>_DIGEST_SIZE.  For example, for GC_MD5 the output buffer
 138    must be 16 bytes.  The return value is 0 (GC_OK) on success, or
 139    another Gc_rc error code. */
 140 extern Gc_rc
 141 gc_hash_buffer (Gc_hash hash, const void *in, size_t inlen, char *out);
 142
 143 /* One-call interface. */
 144 extern Gc_rc gc_md5 (const void *in, size_t inlen, void *resbuf);
 145 extern Gc_rc gc_sha1 (const void *in, size_t inlen, void *resbuf);
 146 extern Gc_rc gc_hmac_md5 (const void *key, size_t keylen,
 147                           const void *in, size_t inlen, char *resbuf);
 148 extern Gc_rc gc_hmac_sha1 (const void *key, size_t keylen,
 149                            const void *in, size_t inlen, char *resbuf);
 150
 151 /* Derive cryptographic keys from a password P of length PLEN, with
 152    salt S of length SLEN, placing the result in pre-allocated buffer
 153    DK of length DKLEN.  An iteration count is specified in C, where a
 154    larger value means this function take more time (typical iteration
 155    counts are 1000-20000).  This function "stretches" the key to be
 156    exactly dkLen bytes long.  GC_OK is returned on success, otherwise
 157    an Gc_rc error code is returned.  */
 158 extern Gc_rc
 159 gc_pbkdf2_sha1 (const char *P, size_t Plen,
 160                 const char *S, size_t Slen,
 161                 unsigned int c, char *DK, size_t dkLen);
 162
 163 /*
 164   TODO:
 165
 166   From: Simon Josefsson <jas@extundo.com>
 167   Subject: Re: generic crypto
 168   Newsgroups: gmane.comp.lib.gnulib.bugs
 169   Cc: bug-gnulib@gnu.org
 170   Date: Fri, 07 Oct 2005 12:50:57 +0200
 171   Mail-Copies-To: nobody
 172
 173   Paul Eggert <eggert@CS.UCLA.EDU> writes:
 174
 175   > Simon Josefsson <jas@extundo.com> writes:
 176   >
 177   >> * Perhaps the /dev/?random reading should be separated into a separate
 178   >>   module?  It might be useful outside of the gc layer too.
 179   >
 180   > Absolutely.  I've been meaning to do that for months (for a "shuffle"
 181   > program I want to add to coreutils), but hadn't gotten around to it.
 182   > It would have to be generalized a bit.  I'd like to have the file
 183   > descriptor cached, for example.
 184
 185   I'll write a separate module for that part.
 186
 187   I think we should even add a good PRNG that is re-seeded from
 188   /dev/?random frequently.  GnuTLS can need a lot of random data on a
 189   big server, more than /dev/random can supply.  And /dev/urandom might
 190   not be strong enough.  Further, the security of /dev/?random can also
 191   be questionable.
 192
 193   >>   I'm also not sure about the names of those functions, they suggest
 194   >>   a more higher-level API than what is really offered (i.e., the
 195   >>   names "nonce" and "pseudo_random" and "random" imply certain
 196   >>   cryptographic properties).
 197   >
 198   > Could you expand a bit more on that?  What is the relationship between
 199   > nonce/pseudorandom/random and the /dev/ values you are using?
 200
 201   There is none, that is the problem.
 202
 203   Applications generally need different kind of "random" numbers.
 204   Sometimes they just need some random data and doesn't care whether it
 205   is possible for an attacker to compute the string (aka a "nonce").
 206   Sometimes they need data that is very difficult to compute (i.e.,
 207   computing it require inverting SHA1 or similar).  Sometimes they need
 208   data that is not possible to compute, i.e., it wants real entropy
 209   collected over time on the system.  Collecting the last kind of random
 210   data is very expensive, so it must not be used too often.  The second
 211   kind of random data ("pseudo random") is typically generated by
 212   seeding a good PRNG with a couple of hundred bytes of real entropy
 213   from the "real random" data pool.  The "nonce" is usually computed
 214   using the PRNG as well, because PRNGs are usually fast.
 215
 216   Pseudo-random data is typically used for session keys.  Strong random
 217   data is often used to generate long-term keys (e.g., private RSA
 218   keys).
 219
 220   Of course, there are many subtleties.  There are several different
 221   kind of nonce:s.  Sometimes a nonce is just an ever-increasing
 222   integer, starting from 0.  Sometimes it is assumed to be unlikely to
 223   be the same as previous nonces, but without a requirement that the
 224   nonce is possible to guess.  MD5(system clock) would thus suffice, if
 225   it isn't called too often.  You can guess what the next value will be,
 226   but it will always be different.
 227
 228   The problem is that /dev/?random doesn't offer any kind of semantic
 229   guarantees.  But applications need an API that make that promise.
 230
 231   I think we should do this in several steps:
 232
 233   1) Write a module that can read from /dev/?random.
 234
 235   2) Add a module for a known-good PRNG suitable for random number
 236   generation, that can be continuously re-seeded.
 237
 238   3) Add a high-level module that provide various different randomness
 239   functions.  One for nonces, perhaps even different kind of nonces,
 240   one for pseudo random data, and one for strong random data.  It is
 241   not clear whether we can hope to achieve the last one in a portable
 242   way.
 243
 244   Further, it would be useful to allow users to provide their own
 245   entropy source as a file, used to seed the PRNG or initialize the
 246   strong randomness pool.  This is used on embedded platforms that
 247   doesn't have enough interrupts to hope to generate good random data.
 248
 249   > For example, why not use OpenBSD's /dev/arandom?
 250
 251   I don't trust ARC4.  For example, recent cryptographic efforts
 252   indicate that you must throw away the first 512 bytes generated from
 253   the PRNG for it to be secure.  I don't know whether OpenBSD do this.
 254   Further, I recall some eprint paper on RC4 security that didn't
 255   inspire confidence.
 256
 257   While I trust the random devices in OpenBSD more than
 258   Solaris/AIX/HPUX/etc, I think that since we need something better on
 259   Solaris/AIX/HPUX we'd might as well use it on OpenBSD or even Linux
 260   too.
 261
 262   > Here is one thought.  The user could specify a desired quality level
 263   > range, and the implementation then would supply random data that is at
 264   > least as good as the lower bound of the range.  I.e., ihe
 265   > implementation refuses to produce any random data if it can't generate
 266   > data that is at least as good as the lower end of the range.  The
 267   > upper bound of the range is advice from the user not to be any more
 268   > expensive than that, but the implementation can ignore the advice if
 269   > it doesn't have anything cheaper.
 270
 271   I'm not sure this is a good idea.  Users can't really be expected to
 272   understand this.  Further, applications need many different kind of
 273   random data.  Selecting the randomness level for each by the user will
 274   be too complicated.
 275
 276   I think it is better if the application decide, from its cryptographic
 277   requirement, what entropy quality it require, and call the proper API.
 278   Meeting the implied semantic properties should be the job for gnulib.
 279
 280   >> Perhaps gc_dev_random and gc_dev_urandom?
 281   >
 282   > To some extent.  I'd rather insulate the user from the details of
 283   > where the random numbers come from.  On the other hand we need to
 284   > provide a way for applications to specify a file that contains
 285   > random bits, so that people can override the defaults.
 286
 287   Agreed.
 288
 289   This may require some thinking before it is finalized.  Is it ok to
 290   install the GC module as-is meanwhile?  Then I can continue to add the
 291   stuff that GnuTLS need, and then come back to re-working the
 292   randomness module.  That way, we have two different projects that use
 293   the code.  GnuTLS includes the same randomness code that was in GNU
 294   SASL and that is in the current gc module.  I feel much more
 295   comfortable working in small steps at a time, rather then working on
 296   this for a long time in gnulib and only later integrate the stuff in
 297   GnuTLS.
 298
 299   Thanks,
 300   Simon
 301  */
 302
 303 #endif /* GC_H */