Módulo OAuth

exception TIPCommon.oauth.AuthenticationError

Bases: Exception

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

class TIPCommon.oauth.AuthorizedOauthClient

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

Bases: cliente

Esta classe representa um cliente autorizado para chamadas API.

Métodos

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

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

class TIPCommon.oauth.CredStorage

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

Bases: object

Faz a gestão do armazenamento e da obtenção de credenciais.

Métodos

• get_instance_identifier()→ str Obtém o identificador da instância SOAR do Google Security Operations do conetor ou da integração.

• get_token()→ OauthToken | None Extrai e desencripta um token da base de dados de contexto.

• set_token(token: OauthToken)→ None Encripta e guarda um token na base de dados de contexto.

exception TIPCommon.oauth.EncryptionError

Bases: Exception

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

class TIPCommon.oauth.OAuthAdapter

Bases: ABC

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

Métodos abstratos

• abstractcheck_signer(token: OauthToken)→ bool Devolve True se o signatário 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 do cliente necessárias para o cliente autorizado.

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

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

Aumenta

AuthenticationError – Quando a resposta indica credenciais expiradas.

class TIPCommon.oauth.OauthManager

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

Bases: object

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

Métodos

• prepare_authorized_client(auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Prepara um cliente autorizado para utilização.

• 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 tiver expirado.

• save_token()→ None Guarda o token atual.

class TIPCommon.oauth.OauthToken

classe 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 respetivos dados associados.

Propriedades

Atributo	Descrição
access_token	str A string da chave de acesso.
additional_data	MutableMapping[str, Any] Dados adicionais associados ao token.
expiration_time	int A hora de expiração do token (data/hora Unix).
refresh_token	str A string do token de atualização. A predefinição é None.
signer	str O signatário do token. A predefinição é None.

Métodos

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

classmethod from_cache

classmethod from_cache(raw_data: JsonString)→ OauthToken

Cria um objeto OauthToken a partir de dados em cache não processados.

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