Censys Python ライブラリ

[!WARNING] 非推奨のお知らせ: Censys Search v1 および v2 API はまもなく非推奨となります。新しい Censys Platform に移行してください。

📖 新しい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 コマンド名を使用するためです。

このライブラリの Censys ASM API は非推奨ではありません。引き続きサポートされます。

Censys API（censys.io）向けの、使いやすく軽量なAPIラッパーです。Python 3.8+ がサポートされています。このライブラリはPython 3.8および3.x（現在のバージョン3.10）でテストされています。

機能

はじめに

ライブラリは pip を使用してインストールできます。

pip install censys

アップグレードするには、pip を使用します。

pip install --upgrade censys

または、poetry を使用してライブラリをインストールすることもできます。

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

必要に応じて、以下の行を ~/.bashrc、~/.zshrc などに追加すると、CLIのタブ補完を有効にできます。

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アカウントをお持ちの場合は、censys asm config を実行するか、CENSYS_ASM_API_KEY 環境変数を設定してASM認証情報を設定できます。

$ censys asm config

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

Successfully authenticated

使用例

examples/ ディレクトリにあるサンプルは、始めるのに最適な場所です。その他のサンプルは使用法ドキュメントにもあります。

ドキュメント

リソース

コントリビューション

すべてのコントリビューション（どんなに小さなものでも）は常に歓迎します。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 の下でライセンスされています。

censys-python

人気