Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:cd4c47744fa1 1 /*****************************************************************************
slowness 0:cd4c47744fa1 2 * randm.h - Random number generator header file.
slowness 0:cd4c47744fa1 3 *
slowness 0:cd4c47744fa1 4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
slowness 0:cd4c47744fa1 5 * Copyright (c) 1998 Global Election Systems Inc.
slowness 0:cd4c47744fa1 6 *
slowness 0:cd4c47744fa1 7 * The authors hereby grant permission to use, copy, modify, distribute,
slowness 0:cd4c47744fa1 8 * and license this software and its documentation for any purpose, provided
slowness 0:cd4c47744fa1 9 * that existing copyright notices are retained in all copies and that this
slowness 0:cd4c47744fa1 10 * notice and the following disclaimer are included verbatim in any
slowness 0:cd4c47744fa1 11 * distributions. No written agreement, license, or royalty fee is required
slowness 0:cd4c47744fa1 12 * for any of the authorized uses.
slowness 0:cd4c47744fa1 13 *
slowness 0:cd4c47744fa1 14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
slowness 0:cd4c47744fa1 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
slowness 0:cd4c47744fa1 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
slowness 0:cd4c47744fa1 17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
slowness 0:cd4c47744fa1 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
slowness 0:cd4c47744fa1 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
slowness 0:cd4c47744fa1 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
slowness 0:cd4c47744fa1 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
slowness 0:cd4c47744fa1 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
slowness 0:cd4c47744fa1 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
slowness 0:cd4c47744fa1 24 *
slowness 0:cd4c47744fa1 25 ******************************************************************************
slowness 0:cd4c47744fa1 26 * REVISION HISTORY
slowness 0:cd4c47744fa1 27 *
slowness 0:cd4c47744fa1 28 * 03-01-01 Marc Boucher <marc@mbsi.ca>
slowness 0:cd4c47744fa1 29 * Ported to lwIP.
slowness 0:cd4c47744fa1 30 * 98-05-29 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
slowness 0:cd4c47744fa1 31 * Extracted from avos.
slowness 0:cd4c47744fa1 32 *****************************************************************************/
slowness 0:cd4c47744fa1 33
slowness 0:cd4c47744fa1 34 #ifndef RANDM_H
slowness 0:cd4c47744fa1 35 #define RANDM_H
slowness 0:cd4c47744fa1 36
slowness 0:cd4c47744fa1 37 /***********************
slowness 0:cd4c47744fa1 38 *** PUBLIC FUNCTIONS ***
slowness 0:cd4c47744fa1 39 ***********************/
slowness 0:cd4c47744fa1 40 /*
slowness 0:cd4c47744fa1 41 * Initialize the random number generator.
slowness 0:cd4c47744fa1 42 */
slowness 0:cd4c47744fa1 43 void avRandomInit(void);
slowness 0:cd4c47744fa1 44
slowness 0:cd4c47744fa1 45 /*
slowness 0:cd4c47744fa1 46 * Churn the randomness pool on a random event. Call this early and often
slowness 0:cd4c47744fa1 47 * on random and semi-random system events to build randomness in time for
slowness 0:cd4c47744fa1 48 * usage. For randomly timed events, pass a null pointer and a zero length
slowness 0:cd4c47744fa1 49 * and this will use the system timer and other sources to add randomness.
slowness 0:cd4c47744fa1 50 * If new random data is available, pass a pointer to that and it will be
slowness 0:cd4c47744fa1 51 * included.
slowness 0:cd4c47744fa1 52 */
slowness 0:cd4c47744fa1 53 void avChurnRand(char *randData, u32_t randLen);
slowness 0:cd4c47744fa1 54
slowness 0:cd4c47744fa1 55 /*
slowness 0:cd4c47744fa1 56 * Randomize our random seed value. To be called for truely random events
slowness 0:cd4c47744fa1 57 * such as user operations and network traffic.
slowness 0:cd4c47744fa1 58 */
slowness 0:cd4c47744fa1 59 #if MD5_SUPPORT
slowness 0:cd4c47744fa1 60 #define avRandomize() avChurnRand(NULL, 0)
slowness 0:cd4c47744fa1 61 #else /* MD5_SUPPORT */
slowness 0:cd4c47744fa1 62 void avRandomize(void);
slowness 0:cd4c47744fa1 63 #endif /* MD5_SUPPORT */
slowness 0:cd4c47744fa1 64
slowness 0:cd4c47744fa1 65 /*
slowness 0:cd4c47744fa1 66 * Use the random pool to generate random data. This degrades to pseudo
slowness 0:cd4c47744fa1 67 * random when used faster than randomness is supplied using churnRand().
slowness 0:cd4c47744fa1 68 * Thus it's important to make sure that the results of this are not
slowness 0:cd4c47744fa1 69 * published directly because one could predict the next result to at
slowness 0:cd4c47744fa1 70 * least some degree. Also, it's important to get a good seed before
slowness 0:cd4c47744fa1 71 * the first use.
slowness 0:cd4c47744fa1 72 */
slowness 0:cd4c47744fa1 73 void avGenRand(char *buf, u32_t bufLen);
slowness 0:cd4c47744fa1 74
slowness 0:cd4c47744fa1 75 /*
slowness 0:cd4c47744fa1 76 * Return a new random number.
slowness 0:cd4c47744fa1 77 */
slowness 0:cd4c47744fa1 78 u32_t avRandom(void);
slowness 0:cd4c47744fa1 79
slowness 0:cd4c47744fa1 80
slowness 0:cd4c47744fa1 81 #endif /* RANDM_H */