1 /* 2 * rand_source.h 3 * 4 * implements a random source based on /dev/random 5 * 6 * David A. McGrew 7 * Cisco Systems, Inc. 8 */ 9 /* 10 * 11 * Copyright(c) 2001-2006 Cisco Systems, Inc. 12 * All rights reserved. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions 16 * are met: 17 * 18 * Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 21 * Redistributions in binary form must reproduce the above 22 * copyright notice, this list of conditions and the following 23 * disclaimer in the documentation and/or other materials provided 24 * with the distribution. 25 * 26 * Neither the name of the Cisco Systems, Inc. nor the names of its 27 * contributors may be used to endorse or promote products derived 28 * from this software without specific prior written permission. 29 * 30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 33 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 34 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 35 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 36 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 37 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 41 * OF THE POSSIBILITY OF SUCH DAMAGE. 42 * 43 */ 44 45 46 #ifndef RAND_SOURCE 47 #define RAND_SOURCE 48 49 #include "err.h" 50 #include "datatypes.h" 51 52 err_status_t 53 rand_source_init(void); 54 55 /* 56 * rand_source_get_octet_string() writes a random octet string. 57 * 58 * The function call rand_source_get_octet_string(dest, len) writes 59 * len octets of random data to the location to which dest points, 60 * and returns an error code. This error code should be checked, 61 * and if a failure is reported, the data in the buffer MUST NOT 62 * be used. 63 * 64 * warning: If the return code is not checked, then non-random 65 * data may inadvertently be used. 66 * 67 * returns: 68 * - err_status_ok if no problems occured. 69 * - [other] a problem occured, and no assumptions should 70 * be made about the contents of the destination 71 * buffer. 72 */ 73 74 err_status_t 75 rand_source_get_octet_string(void *dest, uint32_t length); 76 77 err_status_t 78 rand_source_deinit(void); 79 80 /* 81 * function prototype for a random source function 82 * 83 * A rand_source_func_t writes num_octets at the location indicated by 84 * dest and returns err_status_ok. Any other return value indicates 85 * failure. 86 */ 87 88 typedef err_status_t (*rand_source_func_t) 89 (void *dest, uint32_t num_octets); 90 91 #endif /* RAND_SOURCE */ 92