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

//! (Partial) support for audit logging within the MockHsm
//!
//! No logging is performed and these settings are not yet enforced

use std::collections::BTreeMap;

use audit::*;
use command::CommandType;
use serialization::serialize;

/// Default per-command auditing options
pub const DEFAULT_COMMAND_AUDIT_OPTIONS: &[AuditCommand] = &[
    AuditCommand(CommandType::Echo, AuditOption::Off),
    AuditCommand(CommandType::CreateSession, AuditOption::On),
    AuditCommand(CommandType::AuthSession, AuditOption::On),
    AuditCommand(CommandType::SessionMessage, AuditOption::Off),
    AuditCommand(CommandType::DeviceInfo, AuditOption::Off),
    AuditCommand(CommandType::BSL, AuditOption::Off),
    AuditCommand(CommandType::Command9, AuditOption::Off),
    AuditCommand(CommandType::Reset, AuditOption::On),
    AuditCommand(CommandType::CloseSession, AuditOption::On),
    AuditCommand(CommandType::StorageStatus, AuditOption::On),
    AuditCommand(CommandType::PutOpaqueObject, AuditOption::On),
    AuditCommand(CommandType::GetOpaqueObject, AuditOption::On),
    AuditCommand(CommandType::PutAuthKey, AuditOption::On),
    AuditCommand(CommandType::PutAsymmetricKey, AuditOption::On),
    AuditCommand(CommandType::GenerateAsymmetricKey, AuditOption::On),
    AuditCommand(CommandType::SignDataPKCS1, AuditOption::On),
    AuditCommand(CommandType::SignDataPSS, AuditOption::On),
    AuditCommand(CommandType::SignDataECDSA, AuditOption::On),
    AuditCommand(CommandType::ListObjects, AuditOption::On),
    AuditCommand(CommandType::DecryptPKCS1, AuditOption::On),
    AuditCommand(CommandType::DecryptECDH, AuditOption::On),
    AuditCommand(CommandType::ExportWrapped, AuditOption::On),
    AuditCommand(CommandType::ImportWrapped, AuditOption::On),
    AuditCommand(CommandType::PutWrapKey, AuditOption::On),
    AuditCommand(CommandType::GetLogs, AuditOption::Off),
    AuditCommand(CommandType::SetLogIndex, AuditOption::On),
    AuditCommand(CommandType::GetObjectInfo, AuditOption::On),
    AuditCommand(CommandType::PutOption, AuditOption::On),
    AuditCommand(CommandType::GetOption, AuditOption::On),
    AuditCommand(CommandType::GetPseudoRandom, AuditOption::On),
    AuditCommand(CommandType::PutHMACKey, AuditOption::On),
    AuditCommand(CommandType::HMACData, AuditOption::On),
    AuditCommand(CommandType::GetPubKey, AuditOption::On),
    AuditCommand(CommandType::DeleteObject, AuditOption::On),
    AuditCommand(CommandType::DecryptOAEP, AuditOption::On),
    AuditCommand(CommandType::GenerateHMACKey, AuditOption::On),
    AuditCommand(CommandType::GenerateWrapKey, AuditOption::On),
    AuditCommand(CommandType::VerifyHMAC, AuditOption::On),
    AuditCommand(CommandType::SSHCertify, AuditOption::On),
    AuditCommand(CommandType::PutTemplate, AuditOption::On),
    AuditCommand(CommandType::GetTemplate, AuditOption::On),
    AuditCommand(CommandType::DecryptOTP, AuditOption::On),
    AuditCommand(CommandType::CreateOTPAEAD, AuditOption::On),
    AuditCommand(CommandType::RandomOTPAEAD, AuditOption::On),
    AuditCommand(CommandType::RewrapOTPAEAD, AuditOption::On),
    AuditCommand(CommandType::AttestAsymmetric, AuditOption::On),
    AuditCommand(CommandType::PutOTPAEAD, AuditOption::On),
    AuditCommand(CommandType::GenerateOTPAEAD, AuditOption::On),
    AuditCommand(CommandType::WrapData, AuditOption::On),
    AuditCommand(CommandType::UnwrapData, AuditOption::On),
    AuditCommand(CommandType::SignDataEdDSA, AuditOption::On),
    AuditCommand(CommandType::Blink, AuditOption::On),
];

/// Per-command auditing settings
#[derive(Debug)]
pub struct CommandAuditOptions(BTreeMap<CommandType, AuditOption>);

impl CommandAuditOptions {
    /// Serialize these audit options for use as a `GetObjects` response
    pub fn serialize(&self) -> Vec<u8> {
        let audit_command: Vec<_> = self
            .0
            .iter()
            .map(|(cmd, opt)| AuditCommand(*cmd, *opt))
            .collect();

        serialize(&audit_command).unwrap()
    }

    /// Change a setting for a particular command
    pub fn put(&mut self, command_type: CommandType, audit_option: AuditOption) {
        self.0.insert(command_type, audit_option);
    }
}

impl Default for CommandAuditOptions {
    fn default() -> Self {
        let mut result = BTreeMap::new();

        for audit_command in DEFAULT_COMMAND_AUDIT_OPTIONS {
            result.insert(audit_command.command_type(), audit_command.audit_option());
        }

        CommandAuditOptions(result)
    }
}