srp/src/server.rs

   1 //! SRP server implementation
   2 //!
   3 //! # Usage
   4 //! First receive user's username and public value `a_pub`, retrieve from a
   5 //! database `UserRecord` for a given username, generate `b` (e.g. 512 bits
   6 //! long) and initialize SRP server instance:
   7 //!
   8 //! ```ignore
   9 //! use srp::groups::G_2048;
  10 //!
  11 //! let (username, a_pub) = conn.receive_handshake();
  12 //! let user = db.retrieve_user_record(username);
  13 //! let b = [0u8; 64];
  14 //! rng.fill_bytes(&mut b);
  15 //! let server = SrpServer::<Sha256>::new(&user, &a_pub, &b, &G_2048)?;
  16 //! ```
  17 //!
  18 //! Next send to user `b_pub` and `salt` from user record:
  19 //!
  20 //! ```ignore
  21 //! let b_pub = server.get_b_pub();
  22 //! conn.reply_to_handshake(&user.salt, b_pub);
  23 //! ```
  24 //!
  25 //! And finally receive user proof, verify it and send server proof in the
  26 //! reply:
  27 //!
  28 //! ```ignore
  29 //! let user_proof = conn.receive_proof();
  30 //! let server_proof = server.verify(user_proof)?;
  31 //! conn.send_proof(server_proof);
  32 //! ```
  33 //!
  34 //! To get the shared secret use `get_key` method. As alternative to using
  35 //! `verify` method it's also possible to use this key for authentificated
  36 //! encryption.
  37 use std::marker::PhantomData;
  38
  39 use digest::{Digest, Output};
  40 use num_bigint::BigUint;
  41
  42 use crate::tools::powm;
  43 use crate::types::{SrpAuthError, SrpGroup};
  44
  45 /// Data provided by users upon registration, usually stored in the database.
  46 pub struct UserRecord<'a> {
  47     pub username: &'a [u8],
  48     pub salt: &'a [u8],
  49     /// Password verifier
  50     pub verifier: &'a [u8],
  51 }
  52
  53 /// SRP server state
  54 pub struct SrpServer<D: Digest> {
  55     b: BigUint,
  56     a_pub: BigUint,
  57     b_pub: BigUint,
  58
  59     key: Output<D>,
  60
  61     d: PhantomData<D>,
  62 }
  63
  64 impl<D: Digest> SrpServer<D> {
  65     /// Create new server state.
  66     pub fn new(
  67         user: &UserRecord<'_>,
  68         a_pub: &[u8],
  69         b: &[u8],
  70         params: &SrpGroup,
  71     ) -> Result<Self, SrpAuthError> {
  72         let a_pub = BigUint::from_bytes_be(a_pub);
  73         // Safeguard against malicious A
  74         if &a_pub % &params.n == BigUint::default() {
  75             return Err(SrpAuthError {
  76                 description: "Malicious a_pub value",
  77             });
  78         }
  79         let v = BigUint::from_bytes_be(user.verifier);
  80         let b = BigUint::from_bytes_be(b) % &params.n;
  81         let k = params.compute_k::<D>();
  82         // kv + g^b
  83         let interm = (k * &v) % &params.n;
  84         let b_pub = (interm + &params.powm(&b)) % &params.n;
  85         // H(A || B)
  86         let u = {
  87             let mut d = D::new();
  88             d.update(&a_pub.to_bytes_be());
  89             d.update(&b_pub.to_bytes_be());
  90             d.finalize()
  91         };
  92         let d = Default::default();
  93         //(Av^u) ^ b
  94         let key = {
  95             let u = BigUint::from_bytes_be(u.as_slice());
  96             let t = (&a_pub * powm(&v, &u, &params.n)) % &params.n;
  97             let s = powm(&t, &b, &params.n);
  98             D::digest(&s.to_bytes_be())
  99         };
 100         Ok(Self {
 101             b,
 102             a_pub,
 103             b_pub,
 104             key,
 105             d,
 106         })
 107     }
 108
 109     /// Get private `b` value. (see `new_with_b` documentation)
 110     pub fn get_b(&self) -> Vec<u8> {
 111         self.b.to_bytes_be()
 112     }
 113
 114     /// Get public `b_pub` value for sending to the user.
 115     pub fn get_b_pub(&self) -> Vec<u8> {
 116         self.b_pub.to_bytes_be()
 117     }
 118
 119     /// Get shared secret between user and the server. (do not forget to verify
 120     /// that keys are the same!)
 121     pub fn get_key(&self) -> Output<D> {
 122         self.key.clone()
 123     }
 124
 125     /// Process user proof of having the same shared secret and compute
 126     /// server proof for sending to the user.
 127     pub fn verify(&self, user_proof: &[u8]) -> Result<Output<D>, SrpAuthError> {
 128         // M = H(A, B, K)
 129         let mut d = D::new();
 130         d.update(&self.a_pub.to_bytes_be());
 131         d.update(&self.b_pub.to_bytes_be());
 132         d.update(&self.key);
 133
 134         if user_proof == d.finalize().as_slice() {
 135             // H(A, M, K)
 136             let mut d = D::new();
 137             d.update(&self.a_pub.to_bytes_be());
 138             d.update(user_proof);
 139             d.update(&self.key);
 140             Ok(d.finalize())
 141         } else {
 142             Err(SrpAuthError {
 143                 description: "Incorrect user proof",
 144             })
 145         }
 146     }
 147 }