From 8f95a003ad84d28132c1753243a074fd22d2463c Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Tue, 13 Oct 2009 11:07:08 +0000
Subject: Document rng& argument to PKCS8::load_key

---
 doc/api.tex | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'doc/api.tex')

diff --git a/doc/api.tex b/doc/api.tex
index d86fa79e2..556e76aa0 100644
--- a/doc/api.tex
+++ b/doc/api.tex
@@ -1360,12 +1360,18 @@ private key:
 
 \begin{verbatim}
 namespace PKCS8 {
-   PKCS8_PrivateKey* load_key(DataSource& in, const User_Interface& ui);
-   PKCS8_PrivateKey* load_key(DataSource& in, std::string passphrase = "");
+   PKCS8_PrivateKey* load_key(DataSource& in,
+                              RandomNumberGenerator& rng,
+                              const User_Interface& ui);
+   PKCS8_PrivateKey* load_key(DataSource& in,
+                              RandomNumberGenerator& rng,
+                              std::string passphrase = "");
 
    PKCS8_PrivateKey* load_key(const std::string& filename,
+                              RandomNumberGenerator& rng,
                               const User_Interface& ui);
    PKCS8_PrivateKey* load_key(const std::string& filename,
+                              RandomNumberGenerator& rng,
                               const std::string& passphrase = "");
 }
 \end{verbatim}
@@ -1384,6 +1390,9 @@ using. You can think of it as a user interface interface. The default
 \type{User\_Interface} is actually very dumb, and effectively acts just like
 the versions taking the \type{std::string}.
 
+All versions need access to a \type{RandomNumberGenerator} in order to
+perform probabilistic tests on the loaded key material.
+
 After loading a key, you can use \function{dynamic\_cast} to find out what
 operations it supports, and use it appropriately. Remember to \function{delete}
 it once you are done with it.
-- 
cgit v1.2.3

