Document that you need to include x509.h (to get [i2d|d2i]_DSA_PUBKEY()).

[oweals/openssl.git] / doc / crypto / RAND_add.pod

diff --git a/doc/crypto/RAND_add.pod b/doc/crypto/RAND_add.pod
index a3a2113cac89480ac75664d1df5bb076bea6be21..67c66f3e0c96a9e92ee2731581a3d2bd5499c965 100644 (file)
--- a/doc/crypto/RAND_add.pod
+++ b/doc/crypto/RAND_add.pod
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-RAND_add, RAND_seed, RAND_screen - add entropy to the PRNG
+RAND_add, RAND_seed, RAND_status, RAND_event, RAND_screen - add
+entropy to the PRNG

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -14,6 +15,7 @@ RAND_add, RAND_seed, RAND_screen - add entropy to the PRNG
 
  int  RAND_status(void);
 
 
  int  RAND_status(void);
 

+ int  RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);

  void RAND_screen(void);
 
 =head1 DESCRIPTION
  void RAND_screen(void);
 
 =head1 DESCRIPTION


@@ -34,33 +36,42 @@ passwords. The seed values cannot be recovered from the PRNG output.
 OpenSSL makes sure that the PRNG state is unique for each thread. On
 systems that provide C</dev/urandom>, the randomness device is used
 to seed the PRNG transparently. However, on all other systems, the
 OpenSSL makes sure that the PRNG state is unique for each thread. On
 systems that provide C</dev/urandom>, the randomness device is used
 to seed the PRNG transparently. However, on all other systems, the

-application is responsible for seeding the PRNG by calling RAND_add()
+application is responsible for seeding the PRNG by calling RAND_add(),
+L<RAND_egd(3)|RAND_egd(3)>

 or L<RAND_load_file(3)|RAND_load_file(3)>.
 
 RAND_seed() is equivalent to RAND_add() when B<num == entropy>.
 
 or L<RAND_load_file(3)|RAND_load_file(3)>.
 
 RAND_seed() is equivalent to RAND_add() when B<num == entropy>.
 

+RAND_event() collects the entropy from Windows events such as mouse
+movements and other user interaction. It should be called with the
+B<iMsg>, B<wParam> and B<lParam> arguments of I<all> messages sent to
+the window procedure. It will estimate the entropy contained in the
+event message (if any), and add it to the PRNG. The program can then
+process the messages as usual.
+

 The RAND_screen() function is available for the convenience of Windows
 programmers. It adds the current contents of the screen to the PRNG.
 The RAND_screen() function is available for the convenience of Windows
 programmers. It adds the current contents of the screen to the PRNG.

-For applications that can catch Windows events, seeding the PRNG with
-the parameters of B<WM_MOUSEMOVE> events is a significantly better
-source of randomness. It should be noted that both methods cannot be
-used on servers that run without user interaction.
+For applications that can catch Windows events, seeding the PRNG by
+calling RAND_event() is a significantly better source of
+randomness. It should be noted that both methods cannot be used on
+servers that run without user interaction.

 
 =head1 RETURN VALUES
 
 
 =head1 RETURN VALUES
 

-RAND_status() returns 1 if the PRNG has been seeded with enough data,
-0 otherwise.
+RAND_status() and RAND_event() return 1 if the PRNG has been seeded
+with enough data, 0 otherwise.

 
 The other functions do not return values.
 
 =head1 SEE ALSO
 
 
 The other functions do not return values.
 
 =head1 SEE ALSO
 

-L<rand(3)|rand(3)>, L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>
+L<rand(3)|rand(3)>, L<RAND_egd(3)|RAND_egd(3)>,
+L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>

 
 =head1 HISTORY
 
 RAND_seed() and RAND_screen() are available in all versions of SSLeay
 and OpenSSL. RAND_add() and RAND_status() have been added in OpenSSL
 
 =head1 HISTORY
 
 RAND_seed() and RAND_screen() are available in all versions of SSLeay
 and OpenSSL. RAND_add() and RAND_status() have been added in OpenSSL

-0.9.5.
+0.9.5, RAND_event() in OpenSSL 0.9.5a.

 
 =cut
 
 =cut