מדיניות Basicאימות

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

מה

מאפשר להשתמש באימות בסיסי קל בשביל ואבטחה מלאה. המדיניות לוקחת שם משתמש וסיסמה, מערכת Base64 מקודדת אותם וכותבת את את הערך שמתקבל למשתנה. הפורמט של הערך שמתקבל הוא Basic Base64EncodedString. בדרך כלל כותבים את הערך הזה בכותרת HTTP, כמו הכותרת Authorization

המדיניות גם מאפשרת לפענח שם משתמש פרטי כניסה שמאוחסנים במחרוזת בקידוד Base64 וסיסמה.

דוגמאות

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="BasicAuth.credentials.username" />
   <Password ref="BasicAuth.credentials.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
</BasicAuthentication>

{
  "encrypted" : true,
  "entry" : [ {
    "name" : "username",
    "value" : "MyUsername"
  }, {
    "name" : "password",
    "value" : "MyPassword"
  } ],
  "name" : "BasicAuthCredentials"
}
      

<KeyValueMapOperations name="getCredentials" mapIdentifier="BasicAuthCredentials">
  <Scope>apiproxy</Scope>
  <Get assignTo="credentials.username" index='1'>
    <Key>
      <Parameter>username</Parameter>
    </Key>
  </Get>
  <Get assignTo="credentials.password" index='1'>
    <Key>
      <Parameter>password</Parameter>
    </Key>
  </Get>
</KeyValueMapOperations>
      

<BasicAuthentication name="DecodeBaseAuthHeaders">
   <DisplayName>Decode Basic Authentication Header</DisplayName>
   <Operation>Decode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="request.header.username" />
   <Password ref="request.header.password" />
   <Source>request.header.Authorization</Source>
</BasicAuthentication>

מידע על המדיניות בנושא אימות בסיסי

למדיניות יש שני מצבי פעולה:

• מקודד: מערכת Base64 מקודדת שם משתמש וסיסמה שמאוחסנים משתנים
• מפענח: מפענח את שם המשתמש והסיסמה מחרוזת בקידוד Base64

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

הפניה לרכיב

בהפניה לרכיב מתוארים הרכיבים והמאפיינים של BasicAuthentication המדיניות בנושא

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">
   <DisplayName>Basic Authentication 1</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="request.queryparam.username" />
   <Password ref="request.queryparam.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
   <Source>request.header.Authorization</Source> 
</BasicAuthentication>

<BasicAuthentication> מאפיינים

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">

בטבלה הבאה מתוארים מאפיינים שמשותפים לכל רכיבי ההורה של המדיניות:

<DisplayName> רכיב

צריך להשתמש בנוסף למאפיין name כדי להוסיף תווית למדיניות עורך proxy של ממשק משתמש לניהול עם שם אחר בשפה טבעית.

<DisplayName>Policy Display Name</DisplayName>

<Operation> רכיב

המדיניות קובעת אם המדיניות Base64 מקודדת או מפענחת פרטי כניסה.

<Operation>Encode</Operation>

<IgnoreUnresolvedVariables> רכיב

כשהמדיניות מוגדרת לערך true, המדיניות לא תקפיץ הודעת שגיאה אם אי אפשר לשנות את המשתנה הבעיה נפתרה. כשנעשה בה שימוש בהקשר של מדיניות BasicAuthentication, ההגדרה הזו בדרך כלל מוגדרת. ל-false, כי בדרך כלל כדאי לזרוק שגיאה אם שם משתמש לא ניתן למצוא את הסיסמה במשתנים שצוינו.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<User> רכיב

• לצורך קידוד, צריך להשתמש ברכיב <User> כדי לציין את המשתנה שמכיל את שם המשתמש. הערכים של שם המשתמש והסיסמה חוברו בנקודתיים לפני קידוד Base64.
• לצורך הפענוח, מציינים את המשתנה שבו כתוב שם המשתמש המפוענח.

<User ref="request.queryparam.username" /> 

מאפיינים

<Password> רכיב

• לצורך קידוד, צריך להשתמש ברכיב <Password> כדי לציין את המשתנה שמכיל את הסיסמה.
• לצורך פענוח, מציינים את המשתנה שבו כתובה הסיסמה המפוענחת.

<Password ref="request.queryparam.password" />

מאפיינים

<AssignTo> רכיב

מציינת את משתנה היעד שצריך להגדיר עם הערך המקודד או המפוענח שנוצר על ידי הפונקציה המדיניות בנושא

בדוגמה הבאה מצוין שהמדיניות צריכה להגדיר את המאפיין Authorization. כותרת ההודעה לערך שנוצר:

<AssignTo createNew="false">request.header.Authorization</AssignTo>

מאפיינים

<Source> רכיב

לצורך הפענוח, המשתנה שמכיל את המחרוזת בקידוד Base64, ברכיב טופס Basic Base64EncodedString. לדוגמה, לציין request.header.Authorization, שתואם לכותרת Authorization.

<Source>request.header.Authorization</Source>

משתני זרימה

משתנה הזרימה הבא מוגדר כשהמדיניות נכשלת:

• BasicAuthentication.{policy_name}.failed (עם הערך True)

התייחסות לשגיאות

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

שגיאות זמן ריצה

השגיאות האלה יכולות להתרחש כשהמדיניות מופעלת.

שגיאות בפריסה

השגיאות האלו עשויות להתרחש כאשר פורסים שרת proxy שמכיל את המדיניות הזו.

משתני תקלה

המשתנים האלה מוגדרים כשמתרחשת שגיאה בסביבת זמן הריצה. מידע נוסף זמין במאמר מה צריך לדעת לגבי שגיאות מדיניות.

דוגמה לתגובת שגיאה

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

דוגמה לכלל תקלה

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

סכימות

נושאים קשורים

מפה של ערכי מפתחות מדיניות תפעול