michael@0: /*
michael@0:  * rand_source.h
michael@0:  *
michael@0:  * implements a random source based on /dev/random
michael@0:  *
michael@0:  * David A. McGrew
michael@0:  * Cisco Systems, Inc.
michael@0:  */
michael@0: /*
michael@0:  *	
michael@0:  * Copyright(c) 2001-2006 Cisco Systems, Inc.
michael@0:  * All rights reserved.
michael@0:  * 
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  * 
michael@0:  *   Redistributions of source code must retain the above copyright
michael@0:  *   notice, this list of conditions and the following disclaimer.
michael@0:  * 
michael@0:  *   Redistributions in binary form must reproduce the above
michael@0:  *   copyright notice, this list of conditions and the following
michael@0:  *   disclaimer in the documentation and/or other materials provided
michael@0:  *   with the distribution.
michael@0:  * 
michael@0:  *   Neither the name of the Cisco Systems, Inc. nor the names of its
michael@0:  *   contributors may be used to endorse or promote products derived
michael@0:  *   from this software without specific prior written permission.
michael@0:  * 
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
michael@0:  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
michael@0:  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
michael@0:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
michael@0:  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
michael@0:  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
michael@0:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
michael@0:  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
michael@0:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
michael@0:  * OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: 
michael@0: #ifndef RAND_SOURCE
michael@0: #define RAND_SOURCE
michael@0: 
michael@0: #include "err.h"
michael@0: #include "datatypes.h"
michael@0: 
michael@0: err_status_t
michael@0: rand_source_init(void);
michael@0: 
michael@0: /*
michael@0:  * rand_source_get_octet_string() writes a random octet string.
michael@0:  *
michael@0:  * The function call rand_source_get_octet_string(dest, len) writes
michael@0:  * len octets of random data to the location to which dest points,
michael@0:  * and returns an error code.  This error code should be checked,
michael@0:  * and if a failure is reported, the data in the buffer MUST NOT
michael@0:  * be used.
michael@0:  * 
michael@0:  * warning: If the return code is not checked, then non-random
michael@0:  *          data may inadvertently be used.
michael@0:  *
michael@0:  * returns:
michael@0:  *     - err_status_ok    if no problems occured.
michael@0:  *     - [other]          a problem occured, and no assumptions should
michael@0:  *                        be made about the contents of the destination
michael@0:  *                        buffer.
michael@0:  */
michael@0: 
michael@0: err_status_t
michael@0: rand_source_get_octet_string(void *dest, uint32_t length);
michael@0: 
michael@0: err_status_t
michael@0: rand_source_deinit(void);
michael@0: 
michael@0: /* 
michael@0:  * function prototype for a random source function
michael@0:  *
michael@0:  * A rand_source_func_t writes num_octets at the location indicated by
michael@0:  * dest and returns err_status_ok.  Any other return value indicates
michael@0:  * failure.
michael@0:  */
michael@0: 
michael@0: typedef err_status_t (*rand_source_func_t)
michael@0:      (void *dest, uint32_t num_octets);
michael@0: 
michael@0: #endif /* RAND_SOURCE */