aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2019-05-28 20:54:27 -0400
committerJack Lloyd <[email protected]>2019-05-28 20:54:27 -0400
commitc9f545ce8d55f851ceae20b05249729d760c05b8 (patch)
tree501569d272dcc71c9c105156a12900aef63cc814
parente6775cf25394e2c3333facd060d3951ee30389b5 (diff)
Correct documentation for botan_rng_init
Fixes #1984
-rw-r--r--src/lib/ffi/ffi.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/lib/ffi/ffi.h b/src/lib/ffi/ffi.h
index 323f47557..03eadeac3 100644
--- a/src/lib/ffi/ffi.h
+++ b/src/lib/ffi/ffi.h
@@ -191,8 +191,11 @@ typedef struct botan_rng_struct* botan_rng_t;
* Initialize a random number generator object
* @param rng rng object
* @param rng_type type of the rng, possible values:
-* "system": System_RNG, "user": AutoSeeded_RNG
-* Set rng_type to null or empty string to let the library choose
+* "system": system RNG
+* "user": userspace RNG
+* "user-threadsafe": userspace RNG, with internal locking
+* "rdrand": directly read RDRAND
+* Set rng_type to null to let the library choose some default.
*/
BOTAN_PUBLIC_API(2,0) int botan_rng_init(botan_rng_t* rng, const char* rng_type);