תוסף אימות של Google

קבלת טוקן גישה

בדוגמה הבאה, הפעולה getOauth2AccessToken של התוסף מאחזרת אסימון לשימוש בבקשות אל Cloud Translation API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-Access-Token">
    <DisplayName>Get Access Token</DisplayName>
    <Connector>google-auth</Connector>
    <Action>getOauth2AccessToken</Action>
    <Input><![CDATA[{
      "scope" : [
        "https://www.googleapis.com/auth/cloud-translation"
      ]
    }]]></Input>
    <Output>google.credentials</Output>
</ConnectorCallout>

ערך התגובה נראה כך:

{
  "access_token":"ya29.c.ElpSB...BMgkALBJ0kou-8",
  "token_type":"Bearer",
  "expiresInSec": 3600
}

מדיניות AssignMessage הבאה מאחזרת את ערך התגובה ממדיניות ExtensionCallout ומעתיקה אותו למטען הייעודי (payload) של התגובה. האפשרות הזו יכולה להיות שימושית לניפוי באגים. בפועל, יכול להיות שלא תרצו להחזיר את הטוקן ללקוח.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Retrieve-Auth-Token">
    <DisplayName>Retrieve Auth Token</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{google.credentials.access_token}</Payload>
    </Set>
</AssignMessage>

שמירת טוקן גישה במטמון

כדי להימנע מביצוע קריאות מיותרות לאחזור טוקן, כדאי לשמור במטמון את הטוקן שמתקבל. בשיחות הבאות שדורשות טוקן, שליפת הטוקן מהמטמון של Apigee Edge תהיה מהירה יותר מקבלת טוקן חדש. כשפג התוקף של האסימון שנשמר במטמון, צריך לאחזר אסימון חדש ולרענן איתו את המטמון.

הקוד הבא מתוך דוגמה ל-API proxy ממחיש איך להגדיר ולהשתמש באסימון שמאוחסן במטמון כדי לבצע קריאה ל-Google Translation API באמצעות מדיניות ServiceCallout. כל דוגמת קוד כאן מתייחסת למדיניות אחרת בתהליך.

המדיניות הבאה מופעלת ברצף שמתואר בקובץ ה-XML של התהליך הבא:

  <Request>
    <!-- Attempt to get a token from the cache. -->
    <Step>
        <Name>Get-Cached-Auth-Token</Name>
    </Step>
    <!-- Only execute the following ExtensionCallout policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Google-Auth-Callout</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Only execute the following PopulateCache policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Cache-Auth-Token</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Use the ServiceCallout policy to call the translate API. -->
    <Step>
        <Name>Translate-Text</Name>
    </Step>
</Request>

1. המדיניות LookupCache הבאה מנסה לקבל טוקן מהמטמון. אם האסימון כבר התקבל ונשמר במטמון, המדיניות הזו תאחזר אותו לשימוש ב-API proxy.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <LookupCache async="false" continueOnError="false" enabled="true" name="Get-Cached-Auth-Token">
         <DisplayName>Get Cached Auth Token</DisplayName>
         <!-- Give cache key and scope to specify the entry for the cached token. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <!-- Assign the retrieved token (if any) to a variable, where it
          can be retrieved by policies. -->
         <AssignTo>cloud.translation.auth.token</AssignTo>
     </LookupCache>
   

2. אם החיפוש במטמון לא מאחזר אסימון במטמון, המדיניות ExtensionCallout הבאה מאחזרת אסימון OAuth חדש, ומציינת את Google Cloud Translation API כהיקף של האסימון. אם פרטי הכניסה של חשבון השירות שבהם השתמשתם כשקבעתם את ההגדרות של התוסף Google-Auth-Callout מייצגים חבר בפרויקט שיש לו גישה ל-API, ב-Google Cloud יוחזר טוקן תקין.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Google-Auth-Callout">
         <DisplayName>Google-Auth-Callout</DisplayName>
         <Connector>example-auth-extension</Connector>
         <Action>getOauth2AccessToken</Action>
         <Input><![CDATA[{
           "scope" : ["https://www.googleapis.com/auth/cloud-translation"]
         }]]></Input>
         <Output parsed="false">cloud.translation.auth.token</Output>
     </ConnectorCallout>
   

3. אחרי שמדיניות ExtensionCallout מאחזרת אסימון חדש, מדיניות PopulateCache שומרת אותו במטמון לשימוש מאוחר יותר על ידי מדיניות ב-API proxy.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <PopulateCache async="false" continueOnError="false" enabled="true" name="Cache-Auth-Token">
         <DisplayName>Cache Auth Token</DisplayName>
         <Properties/>
         <!-- Set cache key information to specify a unique key for this entry. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <ExpirySettings>
             <TimeoutInSec>5</TimeoutInSec>
         </ExpirySettings>
         <!-- Get the token to cache from the variable where the ExtensionCallout put it. -->
         <Source>cloud.translation.auth.token</Source>
     </PopulateCache>
   

תחביר

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
  "scope" : [
    "scope1",
    "scope2"
  ]
}]]></Input>

דוגמה

בדוגמה הבאה, הפעולה getOauth2AccessToken של התוסף מאחזרת אסימון לשימוש בבקשות אל Cloud Translation API.

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
    "scope" : [
      "https://www.googleapis.com/auth/cloud-translation"
  ]
}]]></Input>

תחביר

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
    "audience" : "audience"
}]]></Input>

דוגמה: כתובת URL של פונקציה של Cloud Functions

בדוגמה הבאה, הפעולה getOauth2AccessToken של התוסף מאחזרת אסימון לשימוש בבקשות אל Cloud Translation API.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/FUNCTION_NAME"
}]]></Input>

דוגמה: מזהה לקוח שמאובטח באמצעות Cloud IAP

בדוגמה הבאה, הפעולה getOauth2AccessToken של התוסף מאחזרת אסימון לשימוש בבקשות אל Cloud Translation API.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "Cloud-IAP-secured-client-ID"
}]]></Input>