Biblioteca Python do Censys

[!WARNING] AVISO DE OBSOLESCÊNCIA: As APIs Censys Search v1 e v2 serão descontinuadas em breve. Por favor, migre para a nova Plataforma Censys.

• 📖 Nova Documentação da API: https://docs.censys.com/reference/get-started#/
• 📦 Novo SDK Python: Instale com pip install censys-platform - https://pypi.org/project/censys-platform/
• 🖥️ Nova Ferramenta CLI (cencli): https://docs.censys.com/docs/platform-cli
  • ⚠️ Se você planeja usar a nova CLI, precisará desinstalar a CLI deste pacote primeiro, já que ambas usam o nome de comando censys

As APIs Censys ASM nesta biblioteca NÃO estão obsoletas e continuarão sendo suportadas.

Um wrapper de API leve e fácil de usar para as APIs Censys (censys.io). Python 3.8+ é atualmente suportado. Esta biblioteca foi testada no Python 3.8 e 3.x (atualmente versão 3.10).

Funcionalidades

• Pesquisar dados Censys
• Consultas em massa de certificados
• Baixar dados em massa
• Gerenciar ativos, eventos e seeds no Censys ASM
• Interface de linha de comando

Primeiros Passos

A biblioteca pode ser instalada usando pip.

pip install censys

Para atualizar usando pip.

pip install --upgrade censys

Alternativamente, você pode instalar a biblioteca usando poetry.

git clone https://github.com/censys/censys-python.git
cd censys-python/
poetry install

Opcionalmente, você pode habilitar o preenchimento automático (tab completion) para a CLI adicionando esta linha ao seu ~/.bashrc, ~/.zshrc ou equivalente.

Observe que o autocomplete é suportado para nomes de campos no comando search.

eval "$(register-python-argcomplete censys)"

Para configurar suas credenciais de pesquisa, execute censys config ou defina ambas as variáveis de ambiente CENSYS_API_ID e CENSYS_API_SECRET.

$ censys config

ID da API Censys: XXX
Segredo da API Censys: XXX
Você quer saída colorida? [s/n]: y

Autenticado com sucesso para [email protected]

Se você tem uma conta Censys ASM, pode configurar suas credenciais ASM executando censys asm config ou definindo a variável de ambiente CENSYS_ASM_API_KEY.

$ censys asm config

Chave da API ASM Censys: XXX
Você quer saída colorida? [s/n]: y

Autenticado com sucesso

Exemplos

Os exemplos localizados no diretório examples/ são um ótimo ponto de partida. Você também pode encontrar mais exemplos na documentação de uso.

Documentação

Recursos

• Código Fonte
• Rastreador de Problemas
• Histórico de Mudanças
• Documentação
• Discussões
• Página Inicial do Censys
• Pesquisa Censys

Contribuindo

Todas as contribuições (por menores que sejam) são sempre bem-vindas. Veja Contribuindo para o Censys Python

Desenvolvimento

Este projeto usa poetry para gerenciamento de dependências. Certifique-se de ter instalado a versão mais recente.

git clone [email protected]:censys/censys-python.git
cd censys-python/
poetry install

Testes

# Run tests
poetry run pytest
# With coverage report
poetry run pytest --cov-report html

Licença

Este software é licenciado sob a Apache License, Versão 2.0

• Copyright (C) 2024 Censys, Inc.