تثبيت إعدادات الدخول الموحّد (SSO) في Apigee

لتثبيت وحدة الدخول المُوحَّد في Apigee وضبطها باستخدام IDP خارجي، عليك تنفيذ الخطوات التالية:

1. إنشاء مفاتيح وشهادات:
2. إعداد الإعداد الأساسي لميزة الدخول المُوحَّد في Apigee: يجب أن يحتويملف الإعداد الأساسي على السمات الشائعة لجميع إعدادات الدخول المُوحَّد.
3. إضافة سمات ضبط خاصة بموفِّر الهوية: استخدِم إحدى مجموعات سمات الإعداد التالية الخاصة بموفِّر الهوية في ملف الإعداد:
   • خصائص ضبط 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 -aes256 -out server.key 1024

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. غيِّر مالك المفتاح وملف crt إلى مالك apigee:

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

لتفعيل بروتوكول أمان طبقة النقل (TLS) في وحدة الدخول المُوحَّد في Apigee، من خلال ضبط SSO_TOMCAT_PROFILE على SSL_TERMINATION أو على SSL_PROXY، لا يمكنك استخدام شهادة موقَّعة ذاتيًا. يجب إنشاء شهادة من مرجع تصديق. اطّلِع على ضبط الدخول المُوحَّد في Apigee لمنح إذن الوصول إلى بروتوكول HTTPS لمعرفة المزيد.

إعدادات ضبط الدخول المُوحَّد في Apigee

قبل أن تتمكّن من تثبيت وحدة الدخول المُوحَّد (SSO) في Apigee، عليك تحديد ملف إعداد. يتم تمرير ملف الإعدادات هذا إلى أداة التثبيت عند تثبيت وحدة الدخول المُوحَّد في 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

# 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

إذا كنت تستخدم الربط المباشر عبر LDAP لموفِّر الهوية، استخدِم مجموعة الإعدادات التالية للخصائص في ملف الإعدادات، كما هو موضّح في المثال أعلاه:

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

تثبيت وحدة الدخول المُوحَّد في Apigee

بعد إنشاء المفاتيح وإعداد ملف الضبط، يمكنك تثبيت وحدة الدخول المُوحَّد (SSO) في Apigee.

لتركيب وحدة الدخول المُوحَّد في Apigee:

1. سجِّل الدخول إلى عقدة "خادم الإدارة". من المفترض أن تكون هذه العقدة قد تم عليها تثبيت apigee-service، كما هو موضّح في تثبيت أداة إعداد apigee-setup في Edge.

   بدلاً من ذلك، يمكنك تثبيت وحدة الدخول المُوحَّد في Apigee على عقدة مختلفة. ومع ذلك، يجب أن تكون هذه العقدة قادرة على الوصول إلى "خادم الإدارة" عبر المنفذ 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.

لاستخدام ملف بيانات وصفية بدلاً من عنوان URL لضبط الدخول المُوحَّد في Apigee:

1. انسخ محتوى ملف XML للبيانات الوصفية من موفِّر الهوية إلى ملف على عقدة الدخول المُوحَّد في 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://" إلى مسار الملف، متبوعًا بالمسار المطلق من الجذر (/).