master
 1/*
 2 * Copyright (c) 2014 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//  CommonRandom.h
26//  CommonCrypto
27
28#ifndef CommonCrypto_CommonRandom_h
29#define CommonCrypto_CommonRandom_h
30
31#include <sys/types.h>
32#include <os/availability.h>
33
34#include <CommonCrypto/CommonCryptoError.h>
35
36#if defined(__cplusplus)
37extern "C" {
38#endif
39
40typedef CCCryptorStatus CCRNGStatus;
41
42/*!
43 @function      CCRandomGenerateBytes
44
45 @abstract      Return random bytes in a buffer allocated by the caller.
46
47 @discussion    The PRNG returns cryptographically strong random
48                bits suitable for use as cryptographic keys, IVs, nonces etc.
49
50 @param         bytes   Pointer to the return buffer.
51 @param         count   Number of random bytes to return.
52
53 @result        Return kCCSuccess on success.
54 */
55
56CCRNGStatus CCRandomGenerateBytes(void *bytes, size_t count)
57API_AVAILABLE(macos(10.10), ios(8.0));
58
59#if defined(__cplusplus)
60}
61#endif
62
63#endif