OSX/libsecurity_keychain/lib/SecRandom.h

   1 /*
   2  * Copyright (c) 2007-2009,2011 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)
  38 extern "C" {
  39 #endif
  40
  41 CF_ASSUME_NONNULL_BEGIN
  42 CF_IMPLICIT_BRIDGING_ENABLED
  43
  44 /*!
  45     @typedef SecRandomRef
  46     @abstract Reference to a (psuedo) random number generator.
  47 */
  48 typedef const struct __SecRandom * SecRandomRef;
  49
  50 /* This is a synonym for NULL, if you'd rather use a named constant.   This
  51    refers to a cryptographically secure random number generator.  */
  52 extern const SecRandomRef kSecRandomDefault
  53     __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_2_0);
  54
  55 /*!
  56         @function SecRandomCopyBytes
  57         @abstract Return count random bytes in *bytes, allocated by the caller.
  58         It is critical to check the return value for error
  59         @result Return 0 on success or -1 if something went wrong, check errno
  60     to find out the real error.
  61 */
  62 int SecRandomCopyBytes(SecRandomRef __nullable rnd, size_t count, uint8_t *bytes)
  63     __attribute__ ((warn_unused_result))
  64     __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_2_0);
  65
  66 CF_IMPLICIT_BRIDGING_DISABLED
  67 CF_ASSUME_NONNULL_END
  68
  69 #if defined(__cplusplus)
  70 }
  71 #endif
  72
  73 #endif /* !_SECURITY_SECRANDOM_H_ */