Censys Python Library

[!WARNING] УВЕДОМЛЕНИЕ ОБ УСТАРЕВАНИИ: API Censys Search v1 и v2 скоро будут объявлены устаревшими. Пожалуйста, перейдите на новую платформу Censys.

• 📖 Новая документация API: https://docs.censys.com/reference/get-started#/
• 📦 Новый Python SDK: Установка с помощью pip install censys-platform — https://pypi.org/project/censys-platform/
• 🖥️ Новый CLI-инструмент (cencli): https://docs.censys.com/docs/platform-cli
  • ⚠️ Если вы планируете использовать новый CLI, вам необходимо сначала удалить CLI этого пакета, так как оба используют имя команды censys

API Censys ASM в этой библиотеке НЕ являются устаревшими и будут продолжать поддерживаться.

Простая и лёгкая обёртка API для Censys API (censys.io). Поддерживается Python 3.8+. Библиотека протестирована на Python 3.8 и 3.x (в настоящее время версия 3.10).

Возможности

• Поиск данных Censys
• Массовый просмотр сертификатов
• Загрузка массовых данных
• Управление активами, событиями и сидами в Censys ASM
• Интерфейс командной строки

Начало работы

Библиотеку можно установить с помощью pip.

pip install censys

Для обновления с помощью pip.

pip install --upgrade censys

Также можно установить библиотеку с помощью poetry.

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

При желании вы можете включить автодополнение по табуляции для CLI, добавив эту строку в ваш ~/.bashrc, ~/.zshrc или аналогичный файл.

Обратите внимание, что автодополнение поддерживается для имён полей в команде search.

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

Чтобы настроить учётные данные для поиска, выполните censys config или установите переменные окружения CENSYS_API_ID и 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]

Если у вас есть учётная запись Censys ASM, вы можете настроить учётные данные ASM, выполнив censys asm config или установив переменную окружения CENSYS_ASM_API_KEY.

$ censys asm config

Censys ASM API Key: XXX
Do you want color output? [y/n]: y

Successfully authenticated

Примеры

Примеры, расположенные в каталоге examples/, — отличное место для начала. Больше примеров можно найти в документации по использованию.

Документация

Ресурсы

• Исходный код
• Трекер задач
• Журнал изменений
• Документация
• Обсуждения
• Домашняя страница Censys
• Поиск Censys

Вклад

Все вклады (независимо от размера) всегда приветствуются. См. Contributing to Censys Python

Разработка

В этом проекте используется poetry для управления зависимостями. Убедитесь, что у вас установлена последняя версия.

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

Тестирование

# Запуск тестов
poetry run pytest
# С отчётом о покрытии
poetry run pytest --cov-report html

Лицензия

Это программное обеспечение лицензировано в соответствии с Apache License, Version 2.0

• Copyright (C) 2024 Censys, Inc.