krust/passcode.rs
1/// Passcode handling utilities for krust commands
2///
3/// This module provides functions to prompt for and validate passcodes
4/// consistently across all krust commands.
5///
6/// IMPORTANT SECURITY NOTE:
7/// Passcodes are NEVER stored anywhere. They are used transiently for key
8/// derivation operations and then discarded from memory. Each krust command
9/// that needs to derive keys (incept, rotate, etc.) will prompt for the
10/// passcode again or accept it via --passcode argument.
11
12use anyhow::{Result, bail};
13use std::io::{self, Write};
14use rand::Rng;
15
16/// Get a passcode from the user through various input methods
17///
18/// # Parameters
19/// * `provided_passcode` - Optional passcode provided via command line argument
20/// * `nopasscode` - If true, no passcode will be used
21/// * `prompt_text` - Text to display when prompting for passcode
22///
23/// # Returns
24/// * `Option<String>` - The passcode if provided, None if nopasscode is true
25///
26/// # Examples
27/// ```
28/// // Get passcode from user prompt
29/// let passcode = get_passcode(None, false, "Enter passcode for keystore")?;
30///
31/// // Use command-line provided passcode
32/// let passcode = get_passcode(Some("mypass"), false, "Enter passcode")?;
33///
34/// // No passcode
35/// let passcode = get_passcode(None, true, "Enter passcode")?;
36/// assert!(passcode.is_none());
37/// ```
38pub fn get_passcode(
39 provided_passcode: Option<&str>,
40 nopasscode: bool,
41 prompt_text: &str,
42) -> Result<Option<String>> {
43 if nopasscode {
44 return Ok(None);
45 }
46
47 if let Some(pass) = provided_passcode {
48 return Ok(Some(pass.to_string()));
49 }
50
51 // Prompt for passcode securely
52 print!("{} (or press Enter for none): ", prompt_text);
53 io::stdout().flush()?;
54
55 match rpassword::read_password() {
56 Ok(pass) if pass.is_empty() => Ok(None),
57 Ok(pass) => Ok(Some(pass)),
58 Err(e) => bail!("Failed to read passcode: {}", e),
59 }
60}
61
62/// Generate a cryptographically secure random passcode
63///
64/// Generates a 21-character passcode using a CSPRNG (Cryptographically Secure
65/// Pseudo-Random Number Generator). The character set includes uppercase letters,
66/// lowercase letters, and digits 1-9 (excluding '0' to avoid confusion with 'O').
67///
68/// This matches the keripy implementation for compatibility.
69///
70/// # Returns
71/// * `String` - A cryptographically secure random 21-character passcode
72///
73/// # Examples
74/// ```
75/// // Generate 21-character passcode
76/// let passcode = generate_passcode();
77/// println!("Generated passcode: {}", passcode);
78/// ```
79pub fn generate_passcode() -> String {
80 const PASSCODE_SIZE: usize = 21;
81 const PASSCODE_CHARS: &[u8] = b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789";
82
83 let mut rng = rand::thread_rng();
84
85 (0..PASSCODE_SIZE)
86 .map(|_| {
87 let idx = rng.gen_range(0..PASSCODE_CHARS.len());
88 PASSCODE_CHARS[idx] as char
89 })
90 .collect()
91}
92
93#[cfg(test)]
94mod tests {
95 use super::*;
96
97 #[test]
98 fn test_generate_passcode_length() {
99 let passcode = generate_passcode();
100 assert_eq!(passcode.len(), 21);
101
102 // Verify all characters are in the allowed set
103 for c in passcode.chars() {
104 assert!(c.is_ascii_alphanumeric() && c != '0');
105 }
106 }
107
108 #[test]
109 fn test_generate_passcode_uniqueness() {
110 // Generate multiple passcodes and verify they're different
111 let passcode1 = generate_passcode();
112 let passcode2 = generate_passcode();
113 assert_ne!(passcode1, passcode2);
114 }
115}