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 = rng.gen_iter::<u8>().take(64).collect::<Vec<u8>>();
  14 //! let server = SrpServer::<Sha256>::new(&user, &a_pub, &b, &G_2048)?;
  15 //! ```
  16 //!
  17 //! Next send to user `b_pub` and `salt` from user record:
  18 //!
  19 //! ```ignore
  20 //! let b_pub = server.get_b_pub();
  21 //! conn.reply_to_handshake(&user.salt, b_pub);
  22 //! ```
  23 //!
  24 //! And finally recieve user proof, verify it and send server proof in the
  25 //! reply:
  26 //!
  27 //! ```ignore
  28 //! let user_proof = conn.receive_proof();
  29 //! let server_proof = server.verify(user_proof)?;
  30 //! conn.send_proof(server_proof);
  31 //! ```
  32 //!
  33 //! To get the shared secret use `get_key` method. As alternative to using
  34 //! `verify` method it's also possible to use this key for authentificated
  35 //! encryption.
  36 use std::marker::PhantomData;
  37
  38 use digest::Digest;
  39 use generic_array::GenericArray;
  40 use num::{BigUint, Zero};
  41
  42 use tools::powm;
  43 use 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: GenericArray<u8, D::OutputSize>,
  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::zero() {
  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.input(&a_pub.to_bytes_be());
  89             d.input(&b_pub.to_bytes_be());
  90             d.result()
  91         };
  92         let d = Default::default();
  93         //(Av^u) ^ b
  94         let key = {
  95             let u = BigUint::from_bytes_be(&u);
  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) -> GenericArray<u8, D::OutputSize> {
 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(
 128         &self,
 129         user_proof: &[u8],
 130     ) -> Result<GenericArray<u8, D::OutputSize>, SrpAuthError> {
 131         // M = H(A, B, K)
 132         let mut d = D::new();
 133         d.input(&self.a_pub.to_bytes_be());
 134         d.input(&self.b_pub.to_bytes_be());
 135         d.input(&self.key);
 136
 137         if user_proof == d.result().as_slice() {
 138             // H(A, M, K)
 139             let mut d = D::new();
 140             d.input(&self.a_pub.to_bytes_be());
 141             d.input(user_proof);
 142             d.input(&self.key);
 143             Ok(d.result())
 144         } else {
 145             Err(SrpAuthError {
 146                 description: "Incorrect user proof",
 147             })
 148         }
 149     }
 150 }