Como o Sovra constrói, verifica e entrega o seu próprio software
Esta página enumera os controlos que existem hoje no repositório do Sovra, pela ordem do processo de entrega, cada um com uma forma de o verificar por si. Um controlo só aparece aqui enquanto o ficheiro que o implementa continuar a dizê-lo; a página é reavaliada contra esses ficheiros a cada pedido.
Verificar o pacote de evidências
Este pacote pertence à release 0.31.4. Lista de ficheiros com SHA-256
curl -fsSO https://sovra.informatologia.pt/trust/evidence/{SHA256SUMS,SHA256SUMS.sig,allowed_signers,Dockerfile,dependabot.yml,docker-compose.reuse.yml,docker-compose.yml,dockerignore,pyproject.toml,secrets.baseline,sovra-0.31.4.cdx.json,uv.lock,workflow-deploy.yml,workflow-tests.yml}ssh-keygen -Y verify -f allowed_signers -I release@sovra.informatologia.pt -n sovra-release -s SHA256SUMS.sig < SHA256SUMS
sha256sum -c --ignore-missing SHA256SUMS
Execute na pasta onde descarregou o pacote. O ficheiro allowed_signers é a âncora de confiança: não está coberto pelo SHA256SUMS, pelo que depende do TLS deste site.
Dependências
Cada pacote do ficheiro de bloqueio uv.lock está fixado a uma versão exata e traz um hash SHA-256 por ficheiro.
grep -c 'hash = "sha256:' uv.lock
grep -c '{ url = ' uv.lock # same numberOs pacotes de terceiros instalam-se a partir do ficheiro de bloqueio e apenas como wheels pré-compiladas. As distribuições de código-fonte são recusadas (no-build), pelo que nenhum script de compilação de pacotes corre na construção da imagem.
grep -n 'no-build' pyproject.toml
grep -n 'uv sync' Dockerfile
A resolução de dependências ignora qualquer ficheiro publicado dentro de uma janela de espera (exclude-newer), pelo que uma versão maliciosa acabada de publicar não é adotada no primeiro dia.
grep -n 'exclude-newer' pyproject.toml
O Dependabot propõe atualizações semanalmente para GitHub Actions, imagens Docker e pacotes Python, com o mesmo período de espera. Cada atualização passa pelas mesmas verificações que qualquer outra alteração.
cat dependabot.yml
Compilação
Todas as GitHub Actions usadas nos fluxos de trabalho estão fixadas ao SHA completo de um commit, e não a uma etiqueta que pode ser movida.
grep -hn 'uses:' workflow-*.yml
Todos os fluxos de trabalho definem, por omissão, permissões de leitura sobre o repositório (contents: read). A única permissão de escrita existente é contents: write no trabalho de assinatura, que anexa os ficheiros assinados à release.
grep -n -A1 '^permissions:' workflow-*.yml
grep -n ': write' workflow-*.yml # one line: contents: write in the sign job
Todas as imagens base do Dockerfile, incluindo a imagem do instalador uv, estão fixadas pelo respetivo digest SHA-256.
grep -n '^FROM' Dockerfile
O contentor corre com um utilizador sem privilégios. O diretório da aplicação pertence ao root e é só de leitura para esse utilizador; apenas o volume de dados é gravável.
grep -n '^USER\|adduser\|chown' Dockerfile
Nos ficheiros de implantação de referência, o contentor da aplicação tem o sistema de ficheiros raiz só de leitura.
grep -n 'read_only' docker-compose*.yml
Nos ficheiros de implantação de referência, o contentor da aplicação abdica de todas as capabilities do Linux e ativa no-new-privileges.
grep -n -A2 'cap_drop\|no-new-privileges' docker-compose*.yml
Verificações a cada alteração
As verificações abaixo correm em cada pull request e em cada push para main.
sed -n '/^on:/,/^permissions:/p' workflow-tests.yml
O pip-audit verifica o ficheiro de bloqueio exportado, com hashes obrigatórios, contra vulnerabilidades conhecidas.
grep -n 'pip-audit' workflow-tests.yml
O Sovra analisa os seus próprios ficheiros de dependências com o seu próprio motor e publica o SBOM CycloneDX resultante como artefacto da compilação.
grep -n 'selfscan\|upload-artifact' workflow-tests.yml
ls sovra-*.cdx.json # the SBOM of this release, in the bundle
O trabalho de pip-audit e de auto-análise corre também todas as noites, para que um aviso recém-publicado apareça sem ser preciso um commit.
grep -n -A1 'schedule:' workflow-tests.yml
O Semgrep (conjuntos de regras python e security-audit) analisa o código-fonte e qualquer deteção faz falhar a compilação.
grep -n 'semgrep' workflow-tests.yml
O Ruff corre com as regras de segurança flake8-bandit (S) ativas, além das regras de correção.
grep -n -A2 '^\[tool.ruff.lint\]' pyproject.toml
grep -n 'ruff check' workflow-tests.yml
O detect-secrets analisa todos os ficheiros versionados contra uma base de referência auditada, pelo que um segredo introduzido num commit faz falhar a compilação.
grep -n 'detect-secrets' workflow-tests.yml
ls -l secrets.baseline
Os próprios ficheiros dos fluxos de trabalho são verificados com o actionlint e o zizmor.
grep -n 'actionlint\|zizmor' workflow-tests.yml
A execução dos testes falha se a cobertura de linhas descer abaixo de 80%. O limite está em pyproject.toml, pelo que se aplica a todos e não só ao CI.
grep -n 'fail_under' pyproject.toml
grep -n -- '--cov' workflow-tests.yml
Lançamento e implantação
As implantações em produção só começam quando uma release do GitHub é publicada. Nada é implantado por push, por merge ou por execução manual.
sed -n '/^on:/,/^permissions:/p' workflow-deploy.yml
A etiqueta da release tem de apontar para um commit que já está em main. Código que nunca foi integrado não é implantado.
grep -n 'is-ancestor' workflow-deploy.yml
A etiqueta da release tem de ser igual a v mais a versão que o código declara (sovra.__version__).
grep -n 'TAG' workflow-deploy.yml
As pré-releases nunca são implantadas.
grep -n 'prerelease' workflow-deploy.yml
A suite de testes completa, com o limite de cobertura, corre no commit da release. O trabalho de implantação espera por ela e envia exatamente esse commit.
grep -n 'needs:\|pytest\|--ref' workflow-deploy.yml
O trabalho de implantação espera pelo trabalho de assinatura, que constrói os ficheiros da release, assina-os e verifica as cópias publicadas. Uma release sem assinatura, ou cuja assinatura não se verifica, não é implantada.
grep -n 'needs:\|release_sign\|release_verify' workflow-deploy.yml
Lançamentos assinados
Os ficheiros de cada release constam de um ficheiro SHA256SUMS, assinado com uma chave SSH no espaço de nomes sovra-release. A chave pública está publicada abaixo.
curl -fsS https://sovra.informatologia.pt/.well-known/sovra-release-signing.pub -o allowed_signers
ssh-keygen -Y verify -f allowed_signers -I release@sovra.informatologia.pt -n sovra-release -s SHA256SUMS.sig < SHA256SUMS
sha256sum -c --ignore-missing SHA256SUMS
Comunicar uma vulnerabilidade
Envie os relatórios de vulnerabilidades para info@informatologia.pt (mailto). Contacto legível por máquinas: /.well-known/security.txt