نصب و پیکربندی Apigee SSO

برای نصب و پیکربندی واحد Apigee SSO با IDP خارجی، باید کارهای زیر را انجام دهید:

  1. کلیدها و گواهی‌ها را ایجاد کنید.
  2. پیکربندی پایه Apigee SSO را راه‌اندازی کنید: فایل پایه باید شامل ویژگی‌هایی باشد که برای همه پیکربندی‌های SSO مشترک است.
  3. افزودن ویژگی‌های پیکربندی مختص IDP: از یکی از بلوک‌های ویژگی‌های پیکربندی مختص IDP زیر در فایل پیکربندی‌تان استفاده کنید:
  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. تولید درخواست امضای گواهینامه برای CA:
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. گواهی خودامضاشده با زمان انقضای ۳۶۵ روزه ایجاد کنید:
    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، با تنظیم SSO_TOMCAT_PROFILE روی SSL_TERMINATION یا روی SSL_PROXY، نمی‌توانید از گواهی خودامضا استفاده کنید. باید گواهی‌ای از CA تولید کنید. برای اطلاعات بیشتر، پیکربندی Apigee SSO برای دسترسی HTTPS را ببینید.

تنظیمات پیکربندی Apigee SSO

قبل‌از اینکه بتوانید ماژول Apigee SSO را نصب کنید، باید فایل پیکربندی را تعریف کنید. هنگام نصب کردن واحد Apigee SSO، این فایل پیکربندی را به نصب‌کننده منتقل می‌کنید.

فایل پیکربندی فرم زیر را دارد:

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.
# If these credentials change, they must be updated and setup rerun.
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
# Uncomment the following line to set specific SSL cipher using OpenSSL syntax
# SSL_CIPHERS=HIGH:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!kRSA
# 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»

اگر از اتصال مستقیم 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

# Set true to allow users to login with non-email usernames
SSO_ALLOW_NON_EMAIL_USERNAME=false

ویژگی‌های پیکربندی «اتصال غیرمستقیم 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

# 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

نصب واحد Apigee SSO

پس‌از ایجاد کلیدها و راه‌اندازی فایل پیکربندی، می‌توانید ماژول Apigee SSO را نصب کنید.

برای نصب کردن ماژول Apigee SSO:

  1. به گره Management Server وارد شوید. آن گره باید ازقبل apigee-service را نصب کرده باشد، همان‌طور که در نصب ابزار کمکی apigee-setup در Edge شرح داده شده است.

    یا می‌توانید واحد Apigee SSO را در گره دیگری نصب کنید. بااین‌حال، آن گره باید بتواند ازطریق درگاه ۸۰۸۰ به «سرور مدیریت» دسترسی داشته باشد.

  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 به مسیرتان اضافه شود.

به‌جای نشانی وب، فایل فراداده مشخص کنید

اگر ارائه‌دهنده شناسه شما از نشانی وب فراداده HTTP/HTTPS پشتیبانی نمی‌کند، می‌توانید از فایل XML فراداده برای پیکربندی Apigee SSO استفاده کنید.

برای استفاده از فایل فراداده به‌جای نشانی وب برای پیکربندی Apigee SSO:

  1. محتوای XML فراداده را از IDP خود در فایلی در گره Apigee SSO کپی کنید. برای مثال، 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://» را به مسیر فایل اضافه کنید و به‌دنبال آن مسیر مطلق از ریشه (/) را اضافه کنید.