為 HTTPS 存取權設定 apigee-sso

Edge for Private Cloud 4.17.09 版

安裝及設定 Edge SSO 說明如何安裝及設定 Edge SSO 模組，以便在通訊埠 9099 上使用 HTTP，如設定檔中的下列屬性所指定：

SSO_TOMCAT_PROFILE=DEFAULT

或者，您也可以將 SSO_TOMCAT_PROFILE 設為下列其中一個值，啟用 HTTPS 存取權：

  • SSL_PROXY：在 Proxy 模式下設定 apigee-sso，也就是在 apigee-sso 前方安裝負載平衡器，並在負載平衡器上終止 TLS。接著，指定 apigee-sso 上用於負載平衡器要求的通訊埠。
  • SSL_TERMINATION：在您選擇的通訊埠上，啟用對 Edge SSO 模組 apigee-sso 的 TLS 存取權。您必須為這個模式指定含有 CA 簽署憑證的金鑰庫。您無法使用自行簽署的憑證。

您可以在初次安裝及設定 apigee-sso 時啟用 HTTPS，也可以稍後再啟用。

使用任一模式啟用 apigee-sso 的 HTTPS 存取權，都會停用 HTTP 存取權。也就是說，您無法同時使用 HTTP 和 HTTPS 存取 apigee-sso。

啟用 SSL_PROXY 模式

在 SSL_PROXY 模式下，系統會在 Edge SSO 模組前方使用負載平衡器，並在負載平衡器上終止 TLS。在下圖中，負載平衡器會在通訊埠 443 終止 TLS，然後將要求轉送至通訊埠 9099 上的 Edge SSO 模組：

在這個設定中，您信任從負載平衡器到 Edge SSO 模組的連線，因此不需要為該連線使用 TLS。不過，外部實體 (例如 SAML IDP) 現在必須透過通訊埠 443 存取 Edge SSO 模組，而非未受保護的通訊埠 9099。

在 SSL_PROXY 模式下設定 Edge SSO 模組的原因，是 Edge SSO 模組會自動產生 IDP 在外部使用的重新導向網址，做為驗證程序的一部分。因此，這些重新導向網址必須包含負載平衡器上的外部通訊埠編號 (在本例中為 443)，而非 Edge SSO 模組上的內部通訊埠 9099。

注意：您不必為 SSL_PROXY 模式建立 TLS 憑證和金鑰，因為從負載平衡器到 Edge SSO 模組的連線會使用 HTTP。

如要將 Edge SSO 模組設為 SSL_PROXY 模式，請按照下列步驟操作：

  1. 在設定檔中新增下列設定：
    # Enable SSL_PROXY mode.
    SSO_TOMCAT_PROFILE=SSL_PROXY

    # Specify the apigee-sso port, typically between 1025 and 65535.
    # Typically ports 1024 and below require root access by apigee-sso.
    # 預設值為 9099。
    SSO_TOMCAT_PORT=9099

    # Specify the port number on the load balancer for terminating TLS.
    # This port number is necessary for apigee-sso to auto-generate redirect URLs.
    SSO_TOMCAT_PROXY_PORT=443
    SSO_PUBLIC_URL_PORT=443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. 設定 Edge SSO 模組：
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. 更新 IDP 設定，現在在負載平衡器的通訊埠 443 上發出 HTTPS 要求，即可存取 Edge SSO。詳情請參閱「設定 SAML IDP」。
  4. 設定下列屬性，更新 HTTPS 的 Edge UI 設定：
    SSO_PUBLIC_URL_PORT=443
    SSO_PUBLIC_URL_SCHEME=https

    詳情請參閱「在 Edge UI 上啟用 SAML」。
  5. 如果您已安裝開發人員服務入口網站或 API BaaS，請將其更新為使用 HTTPS 存取 Edge SSO。詳情請參閱：

啟用 SSL_TERMINATION 模式

如果是 SSL_TERMINATION 模式，您必須：

  • 產生 TLS 憑證和金鑰，並儲存在 KeyStore 檔案中。您無法使用自行簽署的憑證。您必須從 CA 產生憑證。
  • 更新 apigee-sso 的配置設定。

如要使用憑證和金鑰建立 KeyStore 檔案，請按照下列步驟操作：

  1. 建立 JKS 檔案的目錄：
    > sudo mkdir -p /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  2. 切換至新目錄：
    > cd /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  3. 建立含有憑證和金鑰的 JKS 檔案。您必須為這個模式指定含有 CA 簽署憑證的金鑰庫。您無法使用自行簽署的憑證。如需建立 JKS 檔案的範例，請參閱「為 Edge On-Premises 設定 TLS/SSL」。
  4. 將 JKS 檔案設為由「apigee」使用者擁有：
    > sudo chown -R apigee:apigee /opt/apigee/customer/application/apigee-sso/tomcat-ssl

如要設定 Edge SSO 模組，請按照下列步驟操作：

  1. 在設定檔中新增下列設定：
    # Enable SSL_TERMINATION mode.
    SSO_TOMCAT_PROFILE=SSL_TERMINATION

    # Specify the path to the keystore file.
    SSO_TOMCAT_KEYSTORE_FILEPATH=/opt/apigee/customer/application/apigee-sso/tomcat-ssl/keystore.jks
    SSO_TOMCAT_KEYSTORE_ALIAS=sso

    # The password specified when you created the keystore.
    SSO_TOMCAT_KEYSTORE_PASSWORD=keystorePassword

    # Specify the HTTPS port number between 1025 and 65535.
    # Typically ports 1024 and below require root access by apigee-sso.
    # 預設值為 9099。
    SSO_TOMCAT_PORT=9443
    SSO_PUBLIC_URL_PORT=9443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. 設定 Edge SSO 模組：
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. 更新 IDP 設定，現在在負載平衡器的通訊埠 9443 上發出 HTTPS 要求，即可存取 Edge SSO。詳情請參閱「設定 SAML IDP」。
  4. 設定下列屬性，更新 Edge UI 的 HTTPS 設定：
    SSO_PUBLIC_URL_PORT=9443
    SSO_PUBLIC_URL_SCHEME=https

    詳情請參閱「在 Edge UI 上啟用 SAML」。
  5. 如果您已安裝開發人員服務入口網站或 API BaaS，請將其更新為使用 HTTPS 存取 Edge SSO。詳情請參閱：

使用 SSL_TERMINATION 模式時設定 SSO_TOMCAT_PROXY_PORT

Edge SSO 模組前方可能有負載平衡器，可終止負載平衡器上的 TLS，但也會在負載平衡器和 Edge SSO 之間啟用 TLS。在上圖的 SSL_PROXY 模式中，這表示從負載平衡器到 Edge SSO 的連線使用 TLS。

在這個情境中，您會在 Edge SSO 上設定 TLS，就像上述 SSL_TERMINATION 模式一樣。不過，如果負載平衡器使用的 TLS 通訊埠編號與 Edge SSO 用於 TLS 的通訊埠編號不同，您也必須在設定檔中指定 SSO_TOMCAT_PROXY_PORT 屬性。例如：

  • 負載平衡器會在通訊埠 443 終止 TLS
  • Edge SSO 會在通訊埠 9443 終止 TLS

請務必在設定檔中加入下列設定：

# Specify the port number on the load balancer for terminating TLS.
# This port number is necessary for apigee-sso to generate redirect URLs.
SSO_TOMCAT_PROXY_PORT=443
SSO_PUBLIC_URL_PORT=443

設定 IDP 和 Edge UI，透過通訊埠 443 傳送 HTTPS 要求。