Committer:
donatien
Date:
Fri Jul 09 15:24:33 2010 +0000
Revision:
0:0f5a52711275

        

Who changed what in which revision?

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