התקנה והגדרה של SSO ב-Apigee

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

1. יצירת מפתחות ואישורים
2. הגדרת תצורת הבסיס של SSO ב-Apigee: הקובץ הבסיסי חייב לכלול את המאפיינים שמשותפים לכל הגדרות ה-SSO.
3. הוספת מאפייני תצורה ספציפיים ל-IdP: משתמשים באחד מהבלוקים הבאים של מאפייני תצורה ספציפיים ל-IdP בקובץ התצורה:
   • מאפייני תצורה של SAML
   • מאפייני ההגדרה של קישור ישיר ל-LDAP
   • מאפייני הגדרה של קישור עקיף ל-LDAP
4. התקנה של Apigee SSO: מתקינים את מודול Apigee SSO ומעבירים את קובץ התצורה למתקין.

כל אחד מהשלבים האלה מתואר בקטעים הבאים.

יצירת מפתחות ואישורים

בקטע הזה מוסבר איך ליצור אישורים בחתימה עצמית, שיכולים להתאים לסביבת הבדיקה, אבל צריך להשתמש באישורים בחתימה של רשות אישורים (CA) בסביבת הייצור.

כדי ליצור את זוג המפתחות לחתימה לאימות:

1. כמשתמשי sudo, יוצרים את הספרייה החדשה הבאה:

   sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys

2. עוברים לספרייה החדשה:

   cd /opt/apigee/customer/application/apigee-sso/jwt-keys/

3. יוצרים את המפתח הפרטי באמצעות הפקודה הבאה:

   sudo openssl genrsa -out privkey.pem 2048

4. יוצרים את המפתח הציבורי מהמפתח הפרטי באמצעות הפקודה הבאה:

   sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem

5. משנים את הבעלים של קובץ ה-PEM של הפלט למשתמש 'apigee':

   sudo chown apigee:apigee *.pem

כדי ליצור את המפתח ואת האישור עם החתימה העצמית, ללא ביטוי סיסמה, לצורך תקשורת עם ה-IDP:

1. כמשתמשי sudo, יוצרים ספרייה חדשה:

   sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/

2. עוברים לספרייה החדשה:

   cd /opt/apigee/customer/application/apigee-sso/idp/

3. יוצרים את המפתח הפרטי באמצעות ביטוי סיסמה:

   sudo openssl genrsa -out server.key 2048

4. מסירים את ביטוי הסיסמה מהמפתח:

   sudo openssl rsa -in server.key -out server.key

5. יצירת בקשת חתימה על אישור עבור רשות אישורים:

   sudo openssl req -x509 -sha256 -new -key server.key -out server.csr

6. יצירת אישור בחתימה עצמית עם תאריך תפוגה של 365 ימים:

   sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt

7. מייצאים את המפתח ואת האישור למאגר מפתחות:
1. מייצאים את המפתח והאישור למאגר מפתחות מסוג PKCS12:

sudo openssl pkcs12 -export -clcerts -in <certificate_path> -inkey <key_path> -out <keystore_path> -name <alias>

פרמטרים:

• certificate_path: הנתיב לאישור שנוצר בשלב 6.
• key_path: הנתיב למפתח הפרטי שנוצר בשלב 3.
• keystore_path: הנתיב למאגר המפתחות החדש מסוג PKCS12 שנוצר, שמכיל את האישור ואת המפתח הפרטי.
• alias: כינוי המשמש להפניה לזוג המפתחות והאישורים במאגר המפתחות.

פרטים נוספים זמינים במסמכי התיעוד של OpenSSL.

2. (אופציונלי) מייצאים את המפתח והאישור מ-PKCS12 למאגר המפתחות JKS:

sudo keytool -importkeystore -srckeystore <PKCS12_keystore_path> -srcstoretype PKCS12 
-destkeystore <destination_keystore_path> -deststoretype JKS -alias <alias>

פרמטרים:

• PKCS12_keystore_path: הנתיב למאגר המפתחות מסוג PKCS12 שנוצר בשלב 7, שמכיל את האישור ואת המפתח הפרטי.
• destination_keystore_path: הנתיב למאגר המפתחות החדש מסוג JKS שנוצר, שמכיל את אותו אישור ומפתח.
• alias: כינוי שמשמש לזוג המפתחות והאישורים במאגר המפתחות JKS.

פרטים נוספים זמינים במסמכי התיעוד של keytool.

3. משנים את הבעלים של קובץ מאגר המפתחות של הפלט למשתמש 'apigee':

   sudo chown apigee:apigee <keystore_file>

4. מעדכנים את המאפיינים הבאים ב-silent.conf:

# Path to your keystore  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.p12  

# Keystore password
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123

# Alias within keystore that stores the key and certificate  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert  

# [Optional] Only specify if you are using something other than JKS. Values could be PKCS12 or BCFKS  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

כדי להפעיל TLS במודול ה-SSO של Apigee, על ידי הגדרת SSO_TOMCAT_PROFILE ל-SSL_TERMINATION או ל-SSL_PROXY, אי אפשר להשתמש באישור בחתימה עצמית. צריך ליצור אישור מ-CA. מידע נוסף זמין במאמר הגדרת SSO ב-Apigee לגישה ל-HTTPS.

הגדרות התצורה של SSO ב-Apigee

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

קובץ התצורה נראה כך:

IP1=hostname_or_IP_of_apigee_SSO
IP2=hostname_or_IP_of_apigee_SSO

## Management Server configuration.
# Management Server IP address and port
MSIP=$IP1
MGMT_PORT=8080
# Edge sys admin username and password as set when you installed Edge.
ADMIN_EMAIL=opdk@google.com
APIGEE_ADMINPW=Secret123
# Set the protocol for the Edge management API. Default is http.
# Set to https if you enabled TLS on the management API.
MS_SCHEME=http

## Postgres configuration.
# Postgres IP address and port
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

## Apigee SSO module configuration.
# Choose either "saml" or "ldap".
SSO_PROFILE="[saml|ldap]"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
SSO_PG_DB_NAME=database_name_for_sso

# Default port is 9099. If changing, set both properties to the same value.
SSO_PUBLIC_URL_PORT=9099
SSO_TOMCAT_PORT=9099
# Set Tomcat TLS mode to DEFAULT to use HTTP access to apigee-sso.
SSO_TOMCAT_PROFILE=DEFAULT
SSO_PUBLIC_URL_SCHEME=http

# SSO admin user name. The default is ssoadmin.
SSO_ADMIN_NAME=ssoadmin
# SSO admin password using uppercase, lowercase, number, and special chars.
SSO_ADMIN_SECRET=Secret123

# Enable the ability to sign an authentication request with SAML SSO.
SSO_SAML_SIGN_REQUEST=y

# Path to signing key and secret from Create the TLS keys and certificates above.
SSO_JWT_SIGNING_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/privkey.pem
SSO_JWT_VERIFICATION_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/pubkey.pem

###########################################################
#                 Define External IDP                     #
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                     #
#  - LDAP Direct Binding configuration properties        #
#  - LDAP Indirect Binding configuration properties       #
###########################################################

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect, below)

# Configure an SMTP server so that the Apigee SSO module can send emails to users
SKIP_SMTP=n
SMTPHOST=smtp.example.com
SMTPUSER=smtp@example.com
# omit for no username
SMTPPASSWORD=smtppwd
# omit for no password
SMTPSSL=n
SMTPPORT=25
# The address from which emails are sent
SMTPMAILFROM="My Company <myco@company.com>"

מאפייני תצורה של SSO ב-SAML

אם אתם משתמשים ב-SAML ל-IdP, צריך להשתמש בבלוק הבא של מאפייני ההגדרה בקובץ התצורה (שמתוארים למעלה):

## SAML Configuration Properties
# Insert this section into your base configuration file, as described previously.

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed on the SSO sign-in page after being redirected by either the New or Classic Edge UI for SAML logins.
# Note: Installing SSO does not depend on the Edge UI or which version of the UI you are using.
SSO_SAML_IDP_LOGIN_TEXT="Please log in to your IDP"

# The metadata URL from your IDP.
# If you have a metadata file, and not a URL,
# see "Specifying a metadata file instead of a URL" below.
SSO_SAML_IDP_METADATA_URL=https://dev-343434.oktapreview.com/app/exkar20cl/sso/saml/metadata

# Determines whether to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL.
# This is necessary if the URL uses a self-signed certificate.
# The default value is "n".
SSO_SAML_IDPMETAURL_SKIPSSLVALIDATION=n

# Keystore configuration details
# [Optional] Only specify KEYSTORE_TYPE if you are using something other than JKS. Values could be PKCS12 or BCFKS.
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.jks
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

# Requires that SAML responses be signed by your IDP.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

מאפייני ההגדרה של קישור ישיר ל-LDAP

אם אתם משתמשים בקישור ישיר ל-LDAP ב-IdP, צריך להשתמש בבלוק הבא של מאפייני תצורה בקובץ התצורה, כפי שמתואר בדוגמה שלמעלה:

## LDAP Direct Binding configuration
# Insert this section into your base configuration file, as described previously.

# The type of LDAP profile; in this case, "direct"
SSO_LDAP_PROFILE=direct

# The base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# Attribute name used by the LDAP server to refer to the user's email address; for example, "mail"
SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

# Pattern of the user's DN; for example: =cn={0},ou=people,dc=example,dc=org
# If there is more than one pattern, separate with semicolons (";"); for example:
# =cn={0},ou=people,dc=example,dc=org;=cn={0},ou=people,dc=example,dc=com
SSO_LDAP_USER_DN_PATTERN=LDAP_DN_pattern

מאפייני ההגדרה של קישור עקיף ל-LDAP

אם אתם משתמשים בקישור עקיף של LDAP ל-IdP, צריך להשתמש בבלוק הבא של מאפייני תצורה בקובץ התצורה, כפי שמוצג בדוגמה שלמעלה:

## LDAP Indirect Binding configuration
# Insert this section into your base configuration file, as described previously.

# Type of LDAP profile; in this case, "indirect"
SSO_LDAP_PROFILE=indirect

# Base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# DN and password of the LDAP server's admin user
SSO_LDAP_ADMIN_USER_DN=LDAP_admin_DN
SSO_LDAP_ADMIN_PWD=LDAP_admin_password

# LDAP search base; for example, "dc=example,dc=org"
SSO_LDAP_SEARCH_BASE=LDAP_search_base

# LDAP search filter; for example, "cn={0}"
SSO_LDAP_SEARCH_FILTER=LDAP_search_filter

# שם המאפיין שמשמש את שרת ה-LDAP כדי להפנות לכתובת האימייל של המשתמש. לדוגמה, 'mail' SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

התקנת מודול ה-SSO של Apigee

אחרי שיוצרים את המפתחות ומגדירים את קובץ התצורה, אפשר להתקין את המודול של SSO ב-Apigee.

כך מתקינים את מודול ה-SSO של Apigee:

1. מתחברים לצומת של שרת הניהול. הצומת הזה כבר אמור להכיל את apigee-service, כפי שמתואר במאמר התקנת הכלי apigee-setup ב-Edge.

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

2. כדי להתקין ולהגדיר את apigee-sso, מריצים את הפקודה הבאה:

   /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

   כאשר configFile הוא קובץ התצורה שהגדרתם למעלה.

3. מתקינים את השירות apigee-ssoadminapi.sh שמשתמשים בו לניהול משתמשים עם הרשאת אדמין ומשתמשי מכונה של המודול apigee-sso:

   /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install

4. יוצאים מהמעטפת ונכנסים שוב כדי להוסיף את הכלי apigee-ssoadminapi.sh למסלול.

יש לציין קובץ מטא-נתונים במקום כתובת URL

אם ה-IDP לא תומך בכתובת URL של מטא-נתונים מסוג HTTP/HTTPS, אפשר להשתמש בקובץ XML של המטא-נתונים כדי להגדיר את Apigee SSO.

כדי להשתמש בקובץ מטא-נתונים במקום בכתובת URL כדי להגדיר את SSO ב-Apigee:

1. מעתיקים את תוכן ה-XML של המטא-נתונים מה-IdP לקובץ בצומת SSO של Apigee. לדוגמה, מעתיקים את ה-XML אל:

   /opt/apigee/customer/application/apigee-sso/saml/metadata.xml

2. משנים את הבעלות על קובץ ה-XML למשתמש 'apigee':

   chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml

3. מגדירים את הערך של SSO_SAML_IDP_METADATA_URL לנתיב המוחלט לקובץ:

   SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

   צריך להוסיף לתחילת נתיב הקובץ את הערך file://, ואחריו את הנתיב המוחלט מהשורש (/).