chiark - git - mdw - catacomb/blob - rand/rand.c

   1 /* -*-c-*-
   2  *
   3  * Secure random number generator
   4  *
   5  * (c) 1998 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Catacomb.
  11  *
  12  * Catacomb is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * Catacomb is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with Catacomb; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 /*----- Header files ------------------------------------------------------*/
  29
  30 #include "config.h"
  31
  32 #include <stdarg.h>
  33 #include <stdio.h>
  34 #include <string.h>
  35
  36 #include <mLib/bits.h>
  37 #include <mLib/sub.h>
  38
  39 #include "arena.h"
  40 #include "dispatch.h"
  41 #include "paranoia.h"
  42
  43 #define RAND__HACKS
  44 #include "rand.h"
  45
  46 #include "noise.h"
  47
  48 #include "twofish-counter.h"
  49 #include "sha256.h"
  50
  51 #define CIPHER_CTX twofish_counterctx
  52 #define CIPHER_INIT twofish_counterinit
  53 #define CIPHER_ENCRYPT twofish_counterencrypt
  54 #define CIPHER_IVSZ TWOFISH_BLKSZ
  55 #define CIPHER_KEYSZ TWOFISH_KEYSZ
  56
  57 #define HASH_CTX sha256_ctx
  58 #define HASH_INIT sha256_init
  59 #define HASH sha256_hash
  60 #define HASH_DONE sha256_done
  61 #define HASH_SZ SHA256_HASHSZ
  62
  63 /*----- Static variables --------------------------------------------------*/
  64
  65 static const grand_ops gops;
  66
  67 typedef struct rand__gctx {
  68   grand r;
  69   rand_pool p;
  70 } gctx;
  71
  72 gctx rand_global = {
  73   { &gops },
  74   { { 0 }, 0, 0, 0, 0,
  75     { 0 }, RAND_SECSZ, 0,
  76     { "Catacomb global random byte pool" },
  77     &noise_source }
  78 };
  79
  80 /*----- Macros ------------------------------------------------------------*/
  81
  82 #define RAND_RESOLVE(r)                                                 \
  83   do { if ((r) == RAND_GLOBAL) r = &rand_global.p; } while (0)
  84
  85 #define GENCHECK(r) do {                                                \
  86   unsigned gen = rand_generation();                                     \
  87   if (r->gen != gen) { r->gen = gen; rand_gate(r); }                    \
  88 } while (0)
  89
  90 static int quick(rand_pool *);
  91 #define QUICK(r) do {                                                   \
  92   quick(r);                                                             \
  93   if ((r)->s && (r)->s->timer) (r)->s->timer(r);                        \
  94 } while (0)
  95
  96 /*----- Main code ---------------------------------------------------------*/
  97
  98 /* --- @rand_init@ --- *
  99  *
 100  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 101  *
 102  * Returns:     ---
 103  *
 104  * Use:         Initializes a randomness pool.  The pool doesn't start out
 105  *              very random: that's your job to sort out.  A good suggestion
 106  *              would be to attach an appropriate noise source and call
 107  *              @rand_seed@.
 108  */
 109
 110 void rand_init(rand_pool *r)
 111 {
 112   RAND_RESOLVE(r);
 113   memset(r->pool, 0, sizeof(r->pool));
 114   memset(r->buf, 0, sizeof(r->buf));
 115   r->gen = rand_generation();
 116   r->i = 0;
 117   r->irot = 0;
 118   r->ibits = r->obits = 0;
 119   r->o = RAND_SECSZ;
 120   r->s = &noise_source;
 121   rand_key(r, 0, 0);
 122   rand_gate(r);
 123 }
 124
 125 /* --- @rand_noisesrc@ --- *
 126  *
 127  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 128  *              @const rand_source *s@ = pointer to source definition
 129  *
 130  * Returns:     ---
 131  *
 132  * Use:         Sets a noise source for a randomness pool.  When the pool's
 133  *              estimate of good random bits falls to zero, the @getnoise@
 134  *              function is called, passing the pool handle as an argument.
 135  *              It is expected to increase the number of good bits by at
 136  *              least one, because it'll be called over and over again until
 137  *              there are enough bits to satisfy the caller.  The @timer@
 138  *              function is called frequently throughout the generator's
 139  *              operation.
 140  */
 141
 142 void rand_noisesrc(rand_pool *r, const rand_source *s)
 143 {
 144   RAND_RESOLVE(r);
 145   r->s = s;
 146 }
 147
 148 /* --- @rand_quick@ --- *
 149  *
 150  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 151  *
 152  * Returns:     Zero on success; @-1@ on failure.
 153  *
 154  * Use          Attempts to use some machine-specific `quick' source of
 155  *              entropy to top up @r@.  This may not do anything at all on
 156  *              many systems.
 157  */
 158
 159 CPU_DISPATCH(static, return, int, quick, (rand_pool *r), (r),
 160              pick_quick, trivial_quick);
 161
 162 static int trivial_quick(rand_pool *r) { return (-1); }
 163
 164 #if CPUFAM_X86 || CPUFAM_AMD64
 165 extern int rand_quick_x86ish_rdrand(rand_pool */*r*/);
 166 extern int rand_quick_x86ish_rdseed(rand_pool */*r*/);
 167 #endif
 168
 169 static quick__functype *pick_quick(void)
 170 {
 171 #if CPUFAM_X86 || CPUFAM_AMD64
 172   DISPATCH_PICK_COND(rand_quick, rand_quick_x86ish_rdseed,
 173                      cpu_feature_p(CPUFEAT_X86_RDSEED));
 174   DISPATCH_PICK_COND(rand_quick, rand_quick_x86ish_rdrand,
 175                      cpu_feature_p(CPUFEAT_X86_RDRAND));
 176 #endif
 177   DISPATCH_PICK_FALLBACK(rand_quick, trivial_quick);
 178 }
 179
 180 int rand_quick(rand_pool *r) { RAND_RESOLVE(r); return (quick(r)); }
 181
 182 /* --- @rand_seed@ --- *
 183  *
 184  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 185  *              @unsigned bits@ = number of bits to ensure
 186  *
 187  * Returns:     ---
 188  *
 189  * Use:         Ensures that there are at least @bits@ good bits of entropy
 190  *              in the pool.  It is recommended that you call this after
 191  *              initializing a new pool.  Requesting @bits > RAND_IBITS@ is
 192  *              doomed to failure (and is an error).
 193  */
 194
 195 void rand_seed(rand_pool *r, unsigned bits)
 196 {
 197   RAND_RESOLVE(r);
 198
 199   assert(((void)"bits pointlessly large in rand_seed", bits <= RAND_IBITS));
 200   assert(((void)"no noise source in rand_seed", r->s));
 201
 202   while (r->ibits < bits)
 203     r->s->getnoise(r);
 204   rand_gate(r);
 205 }
 206
 207 /* --- @rand_key@ --- *
 208  *
 209  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 210  *              @const void *k@ = pointer to key data
 211  *              @size_t sz@ = size of key data
 212  *
 213  * Returns:     ---
 214  *
 215  * Use:         Sets the secret key for a randomness pool.  The key is used
 216  *              when mixing in new random bits.
 217  */
 218
 219 void rand_key(rand_pool *r, const void *k, size_t sz)
 220 {
 221   HASH_CTX hc;
 222   octet h[HASH_SZ];
 223   static const char label[] = "Catacomb random pool key";
 224
 225   RAND_RESOLVE(r);
 226
 227   assert(HASH_SZ >= RAND_KEYSZ);
 228   HASH_INIT(&hc);
 229   HASH(&hc, label, sizeof(label));
 230   if (sz) HASH(&hc, k, sz);
 231   HASH_DONE(&hc, h);
 232   memcpy(r->k.k, h, RAND_KEYSZ);
 233 }
 234
 235 /* --- @rand_add@ --- *
 236  *
 237  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 238  *              @const void *p@ = pointer a buffer of data to add
 239  *              @size_t sz@ = size of the data buffer
 240  *              @unsigned goodbits@ = number of good bits estimated in buffer
 241  *
 242  * Returns:     ---
 243  *
 244  * Use:         Mixes the data in the buffer with the contents of the
 245  *              pool.  The estimate of the number of good bits is added to
 246  *              the pool's own count.  The mixing operation is not
 247  *              cryptographically strong.  However, data in the input pool
 248  *              isn't output directly, only through the one-way gating
 249  *              operation, so that shouldn't matter.
 250  */
 251
 252 void rand_add(rand_pool *r, const void *p, size_t sz, unsigned goodbits)
 253 {
 254   const octet *c = p;
 255   int i, rot;
 256
 257   STATIC_ASSERT(RAND_POOLSZ == 128, "Polynomial doesn't match pool size");
 258
 259   RAND_RESOLVE(r);
 260
 261   i = r->i; rot = r->irot;
 262
 263   while (sz) {
 264     octet o = *c++;
 265     r->pool[i] ^= (ROL8(o, rot) ^
 266                    r->pool[(i + 1) % RAND_POOLSZ] ^
 267                    r->pool[(i + 2) % RAND_POOLSZ] ^
 268                    r->pool[(i + 7) % RAND_POOLSZ]);
 269     rot = (rot + 5) & 7;
 270     i++; if (i >= RAND_POOLSZ) i -= RAND_POOLSZ;
 271     sz--;
 272   }
 273
 274   r->i = i;
 275   r->irot = rot;
 276   r->ibits += goodbits;
 277   if (r->ibits > RAND_IBITS)
 278     r->ibits = RAND_IBITS;
 279 }
 280
 281 /* --- @rand_goodbits@ --- *
 282  *
 283  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 284  *
 285  * Returns:     Estimate of the number of good bits remaining in the pool.
 286  */
 287
 288 unsigned rand_goodbits(rand_pool *r)
 289 {
 290   RAND_RESOLVE(r);
 291   return (r->ibits + r->obits);
 292 }
 293
 294 /* --- @rand_gate@ --- *
 295  *
 296  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 297  *
 298  * Returns:     ---
 299  *
 300  * Use:         Mixes up the entire state of the generator in a nonreversible
 301  *              way.
 302  */
 303
 304 void rand_gate(rand_pool *r)
 305 {
 306   octet h[HASH_SZ], g[4];
 307   HASH_CTX hc;
 308   CIPHER_CTX cc;
 309
 310   STATIC_ASSERT(CIPHER_KEYSZ <= HASH_SZ, "rand cipher keysize too long");
 311
 312   RAND_RESOLVE(r);
 313   QUICK(r);
 314
 315   /* --- Hash up all the data in the pool --- */
 316
 317   HASH_INIT(&hc);
 318   STORE32(g, r->gen); HASH(&hc, g, sizeof(g));
 319   HASH(&hc, r->k.k, RAND_KEYSZ);
 320   HASH(&hc, r->pool, RAND_POOLSZ);
 321   HASH(&hc, r->buf, RAND_BUFSZ);
 322   HASH_DONE(&hc, h);
 323   BURN(hc);
 324
 325   /* --- Now mangle all of the data based on the hash --- */
 326
 327   CIPHER_INIT(&cc, h, CIPHER_KEYSZ, 0);
 328   CIPHER_ENCRYPT(&cc, r->pool, r->pool, RAND_POOLSZ);
 329   CIPHER_ENCRYPT(&cc, r->buf, r->buf, RAND_BUFSZ);
 330   BURN(cc);
 331
 332   /* --- Reset the various state variables --- */
 333
 334   r->o = RAND_SECSZ;
 335   r->obits += r->ibits;
 336   if (r->obits > RAND_OBITS) {
 337     r->ibits = r->obits - r->ibits;
 338     r->obits = RAND_OBITS;
 339   } else
 340     r->ibits = 0;
 341   QUICK(r);
 342 }
 343
 344 /* --- @rand_stretch@ --- *
 345  *
 346  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 347  *
 348  * Returns:     ---
 349  *
 350  * Use:         Stretches the contents of the output buffer by transforming
 351  *              it in a nonreversible way.  This doesn't add any entropy
 352  *              worth speaking about, but it works well enough when the
 353  *              caller doesn't care about that sort of thing.
 354  */
 355
 356 void rand_stretch(rand_pool *r)
 357 {
 358   octet h[HASH_SZ], g[4];
 359   HASH_CTX hc;
 360   CIPHER_CTX cc;
 361
 362   STATIC_ASSERT(CIPHER_KEYSZ <= HASH_SZ, "rand cipher keysize too long");
 363
 364   RAND_RESOLVE(r);
 365   QUICK(r);
 366
 367   /* --- Hash up all the data in the buffer --- */
 368
 369   HASH_INIT(&hc);
 370   STORE32(g, r->gen); HASH(&hc, g, sizeof(g));
 371   HASH(&hc, r->k.k, RAND_KEYSZ);
 372   HASH(&hc, r->pool, RAND_POOLSZ);
 373   HASH(&hc, r->buf, RAND_BUFSZ);
 374   HASH_DONE(&hc, h);
 375   BURN(hc);
 376
 377   /* --- Now mangle the buffer based on the hash --- */
 378
 379   CIPHER_INIT(&cc, h, CIPHER_KEYSZ, 0);
 380   CIPHER_ENCRYPT(&cc, r->buf, r->buf, RAND_BUFSZ);
 381   BURN(cc);
 382
 383   /* --- Reset the various state variables --- */
 384
 385   r->o = RAND_SECSZ;
 386   QUICK(r);
 387 }
 388
 389 /* --- @rand_get@ --- *
 390  *
 391  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 392  *              @void *p@ = pointer to output buffer
 393  *              @size_t sz@ = size of output buffer
 394  *
 395  * Returns:     ---
 396  *
 397  * Use:         Gets random data from the pool.  The pool's contents can't be
 398  *              determined from the output of this function; nor can the
 399  *              output data be determined from a knowledge of the data input
 400  *              to the pool wihtout also having knowledge of the secret key.
 401  *              The good bits counter is decremented, although no special
 402  *              action is taken if it reaches zero.
 403  */
 404
 405 void rand_get(rand_pool *r, void *p, size_t sz)
 406 {
 407   octet *o = p;
 408
 409   RAND_RESOLVE(r);
 410   GENCHECK(r);
 411   QUICK(r);
 412
 413   if (!sz)
 414     return;
 415   for (;;) {
 416     if (r->o + sz <= RAND_BUFSZ) {
 417       memcpy(o, r->buf + r->o, sz);
 418       r->o += sz;
 419       break;
 420     } else {
 421       size_t chunk = RAND_BUFSZ - r->o;
 422       if (chunk) {
 423         memcpy(o, r->buf + r->o, chunk);
 424         sz -= chunk;
 425         o += chunk;
 426       }
 427       rand_stretch(r);
 428     }
 429   }
 430
 431   if (r->obits > sz * 8)
 432     r->obits -= sz * 8;
 433   else
 434     r->obits = 0;
 435 }
 436
 437 /* --- @rand_getgood@ --- *
 438  *
 439  * Arguments:   @rand_pool *r@ = pointer to a randomness pool
 440  *              @void *p@ = pointer to output buffer
 441  *              @size_t sz@ = size of output buffer
 442  *
 443  * Returns:     ---
 444  *
 445  * Use:         Gets random data from the pool, ensuring that there are
 446  *              enough good bits.  This interface isn't recommended: it makes
 447  *              the generator slow, and doesn't provide much more security
 448  *              than @rand_get@, assuming you've previously done a
 449  *              @rand_seed@.
 450  */
 451
 452 void rand_getgood(rand_pool *r, void *p, size_t sz)
 453 {
 454   octet *o = p;
 455
 456   RAND_RESOLVE(r);
 457
 458   if (!sz)
 459     return;
 460   if (!r->s || !r->s->getnoise) {
 461     rand_get(r, p, sz);
 462     return;
 463   }
 464   GENCHECK(r);
 465   QUICK(r);
 466
 467   while (sz) {
 468     size_t chunk = sz;
 469
 470     if (chunk * 8 > r->obits) {
 471       if (chunk * 8 > r->ibits + r->obits)
 472         do r->s->getnoise(r); while (r->ibits + r->obits < 256);
 473       rand_gate(r);
 474       if (chunk * 8 > r->obits)
 475         chunk = r->obits / 8;
 476     }
 477
 478     if (chunk + r->o > RAND_BUFSZ)
 479       chunk = RAND_BUFSZ - r->o;
 480
 481     memcpy(o, r->buf + r->o, chunk);
 482     r->o += chunk;
 483     r->obits -= chunk * 8;
 484     o += chunk;
 485     sz -= chunk;
 486   }
 487 }
 488
 489 /*----- Generic random number generator interface -------------------------*/
 490
 491 static void gdestroy(grand *r)
 492 {
 493   gctx *g = (gctx *)r;
 494   if (g != &rand_global) {
 495     BURN(*g);
 496     S_DESTROY(g);
 497   }
 498 }
 499
 500 static int gmisc(grand *r, unsigned op, ...)
 501 {
 502   gctx *g = (gctx *)r;
 503   va_list ap;
 504   int rc = 0;
 505   va_start(ap, op);
 506
 507   switch (op) {
 508     case GRAND_CHECK:
 509       switch (va_arg(ap, unsigned)) {
 510         case GRAND_CHECK:
 511         case GRAND_SEEDINT:
 512         case GRAND_SEEDUINT32:
 513         case GRAND_SEEDBLOCK:
 514         case GRAND_SEEDRAND:
 515         case RAND_GATE:
 516         case RAND_STRETCH:
 517         case RAND_KEY:
 518         case RAND_NOISESRC:
 519         case RAND_SEED:
 520         case RAND_TIMER:
 521         case RAND_GOODBITS:
 522         case RAND_ADD:
 523           rc = 1;
 524           break;
 525         default:
 526           rc = 0;
 527           break;
 528       }
 529       break;
 530     case GRAND_SEEDINT: {
 531       unsigned u = va_arg(ap, unsigned);
 532       rand_add(&g->p, &u, sizeof(u), sizeof(u));
 533     } break;
 534     case GRAND_SEEDUINT32: {
 535       uint32 i = va_arg(ap, uint32);
 536       rand_add(&g->p, &i, sizeof(i), 4);
 537     } break;
 538     case GRAND_SEEDBLOCK: {
 539       const void *p = va_arg(ap, const void *);
 540       size_t sz = va_arg(ap, size_t);
 541       rand_add(&g->p, p, sz, sz);
 542     } break;
 543     case GRAND_SEEDRAND: {
 544       grand *rr = va_arg(ap, grand *);
 545       octet buf[16];
 546       rr->ops->fill(rr, buf, sizeof(buf));
 547       rand_add(&g->p, buf, sizeof(buf), 8);
 548     } break;
 549     case RAND_GATE:
 550       rand_gate(&g->p);
 551       break;
 552     case RAND_STRETCH:
 553       rand_stretch(&g->p);
 554       break;
 555     case RAND_KEY: {
 556       const void *k = va_arg(ap, const void *);
 557       size_t sz = va_arg(ap, size_t);
 558       rand_key(&g->p, k, sz);
 559     } break;
 560     case RAND_NOISESRC:
 561       rand_noisesrc(&g->p, va_arg(ap, const rand_source *));
 562       break;
 563     case RAND_SEED:
 564       rand_seed(&g->p, va_arg(ap, unsigned));
 565       break;
 566     case RAND_TIMER:
 567       QUICK(&g->p);
 568       break;
 569     case RAND_GOODBITS:
 570       rc = rand_goodbits(&g->p);
 571       break;
 572     case RAND_ADD: {
 573       const void *p = va_arg(ap, const void *);
 574       size_t sz = va_arg(ap, size_t);
 575       unsigned goodbits = va_arg(ap, unsigned);
 576       rand_add(&g->p, p, sz, goodbits);
 577     } break;
 578     default:
 579       GRAND_BADOP;
 580       break;
 581   }
 582
 583   va_end(ap);
 584   return (rc);
 585 }
 586
 587 static octet gbyte(grand *r)
 588 {
 589   gctx *g = (gctx *)r;
 590   octet o;
 591   rand_getgood(&g->p, &o, 1);
 592   return (o);
 593 }
 594
 595 static uint32 gword(grand *r)
 596 {
 597   gctx *g = (gctx *)r;
 598   octet b[4];
 599   rand_getgood(&g->p, &b, sizeof(b));
 600   return (LOAD32(b));
 601 }
 602
 603 static void gfill(grand *r, void *p, size_t sz)
 604 {
 605   gctx *g = (gctx *)r;
 606   rand_get(&g->p, p, sz);
 607 }
 608
 609 static const grand_ops gops = {
 610   "rand",
 611   GRAND_CRYPTO, 0,
 612   gmisc, gdestroy,
 613   gword, gbyte, gword, grand_defaultrange, gfill
 614 };
 615
 616 /* --- @rand_create@ --- *
 617  *
 618  * Arguments:   ---
 619  *
 620  * Returns:     Pointer to a generic generator.
 621  *
 622  * Use:         Constructs a generic generator interface over a Catacomb
 623  *              entropy pool generator.
 624  */
 625
 626 grand *rand_create(void)
 627 {
 628   gctx *g = S_CREATE(gctx);
 629   g->r.ops = &gops;
 630   rand_init(&g->p);
 631   return (&g->r);
 632 }
 633
 634 /*----- That's all, folks -------------------------------------------------*/