TLS-Scanner

O TLS-Scanner é uma ferramenta para auxiliar pentesters e pesquisadores de segurança na avaliação de configurações de servidores e clientes TLS.

Observação: O TLS-Scanner é uma ferramenta de pesquisa destinada a desenvolvedores TLS, pentesters, administradores e pesquisadores. Não possui GUI. Está na primeira versão e pode conter alguns bugs.

Compilação

Para compilar e usar o TLS-Scanner, você precisa executar:

$ cd TLS-Scanner
$ git submodule update --init --recursive
$ mvn clean package

Alternativamente, se estiver com pressa, pode pular os testes usando:

$ mvn clean package -DskipTests=true

Se você quiser usar o TLS-Scanner como biblioteca, precisa instalá-lo com o seguinte comando:

$ mvn clean install

Executando

Para executar o TLS-Scanner, você precisa executar um dos arquivos jar na pasta apps/. Eles podem ser obtidos compilando o aplicativo você mesmo ou baixando os arquivos jar lançados do GitHub.

$ java -jar apps/TLS-Server-Scanner.jar -connect localhost:4433

Parâmetros Importantes

Você deve especificar um host que deseja escanear com o parâmetro -connect.

Se você quiser melhorar o desempenho do escaneamento, pode usar o parâmetro -threads para aumentar o número de threads usadas.

Outro parâmetro importante por razões de desempenho é o parâmetro -scanDetail, que pode ser usado para configurar o quão detalhado você deseja escanear. Os valores possíveis variando de rápido a muito detalhado são: QUICK, NORMAL, DETAILED, ALL.

O detalhe da saída pode ser configurado com o parâmetro -reportDetail. Para ver mais detalhes sobre as Diretrizes, use -reportDetail ALL.

Por padrão, os resultados são escritos apenas no console. Se você quiser uma saída legível por máquina, pode usar -outputFile output.json para escrever automaticamente os resultados em um arquivo JSON.

Casos de Uso

Os parâmetros mais importantes para alterar são -scanDetail e -reportDetail. A seguir, explicamos alguns casos de uso para esses parâmetros.

Escaneamento Padrão

Para a maioria dos casos, nossas configurações de parâmetros padrão são suficientes. Isso realiza um escaneamento com ambos os níveis de detalhe definidos como NORMAL.

Escaneamento Rápido

Se você quiser realizar um escaneamento rápido e obter uma visão geral rápida do seu sistema, recomendamos usar ambos os níveis de detalhe definidos como QUICK. Isso limita a extensão de algumas sondas executadas para reduzir o tempo de execução e limita o detalhe do relatório para não incluir informações muito detalhadas e técnicas.

Escaneamento Detalhado

Se você quiser avaliar completamente o seu sistema e executar tudo o que temos, recomendamos usar ambos os níveis de detalhe definidos como ALL. Isso executa todas as sondas existentes completamente e imprime informações muito detalhadas para análise e avaliação adicionais.

Todos os Parâmetros

Para obter informações detalhadas sobre todos os parâmetros possíveis, use o parâmetro -help ou execute o jar sem definir nenhum parâmetro.

Docker

Fornecemos imagens docker pré-construídas para facilitar o uso do TLS-Server-Scanner.

$ docker run -it --network host ghcr.io/tls-attacker/tlsscanner -connect localhost:4433

A imagem foi feita para ser usada para escaneamento de servidores, mas também contém os outros arquivos jar. Eles podem ser acessados alterando o entrypoint.

$ docker run -it --network host --entrypoint java ghcr.io/tls-attacker/tlsscanner -jar TLS-Client-Scanner.jar

Também fornecemos um Dockerfile para que você mesmo construa o contêiner:

$ docker build . -t tlsscanner
$ docker run -t tlsscanner

Observação: Não estou de forma alguma familiarizado com as melhores práticas do Docker. Se você sabe como melhorar o Dockerfile, fique à vontade para abrir um pull request

Sistema de Requisitos

As sondas (TLS) às vezes têm pré-requisitos necessários para executar esta sonda específica. O sistema de requisitos permite definir conjuntos de tais requisitos que devem ser atendidos para que a sonda seja executada.

Cada requisito oferece uma função evaluate que retorna um valor booleano indicando se o requisito foi atendido. Os requisitos podem ser concatenados de várias maneiras usando operações lógicas conhecidas. Cada requisito oferece métodos de instância and, or, not e xor para encadear vários requisitos. As seguintes sondas estão atualmente implementadas e podem ser usadas diretamente:

• FulfilledRequirement - Sempre avalia para true, útil para indicar nenhum requisito.
• UnfulfillableRequirement - Sempre avalia para false, impede a execução de sondas.
• ProbeRequirement - Avalia para true se a(s) sonda(s) especificada(s) foi(ram) executada(s).
• PropertyRequirement - Avalia para true se as propriedades analisadas especificadas têm um valor predefinido. O valor pode ser fornecido como um parâmetro do construtor ou pode-se usar PropertyTrueRequirement e PropertyFalseRequirement como atalho para TestResults.TRUE e TestResults.FALSE.
• PropertyComparatorRequirement - Avalia para se o resultado da coleção de uma propriedade analisada é menor, igual ou maior que um valor constante.

Além desses requisitos predefinidos, pode-se também estender a classe Requirement anonimamente dentro do método getRequirements. Se nada for necessário, você pode retornar um FulfilledRequirement que sempre avalia para true.

Exemplos de como usar requisitos podem ser encontrados nos pacotes probe do tls-client-scanner e tls-server-scanner.

@Override
public Requirement<ClientReport> getRequirements() {
    return new ProbeRequirement<ClientReport>(TlsProbeType.CIPHER_SUITE)
            .and(new PropertyTrueRequirement<>(TlsAnalyzedProperty.SUPPORTS_DHE));
}