Clarifying the persisting of server setup (#344)

facebook · Oct 5, 2023 · ead80ad · ead80ad
1 parent 83795f3
commit ead80ad
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -78,7 +78,8 @@
 //! # Ok::<(), ProtocolError>(())
 //! ```
 //! The server must persist an instance of [ServerSetup] for the registration
-//! and login steps.
+//! and login steps, and can use [ServerSetup::serialize] and
+//! [ServerSetup::deserialize] to save and restore the instance.
 //!
 //! ## Registration
 //! The registration protocol between the client and server consists of four

diff --git a/src/opaque.rs b/src/opaque.rs
@@ -224,6 +224,10 @@ where
     Le<<<OprfHash<CS> as CoreProxy>::Core as BlockSizeUser>::BlockSize, U256>: NonZero,
 {
     /// Create [`ServerSetup`] with the given keypair
+    ///
+    /// This function should not be used to restore a previously-existing
+    /// instance of [ServerSetup]. Instead, use [ServerSetup::serialize] and
+    /// [ServerSetup::deserialize] for this purpose.
     pub fn new_with_key<R: CryptoRng + RngCore>(
         rng: &mut R,
         keypair: KeyPair<CS::KeGroup, S>,