1/*
2 * Copyright (c) 2007-2009 Apple Inc. All Rights Reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24/*!
25	@header SecRandom
26	The functions provided in SecRandom.h implement high-level accessors
27    to cryptographically secure random numbers.
28*/
29
30#ifndef _SECURITY_SECRANDOM_H_
31#define _SECURITY_SECRANDOM_H_
32
33#include <Security/SecBase.h>
34#include <stdint.h>
35#include <sys/types.h>
36
37#if defined(__cplusplus)
38extern "C" {
39#endif
40
41/*!
42    @typedef SecRandomRef
43    @abstract Reference to a (psuedo) random number generator.
44*/
45typedef const struct __SecRandom * SecRandomRef;
46
47/* This is a synonym for NULL, if you'd rather use a named constant.   This
48   refers to a cryptographically secure random number generator.  */
49extern const SecRandomRef kSecRandomDefault
50    __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_2_0);
51
52/*!
53	@function SecRandomCopyBytes
54	@abstract Return count random bytes in *bytes, allocated by the caller.
55	@result Return 0 on success or -1 if something went wrong, check errno
56    to find out the real error.
57*/
58int SecRandomCopyBytes(SecRandomRef rnd, size_t count, uint8_t *bytes)
59    __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_2_0);
60
61
62#if defined(__cplusplus)
63}
64#endif
65
66#endif /* !_SECURITY_SECRANDOM_H_ */
67