Bibliothèque Python Censys

[!WARNING] AVIS DE DÉPRÉCIATION : Les API Censys Search v1 et v2 seront bientôt dépréciées. Veuillez migrer vers la nouvelle Plateforme Censys.

• 📖 Nouvelle documentation API : https://docs.censys.com/reference/get-started#/
• 📦 Nouveau SDK Python : Installez avec pip install censys-platform - https://pypi.org/project/censys-platform/
• 🖥️ Nouvel outil CLI (cencli) : https://docs.censys.com/docs/platform-cli
  • ⚠️ Si vous prévoyez d'utiliser le nouvel outil CLI, vous devrez d'abord désinstaller l'outil CLI de ce paquet car les deux utilisent la commande censys

Les API Censys ASM de cette bibliothèque NE sont PAS dépréciées et continueront d'être prises en charge.

Un wrapper API léger et facile à utiliser pour les API Censys (censys.io). Python 3.8+ est actuellement pris en charge. Cette bibliothèque a été testée sur Python 3.8 et 3.x (actuellement la version 3.10).

Fonctionnalités

• Rechercher des données Censys
• Recherche en masse de certificats
• Télécharger des données en masse
• Gérer les actifs, événements et seeds dans Censys ASM
• Interface en ligne de commande

Pour commencer

La bibliothèque peut être installée avec pip.

pip install censys

Pour la mettre à jour avec pip.

pip install --upgrade censys

Alternativement, vous pouvez installer la bibliothèque avec poetry.

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

Optionnellement, vous pouvez activer la complétion par tabulation pour l'interface CLI en ajoutant cette ligne à votre ~/.bashrc, ~/.zshrc, ou équivalent.

Veuillez noter que la complétion automatique est prise en charge pour les noms de champs dans la commande search.

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

Pour configurer vos identifiants de recherche, exécutez censys config ou définissez les variables d'environnement CENSYS_API_ID et 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]

Si vous possédez un compte Censys ASM, vous pouvez configurer vos identifiants ASM en exécutant censys asm config ou en définissant la variable d'environnement CENSYS_ASM_API_KEY.

$ censys asm config

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

Successfully authenticated

Exemples

Les exemples situés dans le répertoire examples/ sont un excellent point de départ. Vous pouvez également trouver plus d'exemples dans la documentation d'utilisation.

Documentation

Ressources

• Source
• Suivi des problèmes
• Journal des modifications
• Documentation
• Discussions
• Page d'accueil Censys
• Recherche Censys

Contribuer

Toutes les contributions (même les plus petites) sont toujours les bienvenues. Voir Contribuer à Censys Python

Développement

Ce projet utilise poetry pour la gestion des dépendances. Assurez-vous d'avoir installé la dernière version.

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

Tests

# Exécuter les tests
poetry run pytest
# Avec rapport de couverture
poetry run pytest --cov-report html

Licence

Ce logiciel est sous licence Apache License, Version 2.0

• Copyright (C) 2024 Censys, Inc.