sys/dev/random/live_entropy_sources.h

   1 /*-
   2  * Copyright (c) 2013 Arthur Mesh <arthurmesh@gmail.com>
   3  * Copyright (c) 2013 Mark R V Murray
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer
  11  *    in this position and unchanged.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED
  31 #define SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED
  32
  33 typedef u_int random_live_read_func_t(void *, u_int);
  34
  35 /*
  36  * Live entropy source is a source of entropy that can provide
  37  * specified or approximate amount of entropy immediately upon request or within
  38  * an acceptable amount of time.
  39  */
  40 struct live_entropy_source {
  41         const char                      *les_ident;
  42         enum random_entropy_source       les_source;
  43         random_live_read_func_t         *les_read;
  44 };
  45
  46 struct live_entropy_sources {
  47         LIST_ENTRY(live_entropy_sources) lles_entries;  /* list of providers */
  48         struct live_entropy_source      *lles_rsource;  /* associated random adaptor */
  49 };
  50
  51 extern struct mtx live_mtx;
  52
  53 void live_entropy_sources_init(void);
  54 void live_entropy_sources_deinit(void);
  55 void live_entropy_source_register(struct live_entropy_source *);
  56 void live_entropy_source_deregister(struct live_entropy_source *);
  57 void live_entropy_sources_feed(void);
  58
  59 #endif /* SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED */