use std::path::Path;
use std::process::Command;
use std::sync::Arc;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use serde_json::{Value, json};
use crate::pipeline::model::NodeCapability;
use crate::pipeline::nodes::shared::limits::choice;
use crate::pipeline::nodes::shared::project_store::{OnConflict, on_conflict_flag, open_from, open_store, store_fields, store_flag, target_key};
use crate::pipeline::nodes::shared::store_scratch::StoreScratch;
use crate::pipeline::nodes::shared::util::{metadata_scope, with_answer};
use crate::pipeline::{
NodeDefinition, PipelineError,
model::{DslFlag, DslFlagKind, LayoutItem, NodeExample, NodeFieldDef, NodeFieldType, SelectOptionDef},
nodes::{NodeExecutionInput, NodeExecutionOutput, NodeHandler},
};
use crate::platform::services::PlatformService;
pub const NODE_KIND: &str = "fs.archive.extract";
const INPUT_PIN_IN: &str = "in";
const OUTPUT_PIN_OUT: &str = "out";
pub const CODE: &str = "FW_NODE_FS_ARCHIVE_EXTRACT";
pub const CONFIG_CODE: &str = "FW_NODE_FS_ARCHIVE_EXTRACT_CONFIG";
const SOURCE_CODE: &str = "FW_NODE_FS_ARCHIVE_EXTRACT_SOURCE";
const FORMATS: &[&str] = &["tar.gz"];
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Config {
#[serde(default)]
pub from: Value,
#[serde(default)]
pub format: String,
#[serde(default)]
pub delete_source: bool,
#[serde(default)]
pub store: Option<String>,
#[serde(default)]
pub folder: String,
#[serde(default)]
pub on_conflict: Option<String>,
}
fn flag(name: &str, key: &str, description: &str, value: &str) -> DslFlag {
DslFlag {
flag: name.to_string(),
config_key: key.to_string(),
description: description.to_string(),
kind: DslFlagKind::Scalar,
required: false,
value: value.to_string(),
..Default::default()
}
}
fn field(name: &str, label: &str, field_type: NodeFieldType, help: &str) -> NodeFieldDef {
NodeFieldDef { name: name.to_string(), label: label.to_string(), field_type, help: Some(help.to_string()), ..Default::default() }
}
pub fn definition() -> NodeDefinition {
let upload = json!({ "__zf_type": "file_ref", "backend": "zebfs", "store": "local", "ref": "uploads/bundle.tar.gz", "filename": "bundle.tar.gz", "mime": "application/gzip", "kind": "archive", "size": 40211, "sha256": "sha256:…", "lifecycle": "durable", "origin": "fs.file.put", "trust": "untrusted" });
NodeDefinition {
kind: NODE_KIND.to_string(),
capabilities: vec![NodeCapability::Filesystem, NodeCapability::Process],
title: "Archive Extract".to_string(),
description: "Unpacks a tar.gz archive into a folder of a project store. Open the tar.gz archive `--from` names — a FileRef, an upload or a store key — into `--folder` (default `extracted/<archive>`). \
A member that climbs out of the folder or is a link refuses the whole archive before anything is written. A folder that is not empty is an \
error unless `--on-conflict` says otherwise (`overwrite` replaces it). `--delete-source` removes the archive once every member is written. \
Adds `archive: { folder, items, count, source_deleted }` — `items` a durable FileRef per file — and keeps the rest of the payload."
.to_string(),
input_schema: json!({ "type": "object" }),
output_schema: json!({
"type": "object",
"properties": {
"archive": {
"type": "object",
"properties": {
"folder": { "type": "string" },
"items": { "type": "array", "description": "A durable FileRef per extracted file" },
"count": { "type": "integer" },
"source_deleted": { "type": "boolean" }
}
}
}
}),
input_pins: vec![INPUT_PIN_IN.to_string()],
output_pins: vec![OUTPUT_PIN_OUT.to_string()],
script_available: false,
script_bridge: None,
config_schema: Default::default(),
dsl_flags: vec![
DslFlag { required: true, ..flag("--from", "from", "The archive: a FileRef, an upload or a store key.", "file:archive") },
DslFlag { choices: vec!["tar.gz".to_string()], ..flag("--format", "format", "The archive format: tar.gz (default, the only one).", "") },
DslFlag { kind: DslFlagKind::Bool, ..flag("--delete-source", "delete_source", "Delete the archive once every member is written.", "") },
DslFlag { value: "text".to_string(), ..store_flag() },
flag("--folder", "folder", "The folder the archive opens into (default: extracted/<archive>).", "text"),
DslFlag {
choices: ["error", "skip", "overwrite"].iter().map(|w| w.to_string()).collect(),
..on_conflict_flag(OnConflict::Error)
},
],
fields: vec![
field("from", "From", NodeFieldType::Text, "The archive, e.g. {{ input.file }}."),
NodeFieldDef {
default_value: Some(json!("tar.gz")),
options: FORMATS.iter().map(|v| SelectOptionDef { value: v.to_string(), label: v.to_string() }).collect(),
..field("format", "Format", NodeFieldType::Select, "The archive format.")
},
NodeFieldDef { default_value: Some(json!(false)), ..field("delete_source", "Delete source", NodeFieldType::Checkbox, "Delete the archive once every member is written.") },
field("folder", "Folder", NodeFieldType::Text, "The folder the archive opens into (default: extracted/<archive>)."),
]
.into_iter()
.chain(store_fields(OnConflict::Error))
.collect(),
layout: ["from", "format", "delete_source", "folder", "store", "on_conflict"].iter().map(|name| LayoutItem::Field(name.to_string())).collect(),
examples: vec![
NodeExample::dsl("Unpack an uploaded archive", "fs.archive.extract --from \"{{ input.file }}\" --folder imports/latest --delete-source")
.input(json!({ "file": upload.clone() }))
.output(json!({ "file": upload, "archive": { "folder": "imports/latest", "count": 1, "source_deleted": true, "items": [{ "__zf_type": "file_ref", "backend": "zebfs", "store": "local", "ref": "imports/latest/a.csv", "filename": "a.csv", "mime": "text/csv", "kind": "csv", "size": 120, "sha256": "sha256:…", "lifecycle": "durable", "origin": NODE_KIND, "trust": "untrusted" }] } })),
],
..Default::default()
}
}
pub struct Node {
config: Config,
platform: Arc<PlatformService>,
}
impl Node {
pub fn new(config: Config, platform: Arc<PlatformService>) -> Result<Self, PipelineError> {
Ok(Self { config, platform })
}
}
#[async_trait]
impl NodeHandler for Node {
fn kind(&self) -> &'static str {
NODE_KIND
}
fn input_pins(&self) -> &'static [&'static str] {
&[INPUT_PIN_IN]
}
fn output_pins(&self) -> &'static [&'static str] {
&[OUTPUT_PIN_OUT]
}
async fn execute_async(&self, input: NodeExecutionInput) -> Result<NodeExecutionOutput, PipelineError> {
let (owner, project, ..) = metadata_scope(&input.metadata)?;
choice(&self.config.format, FORMATS, "tar.gz", "--format", CONFIG_CODE)?;
let on_conflict = OnConflict::parse(self.config.on_conflict.as_deref(), OnConflict::Error, CONFIG_CODE)?;
let (source_store, source_rel) =
open_from(&self.platform, owner, project, &self.config.from, self.config.store.as_deref(), "--from", SOURCE_CODE)?;
let trust = "untrusted";
match source_store.fs.head(&source_rel) {
Ok(stat) if stat.kind == crate::zebfs::ZebFsEntryKind::Object => {}
_ => return Err(PipelineError::new(SOURCE_CODE, format!("--from: no archive at '{source_rel}'"))),
}
let folder = resolve_output_dir(&self.config.folder, &source_rel);
let folder = target_key(Some(&folder), "", "", CONFIG_CODE)?;
let store = open_store(&self.platform, owner, project, self.config.store.as_deref())?;
if !on_conflict.allows_tree(&store.fs, &folder, CODE)? {
return Ok(NodeExecutionOutput {
output_pins: vec![OUTPUT_PIN_OUT.to_string()],
payload: with_answer(&input.payload, json!({ "archive": { "folder": folder, "items": [], "count": 0, "source_deleted": false } })),
trace: vec![format!("node_kind={NODE_KIND} src={source_rel} out={folder} skipped=true")],
});
}
if on_conflict == OnConflict::Overwrite && store.fs.list(&folder).map(|entries| !entries.is_empty()).unwrap_or(false) {
store.fs.delete(&folder).map_err(|err| PipelineError::new(CODE, format!("clear '{folder}': {err}")))?;
}
let scratch = StoreScratch::new(CODE)?;
let source_abs = scratch.pull(&source_store.fs, &source_rel)?;
let output_abs = scratch.path().join(".zf-extract");
std::fs::create_dir_all(&output_abs).map_err(|err| PipelineError::new(CODE, format!("create extract dir: {err}")))?;
let source_abs_for_task = source_abs.clone();
let output_abs_for_task = output_abs.clone();
tokio::task::spawn_blocking(move || {
refuse_unsafe_archive_entries(&source_abs_for_task)?;
extract_tar_gz(&source_abs_for_task, &output_abs_for_task)?;
refuse_extracted_symlinks(&output_abs_for_task)?;
Ok::<(), PipelineError>(())
})
.await
.map_err(|err| PipelineError::new(CODE, format!("extract task failed: {err}")))??;
let items = scratch.push_tree_refs(&store, &output_abs, &folder, NODE_KIND, trust)?;
let source_deleted = self.config.delete_source;
if source_deleted {
source_store.delete_named(&self.platform, owner, project, &source_rel, CODE)?;
}
let count = items.len();
Ok(NodeExecutionOutput {
output_pins: vec![OUTPUT_PIN_OUT.to_string()],
payload: with_answer(&input.payload, json!({ "archive": { "folder": folder, "items": items, "count": count, "source_deleted": source_deleted } })),
trace: vec![format!("node_kind={NODE_KIND} src={source_rel} out={folder} store={} files={count}", store.id)],
})
}
}
fn refuse_unsafe_archive_entries(source_abs: &Path) -> Result<(), PipelineError> {
crate::platform::services::project_transfer::validate_archive_entry_names(source_abs).map_err(
|err| {
PipelineError::new(SOURCE_CODE, format!("unsafe archive entry: {}", err.message))
},
)
}
fn refuse_extracted_symlinks(output_abs: &Path) -> Result<(), PipelineError> {
let Err(err) = crate::platform::services::project_transfer::refuse_symlinks(output_abs) else {
return Ok(());
};
unlink_symlinks_under(output_abs);
Err(PipelineError::new(SOURCE_CODE, format!("unsafe archive entry: {}", err.message)))
}
fn unlink_symlinks_under(root: &Path) {
let Ok(entries) = std::fs::read_dir(root) else {
return;
};
for entry in entries.flatten() {
let Ok(file_type) = entry.file_type() else {
continue;
};
if file_type.is_symlink() {
let _ = std::fs::remove_file(entry.path());
} else if file_type.is_dir() {
unlink_symlinks_under(&entry.path());
}
}
}
fn extract_tar_gz(source_abs: &Path, output_abs: &Path) -> Result<(), PipelineError> {
let output = Command::new("tar")
.arg("-xzf")
.arg(source_abs)
.arg("-C")
.arg(output_abs)
.output()
.map_err(|err| {
PipelineError::new(
CODE,
format!("failed running tar: {err}"),
)
})?;
if !output.status.success() {
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
return Err(PipelineError::new(
CODE,
format!("tar extract failed: {stderr}"),
));
}
Ok(())
}
fn sanitize_archive_stem(name: &str) -> String {
let base = name.strip_suffix(".tar.gz").unwrap_or(name);
let sanitized: String = base
.chars()
.map(|ch| {
if ch.is_alphanumeric() || ch == '-' || ch == '_' {
ch.to_ascii_lowercase()
} else {
'-'
}
})
.collect();
sanitized
.split('-')
.filter(|segment| !segment.is_empty())
.collect::<Vec<_>>()
.join("-")
}
fn resolve_output_dir(configured: &str, source_rel_path: &str) -> String {
let configured = configured.trim().trim_matches('/');
if !configured.is_empty() {
return configured.to_string();
}
let source_leaf = Path::new(source_rel_path)
.file_name()
.and_then(|value| value.to_str())
.unwrap_or("archive.tar.gz");
let stem = sanitize_archive_stem(source_leaf);
format!(
"extracted/{}",
if stem.is_empty() { "archive" } else { &stem }
)
}
#[cfg(test)]
mod tests {
use std::io::Write;
use std::sync::Arc;
use serde_json::json;
use super::{
Config, NODE_KIND, Node, NodeExecutionInput, NodeHandler, SOURCE_CODE, refuse_extracted_symlinks,
refuse_unsafe_archive_entries, resolve_output_dir,
};
use crate::platform::PlatformConfig;
use crate::platform::services::PlatformService;
fn append_tar_entry(bytes: &mut Vec<u8>, name: &str, type_flag: u8, link: &str, body: &[u8]) {
let mut header = [0_u8; 512];
header[..name.len()].copy_from_slice(name.as_bytes());
header[100..107].copy_from_slice(b"0000644");
header[108..115].copy_from_slice(b"0000000");
header[116..123].copy_from_slice(b"0000000");
let size = if type_flag == b'2' { 0 } else { body.len() };
header[124..135].copy_from_slice(format!("{size:011o}").as_bytes());
header[136..147].copy_from_slice(b"00000000000");
header[156] = type_flag;
header[157..157 + link.len()].copy_from_slice(link.as_bytes());
header[257..262].copy_from_slice(b"ustar");
header[263..265].copy_from_slice(b"00");
header[148..156].copy_from_slice(b" ");
let sum: u32 = header.iter().map(|byte| u32::from(*byte)).sum();
header[148..156].copy_from_slice(format!("{sum:06o}\0 ").as_bytes());
bytes.extend_from_slice(&header);
if type_flag != b'2' {
bytes.extend_from_slice(body);
bytes.extend(std::iter::repeat_n(0_u8, (512 - body.len() % 512) % 512));
}
}
fn write_tar_gz(path: &std::path::Path, entries: &[(&str, u8, &str, &[u8])]) {
let mut tar = Vec::new();
for (name, type_flag, link, body) in entries {
append_tar_entry(&mut tar, name, *type_flag, link, body);
}
tar.extend(std::iter::repeat_n(0_u8, 1024));
let mut encoder = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::default());
encoder.write_all(&tar).unwrap();
std::fs::write(path, encoder.finish().unwrap()).unwrap();
}
#[test]
fn an_archive_member_that_climbs_out_is_refused_before_extraction() {
let dir = tempfile::tempdir().unwrap();
let archive = dir.path().join("hostile.tar.gz");
write_tar_gz(
&archive,
&[
("safe.txt", b'0', "", b"fine"),
("../../../../tmp/zebflow-escape", b'0', "", b"owned"),
],
);
let error = refuse_unsafe_archive_entries(&archive).expect_err("traversal is refused");
assert_eq!(error.code, SOURCE_CODE);
assert!(error.message.contains("unsafe archive entry"), "{error:?}");
}
#[test]
fn an_absolute_archive_member_is_refused() {
let dir = tempfile::tempdir().unwrap();
let archive = dir.path().join("absolute.tar.gz");
write_tar_gz(&archive, &[("/etc/cron.d/evil", b'0', "", b"owned")]);
assert!(refuse_unsafe_archive_entries(&archive).is_err());
}
#[test]
fn an_ordinary_archive_is_accepted() {
let dir = tempfile::tempdir().unwrap();
let archive = dir.path().join("ok.tar.gz");
write_tar_gz(
&archive,
&[
("bundle/", b'5', "", b""),
("bundle/paper.txt", b'0', "", b"content"),
],
);
refuse_unsafe_archive_entries(&archive).expect("an ordinary archive extracts");
}
#[test]
fn a_symlink_member_is_refused_after_extraction_and_unlinked() {
let dir = tempfile::tempdir().unwrap();
let extracted = dir.path().join("extracted");
std::fs::create_dir_all(extracted.join("nested")).unwrap();
std::fs::write(extracted.join("kept.txt"), "pre-existing").unwrap();
std::os::unix::fs::symlink("/etc/passwd", extracted.join("nested").join("link")).unwrap();
let error = refuse_extracted_symlinks(&extracted).expect_err("a symlink is refused");
assert!(error.message.contains("unsafe archive entry"), "{error:?}");
assert!(
!extracted.join("nested").join("link").exists()
&& std::fs::symlink_metadata(extracted.join("nested").join("link")).is_err(),
"the link survived the refusal"
);
assert!(
extracted.join("kept.txt").is_file(),
"a hostile archive must not be able to delete what the project already had"
);
refuse_extracted_symlinks(&extracted).expect("a tree without links is fine");
}
#[tokio::test]
async fn the_node_refuses_an_archive_whose_members_climb_out() {
let tmp = tempfile::tempdir().expect("tempdir");
let mut config = PlatformConfig::default();
config.data_root = tmp.path().join("platform");
let platform = Arc::new(PlatformService::from_config(config).expect("platform"));
let layout = platform
.file
.ensure_project_layout("superadmin", "default")
.expect("layout");
let source_rel = "uploads/hostile.tar.gz";
let source_abs = layout.files_dir.join(source_rel);
std::fs::create_dir_all(source_abs.parent().expect("parent")).expect("parent");
write_tar_gz(
&source_abs,
&[
("safe.txt", b'0', "", b"fine"),
("../../../owned.txt", b'0', "", b"owned"),
],
);
let escape = layout.files_dir.join("../../owned.txt");
let error = extract(&platform, source_rel, json!({ "keep": true })).await
.expect_err("a hostile archive is refused");
assert_eq!(error.code, SOURCE_CODE);
assert!(
!escape.exists(),
"an archive member escaped to {}",
escape.display()
);
assert!(
!layout.files_dir.join("extracted/hostile/safe.txt").exists(),
"extraction started before the archive was reviewed"
);
assert!(error.message.contains("unsafe archive entry"), "{error:?}");
let linked_rel = "uploads/linked.tar.gz";
write_tar_gz(
&layout.files_dir.join(linked_rel),
&[
("payload/readme.txt", b'0', "", b"ordinary"),
("payload/passwd", b'2', "/etc/passwd", b""),
],
);
let error = extract(&platform, linked_rel, json!({ "keep": true })).await
.expect_err("a symlink member is refused");
assert!(error.message.contains("unsafe archive entry"), "{error:?}");
let link = layout.files_dir.join("extracted/linked/payload/passwd");
assert!(
std::fs::symlink_metadata(&link).is_err(),
"the symlink survived at {}",
link.display()
);
let ok_rel = "uploads/ok.tar.gz";
write_tar_gz(
&layout.files_dir.join(ok_rel),
&[("bundle/paper.txt", b'0', "", b"content")],
);
let output = extract(&platform, ok_rel, json!({ "keep": true })).await
.expect("an ordinary archive extracts");
assert_eq!(output.payload["keep"], true, "the payload stays");
assert_eq!(output.payload["archive"]["count"], 1);
assert_eq!(output.payload["archive"]["folder"], "extracted/ok");
assert_eq!(output.payload["archive"]["items"][0]["ref"], "extracted/ok/bundle/paper.txt");
assert_eq!(output.payload["archive"]["items"][0]["origin"], NODE_KIND);
assert_eq!(output.payload["archive"]["source_deleted"], false);
assert!(
layout
.files_dir
.join("extracted/ok/bundle/paper.txt")
.is_file()
);
}
async fn extract(
platform: &Arc<PlatformService>,
from: &str,
payload: serde_json::Value,
) -> Result<crate::pipeline::nodes::NodeExecutionOutput, crate::pipeline::PipelineError> {
let config: Config = serde_json::from_value(json!({ "from": from })).expect("config");
Node::new(config, Arc::clone(platform))
.expect("node")
.execute_async(NodeExecutionInput {
node_id: "n-test".to_string(),
input_pin: "in".to_string(),
payload,
metadata: json!({ "owner": "superadmin", "project": "default", "pipeline": "test", "request_id": "req-1" }),
bus: None,
})
.await
}
#[tokio::test]
async fn from_is_required() {
let tmp = tempfile::tempdir().expect("tempdir");
let mut config = PlatformConfig::default();
config.data_root = tmp.path().join("platform");
let platform = Arc::new(PlatformService::from_config(config).expect("platform"));
let node = Node::new(Config::default(), Arc::clone(&platform)).expect("node");
let error = node
.execute_async(NodeExecutionInput {
node_id: "n-test".to_string(),
input_pin: "in".to_string(),
payload: json!({ "saved": "uploads/a.tar.gz" }),
metadata: json!({ "owner": "superadmin", "project": "default", "pipeline": "test", "request_id": "req-1" }),
bus: None,
})
.await
.expect_err("no --from");
assert_eq!(error.code, SOURCE_CODE);
let missing = extract(&platform, "uploads/none.tar.gz", json!({})).await.expect_err("nothing there");
assert_eq!(missing.code, SOURCE_CODE);
assert_eq!(
crate::pipeline::nodes::node_signature(&super::definition()),
"fs.archive.extract --from ARCHIVE [--format tar.gz] [--delete-source] [--store TEXT] [--folder TEXT] \
[--on-conflict error|skip|overwrite] → archive"
);
}
#[test]
fn derives_default_extract_dir() {
assert_eq!(
resolve_output_dir("", "archives/paper-bundle.tar.gz"),
"extracted/paper-bundle"
);
}
}