
pii-shield v2.2.3
Sidecar K8s sem código para sanitização de logs. Detecta segredos via Análise de Entropia, preserva a integridade do JSON e oculta PII de forma determinística. 🛡️
PII-Shield 🛡️
Sidecar de sanitização de logs sem código para Kubernetes. Previne vazamentos de dados (GDPR/SOC2) ao redigir PII dos logs antes que eles saiam do pod.
O PII-Shield é executado in-process — CLI, sidecar ou WASM. Não há API hospedada nem servidor para onde seus dados são enviados.
Mesmo nome, projetos diferentes. Este não é o proxy de privacidade PII Shield do blog da comunidade de desenvolvedores da Microsoft (maio de 2026, vikasgautam18/pii-shield), nem os produtos de redação de prompts piishield.ai ou piishield.com, e nem o pacote
pii-shieldno PyPI da Intellirim. Nossos pacotes sãopii-shield-wasino PyPI e@aragossa/pii-shield-wasino npm; em texto corrido, chamamos este projeto de sidecar PII-Shield.
"Não deixe a PII envenenar seus modelos de IA." O PII-Shield garante que dados sensíveis nunca cheguem ao seu conjunto de dados de treinamento, poupando você de um retreinamento de modelo forçado pela GDPR.
[!WARNING] Atualizando para a v2.0.0? Movemos a distribuição para usuários finais para instalações baseadas em Helm e Distroless Native Sidecars. O Kustomize não é mais um caminho de instalação de release suportado para usuários de produção, embora o repositório do operator ainda mantenha o scaffolding do Kustomize para desenvolvimento local e geração de manifestos. O acesso a
/bin/shdentro do sidecar PII-Shield não é mais suportado. Leia o Guia de Migração.
Dois Modelos de Implantação
O PII-Shield oferece duas formas distintas de integração à sua stack:
- Kubernetes Operator (Sem código): Nosso modelo de implantação principal. Um K8s Operator totalmente automatizado que injeta um Distroless Sidecar altamente seguro em seus pods para interceptar e sanitizar logs em tempo real.
- WASM In-Process (Para integrações centrais): Para desempenho extremo, o motor central pode ser embutido diretamente via WASM, proporcionando latência
<1mssem saltos de rede.
Status do Projeto e Roadmap
O PII-Shield é uma ferramenta de segurança open-source em desenvolvimento ativo, em fase de endurecimento para produção. A linha de releases v2.x entrega artefatos utilizáveis de CLI, container, Helm/operator e SDK WASM. Os caminhos centrais de redação estão prontos para implantações controladas, enquanto alguns modos de implantação no Kubernetes e garantias de supply-chain ainda estão sendo estabilizados.
| Componente | Status |
|---|---|
| Scanner central | Lançado / implantações controladas |
| Sidecar CLI | Lançado / implantações controladas |
| Kubernetes operator | Fase de estabilização |
| SDKs WASM | Beta lançado |
| Integração de gateway Proxy-Wasm | P&D planejado |
| Servidor de regras (regras centrais, painel) | Primeira versão, imagem auto-hospedada |
| Agente de auditoria eBPF (observa stdout/stderr, nunca redige) | Experimental, veja docs/ebpf-audit.md |
Veja KNOWN_LIMITATIONS.md para os limites atuais de endurecimento para produção.
Por que o PII-Shield?
Desenvolvedores frequentemente esquecem de mascarar dados sensíveis. Filtros regex tradicionais no Fluentd/Logstash são lentos, difíceis de manter e consomem CPU caro nos agregadores de logs.
O PII-Shield fica ao lado do seu contêiner de aplicação:
- Core Engine reforçado para produção: Otimizado para sidecars do Kubernetes, com baixas alocações de memória nos caminhos críticos e correspondência de regex determinística.
- Análise de entropia sensível ao contexto: Detecta segredos de alta entropia mesmo sem chaves (por exemplo,
Error: ... 44saCk9...) ao analisar palavras-chave de contexto. - Regras de regex personalizadas: Redação determinística para dados estruturados (UUIDs, IDs) que substitui as verificações de entropia para padrões conhecidos.
- Assinaturas de segredos integradas: Credenciais com prefixo de emissor — chaves de API da AWS e do Google, tokens do GitHub, Slack e Stripe, JWTs, credenciais
Bearere blocos de chave privada PEM — são redigidas com base no formato, de modo que uma chave válida é capturada mesmo quando seu corpo tem baixa entropia ou o limite foi elevado. - Números de telefone por formato: Números internacionais com
+, formatos norte-americanos(555) 234-5678e dígitos sob uma chave com nome de telefone (phone,mobile,wa_id, ...) são ocultados, mesmo que dígitos isolados nunca sejam pontuados como segredo. - Números de identidade por chave: Dígitos sob uma chave que nomeia um documento de identidade (
idNumber,national_id,ssn,passport_number,tax_id, ...) são ocultados; um id de registro comouser_idouorder_idnão é. - Cobertura de regressão e fuzzing: Testado contra casos de estresse, incluindo lixo binário, aninhamento JSON e logs multilíngues.
- Hashing determinístico: Substitui segredos por hashes únicos (por exemplo,
[HIDDEN:a1b2c]), permitindo que o QA correlacione erros sem ver os dados brutos. - Drop-in: Nenhuma alteração de código necessária. Funciona com qualquer linguagem (Node, Python, Java, Go).
- Suporte a lista de permissões: Permite explicitamente padrões seguros (por exemplo, hashes git, IDs de sistema) usando
PII_SAFE_REGEX_LISTpara evitar falsos positivos.
Gerenciando o PII-Shield em dezenas de clusters?
Um servidor de regras mantém os conjuntos de regras em um único lugar: uma equipe de segurança edita um conjunto no navegador, vê no scanner real o que um rascunho faz com linhas de log coladas, publica uma versão, e cada cluster cujo PiiPolicy nomeia o conjunto o baixa com um token somente leitura, sem reiniciar o pod. Nada sobre um cluster é enviado a ele, a menos que o cluster ative o canal de estatísticas, que envia apenas contadores. Ele é distribuído como a imagem ghcr.io/pii-shield/pii-shield-rules para o seu próprio perímetro, consulte docs/rules-server.md. As publicações podem ser assinadas com chaves que apenas os publicadores possuem, toda alteração vai para um log de atividades, e um canal de estatísticas opcional mostra por cluster qual versão de regra está em execução e quantos valores foram ocultados, apenas como contadores. Ele roda em SQLite, ou em Postgres para várias instâncias; deploy/rules-server o executa em uma única máquina com HTTPS e backups contínuos.
Integrações
A build WASM in-process do PII-Shield é distribuída dentro do GuardSpine Code, uma GitHub Action de governança de código de IA de código aberto, que inclui o binário e o credita em seu NOTICE.