Skip to content

Latest commit

 

History

History
319 lines (245 loc) · 13.2 KB

README.md

File metadata and controls

319 lines (245 loc) · 13.2 KB

pentest-dotfiles

License Last commit Bash Go Python Git Vim Kali Linux Ubuntu Debian

Dotfiles + bootstrap de ferramentas pra deixar uma VM nova (Kali, Ubuntu ou Debian) pronta pra pentest rápido, num único comando.

Uso restrito a máquinas próprias, labs de estudo (OSCP, HTB, Solyd, Exploit Mind) e engajamentos com autorização formal. As ferramentas aqui são as mesmas usadas no dia a dia de qualquer pentester — o script só automatiza a instalação delas.

Tags: pentest · dotfiles · bash · kali-linux · ubuntu · debian · recon · osint · web-security · active-directory · ctf · oscp · bootstrap · vim · golang · pipx

Tecnologias

Camada Tecnologia Uso no projeto
Linguagem Bash install.sh, módulos em scripts/ e lib.sh (instalador modular e idempotente)
Sistemas Kali Linux, Ubuntu, Debian detecção automática da distro (detect_os) e ajuste dos pacotes
Pacotes apt, .deb e releases do GitHub nmap, rustscan (.deb), feroxbuster (apt ou release), hashcat, john, Chromium e dependências base
Ferramentas Go Go (go install) subfinder, httpx, naabu, nuclei, katana, gau, waybackurls, amass, ffuf, gobuster, aquatone → ~/go/bin
Ferramentas Python Python 3 + pipx impacket, bloodhound-python, netexec, enum4linux-ng em venvs isoladas → ~/.local/bin
Código-fonte Git SecLists e sqlmap clonados em /opt e /usr/share/wordlists; versionamento dos dotfiles
Editor Vim + Vundle .vimrc com vim-fugitive, vim-airline e o tema xoria256
Navegador headless Chromium dependência do aquatone para screenshots
Dotfiles symlinks .vimrc, .bashrc e .gitconfig ligados a partir de config/ (com backup do arquivo anterior)

Uso rápido numa VM nova

git clone https://github.com/s3mPr1linux/PENTEST_DOTFILES.git 
cd ~/PENTEST_DOTFILES
chmod +x install.sh scripts/*.sh
./install.sh --all

Depois é só abrir um shell novo (ou source ~/.bashrc) pra tudo entrar no PATH.

Instalação seletiva

./install.sh --recon        # nmap, rustscan, subfinder, amass, httpx, naabu, nuclei, katana, gau, waybackurls, aquatone
./install.sh --webapp       # ffuf, gobuster, feroxbuster, sqlmap
./install.sh --ad           # impacket, bloodhound-python, netexec, enum4linux-ng
./install.sh --wordlists    # SecLists, rockyou.txt, hashcat, john
./install.sh --dotfiles     # .vimrc / .bashrc / .gitconfig + Vundle

# combina o que quiser:
./install.sh --recon --webapp --dotfiles

Flags e módulos ativados

Cada flag ativa uma função install_*, definida em um arquivo de scripts/. Em qualquer modo de instalação, antes dos módulos, sempre rodam detect_os (identifica a distro) e base_packages (git, curl, wget, jq, build-essential, python3/pip/venv, unzip) — definidos no próprio install.sh.

Flag Módulos ativados (função → arquivo) Ferramentas
(base, sempre) detect_os + base_packages → install.sh git, curl, wget, jq, build-essential, python3/pip/venv, unzip
--recon install_recon_osint → scripts/10-recon-osint.sh nmap, rustscan, subfinder, amass, httpx, naabu, nuclei (+ templates), katana, gau, waybackurls, aquatone (+ Chromium)
--webapp install_webapp → scripts/20-webapp.sh ffuf, gobuster, feroxbuster, sqlmap
--ad install_ad_windows → scripts/30-ad-windows.sh impacket, bloodhound-python, netexec, enum4linux-ng
--wordlists install_wordlists_cracking → scripts/40-wordlists-cracking.sh SecLists, rockyou.txt, hashcat, john
--dotfiles install_dotfiles → scripts/90-dotfiles.sh .vimrc, .bashrc, .gitconfig, Vundle + plugins
--all todos os acima: recon + webapp + ad + wordlists + dotfiles tudo
--check nenhum — não instala, só valida (ver seção Validação) —
-h, --help nenhum — imprime a ajuda e sai —

Combinando flags, os módulos rodam sempre nesta ordem fixa, independente da ordem em que você passa: recon → webapp → ad → wordlists → dotfiles. Exemplos:

  • --all → base + os 5 módulos
  • --recon --webapp → base + recon + webapp (SecLists não entra; ele está em --wordlists)
  • --wordlists → base + wordlists (é o único que traz o SecLists)

Como funciona

install.sh é só o orquestrador. Ele faz source dos módulos em scripts/ (cada um expõe uma função install_*) e, conforme as flags, chama as que você pediu. A lógica comum — detecção de distro, apt, go install, pipx, clone em /opt — mora em scripts/lib.sh.

Fluxo de um --all:

  1. detect_os — identifica Kali / Debian / Ubuntu
  2. base_packages — git, curl, python3, build-essential, etc.
  3. install_<módulo> — um por módulo selecionado
  4. summary — lista rápida [ok]/[--] do que caiu no PATH

Cada método instala num lugar diferente, e é por isso que você precisa abrir um shell novo (ou source ~/.bashrc) depois de instalar:

Método Destino Exemplos
apt / .deb /usr/bin nmap, rustscan, feroxbuster, hashcat, john
go install ~/go/bin subfinder, httpx, nuclei, naabu, katana…
pipx ~/.local/bin impacket, netexec, enum4linux-ng
git + /opt /usr/local/bin (wrapper) sqlmap

O que cada módulo instala

Módulo Ferramentas Como
--recon nmap, rustscan, subfinder, amass, httpx, naabu, nuclei (+ templates), katana, gau, waybackurls, aquatone (+ Chromium) apt + .deb + go install
--webapp ffuf, gobuster, feroxbuster, sqlmap go install + apt/release / git em /opt
--ad impacket, bloodhound-python, netexec, enum4linux-ng pipx
--wordlists SecLists, rockyou.txt, hashcat, john git clone + apt
--dotfiles .vimrc, .bashrc, .gitconfig, Vundle + plugins symlink

Burp Suite não é instalado automaticamente — é GUI com licença própria. Baixe em https://portswigger.net/burp.

Validação

Depois de instalar, confirme o que ficou funcional (não só presente no PATH):

./install.sh --check

O --check não instala nada. Para cada ferramenta ele:

  • procura o binário no PATH — já incluindo ~/go/bin, ~/.local/bin e /usr/local/bin, então funciona mesmo sem reabrir o shell;
  • tenta executá-lo (--version/-version/version/-V, com timeout e stdin fechado) e mostra a versão encontrada;
  • as que não têm flag de versão (ex.: waybackurls, enum4linux-ng) aparecem como presente, sem flag de versão.

No fim imprime um placar Presentes: N/total (com versão confirmada: X). Sai com código 1 se não achar nenhuma ferramenta (sinal de que o install.sh não rodou ou o PATH está errado) e 0 caso contrário — ausências de módulos que você não instalou são normais.

Exemplo de saída:

  [ok]   nmap v7.95  (/usr/bin/nmap)
  [ok]   httpx v1.6.9  (/root/go/bin/httpx)
  [ok]   waybackurls (presente, sem flag de versão)  (/root/go/bin/waybackurls)
  [--]   netexec  (ausente)
[*] Presentes: 12/20  (com versão confirmada: 10)  |  Ausentes: 8

BloodHound GUI (manual)

O script instala só o ingestor (bloodhound-python), que já cobre 90% do uso em campo. Se quiser a interface gráfica pra visualizar o grafo, a forma mais simples é via Docker:

curl -L https://ghst.ly/getbhce -o docker-compose.yml
docker compose up

Isso sobe BloodHound CE + Neo4j já configurados. Acesse em http://localhost:8080.

Estrutura do repo

pentest-dotfiles/
├── install.sh              # entrypoint — parse de flags e orquestração
├── README.md
├── config/
│   ├── vimrc
│   ├── bashrc
│   └── gitconfig
└── scripts/
    ├── lib.sh               # cores, logging, detecção de distro, helpers
    ├── 10-recon-osint.sh
    ├── 20-webapp.sh
    ├── 30-ad-windows.sh
    ├── 40-wordlists-cracking.sh
    └── 90-dotfiles.sh

Adicionando uma ferramenta a um módulo existente

Cada módulo é só uma função bash. Pra adicionar algo no módulo de recon, por exemplo, edita scripts/10-recon-osint.sh e acrescenta:

go_install "github.com/owner/ferramenta@latest" "nome-amigavel"

Ou, pra ferramentas Python:

pipx_install "nome-do-pacote" "nome-amigavel"

Ou pra clonar um repo pra /opt e criar um wrapper em /usr/local/bin (mesmo padrão usado pro sqlmap em scripts/20-webapp.sh).

Adicionando uma categoria (módulo) nova

Isso é diferente do item acima: aqui é pra quando você quer uma flag nova inteira (ex: --mobile, --osint-social, --wireless), não só uma ferramenta a mais dentro de um módulo que já existe.

1. Crie o arquivo do módulo em scripts/. Escolha um prefixo numérico que reflita a ordem de execução — os módulos rodam na ordem dos números, e o 90-dotfiles.sh fica por último de propósito, então qualquer coisa nova costuma ficar entre 40- e 90- (ex: 50-):

#!/usr/bin/env bash
# ============================================================
# 50-nome-da-categoria.sh — descrição curta
# ============================================================
set -uo pipefail
DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck disable=SC1091
source "${DIR}/lib.sh"

install_nome_da_categoria() {
    log_head "Nome da Categoria"

    ensure_go || true                                    # ferramentas Go
    go_install "github.com/owner/tool@latest" "tool"

    ensure_pipx                                           # ferramentas Python
    pipx_install "pacote-pypi" "nome-amigavel"

    apt_refresh_once; apt_install pacote1 pacote2          # pacotes apt

    git_clone_or_update "https://github.com/owner/repo.git" "/opt/repo"  # clonar do zero

    log_ok "Nome da Categoria concluído"
}

2. No install.sh, adicione o source junto dos outros módulos, logo abaixo da declaração de REPO_DIR:

source "${REPO_DIR}/scripts/50-nome-da-categoria.sh"

3. Adicione a flag em três pontos dentro do install.sh:

No usage(), na lista de opções:

  --categoria     Descrição curta do que instala

Na declaração de variáveis dentro de main():

RUN_CATEGORIA=0

No case do parsing de argumentos — e, se quiser que --all já inclua essa categoria, também na linha do --all:

--all)
    RUN_RECON=1; RUN_WEBAPP=1; RUN_AD=1; RUN_WORDLISTS=1; RUN_DOTFILES=1; RUN_CATEGORIA=1
    ;;
...
--categoria) RUN_CATEGORIA=1 ;;

4. Chame a função condicionalmente, junto dos outros [ "$RUN_..." -eq 1 ] && ... dentro de main():

[ "$RUN_CATEGORIA" -eq 1 ] && install_nome_da_categoria

5. (Opcional) Liste as ferramentas novas no summary(), no array tools, pra elas aparecerem no resumo final de "o que ficou disponível".

6. Teste antes de confiar:

chmod +x scripts/50-nome-da-categoria.sh
bash -n scripts/50-nome-da-categoria.sh   # checa sintaxe sem executar
./install.sh --categoria                  # testa isolado, sem rodar tudo de novo

Depois é só atualizar a tabela em "O que cada módulo instala" (mais acima neste README) com a linha da categoria nova.

Antes de usar

No config/gitconfig, troca:

[user]
    name = SEU NOME AQUI
    email = seu.email@exemplo.com

pelos seus dados de verdade — senão seus commits saem assinados errado.

Por que os módulos são idempotentes

Rodar ./install.sh --all de novo numa máquina que já tem tudo instalado não quebra nada: go install e pipx install apenas reinstalam/atualizam a versão mais recente, e git_clone_or_update (em lib.sh) faz git pull em vez de clonar de novo se o repo já existir. Dá pra rodar como rotina de manutenção pra manter as ferramentas atualizadas.