Skip to content

Commit 07c3f74

Browse files
authored
update docs: clarify export_key and session_key length (#338)
1 parent d13d261 commit 07c3f74

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/lib.rs

+9-7
Original file line numberDiff line numberDiff line change
@@ -523,8 +523,9 @@
523523
//!
524524
//! Upon a successful completion of the OPAQUE protocol (the client runs login
525525
//! with the same password used during registration), the client and server have
526-
//! access to a session key, which is a pseudorandomly distributed 32-byte
527-
//! string which only the client and server know. Multiple login runs using the
526+
//! access to a session key, which is a pseudorandomly distributed byte
527+
//! string (of length equal to the output size of [voprf::CipherSuite::Hash])
528+
//! which only the client and server know. Multiple login runs using the
528529
//! same password for the same client will produce different session keys,
529530
//! distributed as uniformly random strings. Thus, the session key can be used
530531
//! to establish a secure channel between the client and server.
@@ -620,11 +621,12 @@
620621
//!
621622
//! ## Export Key
622623
//!
623-
//! The export key is a pseudorandomly distributed 32-byte string output by both
624-
//! the [Client Registration Finish](#client-registration-finish) and [Client
625-
//! Login Finish](#client-login-finish) steps. The same export key string will
626-
//! be output by both functions only if the exact same password is passed to
627-
//! [ClientRegistration::start] and [ClientLogin::start].
624+
//! The export key is a pseudorandomly distributed byte string
625+
//! (of length equal to the output size of [voprf::CipherSuite::Hash]) output by
626+
//! both the [Client Registration Finish](#client-registration-finish) and
627+
//! [Client Login Finish](#client-login-finish) steps. The same export key
628+
//! string will be output by both functions only if the exact same password is
629+
//! passed to [ClientRegistration::start] and [ClientLogin::start].
628630
//!
629631
//! The export key retains as much secrecy as the password itself, and is
630632
//! similarly derived through an evaluation of the key stretching function.

0 commit comments

Comments
 (0)