bitwarden_core/auth/
pin.rs

1use bitwarden_crypto::{
2    EncString, PinKey,
3    safe::{PasswordProtectedKeyEnvelope, PasswordProtectedKeyEnvelopeNamespace},
4};
5use tracing::info;
6
7use crate::{
8    Client, NotAuthenticatedError, auth::AuthValidateError, client::UserLoginMethod,
9    key_management::SymmetricKeyId,
10};
11
12pub(crate) fn validate_pin(
13    client: &Client,
14    pin: String,
15    pin_protected_user_key: EncString,
16) -> Result<bool, AuthValidateError> {
17    let login_method = client
18        .internal
19        .get_login_method()
20        .ok_or(NotAuthenticatedError)?;
21
22    match login_method {
23        UserLoginMethod::Username { email, kdf, .. }
24        | UserLoginMethod::ApiKey { email, kdf, .. } => {
25            let key_store = client.internal.get_key_store();
26            let ctx = key_store.context();
27            // FIXME: [PM-18099] Once PinKey deals with KeyIds, this should be updated
28            #[allow(deprecated)]
29            let user_key = ctx.dangerous_get_symmetric_key(SymmetricKeyId::User)?;
30
31            let pin_key = PinKey::derive(pin.as_bytes(), email.as_bytes(), &kdf)?;
32
33            let Ok(decrypted_key) = pin_key.decrypt_user_key(pin_protected_user_key) else {
34                return Ok(false);
35            };
36
37            Ok(*user_key == decrypted_key)
38        }
39    }
40}
41
42/// Validates a PIN-protected user key envelope by attempting to unseal it with the provided PIN.
43pub(crate) fn validate_pin_protected_user_key_envelope(
44    client: &Client,
45    pin: String,
46    pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope,
47) -> bool {
48    let key_store = client.internal.get_key_store();
49    let mut ctx = key_store.context();
50
51    if let Err(e) = pin_protected_user_key_envelope.unseal(
52        pin.as_str(),
53        PasswordProtectedKeyEnvelopeNamespace::PinUnlock,
54        &mut ctx,
55    ) {
56        info!("Validating PIN-protected user key envelope failed: {e:?}");
57        false
58    } else {
59        true
60    }
61}
62
63#[cfg(test)]
64mod tests {
65    use std::num::NonZeroU32;
66
67    use bitwarden_crypto::{Kdf, safe::PasswordProtectedKeyEnvelopeNamespace};
68
69    use super::*;
70    use crate::{
71        client::{Client, LoginMethod, UserLoginMethod},
72        key_management::{
73            MasterPasswordUnlockData, account_cryptographic_state::WrappedAccountCryptographicState,
74        },
75    };
76
77    fn init_client() -> Client {
78        let client = Client::new(None);
79
80        let password = "asdfasdfasdf";
81        let email = "[email protected]";
82        let kdf = Kdf::PBKDF2 {
83            iterations: NonZeroU32::new(600_000).unwrap(),
84        };
85
86        client
87            .internal
88            .set_login_method(LoginMethod::User(UserLoginMethod::Username {
89                email: email.to_string(),
90                kdf: kdf.clone(),
91                client_id: "1".to_string(),
92            }));
93
94        let user_key = "2.Q/2PhzcC7GdeiMHhWguYAQ==|GpqzVdr0go0ug5cZh1n+uixeBC3oC90CIe0hd/HWA/pTRDZ8ane4fmsEIcuc8eMKUt55Y2q/fbNzsYu41YTZzzsJUSeqVjT8/iTQtgnNdpo=|dwI+uyvZ1h/iZ03VQ+/wrGEFYVewBUUl/syYgjsNMbE=";
95        let private_key = "2.yN7l00BOlUE0Sb0M//Q53w==|EwKG/BduQRQ33Izqc/ogoBROIoI5dmgrxSo82sgzgAMIBt3A2FZ9vPRMY+GWT85JiqytDitGR3TqwnFUBhKUpRRAq4x7rA6A1arHrFp5Tp1p21O3SfjtvB3quiOKbqWk6ZaU1Np9HwqwAecddFcB0YyBEiRX3VwF2pgpAdiPbSMuvo2qIgyob0CUoC/h4Bz1be7Qa7B0Xw9/fMKkB1LpOm925lzqosyMQM62YpMGkjMsbZz0uPopu32fxzDWSPr+kekNNyLt9InGhTpxLmq1go/pXR2uw5dfpXc5yuta7DB0EGBwnQ8Vl5HPdDooqOTD9I1jE0mRyuBpWTTI3FRnu3JUh3rIyGBJhUmHqGZvw2CKdqHCIrQeQkkEYqOeJRJVdBjhv5KGJifqT3BFRwX/YFJIChAQpebNQKXe/0kPivWokHWwXlDB7S7mBZzhaAPidZvnuIhalE2qmTypDwHy22FyqV58T8MGGMchcASDi/QXI6kcdpJzPXSeU9o+NC68QDlOIrMVxKFeE7w7PvVmAaxEo0YwmuAzzKy9QpdlK0aab/xEi8V4iXj4hGepqAvHkXIQd+r3FNeiLfllkb61p6WTjr5urcmDQMR94/wYoilpG5OlybHdbhsYHvIzYoLrC7fzl630gcO6t4nM24vdB6Ymg9BVpEgKRAxSbE62Tqacxqnz9AcmgItb48NiR/He3n3ydGjPYuKk/ihZMgEwAEZvSlNxYONSbYrIGDtOY+8Nbt6KiH3l06wjZW8tcmFeVlWv+tWotnTY9IqlAfvNVTjtsobqtQnvsiDjdEVtNy/s2ci5TH+NdZluca2OVEr91Wayxh70kpM6ib4UGbfdmGgCo74gtKvKSJU0rTHakQ5L9JlaSDD5FamBRyI0qfL43Ad9qOUZ8DaffDCyuaVyuqk7cz9HwmEmvWU3VQ+5t06n/5kRDXttcw8w+3qClEEdGo1KeENcnXCB32dQe3tDTFpuAIMLqwXs6FhpawfZ5kPYvLPczGWaqftIs/RXJ/EltGc0ugw2dmTLpoQhCqrcKEBDoYVk0LDZKsnzitOGdi9mOWse7Se8798ib1UsHFUjGzISEt6upestxOeupSTOh0v4+AjXbDzRUyogHww3V+Bqg71bkcMxtB+WM+pn1XNbVTyl9NR040nhP7KEf6e9ruXAtmrBC2ah5cFEpLIot77VFZ9ilLuitSz+7T8n1yAh1IEG6xxXxninAZIzi2qGbH69O5RSpOJuJTv17zTLJQIIc781JwQ2TTwTGnx5wZLbffhCasowJKd2EVcyMJyhz6ru0PvXWJ4hUdkARJs3Xu8dus9a86N8Xk6aAPzBDqzYb1vyFIfBxP0oO8xFHgd30Cgmz8UrSE3qeWRrF8ftrI6xQnFjHBGWD/JWSvd6YMcQED0aVuQkuNW9ST/DzQThPzRfPUoiL10yAmV7Ytu4fR3x2sF0Yfi87YhHFuCMpV/DsqxmUizyiJuD938eRcH8hzR/VO53Qo3UIsqOLcyXtTv6THjSlTopQ+JOLOnHm1w8dzYbLN44OG44rRsbihMUQp+wUZ6bsI8rrOnm9WErzkbQFbrfAINdoCiNa6cimYIjvvnMTaFWNymqY1vZxGztQiMiHiHYwTfwHTXrb9j0uPM=|09J28iXv9oWzYtzK2LBT6Yht4IT4MijEkk0fwFdrVQ4=".parse().unwrap();
96
97        client
98            .internal
99            .initialize_user_crypto_master_password_unlock(
100                password.to_string(),
101                MasterPasswordUnlockData {
102                    kdf,
103                    master_key_wrapped_user_key: user_key.parse().unwrap(),
104                    salt: email.to_string(),
105                },
106                WrappedAccountCryptographicState::V1 { private_key },
107                &None,
108            )
109            .unwrap();
110
111        client
112    }
113
114    #[test]
115    fn test_validate_valid_pin() {
116        let pin = "1234".to_string();
117        let pin_protected_user_key = "2.BXgvdBUeEMyvumqAJkAzPA==|JScDPoqOkVdrC1X755Ubt8tS9pC/thvrvNf5CyNcRg8HZtZ466EcRo7aCqwUzLyTVNRkbCYtFYT+09acGGHur8tGuS7Kmg/pYeaUo4K0UKI=|NpIFg5P9z0SN1MffbixD9OQE0l+NiNmnRQJs/kTsyoQ="
118        .parse()
119        .unwrap();
120
121        let client = init_client();
122        assert!(validate_pin(&client, pin.clone(), pin_protected_user_key).unwrap());
123    }
124
125    #[test]
126    fn test_validate_invalid_pin() {
127        let pin = "1234".to_string();
128        let pin_protected_user_key = "2.BXgvdBUeEMyvumqAJkAyPA==|JScDPoqOkVdrC1X755Ubt8tS9pC/thvrvNf5CyNcRg8HZtZ466EcRo7aCqwUzLyTVNRkbCYtFYT+09acGGHur8tGuS7Kmg/pYeaUo4K0UKI=|NpIFg5P9z0SN1MffbixD9OQE0l+NiNmnRQJs/kTsyoQ="
129        .parse()
130        .unwrap();
131
132        let client = init_client();
133        assert!(!validate_pin(&client, pin.clone(), pin_protected_user_key).unwrap());
134    }
135
136    #[test]
137    fn test_validate_pin_protected_user_key_envelope_valid_pin() {
138        let pin = "1234";
139        let client = init_client();
140
141        // Create a PIN-protected envelope from the user key
142        let key_store = client.internal.get_key_store();
143        let ctx = key_store.context();
144        let envelope = PasswordProtectedKeyEnvelope::seal(
145            SymmetricKeyId::User,
146            pin,
147            PasswordProtectedKeyEnvelopeNamespace::PinUnlock,
148            &ctx,
149        )
150        .unwrap();
151
152        // Validate with the correct PIN
153        let result = validate_pin_protected_user_key_envelope(&client, pin.to_string(), envelope);
154        assert!(result);
155    }
156
157    #[test]
158    fn test_validate_pin_protected_user_key_envelope_invalid_pin() {
159        let correct_pin = "1234";
160        let wrong_pin = "5678";
161        let client = init_client();
162
163        // Create a PIN-protected envelope with the correct PIN
164        let key_store = client.internal.get_key_store();
165        let ctx = key_store.context();
166        let envelope = PasswordProtectedKeyEnvelope::seal(
167            SymmetricKeyId::User,
168            correct_pin,
169            PasswordProtectedKeyEnvelopeNamespace::PinUnlock,
170            &ctx,
171        )
172        .unwrap();
173
174        // Validate with the wrong PIN
175        let result =
176            validate_pin_protected_user_key_envelope(&client, wrong_pin.to_string(), envelope);
177        assert!(!result);
178    }
179
180    #[test]
181    fn test_validate_pin_protected_user_key_malformed_envelope() {
182        let pin = "1234";
183
184        let client = init_client();
185
186        // Create a PIN-protected envelope with the correct PIN
187        let key_store = client.internal.get_key_store();
188        let ctx = key_store.context();
189        let envelope = PasswordProtectedKeyEnvelope::seal(
190            SymmetricKeyId::User,
191            pin,
192            PasswordProtectedKeyEnvelopeNamespace::PinUnlock,
193            &ctx,
194        )
195        .unwrap();
196
197        let mut envelope_bytes: Vec<u8> = (&envelope).into();
198        // Corrupt some bytes
199        envelope_bytes[60] ^= 0xFF;
200
201        let envelope: PasswordProtectedKeyEnvelope =
202            PasswordProtectedKeyEnvelope::try_from(&envelope_bytes).unwrap();
203
204        let client = Client::new(None);
205
206        // Validate should fail because no user key is present in this client
207        let result = validate_pin_protected_user_key_envelope(&client, pin.to_string(), envelope);
208        assert!(!result);
209    }
210}
bitwarden_core/auth/pin.rs

bitwarden_core/auth/
pin.rs
