Um wrapper de API leve e fácil de usar para APIs Censys (censys.io). Atualmente, Python 3.8+ é compatível. Esta biblioteca foi testada em Python 3.8 e 3.x (atualmente versão 3.10).
Aviso: os endpoints v1 do Censys Search foram descontinuados em 30 de novembro de 2021. Comece a usar endpoints v2 para consultar hosts e certificados e verifique nosso centro de suporte para obter recursos.
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 ativar o preenchimento de tabulação para a CLI adicionando esta linha ao seu ~/.bashrc
, ~/.zshrc
ou equivalente.
Observe que o preenchimento automático é compatível com nomes de campos no comando
search
.
eval " $( register-python-argcomplete censys ) "
Para configurar suas credenciais de pesquisa, execute censys config
ou defina as variáveis de ambiente CENSYS_API_ID
e CENSYS_API_SECRET
.
$ censys config
Censys API ID: XXX
Censys API Secret: XXX
Do you want color output ? [y/n]: y
Successfully authenticated for [email protected]
Se você tiver uma conta Censys ASM, poderá configurar suas credenciais ASM executando censys asm config
ou definir ambas as variáveis de ambiente CENSYS_ASM_API_KEY
.
$ censys asm config
Censys ASM API Key: XXX
Do you want color output ? [y/n]: y
Successfully authenticated
Os exemplos localizados no diretório examples/
são um ótimo lugar para começar. Você também pode encontrar mais exemplos na documentação de uso.
Todas as contribuições (por menores que sejam) são sempre bem-vindas. Consulte Contribuindo para o Censys Python
Este projeto usa poesia 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
# Run tests
poetry run pytest
# With coverage report
poetry run pytest --cov-report html
Este software está licenciado sob licença Apache, versão 2.0