הגדרת TLS לממשק המשתמש החדש של Edge

כברירת מחדל, הגישה לממשק המשתמש החדש של Edge מתבצעת באמצעות HTTP, באמצעות כתובת ה-IP או שם ה-DNS של צומת ממשק המשתמש של Edge ויציאה 3001. לדוגמה:

http://newue_IP:3001

לחלופין, אתם יכולים להגדיר גישת TLS לממשק המשתמש של Edge כדי שתוכלו לגשת אליו בפורמט:

https://newue_IP:3001

דרישות לגבי TLS

ממשק המשתמש של Edge תומך רק ב-TLS בגרסה 1.2. אם מפעילים את TLS בממשק המשתמש של Edge, המשתמשים צריכים להתחבר לממשק המשתמש של Edge באמצעות דפדפן שתואם ל-TLS בגרסה 1.2.

מאפייני הגדרות אישיות של TLS

מריצים את הפקודה הבאה כדי להגדיר TLS לממשק המשתמש של Edge:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

configFile הוא קובץ התצורה שבו השתמשתם כדי להתקין את ממשק המשתמש של Edge.

לפני שמריצים את הפקודה הזו, צריך לערוך את קובץ התצורה כדי להגדיר את המאפיינים הנדרשים ששולטים ב-TLS. בטבלה הבאה מתוארים המאפיינים שמשמשים להגדרת TLS לממשק המשתמש של Edge:

נכס תיאור חובה?
MANAGEMENT_UI_SCHEME

מגדירה את הפרוטוקול, "http" או "https", שמשמש לגישה לממשק המשתמש של Edge. ערך ברירת המחדל הוא "http". כדי להפעיל את TLS, מגדירים את הערך "https":

MANAGEMENT_UI_SCHEME=https
כן
MANAGEMENT_UI_TLS_OFFLOAD

אם הערך הוא "n", מציין שבקשות TLS לממשק המשתמש של Edge מסתיימות בממשק המשתמש של Edge. צריך להגדיר את MANAGEMENT_UI_TLS_KEY_FILE ואת MANAGEMENT_UI_TLS_CERT_FILE.

אם הערך הוא "y", מציין שבקשות TLS לממשק המשתמש של Edge מסתיימות במאזן עומסים, ושהוא מעביר את הבקשה לממשק המשתמש של Edge באמצעות HTTP.

אם מסיימים את ה-TLS במאזן העומסים, ממשק המשתמש של Edge עדיין צריך לדעת שהבקשה המקורית הגיעה דרך TLS. לדוגמה, בחלק מקובצי ה-Cookie מוגדר סימון Secure.

צריך להגדיר את MANAGEMENT_UI_SCHEME ל-"https", אחרת המערכת תתעלם מ-MANAGEMENT_UI_TLS_OFFLOAD:

MANAGEMENT_UI_SCHEME=https
MANAGEMENT_UI_TLS_OFFLOAD=y
כן
MANAGEMENT_UI_TLS_KEY_FILE

MANAGEMENT_UI_TLS_CERT_FILE

אם הערך הוא MANAGEMENT_UI_TLS_OFFLOAD=n, מציין את הנתיב המוחלט לקובצי המפתח והאישור של TLS. הקבצים צריכים להיות בפורמט PEM, ללא ביטוי סיסמה, ובבעלות המשתמש "apigee".

המיקום המומלץ לקבצים האלה הוא:

/opt/apigee/customer/application/edge-management-ui

אם הספרייה הזו לא קיימת, צריך ליצור אותה.

אם MANAGEMENT_UI_TLS_OFFLOAD=y, צריך להשמיט את MANAGEMENT_UI_TLS_KEY_FILE ואת MANAGEMENT_UI_TLS_CERT_FILE.. המערכת מתעלמת מהם כי הבקשות לממשק המשתמש של Edge מגיעות דרך HTTP.

כן, אם MANAGEMENT_UI_TLS_OFFLOAD=n
MANAGEMENT_UI_PUBLIC_URIS

אם MANAGEMENT_UI_TLS_OFFLOAD=n, מציין את כתובת ה-URL של ממשק המשתמש של Edge.

מגדירים את המאפיין הזה על סמך מאפיינים אחרים בקובץ התצורה. לדוגמה:

MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT

כאשר:

  • ‫MANAGEMENT_UI_SCHEME מציין את הפרוטוקול, "http" או "https", כמו שמתואר למעלה.
  • MANAGEMENT_UI_IP מציין את כתובת ה-IP או את שם ה-DNS של ממשק המשתמש של Edge.
  • MANAGEMENT_UI_PORT מציין את היציאה שמשמשת את ממשק המשתמש של Edge.

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

אם MANAGEMENT_UI_TLS_OFFLOAD=y:

  • ‫MANAGEMENT_UI_IP מציין את כתובת ה-IP או את שם ה-DNS של מאזן העומסים, ולא של ממשק המשתמש של Edge.
  • מאזן העומסים וה-UE החדש חייבים להשתמש באותו מספר יציאה לבקשות, למשל 3001. משתמשים ב-MANAGEMENT_UI_PORT כדי לציין את מספר היציאה במאזן העומסים ובממשק המשתמש החדש.

כן

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS

מגדירה את רשימת הצפנות ה-TLS הזמינות כמחרוזת שמופרדת בפסיקים או ברווחים.

מחרוזת מופרדת בפסיקים:

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS=TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

מחרוזת מופרדת ברווחים שמוקפת במירכאות כפולות:

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS="TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
SHOEHORN_SCHEME

לפני שמתקינים את ממשק המשתמש החדש של Edge, צריך להתקין את ממשק המשתמש הבסיסי של Edge, שנקרא shoehorn. בקובץ התצורה של ההתקנה, המאפיין הבא משמש כדי לציין את הפרוטוקול, "http", שמשמש לגישה לממשק המשתמש הבסיסי של Edge:

SHOEHORN_SCHEME=http

ממשק המשתמש הבסיסי של Edge לא תומך ב-TLS, כך שגם כשמפעילים TLS בממשק המשתמש של Edge, עדיין צריך להגדיר את המאפיין הזה כ-"http".

כן, ומוגדר כ-"http"

הגדרת TLS

כדי להגדיר גישת TLS לממשק המשתמש של Edge:

  1. יוצרים את אישור ה-TLS ואת המפתח כקובצי PEM ללא ביטוי סיסמה. לדוגמה:

    mykey.pem
    mycert.pem

    יש הרבה דרכים ליצור אישור ומפתח TLS. לדוגמה, אפשר להריץ את הפקודה הבאה כדי ליצור אישור ומפתח לא חתומים:

    openssl req -x509 -newkey rsa:4096 -keyout mykey.pem -out mycert.pem -days 365 -nodes -subj '/CN=localhost'
  2. מעתיקים את קובצי המפתח והאישור לספרייה /opt/apigee/customer/application/edge-management-ui. אם הספרייה הזו לא קיימת, צריך ליצור אותה.
  3. מוודאים שהאישור והמפתח נמצאים בבעלות המשתמש "apigee":

    chown apigee:apigee /opt/apigee/customer/application/edge-management-ui/*.pem
  4. עורכים את קובץ התצורה שבו השתמשתם כדי להתקין את ממשק המשתמש של Edge, כדי להגדיר את מאפייני ה-TLS הבאים:

    # Set to https to enable TLS.
    MANAGEMENT_UI_SCHEME=https 
    # Do NOT terminate TLS on a load balancer.
    MANAGEMENT_UI_TLS_OFFLOAD=n
    
    # Specify the key and cert. 
    MANAGEMENT_UI_TLS_KEY_FILE=/opt/apigee/customer/application/edge-management-ui/mykey.pem
    MANAGEMENT_UI_TLS_CERT_FILE=/opt/apigee/customer/application/edge-management-ui/mycert.pem
    
    # Leave these properties set to the same values as when you installed the Edge UI:
    MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
    SHOEHORN_SCHEME=http
  5. מריצים את הפקודה הבאה כדי להגדיר את TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    כאשר configFile הוא השם של קובץ התצורה.

    הסקריפט מפעיל מחדש את ממשק המשתמש של Edge.

  6. מריצים את הפקודות הבאות כדי להגדיר ולהפעיל מחדש את shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

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

הגדרת ממשק המשתמש של Edge כש-TLS מסתיים במאזן העומסים

אם יש לכם מאזן עומסים שמעביר בקשות לממשק המשתמש של Edge, אתם יכולים לבחור לסיים את חיבור ה-TLS במאזן העומסים, ואז להגדיר שמאזן העומסים יעביר בקשות לממשק המשתמש של Edge באמצעות HTTP:

סיום TLS במאזן העומסים

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

כדי להגדיר את ממשק המשתמש של Edge כשסיום TLS מתבצע במאזן העומסים:

  1. עורכים את קובץ התצורה שבו השתמשתם כדי להתקין את ממשק המשתמש של Edge, כדי להגדיר את מאפייני ה-TLS הבאים:

    # Set to https to enable TLS
    MANAGEMENT_UI_SCHEME=https
    # Terminate TLS on a load balancer
    MANAGEMENT_UI_TLS_OFFLOAD=y
    # Set to the IP address or DNS name of the load balancer.
    MANAGEMENT_UI_IP=LB_IP_DNS
    # Set to the port number for the load balancer and Edge UI.
    # The load balancer and the Edge UI must use the same port number.
    MANAGEMENT_UI_IP=3001
    
    # Leave these properties set to the same values as when you installed the Edge UI:
    MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
    SHOEHORN_SCHEME=http
    

    אם מגדירים את MANAGEMENT_UI_TLS_OFFLOAD=y, צריך להשמיט את MANAGEMENT_UI_TLS_KEY_FILE ואת MANAGEMENT_UI_TLS_CERT_FILE.. המערכת מתעלמת מהם כי הבקשות לממשק המשתמש של Edge מגיעות דרך HTTP.

  2. מריצים את הפקודה הבאה כדי להגדיר את TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    כאשר configFile הוא השם של קובץ התצורה.

    הסקריפט מפעיל מחדש את ממשק המשתמש של Edge.

  3. מריצים את הפקודות הבאות כדי להגדיר ולהפעיל מחדש את shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

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

השבתת TLS בממשק המשתמש של Edge

כדי להשבית את TLS בממשק המשתמש של Edge:

  1. עורכים את קובץ התצורה שבו השתמשתם כדי להתקין את ממשק המשתמש של Edge, כדי להגדיר את מאפיין ה-TLS הבא:

    # Set to http to disable TLS.
    MANAGEMENT_UI_SCHEME=http
    
    # Only if you had terminated TLS on a load balancer,
    # reset to the IP address or DNS name of the Edge UI.
    MANAGEMENT_UI_IP=newue_IP_DNS
    
  2. מריצים את הפקודה הבאה כדי להשבית את TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    כאשר configFile הוא השם של קובץ התצורה.

    הסקריפט מפעיל מחדש את ממשק המשתמש של Edge.

  3. מריצים את הפקודות הבאות כדי להגדיר ולהפעיל מחדש את shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

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