utimaco_pkcs11_loader 5.20.1

Utimaco HSM PKCS#11 loader
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

//! These tests require a connection to a working HSM and are gated behind the `utimaco` feature.
//! To run a test, cd into the crate directory and run:
//! ```bash
//! HSM_USER_PASSWORD=12345678 cargo test --target x86_64-unknown-linux-gnu --features utimaco -- tests::test_hsm_utimaco_all
//! ```

use std::collections::HashMap;

use cosmian_kms_base_hsm::{
    HResult, RsaOaepDigest,
    test_helpers::{get_hsm_password, get_hsm_slot_id},
    tests_shared as shared,
};

use crate::{UTIMACO_PKCS11_LIB, UtimacoCapabilityProvider};

const SLOT_ID: usize = 0x00; // Utimaco default slot

fn cfg() -> HResult<shared::HsmTestConfig> {
    let user_password = get_hsm_password()?;
    let slot = get_hsm_slot_id().unwrap_or(SLOT_ID);
    Ok(shared::HsmTestConfig {
        lib_path: shared::lib_path("UTIMACO_PKCS11_LIB", UTIMACO_PKCS11_LIB),
        slot_ids_and_passwords: HashMap::from([(slot, Some(user_password))]),
        slot_id_for_tests: slot,
        rsa_oaep_digest: Some(RsaOaepDigest::SHA256),
        threads: 4,
        supports_rsa_wrap: true,
    })
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_all() -> HResult<()> {
    test_hsm_utimaco_get_info()?;
    test_hsm_utimaco_get_mechanisms()?;
    test_hsm_utimaco_get_supported_algorithms()?;
    test_hsm_utimaco_destroy_all()?;
    test_hsm_utimaco_generate_aes_key()?;
    test_hsm_utimaco_generate_rsa_keypair()?;
    test_hsm_utimaco_rsa_key_wrap()?;
    test_hsm_utimaco_rsa_pkcs_encrypt()?;
    test_hsm_utimaco_rsa_oaep_encrypt()?;
    test_hsm_utimaco_aes_gcm_encrypt()?;
    test_hsm_utimaco_rsa_pkcs_v15_sign()?;
    test_hsm_utimaco_rsa_sha256_sign()?;
    test_hsm_utimaco_rsa_sign_all_algorithms()?;
    test_hsm_utimaco_multi_threaded_rsa_encrypt_decrypt_test()?;
    test_hsm_utimaco_get_key_metadata()?;
    test_hsm_utimaco_list_objects()?;
    test_hsm_utimaco_search_incompatible_key()?;
    test_hsm_utimaco_destroy_all()?;
    Ok(())
}

// Note: low-level init test removed to avoid unsafe code and pedantic clippy violations.

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_get_info() -> HResult<()> {
    shared::get_info::<UtimacoCapabilityProvider>(&cfg()?)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_get_mechanisms() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::get_mechanisms_and_hashes(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_get_supported_algorithms() -> HResult<()> {
    shared::get_supported_algorithms::<UtimacoCapabilityProvider>(&cfg()?)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_generate_aes_key() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::generate_aes_key(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_generate_rsa_keypair() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::generate_rsa_keypair(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_key_wrap() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_key_wrap(&slot, RsaOaepDigest::SHA256)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_pkcs_encrypt() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_pkcs_encrypt(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_oaep_encrypt() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_oaep_encrypt(&slot, RsaOaepDigest::SHA256)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_aes_gcm_encrypt() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::aes_gcm_encrypt(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_pkcs_v15_sign() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_pkcs_v15_sign(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_sha256_sign() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_sha256_sign(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_rsa_sign_all_algorithms() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::rsa_sign_all_algorithms(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_multi_threaded_rsa_encrypt_decrypt_test() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::multi_threaded_rsa(&slot, RsaOaepDigest::SHA256, 4)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_list_objects() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::list_objects(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_get_key_metadata() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::get_key_metadata(&slot)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_search_incompatible_key() -> HResult<()> {
    let config = &cfg()?;
    let hsm = shared::instantiate::<UtimacoCapabilityProvider>(config)?;
    shared::search_incompatible_key(&hsm, &cfg()?)
}

#[test]
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
fn test_hsm_utimaco_destroy_all() -> HResult<()> {
    let slot = shared::instantiate_and_get_slot::<UtimacoCapabilityProvider>(&cfg()?)?;
    shared::destroy_all(&slot)
}