arcthis 0.5.1

A command-line tool for reading and managing compressed files
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! Controlled MCP mutation planning, binding, and execution.

use std::fs::{self, File};
use std::io::Read;
use std::path::Path;
use std::time::UNIX_EPOCH;

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use walkdir::WalkDir;

use crate::archive::{Archive, ArchiveOpenOptions};
use crate::convert::{ConvertOptions, ConvertPlan, ConvertResult};
use crate::error::{ArcthisError, Result};
use crate::extract::{ExtractOptions, ExtractPlan, ExtractResult};
use crate::lifecycle::CollisionPolicy;
use crate::pack::{PackOptions, PackPlan, PackResult};
use crate::security::ExtractionLimits;
use crate::{CancellationToken, ServiceLimits};

#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub(crate) enum MutationCollision {
    #[default]
    Refuse,
    Overwrite,
    SkipExisting,
    Rename,
}

impl From<MutationCollision> for CollisionPolicy {
    fn from(value: MutationCollision) -> Self {
        match value {
            MutationCollision::Refuse => Self::Refuse,
            MutationCollision::Overwrite => Self::Overwrite,
            MutationCollision::SkipExisting => Self::SkipExisting,
            MutationCollision::Rename => Self::Rename,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub(crate) struct ExtractionMutationInput {
    pub path: String,
    pub output: String,
    #[serde(default)]
    pub entry: Option<String>,
    #[serde(default = "default_max_entries")]
    pub max_entries: u64,
    #[serde(default = "default_max_total_size")]
    pub max_total_size: u64,
    #[serde(default = "default_max_entry_size")]
    pub max_entry_size: u64,
    #[serde(default)]
    pub max_compression_ratio: Option<u64>,
    #[serde(default)]
    pub collision: MutationCollision,
    #[serde(default)]
    pub delete_source: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub(crate) struct PackMutationInput {
    pub path: String,
    pub output: String,
    #[serde(default)]
    pub collision: MutationCollision,
    #[serde(default)]
    pub delete_source: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub(crate) struct ConvertMutationInput {
    pub path: String,
    pub output: String,
    #[serde(default = "default_max_entries")]
    pub max_entries: u64,
    #[serde(default = "default_max_total_size")]
    pub max_total_size: u64,
    #[serde(default = "default_max_entry_size")]
    pub max_entry_size: u64,
    #[serde(default)]
    pub max_compression_ratio: Option<u64>,
    #[serde(default)]
    pub collision: MutationCollision,
    #[serde(default)]
    pub delete_source: bool,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
pub(crate) struct ExtractExecuteInput {
    #[serde(flatten)]
    pub request: ExtractionMutationInput,
    pub plan_digest: String,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
pub(crate) struct PackExecuteInput {
    #[serde(flatten)]
    pub request: PackMutationInput,
    pub plan_digest: String,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
pub(crate) struct ConvertExecuteInput {
    #[serde(flatten)]
    pub request: ConvertMutationInput,
    pub plan_digest: String,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct ExtractPlanOutput {
    pub plan_digest: String,
    pub plan: ExtractPlan,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct PackPlanOutput {
    pub plan_digest: String,
    pub plan: PackPlan,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct ConvertPlanOutput {
    pub plan_digest: String,
    pub plan: ConvertPlan,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct ExtractExecuteOutput {
    pub plan_digest: String,
    pub result: ExtractResult,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct PackExecuteOutput {
    pub plan_digest: String,
    pub result: PackResult,
}

#[derive(Debug, Clone, Serialize, JsonSchema)]
pub(crate) struct ConvertExecuteOutput {
    pub plan_digest: String,
    pub result: ConvertResult,
}

pub(crate) fn plan_extract(
    source: &Path,
    output: &Path,
    request: &ExtractionMutationInput,
    server_limits: &ServiceLimits,
) -> Result<ExtractPlanOutput> {
    let archive = Archive::open(source)?;
    let options = extract_options(output, request, server_limits);
    let plan = archive.plan_extract(request.entry.as_deref(), &options)?;
    let plan_digest = plan_digest("extract", request, &plan, &plan.source, &plan.destination)?;
    Ok(ExtractPlanOutput { plan_digest, plan })
}

pub(crate) fn execute_extract(
    source: &Path,
    output: &Path,
    input: &ExtractExecuteInput,
    cancellation: &CancellationToken,
    server_limits: &ServiceLimits,
) -> Result<ExtractExecuteOutput> {
    cancellation.checkpoint()?;
    let prepared = plan_extract(source, output, &input.request, server_limits)?;
    cancellation.checkpoint()?;
    ensure_digest(&input.plan_digest, &prepared.plan_digest)?;
    let archive = Archive::open(source)?;
    let result = archive.extract(
        input.request.entry.as_deref(),
        &extract_options(output, &input.request, server_limits),
    )?;
    Ok(ExtractExecuteOutput {
        plan_digest: prepared.plan_digest,
        result,
    })
}

pub(crate) fn plan_pack(
    source: &Path,
    output: &Path,
    request: &PackMutationInput,
    server_limits: &ServiceLimits,
) -> Result<PackPlanOutput> {
    let options = pack_options(request, server_limits);
    let plan = crate::pack::plan_pack_source(source, output, &options)?;
    let plan_digest = plan_digest("pack", request, &plan, &plan.source, &plan.destination)?;
    Ok(PackPlanOutput { plan_digest, plan })
}

pub(crate) fn execute_pack(
    source: &Path,
    output: &Path,
    input: &PackExecuteInput,
    cancellation: &CancellationToken,
    server_limits: &ServiceLimits,
) -> Result<PackExecuteOutput> {
    cancellation.checkpoint()?;
    let prepared = plan_pack(source, output, &input.request, server_limits)?;
    cancellation.checkpoint()?;
    ensure_digest(&input.plan_digest, &prepared.plan_digest)?;
    let result = crate::pack::pack_source_with_options(
        source,
        output,
        &pack_options(&input.request, server_limits),
    )?;
    Ok(PackExecuteOutput {
        plan_digest: prepared.plan_digest,
        result,
    })
}

pub(crate) fn plan_convert(
    source: &Path,
    output: &Path,
    request: &ConvertMutationInput,
    server_limits: &ServiceLimits,
) -> Result<ConvertPlanOutput> {
    let options = convert_options(request, server_limits);
    let plan = crate::convert::plan_convert(source, output, &options)?;
    let plan_digest = plan_digest("convert", request, &plan, &plan.source, &plan.destination)?;
    Ok(ConvertPlanOutput { plan_digest, plan })
}

pub(crate) fn execute_convert(
    source: &Path,
    output: &Path,
    input: &ConvertExecuteInput,
    cancellation: &CancellationToken,
    server_limits: &ServiceLimits,
) -> Result<ConvertExecuteOutput> {
    cancellation.checkpoint()?;
    let prepared = plan_convert(source, output, &input.request, server_limits)?;
    cancellation.checkpoint()?;
    ensure_digest(&input.plan_digest, &prepared.plan_digest)?;
    let result = crate::convert::convert_archive(
        source,
        output,
        &convert_options(&input.request, server_limits),
    )?;
    Ok(ConvertExecuteOutput {
        plan_digest: prepared.plan_digest,
        result,
    })
}

fn extract_options(
    output: &Path,
    request: &ExtractionMutationInput,
    server_limits: &ServiceLimits,
) -> ExtractOptions {
    ExtractOptions {
        output: Some(output.to_path_buf()),
        base_directory: None,
        limits: extraction_limits(
            request.max_entries.min(server_limits.max_entries),
            request.max_total_size.min(server_limits.max_decoded_bytes),
            request.max_entry_size.min(server_limits.max_decoded_bytes),
            request.max_compression_ratio,
        ),
        collision_policy: request.collision.into(),
        delete_source: request.delete_source,
    }
}

fn pack_options(request: &PackMutationInput, server_limits: &ServiceLimits) -> PackOptions {
    PackOptions {
        collision_policy: request.collision.into(),
        delete_source: request.delete_source,
        include_source_root: true,
        limits: ExtractionLimits {
            max_entries: server_limits.max_entries,
            max_total_size: server_limits.max_decoded_bytes,
            max_entry_size: server_limits.max_decoded_bytes,
            ..ExtractionLimits::default()
        },
    }
}

fn convert_options(
    request: &ConvertMutationInput,
    server_limits: &ServiceLimits,
) -> ConvertOptions {
    ConvertOptions {
        open: ArchiveOpenOptions::default(),
        limits: extraction_limits(
            request.max_entries.min(server_limits.max_entries),
            request.max_total_size.min(server_limits.max_decoded_bytes),
            request.max_entry_size.min(server_limits.max_decoded_bytes),
            request.max_compression_ratio,
        ),
        collision_policy: request.collision.into(),
        delete_source: request.delete_source,
    }
}

fn extraction_limits(
    max_entries: u64,
    max_total_size: u64,
    max_entry_size: u64,
    max_compression_ratio: Option<u64>,
) -> ExtractionLimits {
    ExtractionLimits {
        max_entries,
        max_total_size,
        max_entry_size,
        max_compression_ratio,
        ..ExtractionLimits::default()
    }
}

fn ensure_digest(expected: &str, actual: &str) -> Result<()> {
    if expected == actual {
        Ok(())
    } else {
        Err(ArcthisError::Collision {
            message:
                "stale MCP mutation plan: source, destination, limits, or collision state changed"
                    .to_owned(),
        })
    }
}

fn plan_digest<R: Serialize, P: Serialize>(
    operation: &str,
    request: &R,
    plan: &P,
    source: &Path,
    destination: &Path,
) -> Result<String> {
    let mut digest = Sha256::new();
    digest.update(b"arcthis-mcp-plan-v1\0");
    digest.update(operation.as_bytes());
    digest.update(b"\0request\0");
    update_json(&mut digest, request)?;
    digest.update(b"\0plan\0");
    update_json(&mut digest, plan)?;
    digest.update(b"\0source\0");
    fingerprint_path(source, &mut digest)?;
    digest.update(b"\0destination\0");
    if destination
        .try_exists()
        .map_err(|error| ArcthisError::io("checking MCP plan destination fingerprint", error))?
    {
        fingerprint_path(destination, &mut digest)?;
    } else {
        digest.update(b"missing\0");
        digest.update(destination.as_os_str().as_encoded_bytes());
    }
    Ok(hex(&digest.finalize()))
}

fn update_json(digest: &mut Sha256, value: &impl Serialize) -> Result<()> {
    let bytes = serde_json::to_vec(value).map_err(|error| ArcthisError::UnsupportedOperation {
        message: format!("serializing MCP mutation plan binding: {error}"),
    })?;
    digest.update(bytes);
    Ok(())
}

fn fingerprint_path(path: &Path, digest: &mut Sha256) -> Result<()> {
    let metadata = fs::symlink_metadata(path)
        .map_err(|error| ArcthisError::io("reading MCP plan source metadata", error))?;
    if metadata.file_type().is_symlink() {
        return Err(ArcthisError::UnsupportedOperation {
            message: format!(
                "MCP mutation fingerprints reject symlinks: {}",
                path.display()
            ),
        });
    }
    if metadata.is_file() {
        fingerprint_file(
            path,
            path.file_name().unwrap_or_default().as_encoded_bytes(),
            digest,
        )?;
        return Ok(());
    }
    if !metadata.is_dir() {
        return Err(ArcthisError::UnsupportedOperation {
            message: format!(
                "MCP mutation source is not a file or directory: {}",
                path.display()
            ),
        });
    }
    for entry in WalkDir::new(path).follow_links(false).sort_by_file_name() {
        let entry = entry.map_err(|error| {
            ArcthisError::io("walking MCP mutation source", std::io::Error::other(error))
        })?;
        let relative = entry.path().strip_prefix(path).map_err(|error| {
            ArcthisError::UnsupportedOperation {
                message: format!("deriving MCP fingerprint path: {error}"),
            }
        })?;
        let metadata = fs::symlink_metadata(entry.path())
            .map_err(|error| ArcthisError::io("reading MCP fingerprint metadata", error))?;
        if metadata.file_type().is_symlink() {
            return Err(ArcthisError::UnsupportedOperation {
                message: format!(
                    "MCP mutation fingerprints reject symlinks: {}",
                    entry.path().display()
                ),
            });
        }
        digest.update(relative.as_os_str().as_encoded_bytes());
        digest.update(b"\0");
        update_metadata(digest, &metadata);
        if metadata.is_file() {
            fingerprint_file(entry.path(), b"", digest)?;
        }
    }
    Ok(())
}

fn fingerprint_file(path: &Path, label: &[u8], digest: &mut Sha256) -> Result<()> {
    let metadata = fs::metadata(path)
        .map_err(|error| ArcthisError::io("reading MCP fingerprint file metadata", error))?;
    digest.update(label);
    digest.update(b"\0file\0");
    update_metadata(digest, &metadata);
    let mut file = File::open(path)
        .map_err(|error| ArcthisError::io("opening MCP fingerprint file", error))?;
    let mut buffer = vec![0_u8; 64 * 1024].into_boxed_slice();
    loop {
        let count = file
            .read(&mut buffer)
            .map_err(|error| ArcthisError::io("hashing MCP fingerprint file", error))?;
        if count == 0 {
            break;
        }
        digest.update(&buffer[..count]);
    }
    Ok(())
}

fn update_metadata(digest: &mut Sha256, metadata: &fs::Metadata) {
    digest.update(metadata.len().to_le_bytes());
    let modified = metadata
        .modified()
        .ok()
        .and_then(|value| value.duration_since(UNIX_EPOCH).ok())
        .map_or(0_u128, |duration| duration.as_nanos());
    digest.update(modified.to_le_bytes());
    digest.update([u8::from(metadata.is_file()), u8::from(metadata.is_dir())]);
}

fn hex(bytes: &[u8]) -> String {
    const DIGITS: &[u8; 16] = b"0123456789abcdef";
    let mut result = String::with_capacity(bytes.len() * 2);
    for byte in bytes {
        result.push(char::from(DIGITS[usize::from(byte >> 4)]));
        result.push(char::from(DIGITS[usize::from(byte & 0x0f)]));
    }
    result
}

const fn default_max_entries() -> u64 {
    100_000
}

const fn default_max_total_size() -> u64 {
    16 * 1024 * 1024 * 1024
}

const fn default_max_entry_size() -> u64 {
    4 * 1024 * 1024 * 1024
}