soar_ops module

TIPCommon.soar_ops.create_slo_message

TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])

Recebe mensagens de aviso de SLO com base nos intervalos de tempo e nos comentários existentes.

Para o parâmetro interval_days=[0, 1, 7, 14], a função envia uma mensagem de aviso de que o SLO vai ser violado de acordo com o seguinte agendamento:

  • 7 a 14 dias até à hora de validade.
  • 1 a 7 dias até à hora de validade.
  • Quando o SLO foi violado.

Se um comentário já tiver sido enviado no intervalo com violações atual, não é devolvido nenhum novo comentário (é devolvido None).

Parâmetros
slo int

A data de violação do SLO em microssegundos Unix (por exemplo, 1_673_774_674_567)

interval_days Iterable[int]

Um iterável que contém o número de dias a partir dos quais devem ser enviados avisos de violação de tempo (por exemplo, [0, 1, 3, 7, 14])

existing_comments Iterable[int]

Os comentários existentes para verificar se um comentário já foi enviado.

Aumenta

ValueError- Quando um dos intervalos de tempo é negativo.

Devoluções

O comentário é devolvido, se aplicável. Caso contrário, é devolvido None.

TIPCommon.soar_ops.get_clean_comment_body

TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)

Remove um prefixo da string de comentário ou do objeto de comentário.

Parâmetros
comment str | CaseComment

A string de comentário ou o objeto de comentário do qual remover o prefixo.

prefix str

O prefixo a remover.

Aumenta

TypeError- Quando o tipo de comentário não é str nem CaseComment.

Devoluções

O comentário sem o prefixo.

Tipo devolvido

str

TIPCommon.soar_ops.get_file

TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None

Devolve o conteúdo do ficheiro em bytes.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.

identifier str

O identificador do nome do ficheiro juntamente com o caminho completo.

Devoluções

Dados de bytes do identificador fornecido.

Tipo devolvido

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Devolve a variável de ambiente SECOPS_MODE.

Devoluções

A variável de ambiente SECOPS_MODE.

Tipo devolvido

str | None

TIPCommon.soar_ops.get_soar_case_comments

TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)

Devolve uma lista de objetos de comentários de um registo, usando o respetivo ID.

Parâmetros
chronicle_soar SiemplifyAction | SiemplifyJob

O objeto SDK.

case_id str | int

O ID do registo cujos comentários são obtidos.

Devoluções

Uma lista de objetos de comentários.

Tipo devolvido

list[base.action.CaseComment]

TIPCommon.soar_ops.get_user_by_id

TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None

Obtém um objeto UserProfileCard a partir de um ID do utilizador.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.

user_id str

O ID do utilizador, por exemplo, f6dc053c-58bb-4da5-95bb-739be7d297a2.

Devoluções

O objeto de utilizador, se for encontrado; caso contrário, None.

Tipo devolvido

UserProfileCard | None

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]

Obtém todos os cartões de perfil de utilizador através da paginação. O tamanho da página serve como limite para o número de utilizadores em cada iteração.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.

search_term str

Os termos de pesquisa.

A predefinição é ''.

page_size int

O número de utilizadores a devolver.

A predefinição é 20.

filter_by_role bool

Defina se quer filtrar por função.

A predefinição é False.

filter_disabled_users bool

Defina se quer filtrar os utilizadores desativados.

A predefinição é False.

filter_support_users bool

Defina se quer filtrar os utilizadores do apoio técnico.

A predefinição é False.

fetch_only_support_users bool

Defina se quer devolver apenas utilizadores de apoio técnico.

A predefinição é False.

filter_permission_types list[int] | None

Uma lista de tipos de autorizações de filtros (por exemplo, 0).

A predefinição é None.

Devoluções

Uma lista de todos os utilizadores.

Tipo devolvido

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Verifica se um comentário é um comentário de aviso de SLO.

Um comentário de SLO é um aviso de SLO ("O SLO vai ser violado em {int} dias") ou uma mensagem de SLO violado ("O SLO foi violado").

Parâmetros
comment str

O comentário a verificar.

Devoluções

True se o comentário for um comentário de SLO. Caso contrário, é devolvido False.

Tipo devolvido

bool

TIPCommon.soar_ops.remove_prefix_from_comments

TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)

Remove um prefixo (quando presente) de uma lista de comentários.

Parâmetros
comments list[str]

Os comentários dos quais remover o prefixo.

prefix str

O prefixo a remover.

Devoluções

Uma lista de todos os comentários depois de o prefixo ter sido removido

Tipo devolvido

list[str]

TIPCommon.soar_ops.save_file

TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None

Guarda um ficheiro num Google Cloud contentor ou num caminho local.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.

path str

O caminho da pasta onde os ficheiros devem ser guardados.

name str

O nome do ficheiro a guardar.

content bytes

O conteúdo do ficheiro no formato de bytes.

Devoluções

O caminho para os ficheiros transferidos.

Tipo devolvido

str | None

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