Crie a sua primeira integração personalizada

Compatível com:

Google secops SOAR

Este documento explica como criar uma integração personalizada no ambiente de desenvolvimento integrado (IDE) com a mesma estrutura das integrações comerciais. As integrações personalizadas aparecem no Google Security Operations Marketplace, onde pode configurá-las para diferentes ambientes a usar em manuais de procedimentos, ações manuais e agentes remotos. Também pode importá-los e exportá-los, como outros itens do IDE.

Neste exemplo de integração personalizada, vai criar uma integração personalizada para o produto da API WHOIS XML. Comece por criar a sua primeira integração, incluindo o processo de registo no produto WHOIS, o registo no produto e a criação da chave da API necessária.

Escolha o produto com o qual pretende fazer a integração

1. Neste exemplo, vai integrar-se com o produto API XML WHOIS, uma ferramenta de código aberto gratuita que fornece acesso à API a dados de domínio, incluindo o nome do solicitador, a organização, o endereço de email, a morada de registo, as informações do registador, as datas de criação, expiração e atualização do domínio, a disponibilidade e a idade do domínio.
2. Aceda a WHOIS XML API/ e registe-se.
3. Depois de iniciar sessão, obtenha a chave da API na página da sua conta: https://user.whoisxmlapi.com/products
4. Use esta chave da API nos parâmetros de integração.

Crie a primeira integração personalizada no IDE

Para criar a sua primeira integração personalizada no IDE, siga estes passos:

1. Na página Resposta > IDE, clique em adicionar Adicionar para adicionar um novo item do IDE.
2. Selecione o botão de opção Integração e introduza um nome para a integração.
3. Clique em Criar. A integração aparece com um ícone de integração personalizado.
4. Clique em Definições.
5. Na caixa de diálogo de integração, defina o Ícone, a Descrição, as Dependências do Python e os Parâmetros de integração.
   Neste exemplo, são apresentados os seguintes detalhes:
• É carregada uma imagem do logótipo da WhoisXML API. Esta imagem aparece no Google SecOps Marketplace com a integração.
• Foi adicionado um ícone SVG junto à integração no IDE com uma breve descrição e um parâmetro, a chave da API. Este é o parâmetro que o produto API XML Whois requer para a configuração da integração.
• Não precisa de bibliotecas Python adicionais para esta integração. Por predefinição, a integração está definida para ser executada no Python 3.7, e pode alterar a versão nas Definições.
Nota: as dependências de scripts são bibliotecas Python que a sua integração personalizada tem de importar. Pode adicioná-los em formatos como ficheiros Wheel (`WHL`), ficheiros tarball (`TAR`), arquivos Gzip (`GZ`) ou ficheiros Python (`PY`). Cada integração é executada no seu próprio ambiente virtual, o que lhe permite incluir versões específicas de bibliotecas, mesmo que já esteja instalada uma versão diferente no sistema. Por exemplo, se precisar de uma versão específica da biblioteca de pedidos, transfira-a de uma fonte fidedigna (como o PyPI ou o GitHub) e adicione-a às dependências do script. Se a dependência não estiver no ambiente virtual, a integração usa a versão instalada no sistema.

Configure a instância predefinida

Depois de criar a integração, pode vê-la nas integrações de resposta do Google SecOps (pesquise o nome da integração na barra de pesquisa ou filtre o tipo de integração por Integrações personalizadas) com a imagem, a descrição e o parâmetro que definiu para a integração.

1. Clique em Definições > Configurar uma instância predefinida.
2. Introduza a chave da API e clique em Guardar.
3. Opcional: para configurar a integração para outro ambiente (que não o ambiente predefinido), clique no separador Configurar e defina os parâmetros para essa instância.
Nota: tem de criar uma ação Ping para que o botão de teste incorporado funcione.

Crie uma ação de ping

1. No Response > IDE, clique em add Adicionar > Adicionar novo item do IDE.
2. Selecione o botão de opção Ação, introduza um nome e selecione a integração.
3. Clique em Criar. Reveja o modelo de código gerado.
4. Copie o seguinte código para a ação Ping. A ação Ping usa o parâmetro API Key que configurou para a integração e coloca-o no URL fornecido pelo produto para fins de teste. Para ver detalhes, consulte o artigo Crie ações personalizadas.

from SiemplifyAction import SiemplifyAction
from SiemplifyUtils import output_handler
import requests

INTEGRATION_NAME = "My first Integration - Whois XML API"
SCRIPT_NAME = "Whois XML API Ping"

@output_handler
def main():
    siemplify = SiemplifyAction()
    siemplify.script_name = SCRIPT_NAME

    api_key = siemplify.extract_configuration_param(provider_name=INTEGRATION_NAME,
                                                    param_name="API Key")
    url = "https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey={api_key}&domainName=google.com".format(api_key=api_key)

    res = requests.get(url)
    res.raise_for_status()

    if "ApiKey authenticate failed" in res.content.decode("utf-8"):
        raise Exception("Error, bad credentials")

    siemplify.end("Successful Connection", True)
if __name__ == "__main__":
    main() 

5. Clique no botão acima da ação e, de seguida, em Guardar para testar a ligação ao produto.
6. Aceda ao Google SecOps Marketplace, clique em Configurar instância predefinida e certifique-se de que a integração está configurada e guardada.
7. Clique em Testar para testar a integração. Uma associação bem-sucedida apresenta uma marca de verificação verde. Uma associação falhada apresenta um X com o erro associado.
8. Depois de concluir a autenticação, crie a sua primeira ação personalizada na integração personalizada. Para ver detalhes, consulte o artigo Crie ações personalizadas.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.