Módulo soar_ops
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 em intervalos de tempo e comentários atuais.
Para o parâmetro interval_days=[0, 1, 7, 14]
, a função envia uma mensagem
avisando que o SLO será violado de acordo com a próxima programação:
- 7 a 14 dias antes do vencimento.
- 1 a 7 dias até o horário de expiração.
- Quando o SLO foi violado.
Se um comentário já tiver sido enviado no intervalo violado atual, nenhum novo comentário será retornado (None
será retornado).
Parâmetros | |
---|---|
slo |
int A data da violação de 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 do envio dos avisos de violação de tempo (por exemplo, [0, 1, 3, 7, 14]) |
existing_comments |
Iterable[int] Os comentários atuais para verificar se um comentário já foi enviado. |
Gera
ValueError
: quando um dos intervalos de tempo é negativo.
Retorna
O comentário será retornado, se aplicável. Caso contrário, None
será retornado.
TIPCommon.soar_ops.get_clean_comment_body
TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)
Remove um prefixo da string ou do objeto de comentário.
Parâmetros | |
---|---|
comment |
str | CaseComment A string ou o objeto de comentário de que o prefixo será removido. |
prefix |
str O prefixo a ser removido. |
Gera
TypeError
: quando o tipo de comentário não é str
nem CaseComment
.
Retorna
O comentário sem o prefixo.
Tipo de retorno
str
TIPCommon.soar_ops.get_file
TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None
Retorna o conteúdo do arquivo em bytes.
Parâmetros
Parâmetros | |
---|---|
chronicle_soar |
ChronicleSOAR Um objeto do SDK do Google Security Operations SOAR. |
identifier |
str O identificador do nome do arquivo junto com o caminho completo. |
Retorna
Dados de bytes do identificador fornecido.
Tipo de retorno
bytes | None
TIPCommon.soar_ops.get_secops_mode
TIPCommon.soar_ops.get_secops_mode()→ str | None
Retorna a variável de ambiente SECOPS_MODE
.
Retorna
A variável de ambiente SECOPS_MODE
.
Tipo de retorno
str | None
TIPCommon.soar_ops.get_soar_case_comments
TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)
Retorna uma lista de objetos de comentários de um caso usando o ID dele.
Parâmetros | |
---|---|
chronicle_soar |
SiemplifyAction | SiemplifyJob O objeto do SDK. |
case_id |
str | int O ID do caso cujos comentários são buscados. |
Retorna
Uma lista de objetos de comentário.
Tipo de retorno
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
Recebe um objeto UserProfileCard de um ID de usuário.
Parâmetros
Parâmetros | |
---|---|
chronicle_soar |
ChronicleSOAR Um objeto do SDK do Google Security Operations SOAR. |
user_id |
str O ID do usuário, por exemplo, |
Retorna
O objeto do usuário, se encontrado. Caso contrário, None
.
Tipo de retorno
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]
Recebe todos os cards de perfil de usuário usando paginação. O tamanho da página serve como limite para o número de usuários em cada iteração.
Parâmetros
Parâmetros | |
---|---|
chronicle_soar |
ChronicleSOAR Um objeto do SDK do Google Security Operations SOAR. |
search_term |
str Os termos de pesquisa. O valor padrão é |
page_size |
int O número de usuários a serem retornados. O valor padrão é |
filter_by_role |
bool Defina se é necessário filtrar por função. O valor padrão é |
filter_disabled_users |
bool Defina se os usuários desativados devem ser filtrados. O valor padrão é |
filter_support_users |
bool Defina se os usuários de suporte serão filtrados. O valor padrão é |
fetch_only_support_users |
bool Defina se você quer retornar apenas usuários de suporte. O valor padrão é |
filter_permission_types |
list[int] | None Uma lista de tipos de permissão de filtro (por exemplo, O valor padrão é |
Retorna
Uma lista de todos os usuários.
Tipo de retorno
list[UserProfileCard]
TIPCommon.soar_ops.is_slo_comment
TIPCommon.soar_ops.is_slo_comment(comment: str)
Verifica se um comentário é um aviso de SLO.
Um comentário de SLO é um aviso de SLO ("O SLO será violado em {int} dias") ou uma mensagem de violação de SLO ("O SLO foi violado").
Parâmetros | |
---|---|
comment |
str O comentário a ser verificado. |
Retorna
True
se o comentário for de SLO. Caso contrário, False
será retornado.
Tipo de retorno
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 de que o prefixo será removido. |
prefix |
str O prefixo a ser removido. |
Retorna
Uma lista de todos os comentários depois que o prefixo foi removido deles.
Tipo de retorno
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
Salva um arquivo em um bucket do Google Cloud ou em um caminho local.
Parâmetros
Parâmetros | |
---|---|
chronicle_soar |
ChronicleSOAR Um objeto do SDK do Google Security Operations SOAR. |
path |
str O caminho da pasta em que os arquivos serão salvos. |
name |
str O nome do arquivo a ser salvo. |
content |
bytes O conteúdo do arquivo em formato de bytes. |
Retorna
O caminho para os arquivos baixados.
Tipo de retorno
str | None
Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.