yubihsm 0.17.3

Pure Rust client for YubiHSM2 devices
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! Compute an RSASSA-PSS signature of the SHA-256 hash of the given data
//!
//! <https://developers.yubico.com/YubiHSM2/Commands/Sign_Data_Pss.html>

use byteorder::{BigEndian, ByteOrder};

use super::{Command, Response};
use session::{Session, SessionError, SessionErrorKind::ProtocolError};
use sha2::{Digest, Sha256};
use Adapter;
use {Algorithm, CommandType, MgfAlg, ObjectId};

/// Maximum message size supported for RSASSA-PSS
pub const RSA_PSS_MAX_MESSAGE_SIZE: usize = 0xFFFF;

/// Compute an RSASSA-PSS signature of the SHA-256 hash of the given data with the given key ID.
///
/// WARNING: This method has not been tested and is not confirmed to actually work! Use at your
/// own risk!
pub fn sign_rsa_pss_sha256<A: Adapter>(
    session: &mut Session<A>,
    key_id: ObjectId,
    data: &[u8],
) -> Result<RSAPSSSignature, SessionError> {
    ensure!(
        data.len() > RSA_PSS_MAX_MESSAGE_SIZE,
        ProtocolError,
        "message too large to be signed (max: {})",
        RSA_PSS_MAX_MESSAGE_SIZE
    );

    let mut hasher = Sha256::default();

    let mut length = [0u8; 2];
    BigEndian::write_u16(&mut length, data.len() as u16);
    hasher.input(&length);
    hasher.input(data);
    let digest = hasher.result();

    session.send_command(SignDataPSSCommand {
        key_id,
        mgf1_hash_alg: Algorithm::Mgf(MgfAlg::SHA256),
        salt_len: digest.as_slice().len() as u16,
        digest: digest.as_slice().into(),
    })
}

/// Request parameters for `command::sign_rsa_pss*`
#[derive(Serialize, Deserialize, Debug)]
pub(crate) struct SignDataPSSCommand {
    /// ID of the key to perform the signature with
    pub key_id: ObjectId,

    /// Hash algorithm to use for MGF1
    pub mgf1_hash_alg: Algorithm,

    /// Salt length
    pub salt_len: u16,

    /// Digest of data to be signed
    pub digest: Vec<u8>,
}

impl Command for SignDataPSSCommand {
    type ResponseType = RSAPSSSignature;
}

/// RSASSA-PSS signatures (ASN.1 DER encoded)
#[derive(Serialize, Deserialize, Debug)]
pub struct RSAPSSSignature(pub Vec<u8>);

impl Response for RSAPSSSignature {
    const COMMAND_TYPE: CommandType = CommandType::SignDataPSS;
}

// TODO: use clippy's scoped lints once they work on stable
#[allow(
    unknown_lints,
    renamed_and_removed_lints,
    len_without_is_empty
)]
impl RSAPSSSignature {
    /// Unwrap inner byte vector
    pub fn into_vec(self) -> Vec<u8> {
        self.into()
    }

    /// Get length of the signature
    #[inline]
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Get slice of the inner byte vector
    #[inline]
    pub fn as_slice(&self) -> &[u8] {
        self.as_ref()
    }
}

impl AsRef<[u8]> for RSAPSSSignature {
    fn as_ref(&self) -> &[u8] {
        self.0.as_ref()
    }
}

impl Into<Vec<u8>> for RSAPSSSignature {
    fn into(self) -> Vec<u8> {
        self.0
    }
}