שימוש ב-SAML עם Edge Management API

Edge for Private Cloud גרסה 4.17.09

אימות בסיסי הוא אחת מהדרכים לאימות כשמבצעים קריאות ל-Edge management API. לדוגמה, אפשר לשלוח את בקשת ה-cURL הבאה ל-Edge management API כדי לגשת למידע על הארגון:

curl -u userName:pWord https://ms_IP_DNS:8080/v1/organizations/orgName

בדוגמה הזו, משתמשים באפשרות cURL -u כדי להעביר פרטי כניסה של Basic Auth. לחלופין, אפשר להעביר אסימון OAuth2 בכותרת Bearer כדי לבצע קריאות ל-Edge Management API. לדוגמה:

curl -H "Authorization: Bearer <access_token>" https://ms_IP_DNS:8080/v1/organizations/orgName

אחרי שמפעילים את SAML, אפשר להשבית את Basic Auth. אם משביתים את Basic Auth, כל הסקריפטים (סקריפטים של Maven, סקריפטים של מעטפת, apigeetool וכו') שמסתמכים על קריאות ל-Edge management API שתומכות ב-Basic Auth לא יפעלו יותר. אתם צריכים לעדכן את כל הקריאות ל-API והסקריפטים שמשתמשים באימות בסיסי כדי להעביר טוקני גישה של OAuth2 בכותרת Bearer.

שימוש ב-get_token כדי לקבל ולרענן טוקנים

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

הכלי get_token מאחסן את האסימונים בדיסק, והם מוכנים לשימוש לפי הצורך. היא גם מדפיסה טוקן גישה תקין ל-stdout. משם, אתם יכולים להשתמש ב-Postman או להטמיע אותו במשתנה סביבה לשימוש ב-curl.

התהליך הבא מתאר איך להשתמש ב-get_token כדי לקבל אסימון גישה של OAuth2 לביצוע קריאות ל-Edge Management API:

  1. מורידים את החבילה של sso-cli:
    curl http://edge_sso_IP_DNS:9099/resources/scripts/sso-cli/ssocli-bundle.zip -o "ssocli-bundle.zip"

    כאשר edge_sso_IP_DNS הוא כתובת ה-IP של שם ה-DNS של המכונה שמארחת את מודול ה-SSO של Edge. אם הגדרתם TLS ב-Edge SSO, השתמשו ב-https ובמספר היציאה הנכון של TLS.

  2. מבטלים את הדחיסה של החבילה ssocli-bundle.zip:
    unzip ssocli-bundle.zip
  3. התקנת get_token ב-/usr/local/bin:
    ./install

    משתמשים באפשרות -b כדי לציין מיקום אחר:

    ./install -b path
  4. מגדירים את משתנה הסביבה SSO_LOGIN_URL לכתובת ה-URL להתחברות, בפורמט הבא:
    export SSO_LOGIN_URL="http://edge_sso_IP_DNS:9099"

    כאשר edge_sso_IP_DNS הוא כתובת ה-IP של שם ה-DNS של המכונה שמארחת את מודול ה-SSO של Edge. אם הגדרתם TLS ב-Edge SSO, השתמשו ב-https ובמספר היציאה הנכון של TLS.

  5. בדפדפן, עוברים לכתובת ה-URL הבאה כדי לקבל קוד גישה חד-פעמי:
    http://edge_sso_IP_DNS:9099/passcode

    אם הגדרתם TLS ב-Edge SSO, השתמשו ב-https ובמספר היציאה הנכון של TLS.

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

  6. מפעילים את get_token כדי לקבל את אסימון הגישה מסוג OAuth2:
    get_token -u emailAddress

    כאשר emailAddress הוא כתובת האימייל של משתמש ב-Edge. תתבקשו להזין את קוד הסיסמה החד-פעמי שקיבלתם בשלב 3:

    One Time Code ( Get one at https://edge_sso_IP.com/passcode )
          Enter the passcode if SAML is enabled or press ENTER:

    מזינים את קוד הגישה. הכלי get_token מקבל את אסימון הגישה מסוג OAuth2, מדפיס אותו במסך וכותב אותו ואת אסימון הרענון בקובץ ~/.sso-cli.

    אפשר להזין את קוד הגישה בשורת הפקודה באמצעות פקודת get_token בפורמט הבא:

    get_token -u emailAddress -p passcode
  7. מעבירים את טוקן הגישה לקריאה ל-API לניהול של Edge בתור כותרת Bearer:
    curl -H "Authorization: Bearer access_token"
    https://ms_IP:8080/v1/organizations/orgName

    אחרי שמקבלים אסימון גישה חדש בפעם הראשונה, אפשר לקבל את אסימון הגישה ולהעביר אותו לקריאה ל-API בפקודה אחת, כמו שמוצג בהמשך:

    header=`get_token` &&
    curl -H "Authorization: Bearer $header"
    https://ms_IP:8080/v1/o/orgName

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

אחרי שפג התוקף של טוקן הרענון, get_token מבקש קוד גישה חדש. כדי ליצור אסימון גישה חדש ל-OAuth, צריך לעבור לכתובת ה-URL שמופיעה בשלב 3 למעלה וליצור קוד גישה חדש.

שימוש ב-Management API כדי לקבל ולרענן טוקנים

במאמר שימוש באבטחת OAuth2 עם ה-Management API של Apigee Edge מוסבר איך להשתמש ב-Management API של Edge כדי לקבל ולרענן טוקני רענון. אתם יכולים גם להשתמש בקריאות ל-Edge API כדי לקבל אסימונים שנוצרו מטענות נכונות (assertions) של SAML.

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

לדוגמה, משתמשים בקריאה הבאה ל-API כדי ליצור את אסימוני הגישה והרענון הראשוניים:

curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" /
  -H "accept: application/json;charset=utf-8" /
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST /
  https://edge_sso_IP_DNS:9099/oauth/token -s /
  -d 'grant_type=password&response_type=token&passcode=passcode'

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

כדי לרענן את אסימון הגישה בהמשך, משתמשים בקריאה הבאה שכוללת את אסימון הרענון:

curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" /
  -H "Accept: application/json;charset=utf-8" /
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST /
  https://edge_sso_IP_DNS:9099/oauth/token /
  -d 'grant_type=refresh_token&refresh_token=refreshToken'