Skip to main content

SDK Python para a API da QuimeraX

Project description

SDK QuimeraX

Este é um SDK em Python para interagir com a API da QuimeraX.

Instalação

pip3 install quimerax

Uso

import quimerax

# Configuração do SDK
config = quimerax.QuimeraXConfig(
    team_id="seu_team_id",
    hash_key="seu_hash_key"
)

# Inicialização do SDK
sdk = quimerax.QuimeraXSDK(config)

# Exemplos de uso

# Listar vulnerabilidades
vulnerabilities = sdk.list_asset_vulnerabilities(
    status=[quimerax.VulnerabilityStatus.OPEN],
    severity=[quimerax.Severity.HIGH],
    domain_id=["123"],
    title="exemplo"
)

# Mostrar detalhes de uma vulnerabilidade
vulnerability = sdk.show_asset_vulnerability("vulnerability_id")

# Atualizar status de uma vulnerabilidade
sdk.update_vulnerability_status(
    "vulnerability_id",
    quimerax.VulnerabilityStatus.FIXED,
    "Vulnerabilidade corrigida pelo time de DevOps"
)

# Listar takedowns
takedowns = sdk.list_takedowns()

# Mostrar detalhes de um takedown
takedown = sdk.show_takedown("takedown_id")

# Armazenar histórico de takedown
sdk.store_takedown_history(
    "takedown_id",
    quimerax.TakedownStatus.IN_PROGRESS,
    "Takedown em andamento"
)

# Listar cartões comprometidos
compromised_cards = sdk.list_compromised_cards()

# Atualizar status de um cartão comprometido
sdk.update_compromised_card_status(
    "card_id",
    quimerax.VulnerabilityStatus.FIXED
)

# Mostrar detalhes de um phishing
phishing = sdk.show_phishing("phishing_id")

# Obter detalhes de fraude relacionado a marca
brand_details = sdk.get_brand_details(
    domain="exemplo.com",
    status="active",
    method="scan",
    detected_at="2024-01-01"
)

# Listar logs de detecção
detection_logs = sdk.list_detection_logs()

# Criar um novo log de detecção
new_log = sdk.create_detection_log(
    domain="exemplo.com",
    status=quimerax.DetectionLogStatus.NEW,
    detection_date="2024-01-01",
    detection_method="scan",
    detection_dataset="dataset1",
    active="true",
    scanned="true"
)

# Mostrar detalhes de um log de detecção
log = sdk.show_detection_log("log_id")

# Deletar um log de detecção
sdk.delete_detection_log("log_id")

# Listar logs de detecção de mídia social
social_logs = sdk.list_social_media_detection_logs()

# Criar um novo log de detecção de mídia social
new_social_log = sdk.create_social_media_detection_log(
    detection_date="2024-01-01",
    active="true",
    url="https://exemplo.com/perfil",
    username="usuario",
    platform_name="facebook",
    description="Perfil suspeito"
)

# Mostrar detalhes de um log de detecção de mídia social
social_log = sdk.show_social_media_detection_log("log_id")

# Deletar um log de detecção de mídia social
sdk.delete_social_media_detection_log("log_id")

# Listar violações de terceiros
breaches = sdk.list_breaches_3parties(
    status=quimerax.VulnerabilityStatus.OPEN,
    f="termo_busca"
)

# Alterar status de um ativo vazado
sdk.change_leaked_asset_status(
    "asset_id",
    quimerax.VulnerabilityStatus.FIXED,
    "Senha alterada pelo usuário"
)

# Alterar status de múltiplos ativos vazados
sdk.change_bulk_leaked_asset_status(
    ["asset_id1", "asset_id2"],
    quimerax.VulnerabilityStatus.FIXED
)

# Listar info stealers
info_stealers = sdk.list_info_stealers(
    search="termo_busca",
    status=quimerax.VulnerabilityStatus.OPEN
)

# Alterar status de um info stealer
sdk.change_info_stealer_status(
    "stealer_id",
    quimerax.InfoStealerStatus.FIXED,
    "Info stealer corrigido"
)

# Alterar status de múltiplos info stealers
sdk.change_bulk_info_stealer_status(
    ["stealer_id1", "stealer_id2"],
    quimerax.InfoStealerStatus.FIXED,
    "Info stealers corrigidos em lote"
)

Enums Disponíveis

VulnerabilityStatus

  • OPEN
  • FIXED
  • FALSE_POSITIVE
  • RISK_ACCEPTED
  • REOPENED
  • IN_PROGRESS
  • CLOSED

Severity

  • UNKNOWN
  • INFO
  • LOW
  • MEDIUM
  • HIGH
  • CRITICAL

TakedownStatus

  • REQUESTED
  • COMPLETED
  • IN_PROGRESS
  • FAILED

DetectionLogStatus

  • NEW
  • TRIAGE
  • TAKEDOWN_REQUEST
  • PENDING_TAKEDOWN
  • IN_PROGRESS_TAKEDOWN
  • COMPLETED_TAKEDOWN
  • FAILED_TAKEDOWN
  • ALLOWED
  • CLOSED
  • ACCEPTED_RISK
  • FALSE_POSITIVE
  • RISK_ACCEPTED

InfoStealerStatus

  • OPEN
  • FIXED
  • FALSE_POSITIVE
  • RISK_ACCEPTED
  • REOPENED
  • IN_PROGRESS

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quimerax-0.1.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quimerax-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file quimerax-0.1.0.tar.gz.

File metadata

  • Download URL: quimerax-0.1.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for quimerax-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fdddfdead07bd2195740df51b1d54adce44130ac9546f42fe0c7702f70fec5e9
MD5 441b5b68073840aa3fbe971754117bba
BLAKE2b-256 f10ccf35f31528ec91715754715d886ab7a88703b794bd4192974315a2bac15e

See more details on using hashes here.

File details

Details for the file quimerax-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: quimerax-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for quimerax-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a54b1fcf7c372787162ca73f9d0ebca4a21f3a59ebbd7a78395e1b0437620602
MD5 83f6f110e7f64ad7349a46a9edac1e59
BLAKE2b-256 947a4921b283ae1d59ed22523999a2151e3156b2746fbdb0e4d97aff5e78b033

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page