minipgp6 0.0.3

minipgp6
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

// SPDX-FileCopyrightText: Heiko Schaefer <heiko@schaefer.name>
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Helpers for password-locked secret key packets

use minipgp6_lock::unlock;
use minipgp6_packet::{body::secret_key::SecretKey, unlocked::UnlockedSoftwareKey};

/// If `key` is not password locked, return a `UnlockedSoftwareKey`
pub fn is_unlocked(key: &SecretKey) -> Option<UnlockedSoftwareKey<'_>> {
    if !key.is_locked() {
        // FIXME: make a nicer API for this in minipgp6_lock?
        unlock(key, None).ok()
    } else {
        None
    }
}

/// Try to unlock a secret key packet with a password
pub fn try_unlock_with_password<'a>(
    key: &'a SecretKey,
    password: &[u8],
) -> Option<UnlockedSoftwareKey<'a>> {
    try_unlock_with_passwords(key, &[password])
}

/// Try to unlock a secret key packet with a list of passwords
pub fn try_unlock_with_passwords<'a>(
    key: &'a SecretKey,
    passwords: &[&[u8]],
) -> Option<UnlockedSoftwareKey<'a>> {
    if let Some(unlocked) = is_unlocked(key) {
        Some(unlocked)
    } else {
        for password in passwords {
            if let Ok(unlocked) = unlock(key, Some(password)) {
                return Some(unlocked);
            }
        }

        None
    }
}