‫Google برای ترجمه محتوا به زبان ترجیحی شما از فناوری هوشواره استفاده می‌کند. ترجمه‌های هوشواره‌ای ممکن است اشتباه داشته باشند.

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

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

ایجاد کلیدها و گواهی‌ها.
پیکربندی پایه Apigee SSO را راه‌اندازی کنید: فایل پایه باید شامل دارایی‌هایی باشد که در همه پیکربندی‌های SSO مشترک هستند.
افزودن خصوصیات پیکربندی ویژه IDP: از یکی از بلوک‌های خصوصیات پیکربندی ویژه IDP زیر در فایل پیکربندی‌تان استفاده کنید:
نصب Apigee SSO: واحد Apigee SSO را نصب کنید و فایل پیکربندی را به نصب‌کننده ارسال کنید.

هریک از این مراحل در بخش‌های بعدی توضیح داده شده است.

ایجاد کلیدها و گواهینامه‌ها

این بخش نحوه ایجاد گواهینامه‌های خودامضا را توضیح می‌دهد که ممکن است برای محیط آزمایش شما مناسب باشد، اما برای محیط تولید باید از گواهینامه‌های امضاشده توسط «مرجع صدور گواهی» (CA) استفاده کنید.

برای ایجاد جفت کلید برای امضا کردن درستی‌سنجی:

به‌عنوان کاربر sudo، دایرکتوری جدید زیر را ایجاد کنید:
```
sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
```

به دایرکتوری جدید تغییر دهید:

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

توجه: اگر از RHEL 9 یا سیستم‌عامل مشابهی استفاده می‌کنید، ممکن است از OpenSSL 3.X استفاده کنید. در چنین مواردی، پرچم -traditional را به فرمان OpenSSL اضافه کنید تا مطمئن شوید کلیدها و گواهینامه‌ها در قالب موردانتظار تولید می‌شوند. برای مثال:

sudo openssl genrsa -out privkey.pem -traditional 2048

کلید خصوصی را با فرمان زیر تولید کنید:
```
sudo openssl genrsa -out privkey.pem 2048
```
کلید عمومی را از کلید خصوصی با فرمان زیر تولید کنید:
```
sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
```
مالک فایل PEM برونداد را به کاربر «apigee» تغییر دهید:
```
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 -out server.key 2048
```
گذرعبارت را از کلید بردارید:
```
sudo openssl rsa -in server.key -out server.key
```
تولید درخواست امضای گواهینامه برای «مرکز صدور گواهی»:
```
sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
```

تولید گواهی خودامضا با زمان انقضای ۳۶۵ روز:

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

کلید و گواهینامه را به یک دسته‌کلید صادر کنید:

کلید و گواهی را به یک انبار کلید PKCS12 صادر کنید:

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

پارامترها:

certificate_path: مسیر گواهینامه ایجادشده در «مرحله ۶».
key_path: مسیر کلید خصوصی تولیدشده در «مرحله ۳».
keystore_path: مسیر انبار کلید PKCS12 که به‌تازگی ایجاد شده است و حاوی گواهی و کلید خصوصی است.
alias: نام مستعار استفاده‌شده برای ارجاع دادن به جفت کلید و گواهینامه در انبار کلید.

برای جزئیات بیشتر، مستندات OpenSSL را ببینید.

توجه: اگر از Edge for Private Cloud با سیستم‌های عامل دارای FIPS استفاده می‌کنید، توصیه می‌شود از PKCS12 به‌عنوان انبار کلید استفاده کنید. اگر ترجیح می‌دهید از انبار کلید PKCS12 استفاده کنید، می‌توانید مرحله زیر را برای تبدیل PKCS12 به JKS و تنظیم SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE به PKCS12 رد کنید.

(اختیاری) کلید و گواهینامه را از PKCS12 به انبار کلید JKS صادر کنید:

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

پارامترها:

PKCS12_keystore_path: مسیر انبار کلید PKCS12 که در «مرحله ۷» ایجاد شده است و حاوی گواهی و کلید خصوصی است.
destination_keystore_path: مسیر به انبار کلید JKS که به‌تازگی ایجاد شده و حاوی همان گواهینامه و کلید است.
alias: نام مستعار استفاده‌شده برای جفت کلید و گواهینامه در انبار کلید JKS.

برای جزئیات بیشتر، مستندات keytool را ببینید.

مالک فایل keystore برونداد را به کاربر «apigee» تغییر دهید:
```
sudo chown apigee:apigee <keystore_file>
```
ویژگی‌های زیر را در 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

برای فعال کردن «امنیت لایه انتقال» در واحد Apigee SSO، با تنظیم SSO_TOMCAT_PROFILE روی SSL_TERMINATION یا روی SSL_PROXY، نمی‌توانید از گواهینامه خودامضایی استفاده کنید. باید گواهی را از مرجع صدور گواهی تولید کنید. برای اطلاعات بیشتر، پیکربندی 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.
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

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

نصب واحد Apigee SSO

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

برای نصب واحد Apigee SSO:

به سیستم گره «سرور مدیریت» وارد شوید. آن گره باید ازقبل apigee-service را نصب کرده باشد، همان‌طور که در نصب ابزار کمکی Edge apigee-setup توضیح داده شده است.
یا می‌توانید واحد Apigee SSO را در گره دیگری نصب کنید. بااین‌حال، آن گره باید بتواند ازطریق درگاه ۸۰۸۰ به «سرور مدیریت» دسترسی داشته باشد.
با اجرای فرمان زیر، 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 را به مسیر خود اضافه کنید.

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

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

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

محتوای فراداده XML را از IDP خود به فایلی در گره Apigee SSO کپی کنید. برای مثال، زبان نشانه‌گذاری توسعه‌پذیر را در اینجا کپی کنید:
```
/opt/apigee/customer/application/apigee-sso/saml/metadata.xml
```
توجه: فایل باید metadata.xml.
نام‌گذاری شود.

مالکیت فایل XML را به کاربر «apigee» تغییر دهید:

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://» پیشوندگذاری کنید و سپس مسیر مطلق را از ریشه (/) اضافه کنید.