Cleanroom Labs
About
Blog
Docs
dev
Development documentation — may change at any time
AirGap Transfer
Documentation
Overview
Features
How It Works
Quick Start
Prerequisites
Installation
First Transfer
Usage
Pack Operation
Unpack Operation
List Operation
Building
Air-Gapped Deployment
Use Cases
Privacy
Why AirGap Transfer?
Platform Support
Documentation
Start Here
Technical Documentation
Project Planning
Use Cases
Use Case Analysis
Purpose
User Personas
IT Administrator
Data Scientist / Researcher
Security Operations Staff
Field Technician
Primary Use Cases
Large File Transfer
Large Directory Transfer
Multiple USB Workflow
Common Requirements Across All Use Cases
Integration with AirGap Deploy
Out of Scope
Success Metrics
See Also
Use Case: Large File Transfer
Scenario
Prerequisites
Workflow Steps
Phase 1: Pack on Source Machine
Phase 2: Physical Transfer
Phase 3: Unpack on Destination Machine
Success Criteria
Error Scenarios
Related Documents
Use Case: Large Directory Transfer
Scenario
Prerequisites
Workflow Steps
Phase 1: Pack on Source Machine
Phase 2: Physical Transfer
Phase 3: Unpack on Destination Machine
Success Criteria
Optimization Notes
Error Scenarios
Related Documents
Use Case: Multi-USB Dataset Transfer
Scenario
Prerequisites
Workflow Steps
Phase 1: Pack with Multiple USB Swaps
Phase 2: Physical Transfer
Phase 3: Unpack on Destination
Success Criteria
Edge Cases
User Experience Notes
Related Documents
Use Case: Transfer Deployment Package with SBOM
Scenario
Prerequisites
Workflow Steps
Pack with SBOM
Transfer
Unpack with Audit Trail
Success Criteria
Related Requirements
Related Documents
Software Requirements Specification
Introduction
Purpose
Scope
Definitions
Overall Description
Product Perspective
Constraints
Functional Requirements
Pack Operation
Unpack Operation
List Operation
Integrity Verification
Cryptographic Agility
State Management
Command Interface
Error Handling
Safety Features
Deployment
Non-Functional Requirements
Performance
Reliability
Usability
Maintainability
Portability
Scalability
Security & Privacy
Deployment
v1.1 — SBOM-Aware Transfer Manifests
Error Handling
Appendix: Chunk Format Specification
Manifest Structure
Chunk Naming Convention
Software Design Document
Introduction
Architecture Overview
System Context
Design Rationale
File Structure
Data Design
Manifest Structure
Chunk File Format
State Persistence
Component Design
CLI Parser (main.rs)
Chunker (chunker.rs)
Verifier (verifier.rs)
Manifest (manifest.rs)
USB Handler (usb.rs)
Interaction Flows
Pack Operation
Unpack Operation
Dependencies
Security & Privacy
Deployment
Air-Gap Support
Platform Packages
Platform Considerations
USB Detection
Filesystem Sync
Test Plan
Introduction
Test Strategy
Test Levels
Features Not Tested
Test Automation Approach
Test Cases by Category
Pack Operation Tests
Unpack Operation Tests
List Operation Tests
Integrity Tests
Cryptographic Agility Tests
State Management Tests
Command Interface Tests
Error Handling Tests
Safety Tests
Deployment Tests
Non-Functional Tests
Test Procedures
Offline Operation Test (TC-TRANSFER-NFR-003)
Checksum Verification Test (TC-INT-003)
Pass/Fail Criteria
Planning
Project Roadmap
v1.0.0 Release
Current Status
MVP Scope
Implementation Phases
Phase 1: Core Infrastructure
Phase 2: Pack Operation
Phase 3: Integrity & Cryptographic Agility
Phase 4: State Management & Resume
Phase 5: Unpack & List
Phase 6: Safety & Validation
Phase 7: CLI Polish
Phase 8: Testing & Documentation
Definition of Done
What’s NOT in MVP
After MVP
Key Documents
See Also
Progress Log
Implementation
API Reference
Planned Architecture
CLI Module (
cli
)
Chunker Module (
chunker
)
Chunker Module — Reconstruction (
chunker
)
Verifier Module (
verifier
)
Manifest Module (
manifest
)
USB Module (
usb
)
Developer Resources
Future Enhancements
AirGap Transfer
Use Cases
Edit on GitHub
Use Cases
Use Case Analysis
Use Case: Large File Transfer
Use Case: Large Directory Transfer
Use Case: Multi-USB Dataset Transfer
Use Case: Transfer Deployment Package with SBOM