xnu-3789.1.32.tar.gz

[apple/xnu.git] / EXTERNAL_HEADERS / corecrypto / ccrng_system.h

diff --git a/EXTERNAL_HEADERS/corecrypto/ccrng_system.h b/EXTERNAL_HEADERS/corecrypto/ccrng_system.h
index b6c8c06fd7c6d892c6fc2900f95f0664b73c2511..a5aab7ed2ca269be4ca32c9b1b075b4435856874 100644 (file)
--- a/EXTERNAL_HEADERS/corecrypto/ccrng_system.h
+++ b/EXTERNAL_HEADERS/corecrypto/ccrng_system.h
@@ -18,7 +18,21 @@ struct ccrng_system_state {
     int fd;
 };
 
-// Setup the system RNG (open descriptor on file /dev/random)
+/*!
+ @function   ccrng_system_init - DEPRECATED
+ @abstract   Default ccrng.
+    Please transition to ccrng() which is easier to use and with provide the fastest, most secure option
+
+ @param  rng   Structure containing the state of the RNG, must remain allocated as
+ long as the rng is used.
+ @result 0 iff successful
+
+ @discussion
+        This RNG require call to "init" AND "done", otherwise it may leak a file descriptor.
+ */
+
+// Initialize ccrng
+// Deprecated, if you need a rng, just call the function ccrng()
 int ccrng_system_init(struct ccrng_system_state *rng);
 
 // Close the system RNG