מודול OAuth

exception TIPCommon.oauth.AuthenticationError

בסיסים: Exception

חריגה כללית לשגיאות אימות.

‫class TIPCommon.oauth.AuthorizedOauthClient

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

בסיסים: Client

המחלקות האלה מייצגות לקוח מורשה לקריאות ל-API.

Methods

• close()→ None שומר את הטוקן וסוגר את סשן הלקוח.

• request(*args, **kwargs)→ Response השיטה מחליפה את פרטי הכניסה כדי לתמוך ברענון אוטומטי שלהם. היא בודקת אם תוקף פרטי הכניסה פג לפני ביצוע הבקשה, ומאמתת את התגובה כדי לבדוק אם מצוינים בה פרטי כניסה שתוקפם פג. אם כן, היא מבצעת את הבקשה שוב עם אסימון רענן.

class TIPCommon.oauth.CredStorage

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

בסיסים: object

ניהול האחסון והאחזור של פרטי הכניסה.

Methods

• ‫get_instance_identifier()→ str מקבל את מזהה המכונה של Google SecOps של המחבר או השילוב.

• ‫get_token()→ OauthToken | None מחולץ ומפענח אסימון ממסד הנתונים של ההקשר.

• ‫set_token(token: OauthToken)→ None מצפין ושומר טוקן במסד הנתונים של ההקשר.

exception TIPCommon.oauth.EncryptionError

בסיסים: Exception

חריגה כללית לשגיאות הצפנה.

class TIPCommon.oauth.OAuthAdapter

בסיסים: ABC

מחלקה בסיסית מופשטת שמגדירה את הממשק לפעולות OAuth.

שיטות מופשטות

• ‫abstractcheck_signer(token: OauthToken)→ bool הפונקציה מחזירה True אם החותם תקף, או False בכל מקרה אחר.

• abstractprepare_authorized_client(token: OauthToken, auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient מגדיר כותרות או הגדרות לקוח נחוצות אחרות עבור הלקוח המורשה.

• ‫abstractrefresh_token()→ OauthToken מרענן את האסימון ומחזיר את מודל הנתונים OauthToken.

• ‫abstract static validate_bad_credentials(response: Response)→ bool בודק אם התשובה מציינת שפג התוקף של פרטי הכניסה.

העלאות

‫AuthenticationError – כשהתשובה מציינת שפג התוקף של פרטי הכניסה.

‫class TIPCommon.oauth.OauthManager

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

בסיסים: object

ניהול תהליכי אימות OAuth, כולל רענון טוקנים והכנת לקוחות.

Methods

• ‫prepare_authorized_client(auth_client: AuthorizedOauthClient)→ AuthorizedOauthClient מכין לקוח מורשה לשימוש.

• ‫refresh_if_bad_credentials(auth_client: AuthorizedOauthClient, response: Response)→ bool מרענן את האסימון אם התגובה מציינת פרטי כניסה שגויים.

• ‫refresh_if_expired(auth_client: AuthorizedOauthClient)→ bool מרענן את הטוקן אם תוקפו פג.

• save_token()→ None שמירת הטוקן הנוכחי.

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

בסיסים: object

מייצג אסימון OAuth עם הנתונים שמשויכים אליו.

מאפיינים

מאפיין	תיאור
access_token	str מחרוזת טוקן הגישה.
additional_data	MutableMapping[str, Any] נתונים נוספים שמשויכים לטוקן.
expiration_time	int תאריך התפוגה של האסימון (חותמת זמן של מערכת Unix).
refresh_token	str מחרוזת של טוקן רענון. ברירת המחדל היא None.
signer	str החותם של האסימון. ברירת המחדל היא None.

Methods

• ‫to_cache()→ JsonString מבצעת סריאליזציה של האובייקט OauthToken לפורמט שמתאים לשמירה במטמון.

‫classmethod from_cache

classmethod from_cache(raw_data: JsonString)→ OauthToken

יוצרת אובייקט OauthToken מנתונים גולמיים שנשמרו במטמון.

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.