דף זה תורגם על ידי Cloud Translation API.

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

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

ליצור מפתחות ואישורים.
קובעים את הגדרת ה-SSO של Apigee הבסיסית: קובץ הבסיס חייב לכלול את המאפיינים המשותפים לכל ההגדרות של SSO.
הוספת מאפייני הגדרות ספציפיים ל-IdP: משתמשים באחד מהמאפיינים הבאים בלוקים ספציפיים ל-IdP של מאפייני תצורה בקובץ התצורה:
התקנת SSO של Apigee: מתקינים את מודול ה-SSO של Apigee ומעבירים את קובץ התצורה שיוקצה למנהל ההתקנה.

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

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

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

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

כמשתמש sudo, יוצרים את הספרייה החדשה הבאה:
```
sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
```

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

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

יוצרים את המפתח הפרטי באמצעות הפקודה הבאה:
```
sudo openssl genrsa -out privkey.pem 2048
```
יוצרים את המפתח הציבורי מהמפתח הפרטי באמצעות הפקודה הבאה:
```
sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
```
משנים את הבעלים של קובץ הפלט PEM ל-"apigee" user:
```
sudo chown apigee:apigee *.pem
```

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

כמשתמש sudo, עליכם ליצור ספרייה חדשה:
```
sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
```

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

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

יצירת המפתח הפרטי באמצעות ביטוי סיסמה:
```
sudo openssl genrsa -aes256 -out server.key 1024
```
מסירים את ביטוי הסיסמה מהמפתח:
```
sudo openssl rsa -in server.key -out server.key
```

יצירת בקשה לחתימה על אישור עבור CA:

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

יצירת אישור עם חתימה עצמית והתוקף שלו יפוג תוך 365 ימים:
```
sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
```

שינוי הבעלים של המפתח וקובץ ה-crt ל-'apigee' owner:

sudo chown apigee:apigee server.key
sudo chown apigee:apigee selfsigned.crt

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

הגדרות אישיות של Apigee SSO

לפני שתוכלו להתקין את מודול ה-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>"

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

אם אתם משתמשים ב-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

# SAML service provider key and cert from Create the TLS keys and certificates above.
SSO_SAML_SERVICE_PROVIDER_KEY=/opt/apigee/customer/application/apigee-sso/saml/server.key
SSO_SAML_SERVICE_PROVIDER_CERTIFICATE=/opt/apigee/customer/application/apigee-sso/saml/selfsigned.crt

# The passphrase used when you created the SAML cert and key.
# The section "Create the TLS keys and certificates" above removes the passphrase,
# but this property is available if you require a passphrase.
# SSO_SAML_SERVICE_PROVIDER_PASSWORD=samlSP123

# 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 Direct Binding

אם משתמשים בקישור ישיר של 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

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

כדי להתקין את מודול ה-SSO של Apigee:

מתחברים לצומת של שרת הניהול. הצומת הזה כבר אמור להכיל בוצעה התקנה של apigee-service, כמו שמתואר ב התקנת כלי ההגדרה של Edge apigee-setup.
לחלופין, אפשר להתקין את מודול ה-SSO של Apigee בצומת אחר. אבל, לפעמים הצומת הזה חייב להיות מסוגל לגשת לשרת הניהול ביציאה 8080.
מריצים את הפקודה הבאה כדי להתקין את apigee-sso ולהגדיר אותו:
```
/opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile
```
כאשר configFile הוא קובץ התצורה שהגדרתם למעלה.
התקנת כלי השירות apigee-ssoadminapi.sh שמשמש לניהול האדמין והמחשב משתמשים במודול apigee-sso:
```
/opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
```
צריך להתנתק מהמעטפת ואז להתחבר שוב כדי להוסיף את apigee-ssoadminapi.sh לנתיב שלכם.

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

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

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

מעתיקים את התוכן של ה-XML של המטא-נתונים מה-IdP שלכם לקובץ בצומת ה-SSO של Apigee. עבור לדוגמה, מעתיקים את ה-XML אל:
```
/opt/apigee/customer/application/apigee-sso/saml/metadata.xml
```
הערה: צריך לתת שם לקובץ metadata.xml.

שינוי הבעלות על קובץ ה-XML ל-apigee user:

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

מגדירים את הערך של SSO_SAML_IDP_METADATA_URL לנתיב הקובץ המוחלט:
```
SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml
```
צריך להוסיף את הקידומת "file://" לנתיב הקובץ ואחריו את הנתיב המוחלט מ: בסיס (/).