ติดตั้งและกําหนดค่า SSO ของ Apigee

หากต้องการติดตั้งและกำหนดค่าโมดูล SSO ของ Apigee ด้วย IDP ภายนอก คุณต้องดำเนินการดังต่อไปนี้

  1. สร้างคีย์และใบรับรอง
  2. ตั้งค่าการกำหนดค่า SSO ของ Apigee พื้นฐาน: ไฟล์ฐานต้องมีพร็อพเพอร์ตี้ที่เหมือนกับการกำหนดค่า SSO ทั้งหมด
  3. เพิ่มพร็อพเพอร์ตี้การกำหนดค่าเฉพาะของ IdP: ใช้บล็อกของพร็อพเพอร์ตี้การกำหนดค่าเฉพาะของ IdP รายการต่อไปนี้ในไฟล์การกำหนดค่า
  4. ติดตั้ง SSO ของ Apigee: ติดตั้งโมดูล SSO ของ Apigee แล้วส่งไฟล์การกำหนดค่าไปยังโปรแกรมติดตั้ง

อ่านข้อมูลเกี่ยวกับแต่ละขั้นตอนเหล่านี้ได้ในส่วนต่อไปนี้

สร้างคีย์และใบรับรอง

หัวข้อนี้จะอธิบายวิธีสร้างใบรับรองแบบ Self-signed ซึ่งอาจเหมาะกับสภาพแวดล้อมการทดสอบ แต่คุณควรใช้ใบรับรองที่ลงชื่อโดยผู้ออกใบรับรอง (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. สร้างใบรับรองแบบ Self-signed ที่มีเวลาหมดอายุ 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 เมื่อตั้งค่า SSO_TOMCAT_PROFILE เป็น SSL_TERMINATION หรือ SSL_PROXY คุณจะใช้ใบรับรองที่ลงชื่อด้วยตนเองไม่ได้ คุณต้องสร้างใบรับรองจาก CA โปรดดูข้อมูลเพิ่มเติมที่กำหนดค่า Apigee SSO สำหรับการเข้าถึง HTTPS

การตั้งค่าการกำหนดค่า SSO ของ Apigee

คุณต้องกำหนดไฟล์การกำหนดค่าก่อน จึงจะติดตั้งโมดูล 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.
# 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 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

# 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

ติดตั้งโมดูล SSO ของ Apigee

หลังจากสร้างคีย์และตั้งค่าไฟล์การกำหนดค่าแล้ว คุณจะติดตั้งโมดูล SSO ของ Apigee ได้

วิธีติดตั้งโมดูล SSO ของ Apigee คือ

  1. เข้าสู่ระบบโหนด Management Server โหนดดังกล่าวควรมีการติดตั้ง apigee-service อยู่แล้วตามที่อธิบายไว้ในติดตั้งยูทิลิตี Edge Apigee-setup

    หรือคุณจะสามารถติดตั้งโมดูล SSO ของ 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. ออกจากระบบ Shell แล้วเข้าสู่ระบบอีกครั้งเพื่อเพิ่มยูทิลิตี apigee-ssoadminapi.sh ลงในเส้นทาง

ระบุไฟล์ข้อมูลเมตาแทน URL

หาก IdP ของคุณไม่รองรับ URL ข้อมูลเมตา HTTP/HTTPS คุณจะใช้ไฟล์ XML ของข้อมูลเมตาเพื่อกำหนดค่า SSO ของ Apigee ได้

วิธีใช้ไฟล์ข้อมูลเมตาแทน URL เพื่อกำหนดค่า SSO ของ Apigee

  1. คัดลอกเนื้อหาของ XML ข้อมูลเมตาจาก IdP ไปยังไฟล์ในโหนด SSO ของ 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://" ตามด้วยเส้นทางสัมบูรณ์จากรูท (/)