Konfigurowanie protokołu TLS dla interfejsu API zarządzania

Domyślnie protokół TLS jest wyłączony w interfejsie API zarządzania. Dostęp do interfejsu Edge Management API uzyskuje się przez HTTP przy użyciu adresu IP węzła serwera zarządzania i portu 8080. Na przykład:

http://ms_IP:8080

Możesz też skonfigurować dostęp TLS do interfejsu API zarządzania w taki sposób, aby móc uzyskać do niego dostęp w tej formie:

https://ms_IP:8443

W tym przykładzie skonfigurujesz dostęp TLS tak, aby używać portu 8443. Jednak ten numer portu nie jest wymagany przez Edge. Możesz skonfigurować serwer zarządzania, aby używał innych wartości portów. Jedynym wymaganiem jest to, aby zapora sieciowa zezwalała na ruch przez określony port.

Aby zapewnić szyfrowanie ruchu do i z interfejsu API zarządzania, skonfiguruj ustawienia w pliku /opt/apigee/customer/application/management-server.properties.

Oprócz konfiguracji TLS możesz też kontrolować weryfikację hasła (długość i siłę hasła), modyfikując plik management-server.properties.

Upewnij się, że port TLS jest otwarty

Procedura podana w tej sekcji pozwala skonfigurować protokół TLS do używania portu 8443 na serwerze zarządzania. Niezależnie od używanego portu musisz się upewnić, że port na serwerze zarządzania musi być otwarty. Aby go otworzyć, możesz na przykład użyć tego polecenia:

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

Konfigurowanie TLS

Edytuj plik /opt/apigee/customer/application/management-server.properties, aby kontrolować użycie TLS w ruchu do i z interfejsu API zarządzania. Jeśli ten plik nie istnieje, utwórz go.

Aby skonfigurować dostęp TLS do interfejsu API do zarządzania:

  1. Wygeneruj plik JKS magazynu kluczy zawierający certyfikat TLS i klucz prywatny. Więcej informacji znajdziesz w artykule o konfigurowaniu TLS/SSL w środowisku Edge On.
  2. Skopiuj plik JKS magazynu kluczy do katalogu w węźle serwera zarządzania, np. /opt/apigee/customer/application.
  3. Zmień własność pliku JKS na użytkownika „apigee”:
    chown apigee:apigee keystore.jks

    Gdzie keystore.jks to nazwa pliku magazynu kluczy.

  4. Edytuj /opt/apigee/customer/application/management-server.properties, aby ustawić poniższe właściwości. Jeśli ten plik nie istnieje, utwórz go:
    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

    Gdzie keyStore.jks to plik magazynu kluczy, a obfuscatedPassword to zaciemnione hasło do magazynu kluczy. Informacje o generowaniu zaciemnionego hasła znajdziesz w artykule o konfigurowaniu TLS/SSL dla przeglądarki Edge On.

  5. Ponownie uruchom serwer zarządzania brzegowymi przy użyciu polecenia:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Interfejs API zarządzania obsługuje teraz dostęp przez protokół TLS.

Skonfiguruj interfejs Edge tak, aby używał TLS do uzyskiwania dostępu do interfejsu Edge API

W powyższej procedurze Apigee zaleca opuszczenie conf_webserver_http.turn.off=false, aby interfejs Edge nadal mógł wykonywać wywołania interfejsu Edge API przez HTTP.

Skorzystaj z poniższej procedury, aby skonfigurować interfejs Edge w taki sposób, aby wywołania te były wykonywane tylko przez HTTPS:

  1. Skonfiguruj dostęp TLS do interfejsu API zarządzania w sposób opisany powyżej.
  2. Gdy potwierdzisz, że protokół TLS działa w interfejsie API zarządzania, edytuj /opt/apigee/customer/application/management-server.properties, aby ustawić tę właściwość:
    conf_webserver_http.turn.off=true
  3. Ponownie uruchom serwer zarządzania brzegowymi, wykonując to polecenie:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart 
  4. Edytuj /opt/apigee/customer/application/ui.properties, aby ustawić tę właściwość interfejsu Edge:
    conf_apigee_apigee.mgmt.baseurl="https://FQ_domain_name:port/v1"

    Gdzie FQ_domain_name to pełna nazwa domeny zgodnie z adresem certyfikatu serwera zarządzania, a port to port określony powyżej przez conf_webserver_ssl.port.

    Jeśli ui.properties nie istnieje, utwórz ją.

  5. Tylko jeśli używasz samodzielnie podpisanego certyfikatu (niezalecanego w środowisku produkcyjnym) podczas konfigurowania dostępu TLS do powyższego interfejsu API zarządzania dodaj do ui.properties tę właściwość:
    conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate=true

    W przeciwnym razie interfejs Edge odrzuci certyfikat podpisany samodzielnie.

  6. Ponownie uruchom interfejs Edge, wykonując to polecenie:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Właściwości TLS serwera zarządzania

W tabeli poniżej znajdziesz wszystkie właściwości TLS/SSL, które możesz ustawić w management-server.properties:

Właściwości Opis

conf_webserver_http.port=8080

Wartość domyślna to 8080.

conf_webserver_ssl.enabled=false

Aby włączyć/wyłączyć TLS/SSL. Przy włączonym TLS/SSL (prawda) musisz też ustawić właściwości ssl.port i keystore.path.

conf_webserver_http.turn.off=true

Aby włączyć/wyłączyć protokół http i https. Jeśli chcesz używać tylko protokołu HTTPS, pozostaw wartość domyślną true.

conf_webserver_ssl.port=8443

Port TLS/SSL.

Wymagane, gdy włączony jest protokół TLS/SSL (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.path=path

Ścieżka do pliku magazynu kluczy.

Wymagane, gdy włączony jest protokół TLS/SSL (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.password=password

Użyj zaciemnionego hasła w formacie OBF:xxxxxxxxxx

conf_webserver_cert.alias=alias

Opcjonalny alias certyfikatu magazynu kluczy

conf_webserver_keymanager.password=password

Jeśli Twój menedżer kluczy ma hasło, wpisz zaciemnioną wersję hasła w tym formacie:

OBF:xxxxxxxxxx

conf_webserver_trust.all=[false | true]

conf_webserver_trust.store.path=path

conf_webserver_trust.store.password=password

Skonfiguruj ustawienia magazynu zaufania. Określ, czy chcesz akceptować wszystkie certyfikaty TLS/SSL (na przykład niestandardowe typy). Wartość domyślna to false. Podaj ścieżkę do magazynu zaufania i wpisz zaciemnione hasło do magazynu zaufania w tym formacie:

OBF:xxxxxxxxxx

conf_http_HTTPTransport.ssl.cipher.suites.blacklist=CIPHER_SUITE_1, CIPHER_SUITE_2

conf_http_HTTPTransport.ssl.cipher.suites.whitelist=

Wskaż zestawy szyfrów, które chcesz uwzględnić lub wykluczyć. Jeśli na przykład wykryjesz lukę w zabezpieczeniach szyfru, możesz go tutaj wykluczyć. Poszczególne mechanizmy szyfrowania rozdziel przecinkami.

Narzędzia usunięte z czarnej listy mają pierwszeństwo przed mechanizmami z białej listy.

Uwaga: jeśli nie podasz czarnej ani białej listy, mechanizmy szyfrowania pasujące do tego wyrażenia regularnego w Javie są domyślnie wykluczone.

^.*_(MD5|SHA|SHA1)$
^TLS_RSA_.*$
^SSL_.*$
^.*_NULL_.*$
^.*_anon_.*$

Jeśli jednak określisz czarną listę, ten filtr zostanie zastąpiony i trzeba będzie dodać wszystkie mechanizmy szyfrowania pojedynczo.

Informacje o pakietach szyfrów i architekturze kryptografii znajdziesz w dokumentacji Java Cryptography Architecture Providers Dokumentacja dostawcy oprogramowania JDK 8.

conf_webserver_ssl.session.cache.size=

conf_webserver_ssl.session.timeout=

Liczba całkowite, które określają:

  • Rozmiar pamięci podręcznej sesji TLS/SSL (w bajtach) służący do przechowywania informacji o sesjach wielu klientów.
  • Czas trwania sesji TLS/SSL, zanim nastąpi przekroczenie limitu czasu (w milisekundach).