yarrow_key_event.c

   1 /* yarrow_key_event.c
   2
   3    Example entropy estimator for key-like input events.
   4
   5    Copyright (C) 2001 Niels Möller
   6
   7    This file is part of GNU Nettle.
   8
   9    GNU Nettle is free software: you can redistribute it and/or
  10    modify it under the terms of either:
  11
  12      * the GNU Lesser General Public License as published by the Free
  13        Software Foundation; either version 3 of the License, or (at your
  14        option) any later version.
  15
  16    or
  17
  18      * the GNU General Public License as published by the Free
  19        Software Foundation; either version 2 of the License, or (at your
  20        option) any later version.
  21
  22    or both in parallel, as here.
  23
  24    GNU Nettle is distributed in the hope that it will be useful,
  25    but WITHOUT ANY WARRANTY; without even the implied warranty of
  26    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  27    General Public License for more details.
  28
  29    You should have received copies of the GNU General Public License and
  30    the GNU Lesser General Public License along with this program.  If
  31    not, see http://www.gnu.org/licenses/.
  32 */
  33
  34 #if HAVE_CONFIG_H
  35 # include "config.h"
  36 #endif
  37
  38 #include "yarrow.h"
  39
  40 void
  41 yarrow_key_event_init(struct yarrow_key_event_ctx *ctx)
  42 {
  43   unsigned i;
  44
  45   ctx->index = 0;
  46   ctx->previous = 0;
  47
  48   for (i = 0; i < YARROW_KEY_EVENT_BUFFER; i++)
  49     ctx->chars[i] = 0;
  50 }
  51
  52 unsigned
  53 yarrow_key_event_estimate(struct yarrow_key_event_ctx *ctx,
  54                           unsigned key, unsigned time)
  55 {
  56   unsigned entropy = 0;
  57   unsigned i;
  58
  59   /* Look at timing first. */
  60   if (ctx->previous && (time > ctx->previous) )
  61     {
  62       if ( (time - ctx->previous) >= 256)
  63         entropy++;
  64     }
  65   ctx->previous = time;
  66
  67   if (!key)
  68     return entropy;
  69
  70   for (i = 0; i < YARROW_KEY_EVENT_BUFFER; i++)
  71     if (key == ctx->chars[i])
  72       /* This is a recent character. Ignore it. */
  73       return entropy;
  74
  75   /* Count one bit of entropy, unless this was one of the initial 16
  76    * characters. */
  77   if (ctx->chars[ctx->index])
  78     entropy++;
  79
  80   /* Remember the character. */
  81
  82   ctx->chars[ctx->index] = key;
  83   ctx->index = (ctx->index + 1) % YARROW_KEY_EVENT_BUFFER;
  84
  85   return entropy;
  86 }
  87