Modulo OAuth

exception TIPCommon.oauth.AuthenticationError

Basi: Eccezione

Un'eccezione generica per gli errori di autenticazione.

class TIPCommon.oauth.AuthorizedOauthClient

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

Basi: Client

Questa classe rappresenta un client autorizzato per le chiamate API.

Metodi

• close()→ None Salva il token e chiude la sessione del client.

• request(*args, **kwargs)→ Response Sovrascritture per supportare l'aggiornamento automatico delle credenziali. Il metodo controlla se le credenziali sono scadute prima di eseguire la richiesta e convalida la risposta per verificare se sono indicate credenziali scadute. In questo caso, esegue nuovamente la richiesta con un token aggiornato.

class TIPCommon.oauth.CredStorage

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

Basi: object

Gestisce l'archiviazione e il recupero delle credenziali.

Metodi

• get_instance_identifier()→ str Recupera l'identificatore dell'istanza Google SecOps del connettore o dell'integrazione.

• get_token()→ OauthToken | None Estrae e decripta un token dal database di contesto.

• set_token(token: OauthToken)→ None Cripta e salva un token nel database di contesto.

exception TIPCommon.oauth.EncryptionError

Basi: Eccezione

Un'eccezione generica per gli errori di crittografia.

class TIPCommon.oauth.OAuthAdapter

Basi: ABC

Una classe base astratta che definisce l'interfaccia per le operazioni OAuth.

Metodi astratti

• abstractcheck_signer(token: OauthToken)→ bool Restituisce True se il firmatario è valido o False in qualsiasi altro caso.

• abstractprepare_authorized_client(token: OauthToken, auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Imposta le intestazioni o altre configurazioni client necessarie per il client autorizzato.

• abstractrefresh_token()→ OauthToken Aggiorna il token e restituisce il modello dei dati OauthToken.

• abstract static validate_bad_credentials(response: Response)→ bool Controlla se la risposta indica credenziali scadute.

Aumenti

AuthenticationError: quando la risposta indica credenziali scadute.

class TIPCommon.oauth.OauthManager

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

Basi: object

Gestisce i flussi di autenticazione OAuth, inclusi l'aggiornamento dei token e la preparazione dei client.

Metodi

• prepare_authorized_client(auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient Prepara un client autorizzato per l'uso.

• refresh_if_bad_credentials(auth_client: AuthorizedOauthClient, response: Response)→ bool Aggiorna il token se la risposta indica credenziali non valide.

• refresh_if_expired(auth_client: AuthorizedOauthClient)→ bool Aggiorna il token se è scaduto.

• save_token()→ None Salva il token corrente.

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>)

Basi: object

Rappresenta un token OAuth con i relativi dati associati.

Proprietà

Attributo	Descrizione
access_token	str La stringa del token di accesso.
additional_data	MutableMapping[str, Any] Dati aggiuntivi associati al token.
expiration_time	int Il tempo di scadenza del token (timestamp Unix).
refresh_token	str La stringa del token di aggiornamento. Il valore predefinito è None.
signer	str Il firmatario del token. Il valore predefinito è None.

Metodi

• to_cache()→ JsonString Serializza l'oggetto OauthToken in un formato adatto alla memorizzazione nella cache.

classmethod from_cache

classmethod from_cache(raw_data: JsonString)→ OauthToken

Crea un oggetto OauthToken dai dati grezzi memorizzati nella cache.

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.