microvms-edges 1.0.0

The MicroVMs client's production port implementations: SigV4 over reqwest, the tunnel, the name registry, the clock and entropy
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

// SPDX-License-Identifier: Apache-2.0
//! The host's Noise initiator for the tunnel identity proof.
//!
//! The identity, its seeds and its pin are `microvms_domain::identity`, and the design argument
//! is `protocol::identity`'s. The initiator is here because building one draws an ephemeral key
//! from the OS random pool. `microvms_core::prelude::TunnelIdentityExt::initiator` is this under
//! the method name it had.

use microvms_app::error::{Error, ErrorKind};
use microvms_app::identity::TunnelIdentity;

/// The handshake state [`initiator`] returns, named here so a caller needn't depend on `snow`.
pub use snow::HandshakeState;

/// A Noise initiator bound to `identity`: proves the host, verifies the pin.
///
/// Built per connection. A `HandshakeState` carries nonces and must never be reused.
/// This low-level handshake has no tunnel context; `/v1/tcp` uses [`tunnel_initiator`].
pub fn initiator(identity: &TunnelIdentity) -> Result<HandshakeState, Error> {
    initiator_with_prologue(identity, &[])
}

/// Builds a verified tunnel handshake bound to its route, version, and guest port.
pub fn tunnel_initiator(
    identity: &TunnelIdentity,
    guest_port: u16,
) -> Result<HandshakeState, Error> {
    initiator_with_prologue(identity, &protocol::identity::tunnel_prologue(guest_port))
}

fn initiator_with_prologue(
    identity: &TunnelIdentity,
    prologue: &[u8],
) -> Result<HandshakeState, Error> {
    // The builder borrows both keys until `build_initiator`, so they need a home that
    // outlives the chain.
    let (host_seed, vm_public_key) = (identity.host_seed(), identity.vm_public_key());
    snow::Builder::new(
        protocol::identity::NOISE_PATTERN
            .parse()
            .expect("the pattern is a compile-time constant the protocol crate tests"),
    )
    .prologue(prologue)
    .and_then(|builder| builder.local_private_key(&host_seed))
    .and_then(|builder| builder.remote_public_key(&vm_public_key))
    .and_then(|builder| builder.build_initiator())
    .map_err(|error| {
        Error::new(
            ErrorKind::Unexpected,
            format!("could not build the identity initiator: {error}"),
        )
    })
}