Marllus
Marllus Analista de TI, mestre em politicas publicas, professor, artista digital e aspirante a tudo que lhe der na telha.

DevSecOps - Pipeline CI/CD para gestão de vulnerabilidades em imagens Docker com Github Actions

DevSecOps - Pipeline CI/CD para gestão de vulnerabilidades em imagens Docker com  Github Actions
Github actions

Este é o primeiro artigo sobre a temática DevSecOps, e nele, trago uma abordagem que relaciona automação na detecção de vulnerabilidades e abertura de tickets, a partir do próprio repositório de código que hospeda os arquivos que mantém a imagem atualizada. Tudo isso através do uso do recurso Github Actions. Não conseguiu entender? Continue a leitura.

Github actions

Github Actions é um recurso criado pelo Github, que possibilita a criação e execução de fluxos de trabalho (workflows), destinados aos mais diversos cenários de build/deploy/delivery, a partir de uma linguagem declarativa (YAML). Em resumo, dá pra você criar fluxos interessantes, que vão desde testar um build em um Dockerfile, até mesmo implantar essa imagem na produção, em algum provedor de nuvem. Tudo de forma automatizada. E a vantagem: é gratuito para projetos públicos (ou 33 horas/mês para repositórios privados, com conta uma free)

Automatize, personalize e execute seus fluxos de trabalho de desenvolvimento do software diretamente no seu repositório com o GitHub Actions. Você pode descobrir, criar e compartilhar ações para realizar qualquer trabalho que desejar, incluindo CI/CD, bem como combinar ações em um fluxo de trabalho completamente personalizado. [Documentação do GitHub Actions - GitHub Docs]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
name: Docker Image CI - Github Actions

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/[email protected]
    - name: Build the Docker image
      run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

O exemplo acima descreve um workflow para o Github Actions onde, intuitivamente, pode-se perceber que uma tarefa (job) será realizada: Testar se o arquivo Dockerfile consegue ser executado para geração de uma imagem. Caso a linha referente ao comando (run) não consiga passar no teste, durante a execução do workflow, na seção Actions do repositório, será gerada uma mensagem de erro, além disso, você receberá um e-mail informando que o workflow falhou. O parâmetro on, especifica em que momentos o fluxo será executado. Nesse caso, em todos os git push e abertura de Pull Request na branch master. Existem dezenas de formas de execução de workflows, inclusive eventos que acionam fluxos de trabalho e workflows que ativam outros workflows.

Exemplo de log, na aba Actions, se o workflow executar com sucesso.
Exemplo de log, na aba Actions, se o workflow executar com sucesso.


Como o que foi dito por funcionários do Github, no episódio sobre a temática, no podcast Hipsters ponto tech: “a imaginação é o limite”. Então, pensando nessa amplitude, montei um pipeline CI para gestão de vulnerabilidades de imagens Docker, contemplando as seguintes ações:

  1. Teste de build em um Dockerfile;

  2. Entrega da imagem (push) para um registry;

  3. Análise agendada de vulnerabilidades (incluindo Lint) nas versões de softwares e sistemas operacionais base, contidos na imagem gerada no passo anterior;

  4. Abertura automática de uma issue no repositório, com a descrição da(s) vulnerabilidade(s).

  5. Notificação automática, na forma de comentário na issue aberta no passo anterior, citando membros específicos do projeto, responsáveis por resolver esse tipo de tarefa.

Será que é possível fazer tudo isso, de forma automatizada? Acompanhe…

Pipeline CI - Unindo tudo

Após criar o repositório e adicionar um arquivo Dockerfile, crie o diretório .github/workflows, e dentro dele, crie o arquivo pipelineci-vulnerability.yml e adicione a seguinte descrição:

O workflow acima define: Se o teste de build da imagem passar com sucesso (job test), faça um push na mesma (job push), usando o registry do github (Github Container Registry), então, caso esse passo termine com sucesso, baixe a imagem e a escaneie por vulnerabilidades (job scan). Esse workflow irá ser executado em todo push e Pull Request na branch master, sendo que, obviamente, o job push somente irá ser ativado caso não seja um evento Pull Request (linha 40 - você não quer enviar uma imagem possivelmente quebrada para o registry, né?).

Antes de enviar este arquivo para o repositório, você terá que criar um token para que, durante a execução do workflow, o job consiga se logar ao Github Container Registry (no ato do push). Então, terá que criar um Personal Token Access (PAT), porque este serviço - diferentemente do GitHub Packages - não permite autenticação com o token GITHUB_TOKEN. Clique aqui para seguir o passo a passo de criação do token PAT. Coloque o nome como CR_PAT e nas permissões marque read:packages and write:packages. Copie esse token, pois iremos usar no próximo passo.

Após o token criado e copiado, você terá que adicioná-lo como segredo criptografado, na opção Secrets, dentro do repositório em questão. O recurso Secrets basicamente é uma forma segura que o Github criou para o runner, que está trabalhando em um workflow, conseguir usar variáveis contendo conteúdo sensível, como senhas e chaves privadas, sem precisar ser declarada em texto plano, dentro do mesmo arquivo yml do workflow. Nesse caso, somente o Github terá acesso à chave definida. Então, vá na página do repositório, clique em Settings > Secrets > New Secret. Defina o nome CR_PAT e cole o token copiado no passo anterior. Aqui contém os passos para criação de uma variável Secrets.

Token criado e adicionado como variável CR_PAT em Secrets.
Token criado e adicionado como variável CR_PAT em Secrets.


A ferramenta que faz o papel de scanner de vulnerabilidades em containers se chama Trivy, e eu usei esta implementação, disponível no marketplace do Github, através da chamada na linha 91. Além de ela realizar o scan, automaticamente também reporta a informação, através da abertura de uma issue. Definição de outros parâmetros de entrada podem ser conferidos na documentação.

Agora, imaginemos que o tempo para atualização desta imagem no repositório seja longo, e que poucas PRs sejam abertas pela equipe ou comunidade. Como consequência, todos (mantenedores e usuários da ferramenta) ficarão um bom tempo sem ter noção de vulnerabilidades novas, que surgem ao longo do tempo. O que fazer para resolver isso?

Criar um novo workflow, mas agora agendado a partir de um cron (semanal). Então, crie um novo arquivo chamado scan-agendado.yml, também na pasta .github/workflow/, com o seguinte conteúdo:

Basicamente, nesse passo, eu copiei o job scan do primeiro workflow e alterei o parâmetro on, agora para agendamento semanal, e caso encontre alguma vulnerabilidade, além de criar uma issue, vai comentá-la, citando um membro responsável, através do envio de um payload usando o comando curl (nesse caso, citei eu mesmo @marlluslustosa - linha 46). Agora, toda manhã de segunda-feira, um novo scan será feito e uma possível nova notificação será enviada ao responsável - para começar a semana ativo!! rsrs

Adicionei esses mesmos arquivos em um repositório de exemplo. E aqui estão os logs de execução do workflow, referente ao arquivo pipelineci-vulnerability.yml. Na aba Actions do mesmo repositório, verá o workflow referente ao arquivo scan-agendado.yml.

Neste commit, fiz um teste usando uma imagem insegura do mariadb-client, que usa como base o alpine 3.3, que contém sérias vulnerabilidades de segurança. O resultado foi a criação de uma issue e, logo em seguida, o comentário nela, citando meu usuário. A issue pode ser conferida aqui: Alerta de segurança · Issue #44 · marlluslustosa/onionize-docker · GitHub.

Bem, é isso. Como você pôde perceber, a imaginação é realmente o limite, para quem quer utilizar CI/CD com testes automatizados relacionados à análise de segurança de artefatos gerados em imagens Docker, utilizando o Github Actions como única ferramenta e usando uma linguagem declarativa, o que facilita ainda mais o entendimento de todo o pipeline, da prototipação do código, criação da infraestrutura à gestão da segurança (popularmente aglutinados no termo DevSecOps).

Conjunto DevSecOps.
Conjunto DevSecOps.


Dúvida nos comentários!
Um abraço.
:)