HASH (Honeypot de Software Agnóstico HTTP)

HASH é um framework para criar e lançar honeypots de baixa interatividade.

🌟 Por que HASH?

A principal filosofia do HASH é ser fácil de configurar e flexível para imitar qualquer software rodando em HTTP/HTTPS. Com a menor pegada possível para evitar ser detectado como honeypot.

⚡ Funcionalidades

• Framework único para implantar honeypots baseados em HTTP/HTTPS
• Facilmente configurável via arquivos YAML
• Honeytraps embutidos
• Randomização poderosa baseada em fakerjs para evitar detecção de honeypot
• Opcionalmente, integração com Datadog para ingerir e analisar logs de honeypots e requisições HTTP através do APM

🚀 Primeiros Passos

HASH é construído usando Node.js mas pode imitar qualquer linguagem/servidor baseado na web dependendo da configuração. Leia a documentação completa abaixo.

Instalação

Você pode Instalar via NPM

npm install -g hash-honeypot

Ou você pode usar diretamente do docker

docker run --rm ghcr.io/datadog/hash help

Uso

Gerar perfil de honeypot

HASH usa arquivos YAML para configurar como simular o software desejado. A estrutura típica para a pasta de perfil é a seguinte

|____templates
|     |____resources
|     |     |____index.html
|     |     |____style.css
|     |     |____favicon.ico
|     |____404.yaml
|     |____default.yaml
|____init.yaml

Você pode construir você mesmo ou gerar usando o comando generate

Usage: HASH generate [options] <folder>

Generate honeypot profile

Arguments:
  folder                         path/to the app

Options:
  -t --template <template_name>  base template (default: "default")
  -n --name <honeypot_name>      Honeypot name
  -s --swagger <swagger_file>    Path to swagger file to convert
  -h, --help                     display help for command

Exemplo

hash-honeypot generate myhoneypot --name my-honey-pot --template default

Você também pode converter arquivos swagger para honeypot diretamente do comando generate

Exemplo convertendo arquivo(s) swagger para honeypot

hash-honeypot generate sample-swagger2 -n sample -s ./test-swagger/test-swagger.yaml

Executando o honeypot

Usage: HASH run [options] <folder>

Run HASH

Arguments:
  folder                     path/to the template folder

Options:
  -l, --log <transport>      logging transport (default: "console,file,datadog")
  -f, --log_file <filename>  logging filename (default: "hash.log")
  -h, --help                 display help for command

exemplo

hash-honeypot my-honeypot-profile -l file -f ./logs/hash.log

Se você estiver usando Datadog para logs, certifique-se de exportar a chave da API do Datadog export DD_API_KEY=<your-api-key>

Personalização e configuração

Você pode personalizar seu perfil de honeypot como quiser

Exemplo de template de requisição:

id: sqli-error
info:
    title: 'SQL error honeytrap'
requests:
    - isTrap: false
      expect:
          method: GET
          path: '/author/:Id([0-9]+)'
      reply:
          status: 200
          headers:
              content-type: 'text/html'
          body:
              view: 'author.html'
    - isTrap: true
      expect:
          method: GET
          path: '/author/:Id'
      reply:
          status: 500
          headers:
              content-type: 'text/html'
          body:
              contents: "You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '' at line 2"

Leia a referência de configuração aqui ou veja os exemplos aqui.

Trabalhos futuros

• Criar pasta de exemplos para mostrar funcionalidades do HASH
• Capacidade de importar formatos de documentação de API (swagger, etc.)
• Empacotar hash como módulo para distribuição mais fácil
• Adicionar capacidades para interações médias
• Adicionar honeytraps populares
• Adicionar testes unitários e de integração

Licença e Contribuição

Lançado sob a licença Apache-2.0, contribuições são bem-vindas!

Contato

Sinta-se à vontade para abrir uma issue ou entrar em contato pelo [email protected].