qos_core 0.7.0

Core components and logic for QuorumOS applications
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

//! Core components and logic for QOS. This contains both the logic for the
//! process running in the enclave and exports for use by secure apps and QOS
//! clients
//!
//! # Maintainers Notes
//!
//! This crate should have as minimal dependencies as possible to decrease
//! supply chain attack vectors and audit burden

// "vm" is necessary for production and we don't want any mock data slipping in.
#[cfg(all(feature = "vm", feature = "mock"))]
compile_error!(
	"feature \"vm\" and feature \"mock\" cannot be enabled at the same time"
);

pub mod client;
pub mod server;

pub mod cli;
pub mod handles;
pub mod io;
pub mod parser;
pub mod protocol;
pub mod reaper;

/// Path to Quorum Key secret.
#[cfg(not(feature = "vm"))]
pub const QUORUM_FILE: &str = "./local-enclave/qos.quorum.key";
/// Path to Quorum Key secret.
#[cfg(feature = "vm")]
pub const QUORUM_FILE: &str = "/qos.quorum.key";

/// Path to Pivot binary.
#[cfg(not(feature = "vm"))]
pub const PIVOT_FILE: &str = "./local-enclave/qos.pivot.bin";
/// Path to Pivot binary.
#[cfg(feature = "vm")]
pub const PIVOT_FILE: &str = "/qos.pivot.bin";

/// Path to Ephemeral Key.
#[cfg(not(feature = "vm"))]
pub const EPHEMERAL_KEY_FILE: &str = "./local-enclave/qos.ephemeral.key";
/// Path to Ephemeral Key.
#[cfg(feature = "vm")]
pub const EPHEMERAL_KEY_FILE: &str = "/qos.ephemeral.key";

/// Path to the Manifest.
#[cfg(not(feature = "vm"))]
pub const MANIFEST_FILE: &str = "./local-enclave/qos.manifest";
/// Path to the Manifest.
#[cfg(feature = "vm")]
pub const MANIFEST_FILE: &str = "/qos.manifest";

/// Default socket for enclave <-> secure app communication.
#[cfg(not(feature = "vm"))]
pub const SEC_APP_SOCK: &str = "./local-enclave/sec_app.sock";
/// Default socket for enclave <-> secure app communication.
#[cfg(feature = "vm")]
pub const SEC_APP_SOCK: &str = "/sec_app.sock";
/// Default socket connect timeout in milliseconds
pub const DEFAULT_SOCKET_TIMEOUT_MS: &str = "5000";