nethsm 0.10.0

A high-level library to interact with the API of a Nitrokey NetHSM
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

//! Tests of NetHSM provisioning.

use std::time::Duration;

use chrono::Utc;
use nethsm::Credentials;
use nethsm::Passphrase;
use nethsm::test::ADMIN_USER_ID;
use nethsm::test::ADMIN_USER_PASSPHRASE;
use nethsm::test::NetHsmImage;
use nethsm::test::UNLOCK_PASSPHRASE;
use nethsm::test::unprovisioned_nethsm;
use nethsm::{NetHsm, SystemState};
use rstest::rstest;
use rustainers::Container;
use testresult::TestResult;
use tokio::time::sleep;

#[rstest]
#[tokio::test]
async fn initial_provisioning(
    #[future] unprovisioned_nethsm: TestResult<(NetHsm, Container<NetHsmImage>)>,
) -> TestResult {
    let (nethsm, _container) = unprovisioned_nethsm.await?;

    nethsm.remove_credentials(&ADMIN_USER_ID.parse()?);

    let info = nethsm.info()?;
    println!("The NetHSM info: {info:?}");

    assert_eq!(nethsm.state()?, SystemState::Unprovisioned);
    nethsm.provision(
        Passphrase::new(UNLOCK_PASSPHRASE.to_string()),
        Passphrase::new(ADMIN_USER_PASSPHRASE.to_string()),
        Utc::now(),
    )?;

    // poll every 200ms if system is operational, until timeout of 1s is reached
    let timeout = 1000;
    let interval = 200;
    let mut elapsed = 0;
    while elapsed <= timeout {
        if nethsm.state()? == SystemState::Operational {
            println!("Waited at least {elapsed}ms until NetHSM became operational");
            break;
        }
        sleep(Duration::from_millis(interval)).await;
        elapsed += interval;
    }

    // now the admin credentials are needed
    nethsm.add_credentials(Credentials::new(
        ADMIN_USER_ID.parse()?,
        Some(Passphrase::new(ADMIN_USER_PASSPHRASE.to_string())),
    ));
    nethsm.use_credentials(&ADMIN_USER_ID.parse()?)?;

    nethsm.lock()?;
    assert_eq!(nethsm.state()?, SystemState::Locked);
    nethsm.unlock(Passphrase::new(UNLOCK_PASSPHRASE.to_string()))?;
    assert_eq!(nethsm.state()?, SystemState::Operational);

    let new_unlock_passphrase = "just-another-unlock-passphrase";
    nethsm.set_unlock_passphrase(
        Passphrase::new(UNLOCK_PASSPHRASE.to_string()),
        Passphrase::new(new_unlock_passphrase.to_string()),
    )?;

    nethsm.lock()?;
    nethsm.remove_credentials(&ADMIN_USER_ID.parse()?);
    nethsm.unlock(Passphrase::new(new_unlock_passphrase.to_string()))?;
    assert_eq!(nethsm.state()?, SystemState::Operational);

    if elapsed > timeout {
        panic!("NetHSM did not become operational within {timeout}ms");
    }

    Ok(())
}