Modify the DEVRANDOM source so that the files are kept open persistently.

[openssl.git] / doc / man3 / RAND_add.pod

diff --git a/doc/man3/RAND_add.pod b/doc/man3/RAND_add.pod
index 1b06d1be87b95af60000bf7b4d78eebf770b7273..b6753fd2ed0b1b0cac0885303226b90d76ed0622 100644 (file)
--- a/doc/man3/RAND_add.pod
+++ b/doc/man3/RAND_add.pod
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-RAND_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen
+RAND_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen,
+RAND_keep_random_devices_open

 - add randomness to the PRNG or get its status
 
 =head1 SYNOPSIS
 - add randomness to the PRNG or get its status
 
 =head1 SYNOPSIS


@@ -15,6 +16,8 @@ RAND_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen
  void RAND_add(const void *buf, int num, double randomness);
  void RAND_seed(const void *buf, int num);
 
  void RAND_add(const void *buf, int num, double randomness);
  void RAND_seed(const void *buf, int num);
 

+ void RAND_keep_random_devices_open(int keep);
+

 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L
 Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x10100000L


@@ -54,6 +57,15 @@ should consider using L<RAND_load_file(3)> instead.
 
 RAND_seed() is equivalent to RAND_add() with B<randomness> set to B<num>.
 
 
 RAND_seed() is equivalent to RAND_add() with B<randomness> set to B<num>.
 

+RAND_keep_random_devices_open() is used to control file descriptor
+usage by the random seed sources. Some seed sources maintain open file
+descriptors by default, which allows such sources to operate in a
+chroot(2) jail without the associated device nodes being available. When
+the B<keep> argument is zero, this call disables the retention of file
+descriptors. Conversely, a non-zero argument enables the retention of
+file descriptors. This function is usually called during initialization
+and it takes effect immediately.
+

 RAND_event() and RAND_screen() are equivalent to RAND_poll() and exist
 for compatibility reasons only. See HISTORY section below.
 
 RAND_event() and RAND_screen() are equivalent to RAND_poll() and exist
 for compatibility reasons only. See HISTORY section below.