Cleaning up docs + README (#98)

src/messages.rs

@@ -26,12 +26,12 @@ use std::convert::TryFrom;
 // =========
 
 /// The message sent by the client to the server, to initiate registration
-pub struct RegisterFirstMessage<Grp> {
+pub struct RegistrationRequest<Grp> {
     /// blinded password information
     pub(crate) alpha: Grp,
 }
 
-impl<Grp: Group> TryFrom<&[u8]> for RegisterFirstMessage<Grp> {
+impl<Grp: Group> TryFrom<&[u8]> for RegistrationRequest<Grp> {
     type Error = ProtocolError;
     fn try_from(first_message_bytes: &[u8]) -> Result<Self, Self::Error> {
         let elem_len = Grp::ElemLen::to_usize();
@@ -45,7 +45,7 @@ impl<Grp: Group> TryFrom<&[u8]> for RegisterFirstMessage<Grp> {
     }
 }
 
-impl<Grp: Group> RegisterFirstMessage<Grp> {
+impl<Grp: Group> RegistrationRequest<Grp> {
     /// Byte representation for the registration request
     pub fn to_bytes(&self) -> Vec<u8> {
         self.alpha.to_arr().to_vec()
@@ -79,7 +79,7 @@ impl<Grp: Group> RegisterFirstMessage<Grp> {
 
 /// The answer sent by the server to the user, upon reception of the
 /// registration attempt
-pub struct RegisterSecondMessage<Grp> {
+pub struct RegistrationResponse<Grp> {
     /// The server's oprf output
     pub(crate) beta: Grp,
     /// Server's static public key
@@ -88,7 +88,7 @@ pub struct RegisterSecondMessage<Grp> {
     pub(crate) ecf: EnvelopeCredentialsFormat,
 }
 
-impl<Grp> TryFrom<&[u8]> for RegisterSecondMessage<Grp>
+impl<Grp> TryFrom<&[u8]> for RegistrationResponse<Grp>
 where
     Grp: Group,
 {
@@ -116,7 +116,7 @@ where
     }
 }
 
-impl<Grp> RegisterSecondMessage<Grp>
+impl<Grp> RegistrationResponse<Grp>
 where
     Grp: Group,
 {
@@ -196,7 +196,7 @@ where
 
 /// The final message from the client, containing sealed cryptographic
 /// identifiers
-pub struct RegisterThirdMessage<KeyFormat: KeyPair, D: Hash> {
+pub struct RegistrationUpload<KeyFormat: KeyPair, D: Hash> {
     /// The "envelope" generated by the user, containing sealed
     /// cryptographic identifiers
     pub(crate) envelope: Envelope<D>,
@@ -204,7 +204,7 @@ pub struct RegisterThirdMessage<KeyFormat: KeyPair, D: Hash> {
     pub(crate) client_s_pk: KeyFormat::Repr,
 }
 
-impl<KeyFormat, D> TryFrom<&[u8]> for RegisterThirdMessage<KeyFormat, D>
+impl<KeyFormat, D> TryFrom<&[u8]> for RegistrationUpload<KeyFormat, D>
 where
     KeyFormat: KeyPair,
     D: Hash,
@@ -229,17 +229,17 @@ where
     }
 }
 
-impl<KeyFormat, D> RegisterThirdMessage<KeyFormat, D>
+impl<KeyFormat, D> RegistrationUpload<KeyFormat, D>
 where
     KeyFormat: KeyPair,
     D: Hash,
 {
     /// Serialization into bytes
     pub fn serialize(&self) -> Vec<u8> {
-        let mut registration_upload: Vec<u8> = Vec::new();
-        registration_upload.extend_from_slice(&self.envelope.serialize());
-        registration_upload.extend_from_slice(&serialize(&self.client_s_pk.to_arr(), 2));
-        registration_upload
+        let mut message: Vec<u8> = Vec::new();
+        message.extend_from_slice(&self.envelope.serialize());
+        message.extend_from_slice(&serialize(&self.client_s_pk.to_arr(), 2));
+        message
     }
 
     /// Deserialization from bytes
@@ -259,20 +259,20 @@ where
 }
 
 /// The message sent by the user to the server, to initiate registration
-pub struct LoginFirstMessage<CS: CipherSuite> {
+pub struct CredentialRequest<CS: CipherSuite> {
     /// blinded password information
     pub(crate) alpha: CS::Group,
     pub(crate) ke1_message: <CS::KeyExchange as KeyExchange<CS::Hash, CS::KeyFormat>>::KE1Message,
 }
 
-impl<CS: CipherSuite> TryFrom<&[u8]> for LoginFirstMessage<CS> {
+impl<CS: CipherSuite> TryFrom<&[u8]> for CredentialRequest<CS> {
     type Error = ProtocolError;
     fn try_from(first_message_bytes: &[u8]) -> Result<Self, Self::Error> {
         Self::deserialize(first_message_bytes)
     }
 }
 
-impl<CS: CipherSuite> LoginFirstMessage<CS> {
+impl<CS: CipherSuite> CredentialRequest<CS> {
     /// byte representation for the login request
     pub(crate) fn to_bytes(&self) -> Vec<u8> {
         [&self.alpha.to_arr()[..], &self.ke1_message.to_bytes()].concat()
@@ -305,8 +305,8 @@ impl<CS: CipherSuite> LoginFirstMessage<CS> {
 }
 
 /// The answer sent by the server to the user, upon reception of the
-/// login attempt.
-pub struct LoginSecondMessage<CS: CipherSuite> {
+/// login attempt
+pub struct CredentialResponse<CS: CipherSuite> {
     /// the server's oprf output
     pub(crate) beta: CS::Group,
     /// the user's sealed information,
@@ -314,7 +314,7 @@ pub struct LoginSecondMessage<CS: CipherSuite> {
     pub(crate) ke2_message: <CS::KeyExchange as KeyExchange<CS::Hash, CS::KeyFormat>>::KE2Message,
 }
 
-impl<CS: CipherSuite> LoginSecondMessage<CS> {
+impl<CS: CipherSuite> CredentialResponse<CS> {
     /// Serialization into bytes
     pub fn serialize(&self) -> Vec<u8> {
         let mut credential_response: Vec<u8> = Vec::new();
@@ -332,7 +332,7 @@ impl<CS: CipherSuite> LoginSecondMessage<CS> {
     }
 }
 
-impl<CS: CipherSuite> TryFrom<&[u8]> for LoginSecondMessage<CS> {
+impl<CS: CipherSuite> TryFrom<&[u8]> for CredentialResponse<CS> {
     type Error = ProtocolError;
     fn try_from(second_message_bytes: &[u8]) -> Result<Self, Self::Error> {
         let elem_len = <CS::Group as Group>::ElemLen::to_usize();
@@ -365,11 +365,11 @@ impl<CS: CipherSuite> TryFrom<&[u8]> for LoginSecondMessage<CS> {
 
 /// The answer sent by the client to the server, upon reception of the
 /// sealed envelope
-pub struct LoginThirdMessage<CS: CipherSuite> {
+pub struct CredentialFinalization<CS: CipherSuite> {
     pub(crate) ke3_message: <CS::KeyExchange as KeyExchange<CS::Hash, CS::KeyFormat>>::KE3Message,
 }
 
-impl<CS: CipherSuite> TryFrom<&[u8]> for LoginThirdMessage<CS> {
+impl<CS: CipherSuite> TryFrom<&[u8]> for CredentialFinalization<CS> {
     type Error = ProtocolError;
 
     fn try_from(bytes: &[u8]) -> Result<Self, Self::Error> {
@@ -379,7 +379,7 @@ impl<CS: CipherSuite> TryFrom<&[u8]> for LoginThirdMessage<CS> {
     }
 }
 
-impl<CS: CipherSuite> LoginThirdMessage<CS> {
+impl<CS: CipherSuite> CredentialFinalization<CS> {
     /// Serialization into bytes
     pub fn serialize(&self) -> Vec<u8> {
         self.ke3_message.to_bytes()