#[cfg(has_bundled_cli)]
use std::collections::HashSet;
#[cfg(any(has_bundled_cli, test))]
use std::fs;
#[cfg(has_bundled_cli)]
use std::io::Read;
#[cfg(any(has_bundled_cli, test))]
use std::io::Write;
use std::path::{Path, PathBuf};
use std::sync::OnceLock;
#[cfg(any(has_bundled_cli, test))]
use std::sync::atomic::{AtomicU64, Ordering};
#[cfg(has_bundled_cli)]
use tracing::{info, warn};
#[cfg(has_bundled_cli)]
mod build_time {
include!(concat!(env!("OUT_DIR"), "/bundled_cli.rs"));
}
#[cfg(has_bundled_cli)]
const CLI_VERSION: &str = env!("COPILOT_SDK_CLI_VERSION");
#[cfg(all(has_bundled_cli, windows))]
const CLI_BINARY_NAME: &str = "copilot.exe";
#[cfg(all(has_bundled_cli, not(windows)))]
const CLI_BINARY_NAME: &str = "copilot";
#[cfg(all(has_bundled_cli, windows))]
const RUNTIME_BINARY_NAME: &str = "copilot-runtime.exe";
#[cfg(all(has_bundled_cli, not(windows)))]
const RUNTIME_BINARY_NAME: &str = "copilot-runtime";
#[cfg(has_bundled_cli)]
const RUNTIME_NODE_NAME: &str = "runtime.node";
#[cfg(has_bundled_cli)]
const RUNTIME_VERSION_MARKER: &str = ".copilot-runtime-version";
#[cfg(feature = "bundled-cli")]
static INSTALLED_PATH: OnceLock<Option<PathBuf>> = OnceLock::new();
#[cfg(feature = "bundled-cli")]
static INSTALLED_RUNTIME_PATH: OnceLock<Option<PathBuf>> = OnceLock::new();
#[cfg(feature = "bundled-cli")]
pub(crate) fn path() -> Option<PathBuf> {
INSTALLED_PATH
.get_or_init(|| {
#[cfg(has_bundled_cli)]
{
let dir = default_install_dir(CLI_VERSION);
match install_cli(
&dir,
build_time::CLI_ARCHIVE,
build_time::CLI_BINARY_SIZE,
) {
Ok(path) => {
info!(path = %path.display(), version = CLI_VERSION, "embedded CLI installed");
return Some(path);
}
Err(e) => {
warn!(error = %e, "embedded CLI installation failed");
}
}
}
None
})
.clone()
}
#[cfg(feature = "bundled-cli")]
#[allow(dead_code)] pub(crate) fn install_at(extract_dir: &Path) -> Option<PathBuf> {
#[cfg(has_bundled_cli)]
{
match install_cli(
extract_dir,
build_time::CLI_ARCHIVE,
build_time::CLI_BINARY_SIZE,
) {
Ok(path) => {
info!(path = %path.display(), version = CLI_VERSION, "embedded CLI installed");
return Some(path);
}
Err(e) => {
warn!(error = %e, "embedded CLI installation failed");
}
}
}
#[cfg(not(has_bundled_cli))]
{
let _ = extract_dir;
}
None
}
#[cfg(feature = "bundled-cli")]
pub(crate) fn runtime_path() -> Option<PathBuf> {
INSTALLED_RUNTIME_PATH
.get_or_init(|| {
#[cfg(has_bundled_cli)]
{
let dir = default_install_dir(CLI_VERSION);
match install_runtime(&dir, build_time::RUNTIME_ARCHIVE) {
Ok(path) => {
info!(path = %path.display(), version = CLI_VERSION, "embedded runtime installed");
return Some(path);
}
Err(e) => {
warn!(error = %e, "embedded runtime installation failed");
}
}
}
None
})
.clone()
}
#[cfg(feature = "bundled-cli")]
pub(crate) fn install_runtime_at(extract_dir: &Path) -> Option<PathBuf> {
#[cfg(has_bundled_cli)]
{
let install_dir = match runtime_install_dir(extract_dir, CLI_VERSION) {
Ok(dir) => dir,
Err(e) => {
warn!(error = %e, "embedded runtime install directory selection failed");
return None;
}
};
match install_runtime(&install_dir, build_time::RUNTIME_ARCHIVE) {
Ok(path) => {
info!(path = %path.display(), version = CLI_VERSION, "embedded runtime installed");
return Some(path);
}
Err(e) => {
warn!(error = %e, "embedded runtime installation failed");
}
}
}
#[cfg(not(has_bundled_cli))]
{
let _ = extract_dir;
}
None
}
#[cfg(has_bundled_cli)]
fn runtime_install_dir(base_dir: &Path, version: &str) -> Result<PathBuf, EmbeddedCliError> {
fs::create_dir_all(base_dir)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::CreateDir, e))?;
let marker = base_dir.join(RUNTIME_VERSION_MARKER);
match fs::OpenOptions::new()
.write(true)
.create_new(true)
.open(&marker)
{
Ok(mut file) => {
if let Err(error) = file
.write_all(version.as_bytes())
.and_then(|()| file.sync_all())
{
drop(file);
let _ = fs::remove_file(&marker);
return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, error));
}
Ok(base_dir.to_path_buf())
}
Err(error) if error.kind() == std::io::ErrorKind::AlreadyExists => {
let installed_version = fs::read_to_string(marker).unwrap_or_default();
if installed_version == version {
Ok(base_dir.to_path_buf())
} else {
Ok(base_dir.join(version))
}
}
Err(error) => Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, error)),
}
}
#[cfg(has_bundled_cli)]
fn default_install_dir(version: &str) -> PathBuf {
let cache = dirs::cache_dir().unwrap_or_else(std::env::temp_dir);
let root = cache.join("github-copilot-sdk").join("cli");
if version.is_empty() {
root.join("unversioned")
} else {
root.join(sanitize_version(version))
}
}
#[cfg(has_bundled_cli)]
const MAX_PUBLISH_ATTEMPTS: u32 = 3;
#[cfg(all(has_bundled_cli, feature = "bundled-in-process", windows))]
const RUNTIME_LIBRARY_NAME: &str = "copilot_runtime.dll";
#[cfg(all(has_bundled_cli, feature = "bundled-in-process", target_os = "macos"))]
const RUNTIME_LIBRARY_NAME: &str = "libcopilot_runtime.dylib";
#[cfg(all(
has_bundled_cli,
feature = "bundled-in-process",
not(windows),
not(target_os = "macos")
))]
const RUNTIME_LIBRARY_NAME: &str = "libcopilot_runtime.so";
#[cfg(has_bundled_cli)]
fn install_runtime(install_dir: &Path, archive: &[u8]) -> Result<PathBuf, EmbeddedCliError> {
fs::create_dir_all(install_dir)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::CreateDir, e))?;
let root = fs::canonicalize(install_dir)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?;
let mut required = vec![RUNTIME_BINARY_NAME, RUNTIME_NODE_NAME];
#[cfg(feature = "bundled-in-process")]
required.push(RUNTIME_LIBRARY_NAME);
let mut seen = HashSet::new();
let mut changed = HashSet::new();
let mut pending = Vec::new();
let mut tar = tar::Archive::new(flate2::read::GzDecoder::new(archive));
for entry in tar
.entries()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?
{
let mut entry =
entry.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
if !entry.header().entry_type().is_file() {
continue;
}
let path = entry
.path()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
let path = runtime_asset_path(&path)?;
if !seen.insert(path.as_os_str().to_ascii_lowercase()) {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Archive,
format!("duplicate embedded runtime asset path: {}", path.display()),
));
}
if !selected_runtime_asset(&path) {
continue;
}
if let Some(index) = required.iter().position(|name| path == Path::new(name)) {
if entry.size() == 0 {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
format!("embedded runtime artifact is empty: {}", path.display()),
));
}
required.remove(index);
}
let target = root.join(&path);
let parent = target.parent().ok_or_else(|| {
EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Archive,
format!("embedded runtime asset has no parent: {}", path.display()),
)
})?;
check_runtime_asset_parent(&root, parent, false)?;
match existing_runtime_file(&target, entry.size())? {
Some(mut installed) => {
let matches = runtime_entry_matches(&mut entry, &mut installed)?;
#[cfg(unix)]
let matches = matches
&& (path != Path::new(RUNTIME_BINARY_NAME)
|| check_runtime_wrapper_execute_access(&target).is_ok());
if !matches {
changed.insert(path);
}
}
None => {
check_runtime_asset_parent(&root, parent, true)?;
pending.push(stage_runtime_entry(&mut entry, &target)?);
}
}
}
std::io::copy(&mut tar.into_inner(), &mut std::io::sink())
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
if !required.is_empty() {
return Err(EmbeddedCliErrorKind::BinaryNotFoundInArchive.into());
}
if !changed.is_empty() {
let mut tar = tar::Archive::new(flate2::read::GzDecoder::new(archive));
for entry in tar
.entries()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?
{
let mut entry =
entry.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
if !entry.header().entry_type().is_file() {
continue;
}
let path = entry
.path()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
let path = runtime_asset_path(&path)?;
if changed.contains(&path) {
pending.push(stage_runtime_entry(&mut entry, &root.join(path))?);
}
}
std::io::copy(&mut tar.into_inner(), &mut std::io::sink())
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
}
for staged in pending {
publish(&staged.temporary, &staged.target)?;
}
#[cfg(unix)]
check_runtime_wrapper_execute_access(&root.join(RUNTIME_BINARY_NAME))
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Verification, e))?;
Ok(install_dir.join(RUNTIME_BINARY_NAME))
}
#[cfg(all(has_bundled_cli, unix))]
fn check_runtime_wrapper_execute_access(path: &Path) -> std::io::Result<()> {
use std::ffi::{CString, c_char, c_int};
use std::os::unix::ffi::OsStrExt;
#[cfg(target_os = "linux")]
const AT_FDCWD: c_int = -100;
#[cfg(target_os = "macos")]
const AT_FDCWD: c_int = -2;
#[cfg(target_os = "linux")]
const AT_EACCESS: c_int = 0x200;
#[cfg(target_os = "macos")]
const AT_EACCESS: c_int = 0x10;
const X_OK: c_int = 1;
unsafe extern "C" {
fn faccessat(dirfd: c_int, path: *const c_char, mode: c_int, flags: c_int) -> c_int;
}
let path = CString::new(path.as_os_str().as_bytes())
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidInput, e))?;
if unsafe { faccessat(AT_FDCWD, path.as_ptr(), X_OK, AT_EACCESS) } == 0 {
Ok(())
} else {
Err(std::io::Error::last_os_error())
}
}
#[cfg(has_bundled_cli)]
fn selected_runtime_asset(path: &Path) -> bool {
if path == Path::new(CLI_BINARY_NAME) {
return false;
}
if matches!(
path.file_name().and_then(|name| name.to_str()),
Some("copilot_runtime.dll" | "libcopilot_runtime.dylib" | "libcopilot_runtime.so")
) {
#[cfg(feature = "bundled-in-process")]
return path == Path::new(RUNTIME_LIBRARY_NAME);
#[cfg(not(feature = "bundled-in-process"))]
return false;
}
true
}
#[cfg(has_bundled_cli)]
fn runtime_asset_path(path: &Path) -> Result<PathBuf, EmbeddedCliError> {
let invalid = || {
EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Archive,
format!(
"non-portable embedded runtime asset path: {}",
path.display()
),
)
};
let name = path
.to_str()
.filter(|name| name.is_ascii())
.ok_or_else(invalid)?;
if name.starts_with(['/', '\\']) {
return Err(invalid());
}
let mut normalized = PathBuf::new();
for component in name.split(['/', '\\']) {
if component.is_empty() || component == "." {
continue;
}
if component == ".."
|| component.ends_with(['.', ' '])
|| component
.bytes()
.any(|byte| byte.is_ascii_control() || b"<>:\"|?*~".contains(&byte))
{
return Err(invalid());
}
let stem = component
.split('.')
.next()
.expect("nonempty component")
.trim_end_matches(' ')
.to_ascii_uppercase();
if matches!(stem.as_str(), "CON" | "PRN" | "AUX" | "NUL")
|| (stem.len() == 4
&& (stem.starts_with("COM") || stem.starts_with("LPT"))
&& matches!(stem.as_bytes()[3], b'1'..=b'9'))
{
return Err(invalid());
}
normalized.push(component);
}
if normalized.as_os_str().is_empty() {
return Err(invalid());
}
Ok(normalized)
}
#[cfg(has_bundled_cli)]
fn check_runtime_asset_parent(
root: &Path,
parent: &Path,
create: bool,
) -> Result<(), EmbeddedCliError> {
let mut current = root.to_path_buf();
for component in parent
.strip_prefix(root)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?
.components()
{
current.push(component);
if create {
match fs::create_dir(¤t) {
Ok(()) => {}
Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => {}
Err(e) => return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::CreateDir, e)),
}
}
let metadata = match fs::symlink_metadata(¤t) {
Ok(metadata) => metadata,
Err(e) if !create && e.kind() == std::io::ErrorKind::NotFound => return Ok(()),
Err(e) => return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e)),
};
if !metadata.is_dir() {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
format!(
"runtime asset parent is not a directory: {}",
current.display()
),
));
}
}
Ok(())
}
#[cfg(has_bundled_cli)]
struct StagedRuntimeFile {
temporary: PathBuf,
target: PathBuf,
}
#[cfg(has_bundled_cli)]
impl Drop for StagedRuntimeFile {
fn drop(&mut self) {
if let Err(error) = fs::remove_file(&self.temporary)
&& error.kind() != std::io::ErrorKind::NotFound
{
warn!(path = %self.temporary.display(), %error, "failed to remove staged runtime asset");
}
}
}
#[cfg(has_bundled_cli)]
fn existing_runtime_file(target: &Path, size: u64) -> Result<Option<fs::File>, EmbeddedCliError> {
let metadata = match fs::symlink_metadata(target) {
Ok(metadata) if metadata.is_file() => Some(metadata),
Ok(_) => {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
format!("runtime asset is not a regular file: {}", target.display()),
));
}
Err(e) if e.kind() == std::io::ErrorKind::NotFound => None,
Err(e) => return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e)),
};
let matches = metadata
.as_ref()
.is_some_and(|metadata| metadata.len() == size);
if matches {
match fs::File::open(target) {
Ok(file) => return Ok(Some(file)),
Err(e) => {
tracing::debug!(path = %target.display(), error = %e,
"existing runtime asset cannot be read; repairing");
}
}
}
Ok(None)
}
#[cfg(has_bundled_cli)]
fn runtime_entry_matches<R: Read>(
entry: &mut tar::Entry<'_, R>,
installed: &mut fs::File,
) -> Result<bool, EmbeddedCliError> {
let mut buffer = [0u8; 64 * 1024];
let mut on_disk = [0u8; 64 * 1024];
let mut remaining = entry.size();
while remaining > 0 {
let length = remaining.min(buffer.len() as u64) as usize;
entry
.read_exact(&mut buffer[..length])
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
remaining -= length as u64;
if let Err(error) = installed.read_exact(&mut on_disk[..length]) {
tracing::debug!(%error, "existing runtime asset cannot be read; repairing");
return Ok(false);
}
if on_disk[..length] != buffer[..length] {
return Ok(false);
}
}
match installed.read(&mut on_disk[..1]) {
Ok(read) => Ok(read == 0),
Err(error) => {
tracing::debug!(%error, "existing runtime asset cannot be read; repairing");
Ok(false)
}
}
}
#[cfg(has_bundled_cli)]
fn stage_runtime_entry<R: Read>(
entry: &mut tar::Entry<'_, R>,
target: &Path,
) -> Result<StagedRuntimeFile, EmbeddedCliError> {
let parent = target.parent().expect("runtime asset has a checked parent");
let (temporary, mut file) = create_temp_file(parent)?;
let staged = StagedRuntimeFile {
temporary,
target: target.to_path_buf(),
};
let result = write_runtime_entry(entry, &mut file);
drop(file);
result?;
Ok(staged)
}
#[cfg(has_bundled_cli)]
fn write_runtime_entry<R: Read>(
entry: &mut tar::Entry<'_, R>,
file: &mut fs::File,
) -> Result<(), EmbeddedCliError> {
let size = entry.size();
let written = std::io::copy(&mut (&mut *entry).take(size), &mut *file)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?;
if written != size {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
format!("runtime entry size mismatch: read {written} bytes, expected {size}"),
));
}
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
let mode = entry
.header()
.mode()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?
& 0o777;
file.set_permissions(fs::Permissions::from_mode(mode))
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?;
}
file.sync_all()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))
}
#[cfg(has_bundled_cli)]
fn install_cli(
install_dir: &Path,
archive: &[u8],
expected_binary_size: u64,
) -> Result<PathBuf, EmbeddedCliError> {
let verbose = std::env::var("COPILOT_CLI_INSTALL_VERBOSE").ok().as_deref() == Some("1");
fs::create_dir_all(install_dir)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::CreateDir, e))?;
let final_path = install_dir.join(CLI_BINARY_NAME);
let marker_path = marker_path(install_dir);
if existing_install_is_valid(&final_path, &marker_path, expected_binary_size) {
if verbose {
eprintln!("embedded CLI already installed at {}", final_path.display());
}
return Ok(final_path);
}
let start = std::time::Instant::now();
let bytes = extract_cli_binary(archive)?;
if bytes.is_empty() {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
"extracted CLI binary is empty",
));
}
let mut last_err: Option<EmbeddedCliError> = None;
for attempt in 1..=MAX_PUBLISH_ATTEMPTS {
match publish_verified(install_dir, &final_path, &marker_path, &bytes) {
Ok(()) => {
if verbose {
eprintln!(
"embedded CLI extracted to {} in {:?}",
final_path.display(),
start.elapsed()
);
}
return Ok(final_path);
}
Err(e) => {
if verify_on_disk_matches(&final_path, &bytes).is_ok() {
let _ = write_marker(&marker_path, bytes.len() as u64);
return Ok(final_path);
}
warn!(attempt, error = %e, "embedded CLI publish attempt failed; retrying");
last_err = Some(e);
}
}
}
Err(EmbeddedCliError::with_source(
EmbeddedCliErrorKind::Blocked,
last_err,
))
}
#[cfg(any(has_bundled_cli, test))]
fn marker_path(install_dir: &Path) -> PathBuf {
install_dir.join(".copilot-cli.ok")
}
#[cfg(any(has_bundled_cli, test))]
fn existing_install_is_valid(
final_path: &Path,
marker_path: &Path,
expected_binary_size: u64,
) -> bool {
let Ok(meta) = fs::metadata(final_path) else {
return false;
};
if !meta.is_file() || meta.len() == 0 {
return false;
}
match read_marker_len(marker_path) {
Some(expected) if expected == expected_binary_size && expected == meta.len() => {
looks_like_valid_image(final_path)
}
_ => false,
}
}
#[cfg(any(has_bundled_cli, test))]
fn publish_verified(
install_dir: &Path,
final_path: &Path,
marker_path: &Path,
bytes: &[u8],
) -> Result<(), EmbeddedCliError> {
let tmp = write_temp_file(install_dir, bytes)?;
if let Err(e) = verify_on_disk_matches(&tmp, bytes) {
let _ = fs::remove_file(&tmp);
return Err(e);
}
if let Err(e) = publish(&tmp, final_path) {
let _ = fs::remove_file(&tmp);
return Err(e);
}
verify_on_disk_matches(final_path, bytes)?;
write_marker(marker_path, bytes.len() as u64)?;
Ok(())
}
#[cfg(any(has_bundled_cli, test))]
fn write_temp_file(dir: &Path, contents: &[u8]) -> Result<PathBuf, EmbeddedCliError> {
let (tmp, mut file) = create_temp_file(dir)?;
if let Err(e) = file
.write_all(contents)
.and_then(|()| file.flush())
.and_then(|()| file.sync_all())
{
drop(file);
let _ = fs::remove_file(&tmp);
return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e));
}
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
if let Err(e) = fs::set_permissions(&tmp, fs::Permissions::from_mode(0o755)) {
drop(file);
let _ = fs::remove_file(&tmp);
return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e));
}
}
drop(file);
Ok(tmp)
}
#[cfg(any(has_bundled_cli, test))]
fn create_temp_file(dir: &Path) -> Result<(PathBuf, fs::File), EmbeddedCliError> {
static COUNTER: AtomicU64 = AtomicU64::new(0);
let nanos = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_nanos())
.unwrap_or(0);
let tmp = dir.join(format!(
".copilot-cli.tmp.{}.{}.{}",
std::process::id(),
COUNTER.fetch_add(1, Ordering::Relaxed),
nanos
));
let file = fs::OpenOptions::new()
.write(true)
.create_new(true)
.open(&tmp)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?;
Ok((tmp, file))
}
#[cfg(any(has_bundled_cli, test))]
fn publish(tmp: &Path, final_path: &Path) -> Result<(), EmbeddedCliError> {
fs::rename(tmp, final_path).map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Publish, e))
}
#[cfg(any(has_bundled_cli, test))]
fn verify_on_disk_matches(path: &Path, expected: &[u8]) -> Result<(), EmbeddedCliError> {
let actual = fs::read(path).map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?;
if actual.len() != expected.len() {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
format!(
"size mismatch: on-disk {} bytes, expected {} bytes",
actual.len(),
expected.len()
),
));
}
if actual != expected {
return Err(EmbeddedCliError::with_message(
EmbeddedCliErrorKind::Verification,
"on-disk binary differs from the embedded image",
));
}
Ok(())
}
#[cfg(any(has_bundled_cli, test))]
fn looks_like_valid_image(path: &Path) -> bool {
use std::io::Read as _;
let mut buf = [0u8; 4];
let Ok(mut file) = fs::File::open(path) else {
return false;
};
let Ok(read) = file.read(&mut buf) else {
return false;
};
let head = &buf[..read];
#[cfg(windows)]
{
head.starts_with(b"MZ")
}
#[cfg(target_os = "macos")]
{
matches!(
head,
[0xfe, 0xed, 0xfa, 0xce] | [0xfe, 0xed, 0xfa, 0xcf] | [0xce, 0xfa, 0xed, 0xfe] | [0xcf, 0xfa, 0xed, 0xfe] | [0xca, 0xfe, 0xba, 0xbe] | [0xbe, 0xba, 0xfe, 0xca] )
}
#[cfg(all(not(windows), not(target_os = "macos")))]
{
head.starts_with(b"\x7fELF")
}
}
#[cfg(any(has_bundled_cli, test))]
fn write_marker(marker_path: &Path, size: u64) -> Result<(), EmbeddedCliError> {
fs::write(marker_path, size.to_string())
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))
}
#[cfg(any(has_bundled_cli, test))]
fn read_marker_len(marker_path: &Path) -> Option<u64> {
fs::read_to_string(marker_path)
.ok()?
.trim()
.parse::<u64>()
.ok()
}
#[cfg(all(has_bundled_cli, not(windows)))]
fn extract_cli_binary(archive: &[u8]) -> Result<Vec<u8>, EmbeddedCliError> {
extract_binary(archive, CLI_BINARY_NAME)
}
#[cfg(all(has_bundled_cli, windows))]
fn extract_cli_binary(archive: &[u8]) -> Result<Vec<u8>, EmbeddedCliError> {
let reader = std::io::Cursor::new(archive);
let mut zip = zip::ZipArchive::new(reader)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
for index in 0..zip.len() {
let mut entry = zip
.by_index(index)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
if entry.name() == CLI_BINARY_NAME || entry.name().ends_with(&format!("/{CLI_BINARY_NAME}"))
{
let mut bytes = Vec::with_capacity(entry.size() as usize);
entry
.read_to_end(&mut bytes)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
return Ok(bytes);
}
}
Err(EmbeddedCliErrorKind::BinaryNotFoundInArchive.into())
}
#[cfg(all(has_bundled_cli, any(not(windows), test)))]
fn extract_binary(archive: &[u8], binary_name: &str) -> Result<Vec<u8>, EmbeddedCliError> {
let gz = flate2::read::GzDecoder::new(archive);
let mut tar = tar::Archive::new(gz);
for entry in tar
.entries()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?
{
let mut entry =
entry.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
let path = entry
.path()
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
let name = path.to_string_lossy();
if name == binary_name || name.ends_with(&format!("/{binary_name}")) {
let mut bytes = Vec::with_capacity(entry.size() as usize);
entry
.read_to_end(&mut bytes)
.map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Archive, e))?;
return Ok(bytes);
}
}
Err(EmbeddedCliErrorKind::BinaryNotFoundInArchive.into())
}
#[cfg(has_bundled_cli)]
fn sanitize_version(version: &str) -> String {
version
.chars()
.map(|c| match c {
'a'..='z' | 'A'..='Z' | '0'..='9' | '.' | '-' | '_' => c,
_ => '_',
})
.collect()
}
#[cfg(any(has_bundled_cli, test))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[allow(dead_code)]
enum EmbeddedCliErrorKind {
CreateDir,
Archive,
BinaryNotFoundInArchive,
Io,
Publish,
Verification,
Blocked,
}
#[cfg(any(has_bundled_cli, test))]
impl std::fmt::Display for EmbeddedCliErrorKind {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
EmbeddedCliErrorKind::CreateDir => f.write_str("failed to create install directory"),
EmbeddedCliErrorKind::Archive => f.write_str("failed to read archive entry"),
EmbeddedCliErrorKind::BinaryNotFoundInArchive => {
f.write_str("CLI binary not found in embedded archive")
}
EmbeddedCliErrorKind::Io => f.write_str("I/O error"),
EmbeddedCliErrorKind::Publish => {
f.write_str("failed to publish the extracted CLI binary")
}
EmbeddedCliErrorKind::Verification => {
f.write_str("extracted CLI binary failed integrity verification")
}
EmbeddedCliErrorKind::Blocked => f.write_str(
"bundled CLI appears blocked or corrupt after multiple attempts \
(possibly quarantined by antivirus)",
),
}
}
}
#[cfg(any(has_bundled_cli, test))]
#[allow(dead_code)]
struct EmbeddedCliError {
repr: crate::errors::Repr<EmbeddedCliErrorKind>,
}
#[cfg(any(has_bundled_cli, test))]
#[allow(dead_code)]
impl EmbeddedCliError {
fn new<E>(kind: EmbeddedCliErrorKind, error: E) -> Self
where
E: Into<Box<dyn std::error::Error + Send + Sync>>,
{
Self {
repr: crate::errors::Repr::Custom(crate::errors::Custom {
kind,
error: error.into(),
}),
}
}
fn with_message(
kind: EmbeddedCliErrorKind,
message: impl Into<std::borrow::Cow<'static, str>>,
) -> Self {
Self {
repr: crate::errors::Repr::SimpleMessage(kind, message.into()),
}
}
fn with_source(kind: EmbeddedCliErrorKind, source: Option<EmbeddedCliError>) -> Self {
match source {
Some(source) => Self::new(kind, Box::new(source)),
None => Self {
repr: crate::errors::Repr::Simple(kind),
},
}
}
}
#[cfg(any(has_bundled_cli, test))]
impl From<EmbeddedCliErrorKind> for EmbeddedCliError {
fn from(kind: EmbeddedCliErrorKind) -> Self {
Self {
repr: crate::errors::Repr::Simple(kind),
}
}
}
#[cfg(any(has_bundled_cli, test))]
impl std::fmt::Display for EmbeddedCliError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.repr {
crate::errors::Repr::Simple(kind) => write!(f, "{kind}"),
crate::errors::Repr::SimpleMessage(_, msg) => write!(f, "{msg}"),
crate::errors::Repr::Custom(crate::errors::Custom { kind, error }) => {
write!(f, "{kind}: {error}")
}
}
}
}
#[cfg(any(has_bundled_cli, test))]
impl std::fmt::Debug for EmbeddedCliError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "EmbeddedCliError({self})")
}
}
#[cfg(any(has_bundled_cli, test))]
impl std::error::Error for EmbeddedCliError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match &self.repr {
crate::errors::Repr::Custom(crate::errors::Custom { error, .. }) => Some(&**error),
_ => None,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(all(has_bundled_cli, feature = "bundled-in-process"))]
#[test]
fn embedded_runtime_archive_contains_runtime_assets_and_excludes_cli() {
let gz = flate2::read::GzDecoder::new(build_time::RUNTIME_ARCHIVE);
let mut archive = tar::Archive::new(gz);
let mut names: Vec<String> = archive
.entries()
.expect("archive entries")
.map(|entry| {
entry
.expect("archive entry")
.path()
.expect("archive path")
.to_string_lossy()
.into_owned()
})
.collect();
names.sort();
assert!(names.contains(&RUNTIME_LIBRARY_NAME.to_string()));
assert!(names.contains(&RUNTIME_BINARY_NAME.to_string()));
assert!(names.contains(&RUNTIME_NODE_NAME.to_string()));
assert!(names.iter().any(|name| name.starts_with("ripgrep/")));
assert!(names.iter().any(|name| name.starts_with("definitions/")));
assert!(!names.contains(&CLI_BINARY_NAME.to_string()));
assert!(!names.contains(&"app.js".to_string()));
}
fn fake_image(extra: usize) -> Vec<u8> {
let mut bytes = Vec::new();
#[cfg(windows)]
bytes.extend_from_slice(b"MZ\x90\x00");
#[cfg(target_os = "macos")]
bytes.extend_from_slice(&[0xfe, 0xed, 0xfa, 0xcf]);
#[cfg(all(not(windows), not(target_os = "macos")))]
bytes.extend_from_slice(b"\x7fELF");
bytes.extend(std::iter::repeat_n(0xAB, extra));
bytes
}
#[test]
fn publish_verified_writes_and_records_marker() {
let dir = tempfile::tempdir().expect("tempdir");
let final_path = dir.path().join("copilot-bin");
let marker = marker_path(dir.path());
let bytes = fake_image(2048);
publish_verified(dir.path(), &final_path, &marker, &bytes).expect("publish");
assert!(final_path.is_file(), "binary should be published");
assert_eq!(fs::read(&final_path).expect("read"), bytes);
assert_eq!(read_marker_len(&marker), Some(bytes.len() as u64));
assert!(existing_install_is_valid(
&final_path,
&marker,
bytes.len() as u64
));
let leftovers: Vec<_> = fs::read_dir(dir.path())
.expect("read_dir")
.filter_map(|e| e.ok())
.filter(|e| e.file_name().to_string_lossy().contains(".tmp."))
.collect();
assert!(leftovers.is_empty(), "temp files should be cleaned up");
}
#[test]
fn publish_overwrites_an_existing_binary() {
let dir = tempfile::tempdir().expect("tempdir");
let final_path = dir.path().join("copilot-bin");
let marker = marker_path(dir.path());
fs::write(&final_path, b"old contents").expect("seed");
let bytes = fake_image(512);
publish_verified(dir.path(), &final_path, &marker, &bytes).expect("publish");
assert_eq!(fs::read(&final_path).expect("read"), bytes);
}
#[test]
fn corrupt_or_unmarked_install_is_rejected() {
let dir = tempfile::tempdir().expect("tempdir");
let final_path = dir.path().join("copilot-bin");
let marker = marker_path(dir.path());
let bytes = fake_image(4096);
assert!(!existing_install_is_valid(&final_path, &marker, 1));
fs::write(&final_path, &bytes).expect("write binary");
assert!(
!existing_install_is_valid(&final_path, &marker, bytes.len() as u64),
"an install without a marker must not be trusted"
);
write_marker(&marker, bytes.len() as u64).expect("marker");
assert!(existing_install_is_valid(
&final_path,
&marker,
bytes.len() as u64
));
assert!(
!existing_install_is_valid(&final_path, &marker, bytes.len() as u64 + 1),
"a marker from the wrapper-as-CLI regression must not validate the full CLI"
);
fs::write(&final_path, &bytes[..bytes.len() / 2]).expect("truncate");
assert!(
!existing_install_is_valid(&final_path, &marker, bytes.len() as u64),
"a truncated binary must be detected via the size marker"
);
fs::write(&final_path, b"").expect("empty");
assert!(!existing_install_is_valid(
&final_path,
&marker,
bytes.len() as u64
));
}
#[test]
fn invalid_image_header_is_rejected() {
let dir = tempfile::tempdir().expect("tempdir");
let final_path = dir.path().join("copilot-bin");
let marker = marker_path(dir.path());
let garbage = vec![0u8; 4096];
fs::write(&final_path, &garbage).expect("write garbage");
write_marker(&marker, garbage.len() as u64).expect("marker");
assert!(
!existing_install_is_valid(&final_path, &marker, garbage.len() as u64),
"a non-executable image must be rejected even with a matching marker"
);
}
#[test]
fn verification_rejects_size_and_content_mismatch() {
let dir = tempfile::tempdir().expect("tempdir");
let path = dir.path().join("staged");
let expected = fake_image(1024);
fs::write(&path, &expected).expect("write");
verify_on_disk_matches(&path, &expected).expect("exact match should verify");
fs::write(&path, &expected[..100]).expect("truncate");
assert!(verify_on_disk_matches(&path, &expected).is_err());
let mut tampered = expected.clone();
*tampered.last_mut().expect("non-empty") ^= 0xFF;
fs::write(&path, &tampered).expect("tamper");
assert!(verify_on_disk_matches(&path, &expected).is_err());
fs::remove_file(&path).expect("remove");
assert!(verify_on_disk_matches(&path, &expected).is_err());
}
#[test]
fn temp_files_are_unique_and_synced() {
let dir = tempfile::tempdir().expect("tempdir");
let data = fake_image(256);
let a = write_temp_file(dir.path(), &data).expect("temp a");
let b = write_temp_file(dir.path(), &data).expect("temp b");
assert_ne!(a, b, "temp file names must be unique");
assert_eq!(fs::read(&a).expect("read a"), data);
assert_eq!(fs::read(&b).expect("read b"), data);
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
let mode = fs::metadata(&a).expect("meta").permissions().mode();
assert_eq!(mode & 0o777, 0o755, "temp binary should be executable");
}
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_install_replaces_stale_pair() {
let dir = tempfile::tempdir().expect("tempdir");
fs::write(dir.path().join(RUNTIME_NODE_NAME), b"stale runtime").expect("seed runtime");
fs::write(dir.path().join(RUNTIME_BINARY_NAME), b"stale wrapper").expect("seed wrapper");
install_runtime(dir.path(), build_time::RUNTIME_ARCHIVE).expect("install runtime");
assert_eq!(
fs::read(dir.path().join(RUNTIME_NODE_NAME)).expect("read runtime"),
extract_binary(build_time::RUNTIME_ARCHIVE, RUNTIME_NODE_NAME)
.expect("extract runtime")
);
assert_eq!(
fs::read(dir.path().join(RUNTIME_BINARY_NAME)).expect("read wrapper"),
extract_binary(build_time::RUNTIME_ARCHIVE, RUNTIME_BINARY_NAME)
.expect("extract wrapper")
);
}
#[cfg(has_bundled_cli)]
#[test]
fn custom_runtime_install_dir_isolated_by_version() {
let dir = tempfile::tempdir().expect("tempdir");
assert_eq!(
runtime_install_dir(dir.path(), "1.0.0").expect("claim directory"),
dir.path()
);
assert_eq!(
runtime_install_dir(dir.path(), "1.0.0").expect("reuse directory"),
dir.path()
);
assert_eq!(
runtime_install_dir(dir.path(), "2.0.0").expect("isolate directory"),
dir.path().join("2.0.0")
);
}
#[cfg(has_bundled_cli)]
fn runtime_fixture(extra: &[(&str, &[u8], u32)]) -> Vec<u8> {
let encoder = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::fast());
let mut archive = tar::Builder::new(encoder);
let mut entries = vec![
(RUNTIME_BINARY_NAME, b"wrapper".as_slice(), 0o755),
(RUNTIME_NODE_NAME, b"runtime".as_slice(), 0o755),
];
#[cfg(feature = "bundled-in-process")]
entries.push((RUNTIME_LIBRARY_NAME, b"library".as_slice(), 0o644));
entries.extend_from_slice(extra);
for (name, bytes, mode) in entries {
let mut header = tar::Header::new_gnu();
header.as_mut_bytes()[..name.len()].copy_from_slice(name.as_bytes());
header.set_size(bytes.len() as u64);
header.set_mode(mode);
header.set_cksum();
archive.append(&header, bytes).expect("append fixture");
}
archive.into_inner().unwrap().finish().unwrap()
}
#[cfg(has_bundled_cli)]
#[test]
fn warm_runtime_rejects_same_size_corruption_despite_unchanged_metadata() {
let dir = tempfile::tempdir().unwrap();
let fixture = runtime_fixture(&[]);
install_runtime(dir.path(), &fixture).unwrap();
let runtime = dir.path().join(RUNTIME_NODE_NAME);
let original = fs::metadata(&runtime).unwrap();
fs::write(&runtime, b"corrupt").unwrap();
fs::File::options()
.write(true)
.open(&runtime)
.unwrap()
.set_times(fs::FileTimes::new().set_modified(original.modified().unwrap()))
.unwrap();
assert!(install_runtime(dir.path(), b"invalid archive").is_err());
assert_eq!(fs::read(&runtime).unwrap(), b"corrupt");
install_runtime(dir.path(), &fixture).unwrap();
assert_eq!(fs::read(&runtime).unwrap(), b"runtime");
}
#[cfg(has_bundled_cli)]
fn assert_no_runtime_temps(dir: &Path) {
for entry in fs::read_dir(dir).unwrap() {
let entry = entry.unwrap();
assert!(
!entry
.file_name()
.to_string_lossy()
.starts_with(".copilot-cli.tmp.")
);
if entry.file_type().unwrap().is_dir() {
assert_no_runtime_temps(&entry.path());
}
}
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_cold_install_and_warm_reuse_preserve_bytes_and_modes() {
let dir = tempfile::tempdir().unwrap();
let data = vec![0xAB; 3 * 64 * 1024 + 17];
let archive = runtime_fixture(&[("nested/asset", &data, 0o640)]);
let wrapper = install_runtime(dir.path(), &archive).unwrap();
assert_eq!(wrapper, dir.path().join(RUNTIME_BINARY_NAME));
let asset = dir.path().join("nested/asset");
assert_eq!(fs::read(&asset).unwrap(), data);
let modified = std::time::UNIX_EPOCH + std::time::Duration::from_secs(1234567890);
fs::File::options()
.write(true)
.open(&asset)
.unwrap()
.set_times(fs::FileTimes::new().set_modified(modified))
.unwrap();
install_runtime(dir.path(), &archive).unwrap();
assert_eq!(fs::metadata(&asset).unwrap().modified().unwrap(), modified);
assert_eq!(fs::read(&asset).unwrap(), data);
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
assert_eq!(
fs::metadata(&asset).unwrap().permissions().mode() & 0o777,
0o640
);
assert_eq!(
fs::metadata(wrapper).unwrap().permissions().mode() & 0o777,
0o755
);
}
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_repairs_same_size_corruption_truncation_and_extra_bytes() {
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[]);
let runtime = dir.path().join(RUNTIME_NODE_NAME);
install_runtime(dir.path(), &archive).unwrap();
for corrupt in [b"runtimX".as_slice(), b"run", b"", b"runtime plus garbage"] {
fs::write(&runtime, corrupt).unwrap();
install_runtime(dir.path(), &archive).unwrap();
assert_eq!(fs::read(&runtime).unwrap(), b"runtime");
assert_no_runtime_temps(dir.path());
}
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_repairs_corruption_across_comparison_chunks() {
let dir = tempfile::tempdir().unwrap();
let bytes = vec![0xAB; 3 * 64 * 1024 + 17];
let archive = runtime_fixture(&[("nested/asset", &bytes, 0o644)]);
install_runtime(dir.path(), &archive).unwrap();
for offset in [0, bytes.len() / 2, bytes.len() - 1] {
let mut corrupt = bytes.clone();
corrupt[offset] ^= 1;
fs::write(dir.path().join("nested/asset"), &corrupt).unwrap();
install_runtime(dir.path(), &archive).unwrap();
assert_eq!(fs::read(dir.path().join("nested/asset")).unwrap(), bytes);
assert_no_runtime_temps(dir.path());
}
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn runtime_reuse_preserves_executable_caller_selected_permissions() {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let fixture = runtime_fixture(&[]);
let wrapper = install_runtime(dir.path(), &fixture).unwrap();
for mode in [0o745, 0o754, 0o700, 0o500] {
fs::set_permissions(&wrapper, fs::Permissions::from_mode(mode)).unwrap();
install_runtime(dir.path(), &fixture).unwrap();
assert_eq!(
fs::metadata(&wrapper).unwrap().permissions().mode() & 0o777,
mode
);
}
assert_no_runtime_temps(dir.path());
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn runtime_repairs_nonexecutable_wrapper() {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[]);
let wrapper = install_runtime(dir.path(), &archive).unwrap();
for mode in [0o400, 0o600] {
fs::set_permissions(&wrapper, fs::Permissions::from_mode(mode)).unwrap();
install_runtime(dir.path(), &archive).unwrap();
assert_eq!(
fs::metadata(&wrapper).unwrap().permissions().mode() & 0o777,
0o755
);
assert_eq!(fs::read(&wrapper).unwrap(), b"wrapper");
assert_no_runtime_temps(dir.path());
}
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn runtime_rejects_nonexecutable_wrapper_in_readonly_cache() {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[]);
let wrapper = install_runtime(dir.path(), &archive).unwrap();
fs::set_permissions(&wrapper, fs::Permissions::from_mode(0o400)).unwrap();
fs::set_permissions(dir.path(), fs::Permissions::from_mode(0o555)).unwrap();
let write_denied = fs::File::create(dir.path().join("write-probe")).is_err();
let result = install_runtime(dir.path(), &archive);
fs::set_permissions(dir.path(), fs::Permissions::from_mode(0o755)).unwrap();
if write_denied {
assert!(
result.is_err(),
"returned a nonexecutable wrapper: {result:?}"
);
assert_eq!(
fs::metadata(&wrapper).unwrap().permissions().mode() & 0o777,
0o400
);
} else {
eprintln!("read-only permission enforcement unavailable (e.g. privileged user)");
fs::remove_file(dir.path().join("write-probe")).unwrap();
result.unwrap();
assert_eq!(
fs::metadata(&wrapper).unwrap().permissions().mode() & 0o777,
0o755
);
}
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_archive_errors_do_not_publish_and_clean_up_staging() {
let dir = tempfile::tempdir().unwrap();
let valid = runtime_fixture(&[("nested/asset", b"asset", 0o644)]);
let mut invalid_crc = valid.clone();
let crc = invalid_crc.len() - 8;
invalid_crc[crc] ^= 0xFF;
let mut invalid_length = valid.clone();
let length = invalid_length.len() - 4;
invalid_length[length] ^= 0xFF;
let mut truncated_trailer = valid.clone();
truncated_trailer.truncate(valid.len() - 1);
let mut truncated_body = valid.clone();
truncated_body.truncate(valid.len() / 2);
for archive in [
invalid_crc,
invalid_length,
truncated_trailer,
truncated_body,
] {
let runtime = dir.path().join(RUNTIME_NODE_NAME);
fs::write(&runtime, b"previous complete runtime").unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(runtime).unwrap(), b"previous complete runtime");
assert!(!dir.path().join(RUNTIME_BINARY_NAME).exists());
assert!(!dir.path().join("nested/asset").exists());
assert_no_runtime_temps(dir.path());
}
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_short_entry_is_rejected_without_publishing() {
let dir = tempfile::tempdir().unwrap();
let mut header = tar::Header::new_gnu();
header.set_path(RUNTIME_NODE_NAME).unwrap();
header.set_size(128 * 1024);
header.set_mode(0o755);
header.set_cksum();
let mut encoder = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::fast());
encoder.write_all(header.as_bytes()).unwrap();
encoder.write_all(b"short").unwrap();
let archive = encoder.finish().unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join(RUNTIME_NODE_NAME).exists());
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_missing_required_entry_is_rejected_before_publish() {
let dir = tempfile::tempdir().unwrap();
let encoder = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::fast());
let mut archive = tar::Builder::new(encoder);
let mut header = tar::Header::new_gnu();
header.set_size(7);
header.set_mode(0o755);
header.set_cksum();
archive
.append_data(&mut header, RUNTIME_BINARY_NAME, b"wrapper".as_slice())
.unwrap();
let archive = archive.into_inner().unwrap().finish().unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join(RUNTIME_BINARY_NAME).exists());
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_rejects_traversal_and_cleans_preceding_entries() {
let dir = tempfile::tempdir().unwrap();
let install_dir = dir.path().join("install");
let archive = runtime_fixture(&[("../escaped", b"bad", 0o644)]);
assert!(install_runtime(&install_dir, &archive).is_err());
assert!(!dir.path().join("escaped").exists());
assert!(!install_dir.join(RUNTIME_BINARY_NAME).exists());
assert_no_runtime_temps(&install_dir);
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn runtime_rejects_symlink_parents_and_targets() {
use std::os::unix::fs::symlink;
let dir = tempfile::tempdir().unwrap();
let outside = tempfile::tempdir().unwrap();
fs::write(outside.path().join("asset"), b"outside").unwrap();
symlink(outside.path(), dir.path().join("nested")).unwrap();
let archive = runtime_fixture(&[("nested/asset", b"new", 0o644)]);
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(outside.path().join("asset")).unwrap(), b"outside");
assert_no_runtime_temps(dir.path());
fs::remove_file(dir.path().join("nested")).unwrap();
symlink(
outside.path().join("asset"),
dir.path().join(RUNTIME_NODE_NAME),
)
.unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(outside.path().join("asset")).unwrap(), b"outside");
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn concurrent_runtime_installers_publish_complete_files() {
let dir = tempfile::tempdir().unwrap();
let data = vec![0xAB; 256 * 1024 + 1];
let archive = runtime_fixture(&[("nested/asset", &data, 0o644)]);
let barrier = std::sync::Barrier::new(6);
std::thread::scope(|scope| {
for _ in 0..6 {
scope.spawn(|| {
barrier.wait();
install_runtime(dir.path(), &archive).unwrap();
});
}
});
assert_eq!(fs::read(dir.path().join("nested/asset")).unwrap(), data);
assert_eq!(
fs::read(dir.path().join(RUNTIME_NODE_NAME)).unwrap(),
b"runtime"
);
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_duplicate_destinations_fail_on_cold_and_warm_installs() {
for name in ["asset", "./asset"] {
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[("asset", b"first", 0o644), (name, b"last", 0o644)]);
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join("asset").exists());
assert_no_runtime_temps(dir.path());
fs::write(dir.path().join("asset"), b"last").unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(dir.path().join("asset")).unwrap(), b"last");
assert_no_runtime_temps(dir.path());
}
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[(RUNTIME_NODE_NAME, b"", 0o755)]);
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join(RUNTIME_NODE_NAME).exists());
assert_no_runtime_temps(dir.path());
install_runtime(dir.path(), &runtime_fixture(&[])).unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(
fs::read(dir.path().join(RUNTIME_NODE_NAME)).unwrap(),
b"runtime"
);
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_case_aliases_cannot_overwrite_required_artifacts() {
let names = [
RUNTIME_NODE_NAME,
RUNTIME_BINARY_NAME,
#[cfg(feature = "bundled-in-process")]
RUNTIME_LIBRARY_NAME,
];
for name in names {
let alias = name.to_ascii_uppercase();
let archive = runtime_fixture(&[(&alias, b"", 0o755)]);
let dir = tempfile::tempdir().unwrap();
let result = install_runtime(dir.path(), &archive);
assert!(result.is_err(), "accepted alias {alias}: {result:?}");
assert!(!dir.path().join(name).exists());
assert_no_runtime_temps(dir.path());
install_runtime(dir.path(), &runtime_fixture(&[])).unwrap();
let original = fs::read(dir.path().join(name)).unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(dir.path().join(name)).unwrap(), original);
fs::write(dir.path().join(name), b"corrupt").unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(dir.path().join(name)).unwrap(), b"corrupt");
assert_no_runtime_temps(dir.path());
}
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_mixed_separator_and_case_aliases_are_rejected() {
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[
("nested/asset", b"first", 0o644),
(r".\NESTED\ASSET", b"last", 0o644),
]);
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join("nested/asset").exists());
assert_no_runtime_temps(dir.path());
install_runtime(
dir.path(),
&runtime_fixture(&[("nested/asset", b"last", 0o644)]),
)
.unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(dir.path().join("nested/asset")).unwrap(), b"last");
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_nonportable_alias_paths_are_rejected_before_publish() {
for name in [
"runtime.node.",
"runtime.node ",
"runtime.node:stream",
"RUNTIM~1.NOD",
"NUL",
"con.txt",
"aux .txt",
"COM1",
"LPT9.txt",
"n\u{00e9}sted/asset",
r"..\escaped",
r"C:\escaped",
r"\\server\share\asset",
] {
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[(name, b"bad", 0o644)]);
assert!(
install_runtime(dir.path(), &archive).is_err(),
"accepted {name}"
);
assert!(!dir.path().join(RUNTIME_NODE_NAME).exists());
assert_no_runtime_temps(dir.path());
}
}
#[cfg(all(has_bundled_cli, feature = "bundled-in-process"))]
#[test]
fn runtime_library_aliases_are_rejected_before_repair() {
let alias = format!("./{RUNTIME_LIBRARY_NAME}");
for duplicate in [b"another".as_slice(), b""] {
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[(&alias, duplicate, 0o644)]);
assert!(install_runtime(dir.path(), &archive).is_err());
assert!(!dir.path().join(RUNTIME_LIBRARY_NAME).exists());
assert_no_runtime_temps(dir.path());
install_runtime(dir.path(), &runtime_fixture(&[])).unwrap();
let library = dir.path().join(RUNTIME_LIBRARY_NAME);
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(&library).unwrap(), b"library");
fs::write(&library, b"corrupt").unwrap();
assert!(install_runtime(dir.path(), &archive).is_err());
assert_eq!(fs::read(&library).unwrap(), b"corrupt");
assert_no_runtime_temps(dir.path());
}
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn warm_runtime_install_needs_no_writable_cache() {
assert_read_only_runtime_cache(0o555, false);
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn warm_runtime_reuses_owner_only_immutable_cache() {
assert_read_only_runtime_cache(0o500, false);
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn warm_runtime_reuses_nonexecutable_native_library() {
assert_read_only_runtime_cache(0o555, true);
assert_read_only_runtime_cache(0o500, true);
}
#[cfg(all(has_bundled_cli, unix))]
fn assert_read_only_runtime_cache(permission_mask: u32, readonly_native_library: bool) {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[("nested/asset", b"asset", 0o644)]);
install_runtime(dir.path(), &archive).unwrap();
let files = [
RUNTIME_BINARY_NAME,
RUNTIME_NODE_NAME,
"nested/asset",
#[cfg(feature = "bundled-in-process")]
RUNTIME_LIBRARY_NAME,
];
let mut read_only_files = Vec::new();
for name in files {
let path = dir.path().join(name);
let mut mode = fs::metadata(&path).unwrap().permissions().mode() & permission_mask;
if readonly_native_library && name != RUNTIME_BINARY_NAME {
mode &= !0o111;
}
fs::set_permissions(&path, fs::Permissions::from_mode(mode)).unwrap();
read_only_files.push((path, mode));
}
fs::set_permissions(
dir.path().join("nested"),
fs::Permissions::from_mode(permission_mask),
)
.unwrap();
fs::set_permissions(dir.path(), fs::Permissions::from_mode(permission_mask)).unwrap();
let write_denied = fs::File::create(dir.path().join("write-probe")).is_err();
let result = install_runtime(dir.path(), &archive);
fs::set_permissions(dir.path(), fs::Permissions::from_mode(0o755)).unwrap();
fs::set_permissions(dir.path().join("nested"), fs::Permissions::from_mode(0o755)).unwrap();
result.unwrap();
if !write_denied {
eprintln!("read-only permission enforcement unavailable (e.g. privileged user)");
fs::remove_file(dir.path().join("write-probe")).unwrap();
}
for (path, mode) in read_only_files {
assert_eq!(
fs::metadata(path).unwrap().permissions().mode() & 0o777,
mode
);
}
assert_eq!(fs::read(dir.path().join("nested/asset")).unwrap(), b"asset");
assert_no_runtime_temps(dir.path());
}
#[cfg(all(has_bundled_cli, unix))]
#[test]
fn runtime_repairs_unreadable_but_replaceable_file() {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let archive = runtime_fixture(&[("asset", b"trusted", 0o000)]);
let asset = dir.path().join("asset");
fs::write(&asset, b"corrupt").unwrap();
fs::set_permissions(&asset, fs::Permissions::from_mode(0o000)).unwrap();
if fs::File::open(&asset).is_ok() {
eprintln!("unreadable permission enforcement unavailable (e.g. privileged user)");
}
let result = install_runtime(dir.path(), &archive);
let mode = fs::metadata(&asset).unwrap().permissions().mode() & 0o777;
fs::set_permissions(&asset, fs::Permissions::from_mode(0o600)).unwrap();
result.unwrap();
assert_eq!(mode, 0o000);
assert_eq!(fs::read(asset).unwrap(), b"trusted");
assert_no_runtime_temps(dir.path());
}
#[cfg(has_bundled_cli)]
#[test]
fn runtime_replacement_preserves_open_reader_contents() {
let dir = tempfile::tempdir().unwrap();
let asset = dir.path().join("asset");
let original = runtime_fixture(&[("asset", b"old complete file", 0o644)]);
install_runtime(dir.path(), &original).unwrap();
let mut reader = fs::File::open(&asset).unwrap();
let replacement = runtime_fixture(&[("asset", b"new complete file", 0o644)]);
install_runtime(dir.path(), &replacement).unwrap();
let mut bytes = Vec::new();
reader.read_to_end(&mut bytes).unwrap();
assert_eq!(bytes, b"old complete file");
assert_eq!(fs::read(&asset).unwrap(), b"new complete file");
assert_no_runtime_temps(dir.path());
}
#[test]
fn failed_publish_does_not_remove_previous_file() {
let dir = tempfile::tempdir().unwrap();
let target = dir.path().join("installed");
fs::write(&target, b"previous complete file").unwrap();
assert!(publish(&dir.path().join("missing-temporary"), &target).is_err());
assert_eq!(fs::read(target).unwrap(), b"previous complete file");
}
}