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_MD5
  45   };
  46 typedef enum Gc_hash Gc_hash;
  47
  48 #define GC_MD5_DIGEST_SIZE 16
  49
  50 /* Call before respectively after any other functions. */
  51 extern int gc_init (void);
  52 extern void gc_done (void);
  53
  54 /* Memory allocation (avoid). */
  55 typedef void *(*gc_malloc_t) (size_t n);
  56 typedef int (*gc_secure_check_t) (const void *);
  57 typedef void *(*gc_realloc_t) (void *p, size_t n);
  58 typedef void (*gc_free_t) (void *);
  59 extern void gc_set_allocators (gc_malloc_t func_malloc,
  60                                gc_malloc_t secure_malloc,
  61                                gc_secure_check_t secure_check,
  62                                gc_realloc_t func_realloc,
  63                                gc_free_t func_free);
  64
  65 /* Hashes. */
  66
  67 /* Compute a hash value over buffer IN of INLEN bytes size using the
  68    algorithm HASH, placing the result in the pre-allocated buffer OUT.
  69    The required size of OUT depends on HASH, and is generally
  70    GC_<HASH>_DIGEST_SIZE.  For example, for GC_MD5 the output buffer
  71    must be 16 bytes.  The return value is 0 (GC_OK) on success, or
  72    another Gc_rc error code. */
  73 extern int
  74 gc_hash_buffer (Gc_hash hash, const void *in, size_t inlen, char *out);
  75
  76 /* One-call interface. */
  77 extern int gc_md5 (const void *in, size_t inlen, void *resbuf);
  78 extern int gc_hmac_md5 (const void *key, size_t keylen,
  79                         const void *in, size_t inlen,
  80                         char *resbuf);
  81
  82 /*
  83   TODO:
  84
  85   From: Simon Josefsson <jas@extundo.com>
  86   Subject: Re: generic crypto
  87   Newsgroups: gmane.comp.lib.gnulib.bugs
  88   Cc: bug-gnulib@gnu.org
  89   Date: Fri, 07 Oct 2005 12:50:57 +0200
  90   Mail-Copies-To: nobody
  91
  92   Paul Eggert <eggert@CS.UCLA.EDU> writes:
  93
  94   > Simon Josefsson <jas@extundo.com> writes:
  95   >
  96   >> * Perhaps the /dev/*random reading should be separated into a separate
  97   >>   module?  It might be useful outside of the gc layer too.
  98   >
  99   > Absolutely.  I've been meaning to do that for months (for a "shuffle"
 100   > program I want to add to coreutils), but hadn't gotten around to it.
 101   > It would have to be generalized a bit.  I'd like to have the file
 102   > descriptor cached, for example.
 103
 104   I'll write a separate module for that part.
 105
 106   I think we should even add a good PRNG that is re-seeded from
 107   /dev/*random frequently.  GnuTLS can need a lot of random data on a
 108   big server, more than /dev/random can supply.  And /dev/urandom might
 109   not be strong enough.  Further, the security of /dev/*random can also
 110   be questionable.
 111
 112   >>   I'm also not sure about the names of those functions, they suggest
 113   >>   a more higher-level API than what is really offered (i.e., the
 114   >>   names "nonce" and "pseudo_random" and "random" imply certain
 115   >>   cryptographic properties).
 116   >
 117   > Could you expand a bit more on that?  What is the relationship between
 118   > nonce/pseudorandom/random and the /dev/ values you are using?
 119
 120   There is none, that is the problem.
 121
 122   Applications generally need different kind of "random" numbers.
 123   Sometimes they just need some random data and doesn't care whether it
 124   is possible for an attacker to compute the string (aka a "nonce").
 125   Sometimes they need data that is very difficult to compute (i.e.,
 126   computing it require inverting SHA1 or similar).  Sometimes they need
 127   data that is not possible to compute, i.e., it wants real entropy
 128   collected over time on the system.  Collecting the last kind of random
 129   data is very expensive, so it must not be used too often.  The second
 130   kind of random data ("pseudo random") is typically generated by
 131   seeding a good PRNG with a couple of hundred bytes of real entropy
 132   from the "real random" data pool.  The "nonce" is usually computed
 133   using the PRNG as well, because PRNGs are usually fast.
 134
 135   Pseudo-random data is typically used for session keys.  Strong random
 136   data is often used to generate long-term keys (e.g., private RSA
 137   keys).
 138
 139   Of course, there are many subtleties.  There are several different
 140   kind of nonce:s.  Sometimes a nonce is just an ever-increasing
 141   integer, starting from 0.  Sometimes it is assumed to be unlikely to
 142   be the same as previous nonces, but without a requirement that the
 143   nonce is possible to guess.  MD5(system clock) would thus suffice, if
 144   it isn't called too often.  You can guess what the next value will be,
 145   but it will always be different.
 146
 147   The problem is that /dev/*random doesn't offer any kind of semantic
 148   guarantees.  But applications need an API that make that promise.
 149
 150   I think we should do this in several steps:
 151
 152   1) Write a module that can read from /dev/*random.
 153
 154   2) Add a module for a known-good PRNG suitable for random number
 155   generation, that can be continuously re-seeded.
 156
 157   3) Add a high-level module that provide various different randomness
 158   functions.  One for nonces, perhaps even different kind of nonces,
 159   one for pseudo random data, and one for strong random data.  It is
 160   not clear whether we can hope to achieve the last one in a portable
 161   way.
 162
 163   Further, it would be useful to allow users to provide their own
 164   entropy source as a file, used to seed the PRNG or initialize the
 165   strong randomness pool.  This is used on embedded platforms that
 166   doesn't have enough interrupts to hope to generate good random data.
 167
 168   > For example, why not use OpenBSD's /dev/arandom?
 169
 170   I don't trust ARC4.  For example, recent cryptographic efforts
 171   indicate that you must throw away the first 512 bytes generated from
 172   the PRNG for it to be secure.  I don't know whether OpenBSD do this.
 173   Further, I recall some eprint paper on RC4 security that didn't
 174   inspire confidence.
 175
 176   While I trust the random devices in OpenBSD more than
 177   Solaris/AIX/HPUX/etc, I think that since we need something better on
 178   Solaris/AIX/HPUX we'd might as well use it on OpenBSD or even Linux
 179   too.
 180
 181   > Here is one thought.  The user could specify a desired quality level
 182   > range, and the implementation then would supply random data that is at
 183   > least as good as the lower bound of the range.  I.e., ihe
 184   > implementation refuses to produce any random data if it can't generate
 185   > data that is at least as good as the lower end of the range.  The
 186   > upper bound of the range is advice from the user not to be any more
 187   > expensive than that, but the implementation can ignore the advice if
 188   > it doesn't have anything cheaper.
 189
 190   I'm not sure this is a good idea.  Users can't really be expected to
 191   understand this.  Further, applications need many different kind of
 192   random data.  Selecting the randomness level for each by the user will
 193   be too complicated.
 194
 195   I think it is better if the application decide, from its cryptographic
 196   requirement, what entropy quality it require, and call the proper API.
 197   Meeting the implied semantic properties should be the job for gnulib.
 198
 199   >> Perhaps gc_dev_random and gc_dev_urandom?
 200   >
 201   > To some extent.  I'd rather insulate the user from the details of
 202   > where the random numbers come from.  On the other hand we need to
 203   > provide a way for applications to specify a file that contains
 204   > random bits, so that people can override the defaults.
 205
 206   Agreed.
 207
 208   This may require some thinking before it is finalized.  Is it ok to
 209   install the GC module as-is meanwhile?  Then I can continue to add the
 210   stuff that GnuTLS need, and then come back to re-working the
 211   randomness module.  That way, we have two different projects that use
 212   the code.  GnuTLS includes the same randomness code that was in GNU
 213   SASL and that is in the current gc module.  I feel much more
 214   comfortable working in small steps at a time, rather then working on
 215   this for a long time in gnulib and only later integrate the stuff in
 216   GnuTLS.
 217
 218   Thanks,
 219   Simon
 220  */
 221
 222 #endif /* GC_H */