Módulo OAuth

excepción TIPCommon.oauth.AuthenticationError

Bases: Exception

Excepción genérica para errores de autenticación.

class TIPCommon.oauth.AuthorizedOauthClient

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

Bases: Cliente

Esta clase representa un cliente autorizado para las llamadas a la API.

Métodos

• close()→ None Guarda el token y cierra la sesión del cliente.

• request(*args, **kwargs)→ Response Sobreescrituras para admitir la actualización automática de credenciales. El método comprueba si las credenciales han caducado antes de ejecutar la solicitud y valida la respuesta para comprobar si se indican credenciales caducadas. Si es así, vuelve a ejecutar la solicitud con un token actualizado.

class TIPCommon.oauth.CredStorage

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

Bases: object

Gestiona el almacenamiento y la recuperación de credenciales.

Métodos

• get_instance_identifier()→ str Obtiene el identificador de instancia de SOAR de Google Security Operations del conector o la integración.

• get_token()→ OauthToken | None Extrae y descifra un token de la base de datos de contexto.

• set_token(token: OauthToken)→ None Cifra y guarda un token en la base de datos de contexto.

excepción TIPCommon.oauth.EncryptionError

Bases: Exception

Excepción genérica para errores de cifrado.

class TIPCommon.oauth.OAuthAdapter

Bases: ABC

Clase base abstracta que define la interfaz de las operaciones de OAuth.

Métodos abstractos

• abstractcheck_signer(token: OauthToken)→ bool Devuelve True si el firmante es válido o False en cualquier otro caso.

• abstractprepare_authorized_client(token: OauthToken, auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Define encabezados u otras configuraciones de cliente necesarias para el cliente autorizado.

• abstractrefresh_token()→ OauthToken Actualiza el token y devuelve el modelo de datos OauthToken.

• abstract static validate_bad_credentials(response: Response)→ bool Comprueba si la respuesta indica que las credenciales han caducado.

Aumentos

AuthenticationError: cuando la respuesta indica que las credenciales han caducado.

class TIPCommon.oauth.OauthManager

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

Bases: object

Gestiona los flujos de autenticación de OAuth, incluida la actualización de tokens y la preparación de clientes.

Métodos

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

• refresh_if_bad_credentials(auth_client: AuthorizedOauthClient, response: Response)→ bool Actualiza el token si la respuesta indica que las credenciales no son válidas.

• refresh_if_expired(auth_client: AuthorizedOauthClient)→ bool Actualiza el token si ha caducado.

• save_token()→ None Guarda el token actual.

class TIPCommon.oauth.OauthToken

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

Bases: object

Representa un token de OAuth con sus datos asociados.

Propiedades

Atributo	Descripción
access_token	str Cadena del token de acceso.
additional_data	MutableMapping[str, Any] Datos adicionales asociados al token.
expiration_time	int Hora de caducidad del token (marca de tiempo Unix).
refresh_token	str Cadena del token de actualización. El valor predeterminado es None.
signer	str Signatario del token. El valor predeterminado es None.

Métodos

• to_cache()→ JsonString Serializa el objeto OauthToken en un formato adecuado para el almacenamiento en caché.

classmethod from_cache

classmethod from_cache(raw_data: JsonString)→ OauthToken

Crea un objeto OauthToken a partir de datos sin procesar almacenados en caché.

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.