Orb – Zero-Trust Ordner-Tunneling-Tool

Orb ist ein sicheres, terminalorientiertes Werkzeug, mit dem Sie einen lokalen Ordner über das Internet mithilfe von Ende-zu-Ende-Verschlüsselung teilen können. Keine Konten, kein Cloud-Speicher, keine Portweiterleitung erforderlich.

Demo

Ordner freigeben

Teilen Sie einen Ordner mit einem einzigen Befehl – Ende-zu-Ende verschlüsselt

Freigegebene Dateien durchsuchen

Interaktiver TUI-Browser für sicheren Dateizugriff

Funktionen

• Zero-Trust-Architektur: Der Relay-Server sieht niemals Klartextdaten
• Starke Kryptographie: Argon2id für Schlüsselableitung, Noise-Protokoll für Handshake, ChaCha20-Poly1305 für Transportverschlüsselung
• Plattformübergreifend: Funktioniert unter Linux, macOS und Windows
• NAT-sicher: Alle Verbindungen sind ausgehend, funktioniert hinter Firewalls
• TUI-Dateibrowser: Interaktive Terminaloberfläche zum Durchsuchen und Herunterladen von Dateien
• Keine langfristigen Geheimnisse: Sitzungen laufen automatisch ab
• Sicher durch Design: Pfadbereinigung, Symlink-Schutz, Replay-Schutz

Schnellstart

Installation

# Download the binary for your platform
curl -L https://github.com/Zayan-Mohamed/orb/releases/latest/download/orb-$(uname -s)-$(uname -m) -o orb
chmod +x orb
sudo mv orb /usr/local/bin/

Oder aus dem Quellcode erstellen.

Ordner freigeben

orb share ./myfolder

Ausgabe:

Session ID: abc123def456
Passcode: secure-random-passcode
Relay: ws://localhost:8080

Share these credentials securely with the recipient.
Waiting for connection...

Mit einem freigegebenen Ordner verbinden

orb connect 7F9Q2A

Fordert zur Eingabe des Passcodes auf und öffnet einen interaktiven Dateibrowser.

Befehle

orb share <path>

Teilt ein lokales Verzeichnis über einen verschlüsselten Tunnel.

Optionen:

• --relay <url>: URL des Relay-Servers (Standard: http://localhost:8080)
• --readonly: Ordner im Nur-Lese-Modus freigeben

Beispiel:

orb share ./documents --readonly

orb connect <session-id>

Mit einer freigegebenen Sitzung verbinden.

Optionen:

• --relay <url>: URL des Relay-Servers
• --passcode <code>: Sitzungs-Passcode (Eingabeaufforderung, falls nicht angegeben)
• --tui: TUI-Dateibrowser verwenden (Standard: true)
• --mount <path>: Einhängepunkt für FUSE (nur Linux/macOS)

Beispiel:

orb connect 7F9Q2A --passcode 493-771 --tui

orb relay

Startet einen Relay-Server.

Optionen:

• --listen <addr>: Lauschadresse (Standard: :8080)

Beispiel:

orb relay --listen 0.0.0.0:8080

Sicherheitsfunktionen

Kryptographie

• Schlüsselableitung: Argon2id mit 64 MB Speicher, 3 Iterationen
• Handshake: Noise-Protokoll-Framework mit X25519-Schlüsselaustausch
• Transport: ChaCha20-Poly1305 authentifizierte Verschlüsselung
• Zufallserzeugung: Kryptographisch sichere Zufallszahlen

Schutz gegen

• Passcode-Brute-Force (Argon2id speicherharte Funktion)
• Replay-Angriffe (einzigartige Nonces pro Paket)
• Man-in-the-Middle (gegenseitige Authentifizierung durch Noise-Protokoll)
• Pfad-Traversal (Pfadbereinigung und -validierung)
• Symlink-Angriffe (Symlink-Auflösung und Grenzprüfung)
• Sitzungsentführung (Ratenbegrenzung und Sitzungssperrung)
• Relay-Kompromittierung (Ende-zu-Ende-Verschlüsselung, Relay ist blind)

Dateisystemsicherheit

• Alle Pfade werden bereinigt und validiert
• Symlinks, die außerhalb des freigegebenen Verzeichnisses zeigen, werden blockiert
• Keine Ausführung von Dateien aus der Ferne
• Konfigurierbarer Nur-Lese-Modus
• Automatischer Sitzungsablauf

Architektur

Orb besteht aus drei Komponenten:

1. CLI: Benutzeroberfläche zum Freigeben und Verbinden
2. Relay-Server: Blinde Byte-Pipe, die verschlüsselte Daten weiterleitet
3. Verschlüsselter Tunnel: Ende-zu-Ende verschlüsselter Kommunikationskanal

┌─────────┐                  ┌───────────┐                  ┌─────────┐
│ Sharer  │◄────encrypted────►│   Relay   │◄────encrypted────►│Receiver │
│  (CLI)  │                  │  Server   │                  │  (CLI)  │
└─────────┘                  └───────────┘                  └─────────┘
     │                              │                              │
     │                              │                              │
     └──────────────────────────────┴──────────────────────────────┘
              All encryption happens at the edges
              Relay never sees plaintext data

Aus dem Quellcode erstellen

Voraussetzungen

• Go 1.22 oder später
• Make (optional, aber empfohlen)

Erstellen

# Clone the repository
git clone https://github.com/Zayan-Mohamed/orb.git
cd orb

# Install dependencies
go mod download

# Build for current platform
make build-local

# Or build for all platforms
./build.sh

Plattformübergreifende Builds

# Build for all platforms
./build.sh

# Binaries will be in build/
ls build/
# orb-linux-amd64
# orb-linux-arm64
# orb-darwin-amd64
# orb-darwin-arm64
# orb-windows-amd64.exe

Entwicklung

Tests ausführen

make test

Codeabdeckung

go test -cover ./...

Relay-Server lokal ausführen

make relay

Freigebenden ausführen

make share

Empfänger ausführen

SESSION=<session-id> make connect

Konfiguration

Orb verwendet sinnvolle Voreinstellungen und benötigt keine Konfigurationsdateien. Alle Einstellungen werden über Befehlszeilenflags übergeben.

Dokumentation

Ausführliche Dokumentation finden Sie unter Orb-Dokumentation:

• Erste Schritte

  • Installationsanleitung
  • Erste Schritte
  • Anwendungsbeispiele

• Benutzerhandbücher

  • Dateien freigeben
  • Verbinden
  • TUI-Browser
  • Fehlerbehebung

• Sicherheit

  • Kryptographiedetails
  • Bewährte Verfahren
  • Bedrohungsmodell

• Bereitstellung

  • Relay-Server
  • Produktion
  • Docker

• Entwicklung

  • Aus dem Quellcode erstellen
  • Mitwirken
  • API-Referenz

Dokumentationsseite erstellen

# Install MkDocs
pip install -r requirements.txt

# Serve locally
mkdocs serve

# Build static site
mkdocs build

Plattformspezifische Hinweise

Linux

• Der TUI-Modus funktioniert sofort
• Installation: Verwenden Sie die bereitgestellten Binärdateien oder erstellen Sie sie aus dem Quellcode

macOS

• Der TUI-Modus funktioniert sofort
• Installation: Verwenden Sie die bereitgestellten Binärdateien oder erstellen Sie sie aus dem Quellcode

Windows

• Der TUI-Modus funktioniert sofort
• Installation: Verwenden Sie die bereitgestellten Binärdateien oder erstellen Sie sie aus dem Quellcode

Einschränkungen

• Maximale Dateigröße: Begrenzt durch verfügbaren Speicher (10 MB pro Lesevorgang)
• Sitzungen laufen nach 24 Stunden ab
• Maximal 5 fehlgeschlagene Passcode-Versuche vor Sitzungssperrung
• Nur-Lese-Zugriff (kein Hochladen/Ändern von Dateien)

Sicherheitsmeldung

Wenn Sie eine Sicherheitslücke entdecken, senden Sie bitte eine E-Mail an [email protected]. Erstellen Sie keine öffentlichen Issues für Sicherheitslücken.

Lizenz

MIT-Lizenz – siehe Datei LICENSE für Details

Mitwirken

Beiträge sind willkommen! Bitte lesen Sie den Leitfaden zum Mitwirken für Richtlinien.

Danksagungen

• Noise Protocol Framework
• ChaCha20-Poly1305 (RFC 8439)
• Argon2id (RFC 9106)
• Bubble Tea TUI framework
• Go crypto libraries