为 Management API 配置 TLS

Edge for Private Cloud v4.19.01

默认情况下，管理 API 的 TLS 处于停用状态，您可以使用 Management Server 节点的 IP 地址和端口 8080 通过 HTTP 访问 Edge Management API。例如：

http://ms_IP:8080

或者，您可以配置对 Management API 的 TLS 访问权限，以便通过以下形式访问它：

https://ms_IP:8443

在此示例中，您将 TLS 访问配置为使用端口 8443。但是，Edge 不需要该端口号 - 您可以将 Management Server 配置为使用其他端口值。唯一的要求是您的防火墙允许通过指定端口传输流量。

如需确保进出 Management API 的流量加密，请在 /opt/apigee/customer/application/management-server.properties 文件中配置设置。

除了 TLS 配置之外，您还可以通过修改 management-server.properties 文件来控制密码验证（密码长度和强度）。

确保 TLS 端口已打开

本部分中的过程会将 TLS 配置为在管理服务器上使用端口 8443。无论您使用哪个端口，都必须确保该端口在管理服务器上处于打开状态。例如，您可以使用以下命令打开它：

iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 8443 -j ACCEPT --verbose

配置 TLS

修改 /opt/apigee/customer/application/management-server.properties 文件，以控制进出 Management API 的流量的 TLS 使用。如果此文件不存在，请创建它。

如需配置对 Management API 的 TLS 访问权限，请执行以下操作：

1. 生成包含 TLS 证书和私钥的密钥库 JKS 文件。如需了解详情，请参阅为 Edge for On-Premises 配置 TLS/SSL。
2. 将密钥库 JKS 文件复制到管理服务器节点上的目录，例如 /opt/apigee/customer/application。
3. 将 JKS 文件的所有权更改为“apigee”用户：

   chown apigee:apigee keystore.jks

   其中，keystore.jks 是密钥库文件的名称。

4. 修改 /opt/apigee/customer/application/management-server.properties 以设置以下属性。如果该文件不存在，请创建它：

   conf_webserver_ssl.enabled=true
   # Leave conf_webserver_http.turn.off set to false
   # because many Edge internal calls use HTTP.
   conf_webserver_http.turn.off=false
   conf_webserver_ssl.port=8443
   conf_webserver_keystore.path=/opt/apigee/customer/application/keystore.jks
   # Enter the obfuscated keystore password below.
   conf_webserver_keystore.password=OBF:obfuscatedPassword

   其中，keyStore.jks 是您的密钥库文件，obfuscatedPassword 是经过混淆处理的密钥库密码。如需了解如何生成经过混淆处理的密码，请参阅为 Edge for Private Cloud 配置 TLS/SSL。

5. 使用以下命令重启 Edge Management Server：

   /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

管理 API 现在支持通过 TLS 进行访问。

将 Edge 界面配置为使用 TLS 访问 Edge API

在上述过程中，Apigee 建议保留 conf_webserver_http.turn.off=false，以便 Edge 界面可以继续通过 HTTP 发出 Edge API 调用。

请按照以下步骤配置 Edge 界面，使其仅通过 HTTPS 发出这些调用：

1. 按照上述说明配置对 Management API 的 TLS 访问权限。
2. 确认 TLS 适用于 Management API 后，修改 /opt/apigee/customer/application/management-server.properties 以设置以下属性：

   conf_webserver_http.turn.off=true

3. 执行以下命令，重启 Edge Management Server：

   /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart 

4. 修改 /opt/apigee/customer/application/ui.properties，为 Edge 界面设置以下属性：

   conf_apigee_apigee.mgmt.baseurl="https://FQ_domain_name:port/v1"

   其中 FQ_domain_name 是完整域名（根据管理服务器的证书地址），port 是上面由 conf_webserver_ssl.port 指定的端口。

   如果 ui.properties 不存在，请创建它。

5. 仅当您在配置对上述 Management API 的 TLS 访问权限时使用了自签名证书（不建议在生产环境中使用），才需要将以下属性添加到 ui.properties：

   conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate=true

   否则，Edge 界面会拒绝自签名证书。

6. 执行以下命令重启 Edge 界面：

   /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Management Server 的 TLS 属性

下表列出了您可以在 management-server.properties 中设置的所有 TLS/SSL 属性：

OBF:xxxxxxxxxx

OBF:xxxxxxxxxx