Skip to content

README.md

Latest commit

 

History

History
108 lines (73 loc) · 5.65 KB

README.md

File metadata and controls

108 lines (73 loc) · 5.65 KB
Raw

CryptGuard

Documentação Checks Python Licença Apache-2.0

CryptGuard é uma aplicação de criptografia autenticada de arquivos com interface gráfica em PySide6, CLI, Vault, KeyGuard e containers seguros.

Important

O projeto utiliza primitivas criptográficas consolidadas e práticas defensivas, mas nenhum software oferece segurança absoluta. Ele está em desenvolvimento, ainda precisa de testes automatizados mais amplos e não passou por auditoria criptográfica externa independente. Avalie o código e o modelo de ameaça antes de proteger dados críticos.

Principais recursos

  • Criptografia autenticada de arquivos.
  • Verificação de integridade.
  • Vault para organização de arquivos já criptografados.
  • KeyGuard para geração e gerenciamento local de senhas.
  • Containers seguros .vault para transporte e backup de itens selecionados.
  • CLI para containers e higiene de arquivos.
  • Hardening best-effort de memória, processo, arquivos temporários e logs.
  • Secure delete best-effort, sujeito às limitações da mídia e do sistema de arquivos.

Estado atual

A aplicação principal está em CryptGuardv2/. A série 3.x documenta escrita no formato v5 com XChaCha20-Poly1305 SecretStream, Argon2id calibrado, cabeçalho associado à autenticação e metadados finais autenticados. A árvore também mantém componentes de compatibilidade para leitura de formatos anteriores.

Não há, neste repositório, uma release binária oficial ou uma garantia de estabilidade de formato e API. O uso atual deve ser feito a partir do código-fonte. Consulte o changelog e o roadmap para distinguir o estado documentado das metas futuras.

A documentação externa, a governança e a automação do repositório estão organizadas fora da aplicação. A profissionalização do código interno de CryptGuardv2/ será realizada separadamente, com testes e revisão próprios.

Instalação pelo código-fonte

Use Python 3.11 ou mais recente. Python 3.13 é a versão usada para gerar o arquivo de dependências travadas atualmente disponível no projeto.

git clone https://github.com/Crypt-Guard/CryptGuard.git
cd CryptGuard/CryptGuardv2
python -m venv .venv

Ative o ambiente virtual:

# Windows
.venv\Scripts\activate

# Linux/macOS
source .venv/bin/activate

Instale e execute:

pip install -r requirements.txt
python main_app.py

Instruções específicas por plataforma estão em Instalação.

Uso básico

Na interface gráfica, selecione um arquivo e use Encrypt, Decrypt ou Verify conforme a operação desejada. O Vault, o KeyGuard e os containers seguros possuem fluxos próprios na interface.

Para conhecer os comandos auxiliares e as práticas recomendadas, consulte o guia de uso.

Modelo de segurança

O CryptGuard busca oferecer confidencialidade e detecção de adulteração para dados armazenados, desde que a senha seja adequada e o ambiente de execução seja confiável. O formato v5 usa criptografia autenticada em streaming; parâmetros de derivação e metadados relevantes são vinculados à autenticação.

Vaults e containers reduzem a exposição operacional, mas não substituem controle de acesso do sistema, criptografia de disco ou backups. As proteções de memória, processo e exclusão segura são best-effort.

Leia a Política de Segurança e o modelo de segurança completo antes de usar o projeto com dados sensíveis.

Limitações

  • Uma máquina comprometida, malware, keylogger ou acesso root/administrador pode capturar senhas e dados em texto claro.
  • Exclusão segura não pode ser garantida em SSDs, NVMe, sistemas com copy-on-write, snapshots ou backups.
  • Senhas perdidas não podem ser recuperadas pelo projeto.
  • Arquivos autenticados corrompidos não devem ser reparados manualmente; restaure uma cópia íntegra.
  • Não há promessa de segurança absoluta, inviolabilidade ou adequação automática a requisitos regulatórios.
  • Compatibilidade legada deve ser validada com cópias de teste antes de qualquer migração importante.

Documentação

Contribuindo

Issues e pull requests são bem-vindos. Antes de contribuir, leia o guia de contribuição e o Código de Conduta. Mudanças em criptografia, formato de arquivo, KDF, Vault ou controles de segurança devem explicar impacto, riscos e compatibilidade.

Política de segurança

Não publique vulnerabilidades exploráveis em issues. Siga o processo de divulgação responsável descrito em SECURITY.md.

Licença

CryptGuard é distribuído sob a Apache License 2.0. Dependências de terceiros mantêm suas próprias licenças; consulte também o arquivo NOTICE.