Orb — Ferramenta de Tunelamento de Pastas com Confiança Zero

Orb é um utilitário seguro, focado no terminal, que permite compartilhar uma pasta local pela internet usando criptografia de ponta a ponta. Sem contas, sem armazenamento em nuvem, sem necessidade de redirecionamento de portas.

Demonstração

Compartilhando uma Pasta

Compartilhe uma pasta com um único comando – criptografado de ponta a ponta

Navegando pelos Arquivos Compartilhados

Navegador TUI interativo para acesso seguro a arquivos

Funcionalidades

• Arquitetura de Confiança Zero: O servidor de retransmissão nunca vê dados em texto puro
• Criptografia Robusta: Argon2id para derivação de chave, Protocolo Noise para handshake, ChaCha20-Poly1305 para criptografia de transporte
• Multiplataforma: Funciona em Linux, macOS e Windows
• Compatível com NAT: Todas as conexões são de saída, funciona atrás de firewalls
• Navegador de Arquivos TUI: Interface interativa de terminal para navegar e baixar arquivos
• Sem Segredos de Longo Prazo: Sessões expiram automaticamente
• Seguro por Projeto: Sanitização de caminhos, proteção contra links simbólicos, proteção contra repetição

Início Rápido

Instalação

# Baixe o binário para sua plataforma
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/

Ou compile a partir do código-fonte.

Compartilhar uma Pasta

orb share ./myfolder

Saída:

ID da Sessão: abc123def456
Senha de Acesso: secure-random-passcode
Retransmissor: ws://localhost:8080

Compartilhe estas credenciais de forma segura com o destinatário.
Aguardando conexão...

Conectar a uma Pasta Compartilhada

orb connect 7F9Q2A

Solicita a senha de acesso e abre um navegador de arquivos interativo.

Comandos

orb share <caminho>

Compartilha um diretório local através de um túnel criptografado.

Opções:

• --relay <url>: URL do servidor de retransmissão (padrão: http://localhost:8080)
• --readonly: Compartilha a pasta em modo somente leitura

Exemplo:

orb share ./documentos --readonly

orb connect <id-da-sessão>

Conecta a uma sessão compartilhada.

Opções:

• --relay <url>: URL do servidor de retransmissão
• --passcode <código>: Senha de acesso da sessão (solicita se não fornecida)
• --tui: Usar navegador de arquivos TUI (padrão: true)
• --mount <caminho>: Ponto de montagem para FUSE (apenas Linux/macOS)

Exemplo:

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

orb relay

Inicia um servidor de retransmissão.

Opções:

• --listen <endereço>: Endereço de escuta (padrão: :8080)

Exemplo:

orb relay --listen 0.0.0.0:8080

Recursos de Segurança

Criptografia

• Derivação de Chave: Argon2id com 64MB de memória, 3 iterações
• Handshake: Framework do Protocolo Noise com troca de chaves X25519
• Transporte: Criptografia autenticada ChaCha20-Poly1305
• Geração Aleatória: Números aleatórios criptograficamente seguros

Proteção Contra

• Força bruta de senha de acesso (função de memória pesada Argon2id)
• Ataques de repetição (nonces únicos por pacote)
• Intermediário (autenticação mútua do Protocolo Noise)
• Travessia de caminho (sanitização e validação de caminho)
• Ataques de link simbólico (resolução de link simbólico e verificação de limites)
• Sequestro de sessão (limitação de taxa e bloqueio de sessão)
• Comprometimento do retransmissor (criptografia de ponta a ponta; o retransmissor é cego)

Segurança do Sistema de Arquivos

• Todos os caminhos são sanitizados e validados
• Links simbólicos que apontam para fora do diretório compartilhado são bloqueados
• Nenhuma execução remota de arquivos
• Modo somente leitura configurável
• Expiração automática da sessão

Arquitetura

Orb consiste em três componentes:

1. CLI: Interface de usuário para compartilhar e conectar
2. Servidor de Retransmissão: Tubo cego de bytes que encaminha dados criptografados
3. Túnel Criptografado: Canal de comunicação criptografado de ponta a ponta

┌─────────┐                  ┌───────────┐                  ┌─────────┐
│Compart. │◄───criptografado──►│Retransm. │◄───criptografado──►Receptor │
│  (CLI)  │                  │ Servidor  │                  │  (CLI)  │
└─────────┘                  └───────────┘                  └─────────┘
     │                              │                              │
     │                              │                              │
     └──────────────────────────────┴──────────────────────────────┘
          Toda criptografia ocorre nas bordas
          O retransmissor nunca vê dados em texto puro

Compilando a Partir do Código-Fonte

Pré-requisitos

• Go 1.22 ou superior
• Make (opcional, mas recomendado)

Compilar

# Clone o repositório
git clone https://github.com/Zayan-Mohamed/orb.git
cd orb

# Instale as dependências
go mod download

# Compile para a plataforma atual
make build-local

# Ou compile para todas as plataformas
./build.sh

Compilações Multiplataforma

# Compile para todas as plataformas
./build.sh

# Os binários estarão em build/
ls build/
# orb-linux-amd64
# orb-linux-arm64
# orb-darwin-amd64
# orb-darwin-arm64
# orb-windows-amd64.exe

Desenvolvimento

Executar Testes

make test

Cobertura de Código

go test -cover ./...

Executar Servidor de Retransmissão Localmente

make relay

Executar Compartilhador

make share

Executar Receptor

SESSION=<id-da-sessão> make connect

Configuração

Orb usa padrões sensatos e não requer arquivos de configuração. Todas as configurações são passadas por meio de flags da linha de comando.

Documentação

Para documentação abrangente, visite a Documentação do Orb:

• Introdução

  • Guia de Instalação
  • Primeiros Passos
  • Exemplos de Uso

• Guias do Usuário

  • Compartilhando Arquivos
  • Conectando
  • Navegador TUI
  • Solução de Problemas

• Segurança

  • Detalhes de Criptografia
  • Melhores Práticas
  • Modelo de Ameaças

• Implantação

  • Servidor de Retransmissão
  • Produção
  • Docker

• Desenvolvimento

  • Compilando a Partir do Código-Fonte
  • Contribuindo
  • Referência da API

Compilando o Site de Documentação

# Instale MkDocs
pip install -r requirements.txt

# Sirva localmente
mkdocs serve

# Compile o site estático
mkdocs build

Notas Específicas por Plataforma

Linux

• O modo TUI funciona nativamente
• Instalação: Use os binários fornecidos ou compile a partir do código-fonte

macOS

• O modo TUI funciona nativamente
• Instalação: Use os binários fornecidos ou compile a partir do código-fonte

Windows

• O modo TUI funciona nativamente
• Instalação: Use os binários fornecidos ou compile a partir do código-fonte

Limitações

• Tamanho máximo de arquivo: Limitado pela memória disponível (10MB por operação de leitura)
• Sessões expiram após 24 horas
• Máximo de 5 tentativas de senha de acesso com falha antes do bloqueio da sessão
• Acesso somente leitura (sem upload ou modificação de arquivos)

Divulgação de Segurança

Se você descobrir uma vulnerabilidade de segurança, envie um e-mail para [email protected]. Não crie issues públicas para vulnerabilidades de segurança.

Licença

Licença MIT – consulte o arquivo LICENSE para obter detalhes

Contribuindo

Contribuições são bem-vindas! Leia o Guia de Contribuição para obter diretrizes.

Agradecimentos

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