1use base64::Engine;
12use base64::engine::general_purpose::STANDARD as BASE64;
13use hmac::{Hmac, Mac};
14use pbkdf2::pbkdf2_hmac;
15use rand::Rng;
16use sha2::{Digest, Sha256};
17use subtle::ConstantTimeEq;
18
19type HmacSha256 = Hmac<Sha256>;
20
21pub const DEFAULT_ITERATIONS: u32 = 100_000;
23
24#[derive(Debug, thiserror::Error)]
30pub enum AuthError {
31 #[error("invalid credentials")]
32 InvalidCredentials,
33 #[error("invalid auth header: {0}")]
34 InvalidHeader(String),
35 #[error("handshake failed: {0}")]
36 HandshakeFailed(String),
37 #[error("base64 decode error: {0}")]
38 Base64Error(String),
39}
40
41#[derive(Debug, Clone)]
47pub struct ScramCredentials {
48 pub salt: Vec<u8>,
49 pub iterations: u32,
50 pub stored_key: Vec<u8>,
51 pub server_key: Vec<u8>,
52}
53
54#[derive(Debug, Clone)]
57pub struct ScramHandshake {
58 pub username: String,
59 pub client_nonce: String,
60 pub server_nonce: String,
61 pub salt: Vec<u8>,
62 pub iterations: u32,
63 pub auth_message: String,
64 pub server_signature: Vec<u8>,
65 stored_key: Vec<u8>,
67}
68
69#[derive(Debug, Clone, PartialEq, Eq)]
71pub enum AuthHeader {
72 Hello {
73 username: String,
74 data: Option<String>,
76 },
77 Scram {
78 handshake_token: String,
79 data: String,
80 },
81 Bearer {
82 auth_token: String,
83 },
84}
85
86fn hmac_sha256(key: &[u8], msg: &[u8]) -> Vec<u8> {
92 let mut mac = HmacSha256::new_from_slice(key).expect("HMAC accepts keys of any size");
93 mac.update(msg);
94 mac.finalize().into_bytes().to_vec()
95}
96
97fn sha256(data: &[u8]) -> Vec<u8> {
99 let mut hasher = Sha256::new();
100 hasher.update(data);
101 hasher.finalize().to_vec()
102}
103
104fn xor_bytes(a: &[u8], b: &[u8]) -> Vec<u8> {
106 assert_eq!(a.len(), b.len(), "XOR operands must be the same length");
107 a.iter().zip(b.iter()).map(|(x, y)| x ^ y).collect()
108}
109
110fn pbkdf2_sha256(password: &[u8], salt: &[u8], iterations: u32) -> Vec<u8> {
112 let mut salted_password = vec![0u8; 32];
113 pbkdf2_hmac::<Sha256>(password, salt, iterations, &mut salted_password);
114 salted_password
115}
116
117fn derive_keys(salted_password: &[u8]) -> (Vec<u8>, Vec<u8>, Vec<u8>) {
119 let client_key = hmac_sha256(salted_password, b"Client Key");
120 let stored_key = sha256(&client_key);
121 let server_key = hmac_sha256(salted_password, b"Server Key");
122 (client_key, stored_key, server_key)
123}
124
125fn parse_scram_param<'a>(segment: &'a str, prefix: &str) -> Result<&'a str, AuthError> {
127 let trimmed = segment.trim();
128 trimmed.strip_prefix(prefix).ok_or_else(|| {
129 AuthError::HandshakeFailed(format!(
130 "expected prefix '{}' but got '{}'",
131 prefix, trimmed
132 ))
133 })
134}
135
136fn make_client_first_bare(username: &str, client_nonce: &str) -> String {
138 format!("n={},r={}", username, client_nonce)
139}
140
141pub fn derive_credentials(password: &str, salt: &[u8], iterations: u32) -> ScramCredentials {
149 let salted_password = pbkdf2_sha256(password.as_bytes(), salt, iterations);
150 let (_client_key, stored_key, server_key) = derive_keys(&salted_password);
151 ScramCredentials {
152 salt: salt.to_vec(),
153 iterations,
154 stored_key,
155 server_key,
156 }
157}
158
159pub fn generate_nonce() -> String {
161 let mut bytes = [0u8; 18];
162 rand::rng().fill(&mut bytes);
163 BASE64.encode(bytes)
164}
165
166pub fn client_first_message(username: &str) -> (String, String) {
173 let client_nonce = generate_nonce();
174 let bare = make_client_first_bare(username, &client_nonce);
175 let full = format!("n,,{}", bare);
176 let encoded = BASE64.encode(full.as_bytes());
177 (client_nonce, encoded)
178}
179
180pub fn server_first_message(
188 username: &str,
189 client_nonce_b64: &str,
190 credentials: &ScramCredentials,
191) -> (ScramHandshake, String) {
192 let server_nonce = generate_nonce();
193 let combined_nonce = format!("{}{}", client_nonce_b64, server_nonce);
194 let salt_b64 = BASE64.encode(&credentials.salt);
195
196 let server_first_msg = format!(
198 "r={},s={},i={}",
199 combined_nonce, salt_b64, credentials.iterations
200 );
201
202 let cfmb = make_client_first_bare(username, client_nonce_b64);
204
205 let client_final_without_proof = format!("c=biws,r={}", combined_nonce);
207
208 let auth_message = format!(
210 "{},{},{}",
211 cfmb, server_first_msg, client_final_without_proof
212 );
213
214 let server_signature = hmac_sha256(&credentials.server_key, auth_message.as_bytes());
216
217 let server_first_b64 = BASE64.encode(server_first_msg.as_bytes());
218
219 let handshake = ScramHandshake {
220 username: username.to_string(),
221 client_nonce: client_nonce_b64.to_string(),
222 server_nonce,
223 salt: credentials.salt.clone(),
224 iterations: credentials.iterations,
225 auth_message,
226 server_signature,
227 stored_key: credentials.stored_key.clone(),
228 };
229
230 (handshake, server_first_b64)
231}
232
233pub fn client_final_message(
242 password: &str,
243 client_nonce: &str,
244 server_first_b64: &str,
245 username: &str,
246) -> Result<(String, Vec<u8>), AuthError> {
247 let server_first_bytes = BASE64
249 .decode(server_first_b64)
250 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
251 let server_first_msg = String::from_utf8(server_first_bytes)
252 .map_err(|e| AuthError::HandshakeFailed(e.to_string()))?;
253
254 let parts: Vec<&str> = server_first_msg.splitn(3, ',').collect();
256 if parts.len() != 3 {
257 return Err(AuthError::HandshakeFailed(
258 "invalid server-first-message format".to_string(),
259 ));
260 }
261
262 let combined_nonce = parse_scram_param(parts[0], "r=")?;
263 let salt_b64 = parse_scram_param(parts[1], "s=")?;
264 let iterations_str = parse_scram_param(parts[2], "i=")?;
265
266 if !combined_nonce.starts_with(client_nonce) {
268 return Err(AuthError::HandshakeFailed(
269 "combined nonce does not start with client nonce".to_string(),
270 ));
271 }
272
273 let salt = BASE64
274 .decode(salt_b64)
275 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
276 let iterations: u32 = iterations_str
277 .parse()
278 .map_err(|e: std::num::ParseIntError| AuthError::HandshakeFailed(e.to_string()))?;
279
280 let salted_password = pbkdf2_sha256(password.as_bytes(), &salt, iterations);
282 let (client_key, stored_key, server_key) = derive_keys(&salted_password);
283
284 let cfmb = make_client_first_bare(username, client_nonce);
286 let client_final_without_proof = format!("c=biws,r={}", combined_nonce);
287 let auth_message = format!(
288 "{},{},{}",
289 cfmb, server_first_msg, client_final_without_proof
290 );
291
292 let client_signature = hmac_sha256(&stored_key, auth_message.as_bytes());
294 let client_proof = xor_bytes(&client_key, &client_signature);
296 let server_signature = hmac_sha256(&server_key, auth_message.as_bytes());
298
299 let proof_b64 = BASE64.encode(&client_proof);
301 let client_final_msg = format!("{},p={}", client_final_without_proof, proof_b64);
302 let client_final_b64 = BASE64.encode(client_final_msg.as_bytes());
303
304 Ok((client_final_b64, server_signature))
305}
306
307pub fn server_verify_final(
313 handshake: &ScramHandshake,
314 client_final_b64: &str,
315) -> Result<Vec<u8>, AuthError> {
316 let client_final_bytes = BASE64
318 .decode(client_final_b64)
319 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
320 let client_final_msg = String::from_utf8(client_final_bytes)
321 .map_err(|e| AuthError::HandshakeFailed(e.to_string()))?;
322
323 let parts: Vec<&str> = client_final_msg.splitn(3, ',').collect();
325 if parts.len() != 3 {
326 return Err(AuthError::HandshakeFailed(
327 "invalid client-final-message format".to_string(),
328 ));
329 }
330
331 let channel_binding = parse_scram_param(parts[0], "c=")?;
333 if channel_binding != "biws" {
334 return Err(AuthError::HandshakeFailed(
335 "unexpected channel binding".to_string(),
336 ));
337 }
338
339 let combined_nonce = parse_scram_param(parts[1], "r=")?;
341 let expected_combined = format!("{}{}", handshake.client_nonce, handshake.server_nonce);
342 if combined_nonce != expected_combined {
343 return Err(AuthError::HandshakeFailed("nonce mismatch".to_string()));
344 }
345
346 let proof_b64 = parse_scram_param(parts[2], "p=")?;
348 let client_proof = BASE64
349 .decode(proof_b64)
350 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
351
352 let client_signature = hmac_sha256(&handshake.stored_key, handshake.auth_message.as_bytes());
357 let recovered_client_key = xor_bytes(&client_proof, &client_signature);
358 let recovered_stored_key = sha256(&recovered_client_key);
359
360 if recovered_stored_key
361 .ct_eq(&handshake.stored_key)
362 .unwrap_u8()
363 == 0
364 {
365 return Err(AuthError::InvalidCredentials);
366 }
367
368 Ok(handshake.server_signature.clone())
370}
371
372pub fn extract_client_nonce(client_first_b64: &str) -> Result<String, AuthError> {
377 let bytes = BASE64
378 .decode(client_first_b64)
379 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
380 let msg = String::from_utf8(bytes).map_err(|e| AuthError::HandshakeFailed(e.to_string()))?;
381 let bare = msg
383 .strip_prefix("n,,")
384 .ok_or_else(|| AuthError::HandshakeFailed("missing GS2 header in client-first".into()))?;
385 for part in bare.split(',') {
387 if let Some(nonce) = part.strip_prefix("r=") {
388 return Ok(nonce.to_string());
389 }
390 }
391 Err(AuthError::HandshakeFailed(
392 "missing r= nonce in client-first-message".into(),
393 ))
394}
395
396pub fn parse_auth_header(header: &str) -> Result<AuthHeader, AuthError> {
403 let header = header.trim();
404
405 if let Some(rest) = header.strip_prefix("HELLO ") {
406 let mut username_b64_val = None;
407 let mut data_val = None;
408 for part in rest.split(',') {
409 let part = part.trim();
410 if let Some(val) = part.strip_prefix("username=") {
411 username_b64_val = Some(val.trim().to_string());
412 } else if let Some(val) = part.strip_prefix("data=") {
413 data_val = Some(val.trim().to_string());
414 }
415 }
416 let username_b64 = username_b64_val
417 .ok_or_else(|| AuthError::InvalidHeader("missing username= in HELLO".into()))?;
418 let username_bytes = BASE64
419 .decode(&username_b64)
420 .map_err(|e| AuthError::Base64Error(e.to_string()))?;
421 let username = String::from_utf8(username_bytes)
422 .map_err(|e| AuthError::InvalidHeader(e.to_string()))?;
423 Ok(AuthHeader::Hello {
424 username,
425 data: data_val,
426 })
427 } else if let Some(rest) = header.strip_prefix("SCRAM ") {
428 let mut handshake_token = None;
429 let mut data = None;
430 for part in rest.split(',') {
431 let part = part.trim();
432 if let Some(val) = part.strip_prefix("handshakeToken=") {
433 handshake_token = Some(val.trim().to_string());
434 } else if let Some(val) = part.strip_prefix("data=") {
435 data = Some(val.trim().to_string());
436 }
437 }
438 let handshake_token = handshake_token
439 .ok_or_else(|| AuthError::InvalidHeader("missing handshakeToken= in SCRAM".into()))?;
440 let data = data.ok_or_else(|| AuthError::InvalidHeader("missing data= in SCRAM".into()))?;
441 Ok(AuthHeader::Scram {
442 handshake_token,
443 data,
444 })
445 } else if let Some(rest) = header.strip_prefix("BEARER ") {
446 let token = rest
447 .trim()
448 .strip_prefix("authToken=")
449 .ok_or_else(|| AuthError::InvalidHeader("missing authToken= in BEARER".into()))?;
450 Ok(AuthHeader::Bearer {
451 auth_token: token.trim().to_string(),
452 })
453 } else {
454 Err(AuthError::InvalidHeader(format!(
455 "unrecognized auth scheme: {}",
456 header
457 )))
458 }
459}
460
461pub fn format_www_authenticate(handshake_token: &str, hash: &str, data_b64: &str) -> String {
465 format!(
466 "SCRAM handshakeToken={}, hash={}, data={}",
467 handshake_token, hash, data_b64
468 )
469}
470
471pub fn format_auth_info(auth_token: &str, data_b64: &str) -> String {
475 format!("authToken={}, data={}", auth_token, data_b64)
476}
477
478#[cfg(test)]
483mod tests {
484 use super::*;
485
486 #[test]
487 fn test_derive_credentials() {
488 let password = "pencil";
489 let salt = b"random-salt-value";
490 let iterations = 4096;
491
492 let creds = derive_credentials(password, salt, iterations);
493
494 assert_eq!(creds.salt, salt.to_vec());
496 assert_eq!(creds.iterations, iterations);
497 assert_eq!(creds.stored_key.len(), 32); assert_eq!(creds.server_key.len(), 32);
499
500 let creds2 = derive_credentials(password, salt, iterations);
502 assert_eq!(creds.stored_key, creds2.stored_key);
503 assert_eq!(creds.server_key, creds2.server_key);
504
505 let creds3 = derive_credentials("other", salt, iterations);
507 assert_ne!(creds.stored_key, creds3.stored_key);
508 assert_ne!(creds.server_key, creds3.server_key);
509 }
510
511 #[test]
512 fn test_generate_nonce() {
513 let n1 = generate_nonce();
514 let n2 = generate_nonce();
515
516 assert_ne!(n1, n2);
518
519 let decoded1 = BASE64.decode(&n1).expect("nonce must be valid base64");
521 assert_eq!(decoded1.len(), 18);
522
523 let decoded2 = BASE64.decode(&n2).expect("nonce must be valid base64");
524 assert_eq!(decoded2.len(), 18);
525 }
526
527 #[test]
528 fn test_parse_auth_header_hello() {
529 let username = "user";
530 let username_b64 = BASE64.encode(username.as_bytes());
531 let header = format!("HELLO username={}", username_b64);
532
533 let parsed = parse_auth_header(&header).unwrap();
534 assert_eq!(
535 parsed,
536 AuthHeader::Hello {
537 username: "user".to_string(),
538 data: None,
539 }
540 );
541 }
542
543 #[test]
544 fn test_parse_auth_header_scram() {
545 let header = "SCRAM handshakeToken=abc123, data=c29tZWRhdGE=";
546 let parsed = parse_auth_header(header).unwrap();
547 assert_eq!(
548 parsed,
549 AuthHeader::Scram {
550 handshake_token: "abc123".to_string(),
551 data: "c29tZWRhdGE=".to_string(),
552 }
553 );
554 }
555
556 #[test]
557 fn test_parse_auth_header_bearer() {
558 let header = "BEARER authToken=mytoken123";
559 let parsed = parse_auth_header(header).unwrap();
560 assert_eq!(
561 parsed,
562 AuthHeader::Bearer {
563 auth_token: "mytoken123".to_string(),
564 }
565 );
566 }
567
568 #[test]
569 fn test_parse_auth_header_invalid() {
570 assert!(parse_auth_header("UNKNOWN foo=bar").is_err());
572 assert!(parse_auth_header("HELLO foo=bar").is_err());
574 assert!(parse_auth_header("SCRAM handshakeToken=abc").is_err());
576 assert!(parse_auth_header("BEARER token=abc").is_err());
578 assert!(parse_auth_header("").is_err());
580 }
581
582 #[test]
583 fn test_full_handshake() {
584 let username = "testuser";
586 let password = "s3cret";
587 let salt = b"test-salt-12345";
588 let iterations = 4096;
589
590 let credentials = derive_credentials(password, salt, iterations);
592
593 let username_b64 = BASE64.encode(username.as_bytes());
595 let hello_header = format!("HELLO username={}", username_b64);
596 let parsed = parse_auth_header(&hello_header).unwrap();
597 match &parsed {
598 AuthHeader::Hello { username: u, .. } => assert_eq!(u, username),
599 _ => panic!("expected Hello variant"),
600 }
601
602 let (client_nonce, _client_first_b64) = client_first_message(username);
604
605 let (handshake, server_first_b64) =
607 server_first_message(username, &client_nonce, &credentials);
608
609 let www_auth = format_www_authenticate("handshake-token-xyz", "SHA-256", &server_first_b64);
611 assert!(www_auth.contains("SCRAM"));
612 assert!(www_auth.contains("SHA-256"));
613 assert!(www_auth.contains("handshake-token-xyz"));
614
615 let (client_final_b64, expected_server_sig) =
617 client_final_message(password, &client_nonce, &server_first_b64, username).unwrap();
618
619 let server_sig = server_verify_final(&handshake, &client_final_b64).unwrap();
621
622 assert_eq!(server_sig, expected_server_sig);
624
625 let server_final_msg = format!("v={}", BASE64.encode(&server_sig));
627 let server_final_b64 = BASE64.encode(server_final_msg.as_bytes());
628 let auth_info = format_auth_info("auth-token-abc", &server_final_b64);
629 assert!(auth_info.contains("authToken=auth-token-abc"));
630
631 let server_final_decoded = BASE64.decode(&server_final_b64).unwrap();
633 let server_final_str = String::from_utf8(server_final_decoded).unwrap();
634 let sig_b64 = server_final_str.strip_prefix("v=").unwrap();
635 let received_server_sig = BASE64.decode(sig_b64).unwrap();
636 assert_eq!(received_server_sig, expected_server_sig);
637 }
638
639 #[test]
640 fn test_client_server_roundtrip() {
641 let username = "admin";
643 let password = "correcthorsebatterystaple";
644 let salt = b"unique-salt-value";
645 let iterations = DEFAULT_ITERATIONS;
646
647 let credentials = derive_credentials(password, salt, iterations);
649
650 let (client_nonce, client_first_b64) = client_first_message(username);
652
653 let client_first_decoded = BASE64.decode(&client_first_b64).unwrap();
655 let client_first_str = String::from_utf8(client_first_decoded).unwrap();
656 assert!(client_first_str.starts_with("n,,"));
657 assert!(client_first_str.contains(&format!("r={}", client_nonce)));
658
659 let (handshake, server_first_b64) =
661 server_first_message(username, &client_nonce, &credentials);
662
663 let server_first_decoded = BASE64.decode(&server_first_b64).unwrap();
665 let server_first_str = String::from_utf8(server_first_decoded).unwrap();
666 assert!(server_first_str.starts_with("r="));
667 assert!(server_first_str.contains(",s="));
668 assert!(server_first_str.contains(",i="));
669 assert!(server_first_str.contains(&client_nonce));
670
671 let (client_final_b64, expected_server_sig) =
673 client_final_message(password, &client_nonce, &server_first_b64, username).unwrap();
674
675 let client_final_decoded = BASE64.decode(&client_final_b64).unwrap();
677 let client_final_str = String::from_utf8(client_final_decoded).unwrap();
678 assert!(client_final_str.starts_with("c=biws,"));
679 assert!(client_final_str.contains(",p="));
680
681 let server_sig = server_verify_final(&handshake, &client_final_b64).unwrap();
683 assert_eq!(server_sig, expected_server_sig);
684
685 let (wrong_final_b64, _) =
687 client_final_message("wrongpassword", &client_nonce, &server_first_b64, username)
688 .unwrap();
689 let result = server_verify_final(&handshake, &wrong_final_b64);
690 assert!(result.is_err());
691 match result {
692 Err(AuthError::InvalidCredentials) => {} other => panic!("expected InvalidCredentials, got {:?}", other),
694 }
695 }
696
697 #[test]
698 fn test_format_www_authenticate() {
699 let result = format_www_authenticate("tok123", "SHA-256", "c29tZQ==");
700 assert_eq!(
701 result,
702 "SCRAM handshakeToken=tok123, hash=SHA-256, data=c29tZQ=="
703 );
704 }
705
706 #[test]
707 fn test_format_auth_info() {
708 let result = format_auth_info("auth-tok", "ZGF0YQ==");
709 assert_eq!(result, "authToken=auth-tok, data=ZGF0YQ==");
710 }
711}