Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions cli/src/artifact.rs
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,11 @@ impl Artifact {
None
}
Some(registry) => {
match registry.pull_selected(&format!("sha256:{}", index.sha256), host) {
match registry.pull_for_provider(
&format!("sha256:{}", index.sha256),
host,
&manifest,
) {
Ok(Some(layout)) if layout.digest.is_none() => {
warn_no_snapshot_variant(&manifest.id, host);
None
Expand Down Expand Up @@ -443,8 +447,13 @@ impl Artifact {
}
},
_ => {
let selected =
variants::select_layout(&directory, index, host, &artifact_path)?;
let selected = variants::select_layout(
&directory,
index,
host,
&artifact_path,
&manifest,
)?;
if selected.is_none() {
warn_no_snapshot_variant(&manifest.id, host);
}
Expand Down
126 changes: 121 additions & 5 deletions cli/src/artifact/variants.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use cap_std::fs::Dir;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};

use super::{FileDigest, open_artifact_file};
use super::{FileDigest, Manifest, open_artifact_file};
use crate::runtime::PAYLOAD_LIMIT;

const INDEX: &str = "application/vnd.oci.image.index.v1+json";
Expand Down Expand Up @@ -114,7 +114,12 @@ fn native_compatibility() -> Option<(String, String)> {
}

impl SnapshotIndex {
pub fn select(&self, host: &HostCompatibility) -> Result<Option<&OciDescriptor>> {
/// Prefetch has no provider manifest, but still requires complete input bindings.
pub fn select(
&self,
host: &HostCompatibility,
provider: Option<&Manifest>,
) -> Result<Option<&OciDescriptor>> {
ensure!(
self.schema_version == 2 && self.media_type == INDEX,
"unsupported provider snapshot OCI index"
Expand All @@ -126,7 +131,7 @@ impl SnapshotIndex {
let (Some(hypervisor), Some(vendor)) = (&host.hypervisor, &host.cpu_vendor) else {
return Ok(None);
};
Ok(self
let selected = self
.manifests
.iter()
.filter(|descriptor| {
Expand All @@ -139,7 +144,11 @@ impl SnapshotIndex {
.is_some_and(|release| release.ends_with('-'))
})
})
.min_by(|left, right| (&left.digest, left.size).cmp(&(&right.digest, right.size))))
.min_by(|left, right| (&left.digest, left.size).cmp(&(&right.digest, right.size)));
if let Some(selected) = selected {
selected.validate_inputs(provider, &host.architecture)?;
}
Ok(selected)
}
}

Expand All @@ -148,6 +157,7 @@ pub(super) fn select_layout(
file: &FileDigest,
host: &HostCompatibility,
artifact_path: &Path,
provider: &Manifest,
) -> Result<Option<(PathBuf, String)>> {
let (bytes, _) = read_verified(directory, file, PAYLOAD_LIMIT as u64, true)?;
let index: SnapshotIndex =
Expand All @@ -159,7 +169,7 @@ pub(super) fn select_layout(
.is_some_and(|name| name == "index.json"),
"provider snapshot index must name a native OCI index.json"
);
let Some(descriptor) = index.select(host)? else {
let Some(descriptor) = index.select(host, Some(provider))? else {
return Ok(None);
};
let parent = index_path
Expand Down Expand Up @@ -275,6 +285,46 @@ impl SnapshotManifest {
}

impl OciDescriptor {
fn validate_inputs(&self, provider: Option<&Manifest>, architecture: &str) -> Result<()> {
let kernel = provider
.map(|provider| {
provider.kernel.as_ref().map_or_else(
|| crate::assets::embedded_kernel_sha256(architecture),
|file| Ok(file.sha256.clone()),
)
})
.transpose()?;
for (field, expected) in [
(
"rootfs",
provider.map(|provider| provider.rootfs.sha256.as_str()),
),
(
"program",
provider.map(|provider| provider.program.sha256.as_str()),
),
("kernel", kernel.as_deref()),
] {
let actual = self
.annotations
.get(&format!("dev.lampyr.provider.{field}.sha256"));
ensure!(
actual.is_some_and(|hash| hash.len() == 64
&& hash
.bytes()
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))),
"selected provider snapshot {field} digest is missing or invalid; recapture the variant"
);
if let Some(expected) = expected {
ensure!(
actual.map(String::as_str) == Some(expected),
"selected provider snapshot {field} digest does not match the provider's cold-boot asset"
);
}
}
Ok(())
}

pub(crate) fn hash(&self, limit: u64) -> Result<&str> {
let hash = self
.digest
Expand Down Expand Up @@ -347,6 +397,72 @@ fn read_verified(
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;

#[test]
fn selected_variant_bindings_are_required_and_checked_before_blob_loading() {
let host = HostCompatibility {
architecture: "x86_64".into(),
hypervisor: Some("kvm".into()),
cpu_vendor: Some("GenuineIntel".into()),
};
let provider: Manifest = serde_json::from_value(json!({
"protocolVersion": 1, "id": "test", "version": "1",
"runtimeVersion": crate::assets::VERSION, "memoryMiB": 256,
"rootfs": {"path": "rootfs.cpio", "sha256": "a".repeat(64)},
"program": {"path": "provider.py", "sha256": "b".repeat(64)},
"operations": {"describe": []},
}))
.unwrap();
let mut selected = layer(MANIFEST, 1);
selected.annotations = BTreeMap::from([
(ARCH.into(), host.architecture.clone()),
(HYPERVISOR.into(), "kvm".into()),
(CPU_VENDOR.into(), "GenuineIntel".into()),
(
REF_NAME.into(),
format!(
"{}-{}",
crate::assets::VERSION,
hyperlight_unikraft::SNAPSHOT_KEY
),
),
(
"dev.lampyr.provider.rootfs.sha256".into(),
provider.rootfs.sha256.clone(),
),
(
"dev.lampyr.provider.program.sha256".into(),
provider.program.sha256.clone(),
),
(
"dev.lampyr.provider.kernel.sha256".into(),
crate::assets::embedded_kernel_sha256(&host.architecture).unwrap(),
),
]);
let index = SnapshotIndex {
schema_version: 2,
media_type: INDEX.into(),
manifests: vec![selected],
};
assert!(index.select(&host, Some(&provider)).unwrap().is_some());
for field in ["rootfs", "program", "kernel"] {
for value in [None, Some("c".repeat(64)), Some("SHA256:bad".into())] {
let mut invalid = index.clone();
let key = format!("dev.lampyr.provider.{field}.sha256");
if let Some(value) = value {
invalid.manifests[0].annotations.insert(key, value);
} else {
invalid.manifests[0].annotations.remove(&key);
}
let error = invalid.select(&host, Some(&provider)).unwrap_err();
assert!(error.to_string().contains(field), "{error}");
let mut other = host.clone();
other.cpu_vendor = Some("AuthenticAMD".into());
assert!(invalid.select(&other, Some(&provider)).unwrap().is_none());
}
}
}

fn layer(media_type: &str, size: u64) -> OciDescriptor {
OciDescriptor {
Expand Down
35 changes: 31 additions & 4 deletions cli/src/assets.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,33 @@ pub(crate) const UNIKRAFT_COMMIT: &str = "3b7cba8816c02a497e7b5aa9c901655784a010
const RELEASE: &str =
"https://github.com/hyperlight-dev/hyperlight-unikraft/releases/download/v0.21.0";
const KERNEL: &str = "https://raw.githubusercontent.com/hyperlight-dev/hyperlight-unikraft/34c0d647a9f8679c0ce53b76e174894b2c5bfa7a/kernel/elfloader_hyperlight-x86_64";
const KERNEL_HASH: &str = "fb05f5f9150b9c48de9c035b94eee0fa4c580bd5332586b48f0cee2e860cf861";

/// Full hashes of the kernels in the checksum-locked hyperlight-unikraft crate.
pub fn embedded_kernel_sha256(architecture: &str) -> Result<String> {
let pins: serde_json::Value = serde_json::from_str(include_str!("embedded-kernels.json"))?;
ensure!(
pins["runtimeVersion"] == VERSION,
"embedded provider kernel hashes need updating for runtime {VERSION}"
);
let hash = pins["kernels"][architecture]
.as_str()
.map(str::to_owned)
.context("provider snapshot has no pinned embedded kernel for its architecture")?;
ensure!(
hash.len() == 64
&& hash
.bytes()
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte)),
"invalid pinned embedded provider kernel hash"
);
if architecture == std::env::consts::ARCH {
ensure!(
hyperlight_unikraft::SNAPSHOT_KEY.starts_with(&format!("k{}-c", &hash[..16])),
"embedded provider kernel hash does not match the runtime snapshot key"
);
}
Ok(hash)
}

struct Binary {
target: &'static str,
Expand Down Expand Up @@ -115,16 +141,17 @@ pub fn setup(root: &Path, host: &Host) -> Result<()> {
install_binary(&native, &native_path(root), host)?;
}
let kernel = root.join("build/kernel");
if !matches(&kernel, KERNEL_HASH)? {
let kernel_hash = embedded_kernel_sha256("x86_64")?;
if !matches(&kernel, &kernel_hash)? {
let file = download(
KERNEL,
root.join("build").as_path(),
KERNEL_HASH,
&kernel_hash,
128 << 20,
Duration::from_secs(120),
host,
)?;
install(file.reopen()?, &kernel, KERNEL_HASH)?;
install(file.reopen()?, &kernel, &kernel_hash)?;
}
Ok(())
}
Expand Down
7 changes: 7 additions & 0 deletions cli/src/embedded-kernels.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"runtimeVersion": "0.21.0",
"kernels": {
"x86_64": "fb05f5f9150b9c48de9c035b94eee0fa4c580bd5332586b48f0cee2e860cf861",
"aarch64": "097a8080d7532764d557526b5a5da536cbf5269d52cdb09b7664d53a285ca5be"
}
}
33 changes: 29 additions & 4 deletions cli/src/provider_registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ use sha2::{Digest, Sha256};
use url::Url;
use zeroize::{Zeroize, Zeroizing};

use crate::artifact::{HostCompatibility, OciDescriptor, SnapshotIndex, SnapshotManifest};
use crate::artifact::{
HostCompatibility, Manifest, OciDescriptor, SnapshotIndex, SnapshotManifest,
};
use crate::runtime::{Cancellation, PAYLOAD_LIMIT};

const INDEX: &str = "application/vnd.oci.image.index.v1+json";
Expand Down Expand Up @@ -170,14 +172,37 @@ impl SnapshotRegistry {
&self,
digest: &str,
host: &HostCompatibility,
) -> Result<Option<PulledLayout>> {
self.pull_checked(digest, host, None)
}

pub(crate) fn pull_for_provider(
&self,
digest: &str,
host: &HostCompatibility,
provider: &Manifest,
) -> Result<Option<PulledLayout>> {
self.pull_checked(digest, host, Some(provider))
}

fn pull_checked(
&self,
digest: &str,
host: &HostCompatibility,
provider: Option<&Manifest>,
) -> Result<Option<PulledLayout>> {
ensure!(!self.cancellation.is_cancelled(), "snapshot pull cancelled");
let result = self.pull_inner(digest, host);
let result = self.pull_inner(digest, host, provider);
ensure!(!self.cancellation.is_cancelled(), "snapshot pull cancelled");
result
}

fn pull_inner(&self, digest: &str, host: &HostCompatibility) -> Result<Option<PulledLayout>> {
fn pull_inner(
&self,
digest: &str,
host: &HostCompatibility,
provider: Option<&Manifest>,
) -> Result<Option<PulledLayout>> {
let index_descriptor = OciDescriptor {
media_type: INDEX.into(),
digest: digest.into(),
Expand Down Expand Up @@ -265,7 +290,7 @@ impl SnapshotRegistry {
};
let parsed: SnapshotIndex =
serde_json::from_slice(&index).context("decode registry snapshot index")?;
let selected = parsed.select(host)?;
let selected = parsed.select(host, provider)?;
if let Some(descriptor) = selected {
let bytes = read_limited(
self.blob(
Expand Down
Loading
Loading