在啟用 FIPS 的 RHEL 8.X 上執行 Edge for Private Cloud

本節說明如何在 RHEL 8 上啟用 FIPS 模式,確保 Edge for Private Cloud 4.53.00 以上版本的環境安全且符合規範。

預先安裝

請確認節點已啟用 FIPS,並符合「Edge 安裝總覽」說明文件列出的其他標準設定必要條件。

fips-mode-setup --check  
FIPS mode is enabled.  # Command output

如果 FIPS 模式目前已停用,請參閱 Red Hat 官方說明文件,瞭解如何啟用:將 RHEL 8 切換至 FIPS 模式。

Java 需求

您使用的 Java 應從 Red Hat 的存放區下載,確保其安全性模組符合 FIPS 規範,並透過 Java 安全性啟用 FIPS 專屬限制。

安裝

在 Edge 設定檔參考資料中,為每個節點設定 FIPS_OS=true。您可以按照一般步驟安裝 Edge for Private Cloud。

私密金鑰格式

只有 PKCS12/PFX 格式可用於將私密金鑰上傳至 Apigee 鍵盤,以便在 API Proxy 或虛擬主機中使用。如需建立檔案的指南,請參閱「將憑證轉換為支援的格式」。

一般 TLS 作業

在啟用 FIPS 的 RHEL 8.X 上使用 Edge for Private Cloud 4.53.00 以上版本時,Edge 的大部分 TLS 相關元件設定都必須透過 PKCS12 或 BCFKS 格式的金鑰儲存庫完成。

如要瞭解詳情,請參閱 TLS 設定相關說明文章中的 FIPS 專屬說明文件或附註。附錄列出一些實用指令,可用來產生這些 KeyStore。

預設 Java KeyStore/TrustStore

在啟用 FIPS 的 RHEL 8.X 上使用 Edge for Private Cloud 4.53.00 時,訊息處理器、Management Server 和其他 edge-* 元件預設會指向產品隨附的預留位置 BCFKS 鍵盤儲存庫和信任儲存庫 (/opt/apigee/edge-gateway/vault/bcfks-cacerts)。

如要產生自己的 BCFKS cacerts 存放區,並設定 Edge 元件使用該存放區,請按照下列步驟操作:

  1. 產生自己的 BCFKS 格式 cacerts 檔案,其中包含您要信任的所有 CA 憑證。請確認金鑰庫密碼和金鑰密碼相同 (如果適用嚴格的 BCFIPS 密碼檢查,則至少須有 14 個字元)。

    • 方法 A:將主機 OS 或 JDK cacerts 存放區轉換為 BCFKS 格式 (如要納入由 update-ca-trust 管理的標準 OS 信任根 CA,建議採用此方法):

      BC_FIPS_JAR=$(ls /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-*.jar \
        | head -n 1)
      keytool -J-Dcom.redhat.fips=false -importkeystore \
        -srckeystore /etc/pki/java/cacerts \
        -srcstoretype JKS \
        -srcstorepass changeit \
        -destkeystore my-cacerts.bcfks \
        -deststoretype BCFKS \
        -deststorepass YOUR_STORE_PASSWORD \
        -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \
        -providername BCFIPS \
        -providerpath "$BC_FIPS_JAR" \
        -noprompt
    • 方法 B:使用自訂 CA 憑證 (.pem 或 .crt) 建立新的 BCFKS 存放區,或將其他自訂 CA 憑證匯入現有的 BCFKS 存放區 (例如方法 A 的 my-cacerts.bcfks):

      BC_FIPS_JAR=$(ls /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-*.jar \
        | head -n 1)
      keytool -J-Dcom.redhat.fips=false -importcert \
        -file PATH_TO_CA_CERT.pem \
        -alias CA_ALIAS \
        -keystore my-cacerts.bcfks \
        -storetype BCFKS \
        -storepass YOUR_STORE_PASSWORD \
        -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \
        -providername BCFIPS \
        -providerpath "$BC_FIPS_JAR" \
        -noprompt
    • 選用:驗證 BCFKS 存放區的內容:

      BC_FIPS_JAR=$(ls /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-*.jar \
        | head -n 1)
      keytool -J-Dcom.redhat.fips=false -list \
        -keystore my-cacerts.bcfks \
        -storetype BCFKS \
        -storepass YOUR_STORE_PASSWORD \
        -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \
        -providername BCFIPS \
        -providerpath "$BC_FIPS_JAR"
  2. 在執行步驟 3 所列任何 Edge 元件的每個節點上,將 BCFKS 檔案複製到適當的路徑,並確保 apigee 使用者可以讀取該檔案:

    cp my-cacerts.bcfks /opt/apigee/customer/application/my-cacerts.bcfks
    chown apigee:apigee /opt/apigee/customer/application/my-cacerts.bcfks
    chmod 600 /opt/apigee/customer/application/my-cacerts.bcfks
  3. 在每個節點上,為下表列出的每個已安裝元件建立或編輯設定檔 (針對節點上列出的每個元件,重複步驟 3 至 6):

    元件 檔案
    edge-management-server /opt/apigee/customer/application/management-server.properties
    edge-message-processor /opt/apigee/customer/application/message-processor.properties
    edge-router /opt/apigee/customer/application/router.properties
    edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
    edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
  4. 在設定檔中新增下列幾行內容:

    conf_system_javax.net.ssl.trustStore=/opt/apigee/customer/application/my-cacerts.bcfks
    conf_system_javax.net.ssl.trustStorePassword=YOUR_STORE_PASSWORD
    conf_system_javax.net.ssl.keyStore=/opt/apigee/customer/application/my-cacerts.bcfks
    conf_system_javax.net.ssl.keyStoreType=BCFKS
    conf_system_javax.net.ssl.keyStorePassword=YOUR_STORE_PASSWORD

    將 /opt/apigee/customer/application/my-cacerts.bcfks 和 YOUR_STORE_PASSWORD 替換為 BCFKS cacerts 檔案的路徑和密碼。

  5. 確認 apigee 使用者擁有並可讀取設定檔:

    chown apigee:apigee /opt/apigee/customer/application/FILE.properties
  6. 重新啟動元件:

    /opt/apigee/apigee-service/bin/apigee-service COMPONENT restart

附錄

BCFKS 鍵盤儲存庫作業指令範例

下列指令會產生 BCFKS 鍵盤,其中包含自行簽署的金鑰和憑證組合:

keytool -genkeypair -keyalg RSA -alias node0 -validity 365 -keystore keystore.node0 \
-storepass keypass -keypass keypass -v \
-dname "EMAILADDRESS=youremail@domain.com, CN=yourcn, OU=yourou, O=youro, L=yourl, C=yourc" \
-storetype BCFKS -providerpath /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-1.0.2.4.jar \
-providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider -providername BCFIPS

Keytool 指令與一般使用的指令一致,但必須包含下列選項:

--storetype BCFKS -providerpath /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-1.0.2.4.jar
-providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider 
-providername BCFIPS

Keytool 引數

Keytool 引數 說明
-storetype 將商店類型設為「BCFKS」。
-providerpath 指定 bc-fips-XXXX.jar 的路徑。這個版本可能會在日後的 OPDK 版本中變更。請使用 Apigee 提供的版本,或從 Bouncycastle 的存放區下載。如果是 OPDK 4.53,路徑應為 /opt/apigee/edge-gateway/lib/thirdparty/bc-fips-1.0.2.4.jar。
-providerclass 請將此值設為 org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider。
-providername 請將此值設為 BCFIPS。

您可以使用類似的 keytool 指令,從 BCFKS 格式金鑰庫匯入或匯出憑證和/或金鑰。如要進一步瞭解如何使用 BCFKS,請參閱 BouncyCastle 說明文件。

PKCS12 儲存庫

如要產生 PKCS12 儲存庫,可以使用 openssl 指令:

# Generate a self-signed private key and certificate
openssl req -x509 -newkey rsa:2048 -keyout private.key -out certificate.pem -sha256 -days 36500 -nodes -subj "/C=yourc/ST=yourst/L=yourl/O=youro/OU=yourou/CN=cn/emailAddress=email"
# Package the above generated key and cert into a PKCS12
openssl pkcs12 -export -clcerts -in certificate.pem -inkey private.key -out keystore.pfx -name myalias

如果您有自己的私密金鑰和憑證,且需要將其轉換為 PKCS12 格式,請參閱「將憑證轉換為支援的格式」。