Módulo OAuth

exception TIPCommon.oauth.AuthenticationError

Bases: Exception

Uma exceção genérica para erros de autenticação.

class TIPCommon.oauth.AuthorizedOauthClient

class TIPCommon.oauth.AuthorizedOauthClient(oauth_manager: OauthManager, *args, **kwargs)

Bases: Client

Essa classe representa um cliente autorizado para chamadas de API.

Métodos

  • close()→ None Salva o token e fecha a sessão do cliente.

  • request(*args, **kwargs)→ Response Substituições para oferecer suporte à atualização automática de credenciais. O método verifica se as credenciais expiraram antes de executar a solicitação e valida a resposta para verificar se credenciais expiradas são indicadas. Se for, ele executa a solicitação novamente com um token atualizado.

class TIPCommon.oauth.CredStorage

class TIPCommon.oauth.CredStorage(encryption_password: str, chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)

Bases: object

Gerencia o armazenamento e a recuperação de credenciais.

Métodos

  • get_instance_identifier()→ str Recebe o identificador da instância do Google SecOps do conector ou da integração.

  • get_token()→ OauthToken | None Extrai e descriptografa um token do banco de dados de contexto.

  • set_token(token: OauthToken)→ None Criptografa e salva um token no banco de dados de contexto.

exception TIPCommon.oauth.EncryptionError

Bases: Exception

Uma exceção genérica para erros de criptografia.

class TIPCommon.oauth.OAuthAdapter

Bases: ABC

Uma classe base abstrata que define a interface para operações do OAuth.

Métodos abstratos

  • abstractcheck_signer(token: OauthToken)→ bool Retorna True se o assinante for válido ou False em qualquer outro caso.

  • abstractprepare_authorized_client(token: OauthToken, auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Define cabeçalhos ou outras configurações necessárias do cliente autorizado.

  • abstractrefresh_token()→ OauthToken Atualiza o token e retorna o modelo de dados OauthToken.

  • abstract static validate_bad_credentials(response: Response)→ bool Verifica se a resposta indica credenciais expiradas.

Gera

AuthenticationError: quando a resposta indica credenciais expiradas.

class TIPCommon.oauth.OauthManager

class TIPCommon.oauth.OauthManager(oauth_adapter: OAuthAdapter, cred_storage: CredStorage)

Bases: object

Gerencia fluxos de autenticação OAuth, incluindo atualização de token e preparação do cliente.

Métodos

  • prepare_authorized_client(auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Prepara um cliente autorizado para uso.

  • refresh_if_bad_credentials(auth_client: AuthorizedOauthClient, response: Response)→ bool Atualiza o token se a resposta indicar credenciais inválidas.

  • refresh_if_expired(auth_client: AuthorizedOauthClient)→ bool Atualiza o token se ele tiver expirado.

  • save_token()→ None Salva o token atual.

class TIPCommon.oauth.OauthToken

class TIPCommon.oauth.OauthToken(access_token: 'str', expiration_time: 'int', refresh_token: 'str' = None, signer: 'str' = None, additional_data: 'SingleJson' = <factory>)

Bases: object

Representa um token OAuth com os dados associados.

Propriedades

Atributo Descrição
access_token str

A string do token de acesso.

additional_data MutableMapping[str, Any]

Dados extras associados ao token.

expiration_time int

O tempo de expiração do token (carimbo de data/hora Unix).

refresh_token str

A string do token de atualização.

O valor padrão é None.

signer str

O signatário do token.

O valor padrão é None.

Métodos

  • to_cache()→ JsonString Serializa o objeto OauthToken em um formato adequado para armazenamento em cache.

classmethod from_cache

classmethod from_cache(raw_data: JsonString)→ OauthToken

Cria um objeto OauthToken com base em dados brutos armazenados em cache.

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