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)에서 테스트되었습니다.

기능

• 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

선택적으로, 이 줄을 ~/.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 홈페이지
• Censys 검색

기여하기

작은 기여라도 언제나 환영합니다. 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에 따라 라이선스가 부여됩니다.

• 저작권 (C) 2024 Censys, Inc.