Skip to content

docs: comentário de Scanner.Scan afirma que nunca lê conteúdo de arquivos, o que não é mais verdade #36

Closed

Description

@joaooncode

Problema

O comentário de documentação de Scanner.Scan (internal/scanner/scanner.go) afirma: "It never opens or reads file contents." Isso era verdade antes do Secret Scanner ser adicionado, mas Scan agora chama scanSecrets/readScannableContent, que abrem e leem até 1MB do conteúdo de todo arquivo de ambiente não permitido pelo Allowlist.

Impacto

Quem confiar nessa garantia documentada — por exemplo, assumindo que o envguard é seguro para apontar a arquivos sensíveis sem nenhum risco de leitura/exposição, ou raciocinando sobre sua pegada de I/O — é induzido ao erro.

Correção sugerida

Atualizar o comentário para refletir que Scan agora lê o conteúdo dos arquivos de ambiente (limitado pelo teto de 1MB e pulando arquivos binários) para a detecção de secrets, exceto quando o arquivo está no Allowlist.

Contexto

  • Encontrado durante o code review da branch feat/secret-scanning (commit 40a4708).
  • Arquivo: internal/scanner/scanner.go:80

Activity

  1. added
    documentationImprovements or additions to documentation
    coreCore engine, scanning, and detectors
    on Sep 11, 2026
  2. changed the title [-]docs: Scanner.Scan doc comment claims it never reads file contents, which is no longer true[/-] [+]docs: comentário de Scanner.Scan afirma que nunca lê conteúdo de arquivos, o que não é mais verdade[/+] on Sep 11, 2026
  3. nightcityblade commented on Sep 11, 2026

    @nightcityblade
    Contributor

    Hi, I'd like to work on this. I'll submit a PR shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreCore engine, scanning, and detectorsdocumentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions