Management API の TLS の構成

Edge for Private Cloud v4.19.01

デフォルトでは、Management API の TLS は無効になっており、Management Server ノードの IP アドレスとポート 8080 を使用して HTTP で Edge Management API にアクセスします。例:

http://ms_IP:8080

また、次の形式で管理 API にアクセスできるように、管理 API への TLS アクセスを構成することもできます。

https://ms_IP:8443

この例では、ポート 8443 を使用するように TLS アクセスを構成します。ただし、Edge では、このポート番号は必要ありません。他のポート番号を使用するように Management Server を構成できます。唯一の要件は、ファイアウォールが指定されたポートでトラフィックを許可することです。

Management API との間のトラフィックを暗号化するには、/opt/apigee/customer/application/management-server.properties ファイル内の設定を構成します。

TLS 構成に加えて、management-server.properties ファイルを変更することで、パスワード検証(パスワードの長さと強度)を制御することもできます。

TLS ポートが開いていることを確認する

このセクションの手順では、Management Server でポート 8443 を使用するように TLS を構成します。使用するポートに関係なく、Management Server でポートが開いている必要があります。たとえば、次のコマンドを使用して開くことができます。

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

TLS の構成

/opt/apigee/customer/application/management-server.properties ファイルを編集して、管理 API との間のトラフィックでの TLS の使用を制御します。このファイルが存在しない場合は作成します。

管理 API への TLS アクセスを構成するには:

  1. TLS 証明書と秘密鍵を含むキーストア JKS ファイルを生成します。詳細については、オンプレミスの Edge での TLS/SSL の構成をご覧ください。
  2. キーストア JKS ファイルを Management Server ノードのディレクトリ(/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 での TLS/SSL の構成をご覧ください。

  5. /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
    コマンドを使用して Edge Management Server を再起動します。

管理 API で TLS 経由のアクセスがサポートされるようになりました。

TLS を使用して Edge API にアクセスするように Edge UI を構成する

上記の手順では、Edge UI が引き続き HTTP 経由で Edge API 呼び出しを行えるように、conf_webserver_http.turn.off=false を終了することをおすすめします。

HTTPS 経由でのみこれらの呼び出しを行うように Edge UI を構成するには、次の操作を行います。

  1. 上記のように、管理 API への TLS アクセスを構成します。
  2. Management API で TLS が動作していることを確認したら、/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 UI の次のプロパティを設定します。
    conf_apigee_apigee.mgmt.baseurl="https://FQ_domain_name:port/v1"

    ここで、FQ_domain_name は Management Server の証明書アドレスに基づく完全なドメイン名で、port は上記の conf_webserver_ssl.port で指定されたポートです。

    ui.properties が存在しない場合は作成します。

  5. 自己署名証明書を使用した場合のみ(本番環境では推奨されません)上記の管理 API への TLS アクセスを構成するときに、次のプロパティを ui.properties に追加します。
    conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate=true

    そうしないと、自己署名証明書は Edge UI で拒否されます。

  6. 次のコマンドを実行して、Edge UI を再起動します。
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Management Server の TLS プロパティ

次の表に、management-server.properties で設定できるすべての TLS/SSL プロパティを示します。

プロパティ 説明

conf_webserver_http.port=8080

デフォルトは 8,080 です。

conf_webserver_ssl.enabled=false

TLS / SSL を有効または無効にする。TLS/SSL が有効(true)の場合は、ssl.port プロパティと keystore.path プロパティも設定する必要があります。

conf_webserver_http.turn.off=true

https に加えて http も有効または無効にします。HTTPS のみを使用する場合は、デフォルト値を true のままにします。

conf_webserver_ssl.port=8443

TLS/SSL ポート。

TLS/SSL が有効な場合は必須です(conf_webserver_ssl.enabled=true)。

conf_webserver_keystore.path=path

キーストア ファイルのパス。

TLS/SSL が有効な場合は必須です(conf_webserver_ssl.enabled=true)。

conf_webserver_keystore.password=password

OBF:xxxxxxxxxx という形式の難読化されたパスワードを使用してください

conf_webserver_cert.alias=alias

キーストア証明書のエイリアス(省略可)

conf_webserver_keymanager.password=password

鍵マネージャーにパスワードがある場合は、次の形式で難読化されたバージョンのパスワードを入力します。

OBF:xxxxxxxxxx

conf_webserver_trust.all=[false | true]

conf_webserver_trust.store.path=path

conf_webserver_trust.store.password=password

トラストストアの設定を構成します。すべての TLS/SSL 証明書を受け入れるかどうか(非標準のタイプなどを受け入れるかどうか)を決定します。デフォルトは false です。トラストストアへのパスを指定し、難読化されたトラストストアのパスワードを次の形式で入力します。

OBF:xxxxxxxxxx

conf_webserver_exclude.cipher.suites=CIPHER_SUITE_1 CIPHER_SUITE_2

conf_webserver_include.cipher.suites=

包含または除外する暗号スイートを指定します。たとえば、暗号に脆弱性が見つかった場合は、ここで除外できます。複数の暗号を指定する場合は、スペースで区切ります。

暗号スイートと暗号アーキテクチャについては、 JDK 8 向け Java 暗号化アーキテクチャ Oracle プロバイダ ドキュメントをご覧ください。

conf_webserver_ssl.session.cache.size=

conf_webserver_ssl.session.timeout=

以下を判断する整数:

  • 複数のクライアントのセッション情報を保存する TLS/SSL セッション キャッシュ サイズ(バイト単位)。
  • TLS/SSL セッションがタイムアウトになるまでの時間(ミリ秒)。