تثبيت خدمة الدخول الموحَّد (SSO) على Edge وإعدادها

Edge for Private Cloud الإصدار 4.19.01

يتطلب تثبيت وحدة الدخول الموحّد (SSO) في Edge وضبطها إنشاء مجموعتين من مفاتيح وشهادات بروتوكول أمان طبقة النقل (TLS) أولاً. تستخدم وحدة Edge SSO بروتوكول أمان طبقة النقل (TLS) لتأمين نقل المعلومات كجزء من عملية تأكيد الاتصال عبر SAML مع موفِّر الهوية (IDP) عبر SAML.

إنشاء مفاتيح وشهادات بروتوكول أمان طبقة النقل (TLS)

تنشئ الخطوات أدناه شهادات موقَّعة ذاتيًا قد تكون مناسبة لبيئة الاختبار، ولكنّك تحتاج عادةً إلى شهادات موقَّعة من مرجع تصديق لبيئة التشغيل الفعلي.

لإنشاء مفتاح التحقّق والتوقيع والشهادة الموقَّعة ذاتيًا، اتّبِع الخطوات التالية:

  1. 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. sudo chown apigee:apigee *.pem

لإنشاء المفتاح والشهادة الموقَّعة ذاتيًا، بدون عبارة مرور، للتواصل مع موفِّر الهوية (IDP) في SAML:

  1. sudo mkdir -p /opt/apigee/customer/application/apigee-sso/saml/
  2. cd /opt/apigee/customer/application/apigee-sso/saml/
  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. sudo chown apigee:apigee server.key
  8. sudo chown apigee:apigee selfsigned.crt

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

تثبيت Edge SSO وضبطه للوصول إلى HTTP

لتثبيت وحدة Edge SSO، apigee-sso، يجب استخدام العملية نفسها التي استخدمتها لتثبيت Edge. بما أنّ apigee-sso يتم تمثيله بملف RPM، يعني ذلك أنّ المستخدم الذي يجري عملية التثبيت يجب أن يكون المستخدم الجذر أو مستخدمًا لديه إذن وصول كامل إلى sudo. لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على تثبيت Edge.

مرِّر ملف إعداد إلى أداة التثبيت. يأخذ ملف الإعداد الشكل التالي:

IP1=hostname_or_ip_of_management_server
IP2=hostname_or_ip_of_UI_and_apigge_sso

## Management Server configuration.
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.
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

# apigee-sso configuration.
SSO_PROFILE="saml"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
# 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

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed to user when they attempt to access Edge UI.
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

# Specifies to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL. Necessary if URL uses a self-signed cert. 
# 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.
SSO_SAML_SIGNED_ASSERTIONS=y

# Must configure an SMTP server so Edge SSO 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
SMTPMAILFROM="My Company <myco@company.com>"

لتثبيت وحدة Edge SSO:

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

    يُرجى العِلم أنّه يمكنك تثبيت Edge 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

إذا كان موفّر الهوية لا يتيح استخدام عنوان URL للبيانات الوصفية يتضمّن HTTP/HTTPS، يمكنك استخدام ملف XML للبيانات الوصفية من أجل ضبط الدخول المُوحَّد في Edge:

  1. انسخ محتوى ملف XML للبيانات الوصفية من موفِّر الهوية إلى ملف على عقدة الدخول المُوحَّد في Edge. على سبيل المثال، انسخ ملف XML إلى: 
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. غيِّر ملكية الملف إلى apigee: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://"، متبوعة بالمسار المطلق من الجذر (/).