Định cấu hình TLS cho API quản lý

Theo mặc định, TLS bị tắt cho API quản lý và bạn truy cập vào API quản lý Edge qua HTTP bằng cách sử dụng địa chỉ IP của nút Máy chủ quản lý và cổng 8080. Ví dụ:

http://ms_IP:8080

Ngoài ra, bạn có thể định cấu hình quyền truy cập TLS vào API quản lý để có thể truy cập API đó trong biểu mẫu:

https://ms_IP:8443

Trong ví dụ này, bạn định cấu hình quyền truy cập TLS để sử dụng cổng 8443. Tuy nhiên, Edge không yêu cầu số cổng đó. Bạn có thể định cấu hình Máy chủ quản lý để sử dụng các giá trị cổng khác. Yêu cầu duy nhất là tường lửa của bạn cho phép lưu lượng truy cập qua cổng đã chỉ định.

Để đảm bảo việc mã hoá lưu lượng truy cập đến và đi từ API quản lý, hãy định cấu hình các chế độ cài đặt trong tệp /opt/apigee/customer/application/management-server.properties.

Ngoài cấu hình TLS, bạn cũng có thể kiểm soát hoạt động xác thực mật khẩu (độ dài và độ mạnh của mật khẩu) bằng cách sửa đổi tệp management-server.properties.

Đảm bảo rằng cổng TLS đang mở

Quy trình trong phần này định cấu hình TLS để sử dụng cổng 8443 trên Máy chủ quản lý. Bất kể cổng bạn sử dụng là gì, bạn phải đảm bảo cổng đó đang mở trên Máy chủ quản lý. Ví dụ: bạn có thể sử dụng lệnh sau để mở tệp:

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

Định cấu hình TLS

Chỉnh sửa tệp /opt/apigee/customer/application/management-server.properties để kiểm soát việc sử dụng TLS trên lưu lượng truy cập đến và đi từ API quản lý. Nếu tệp này không tồn tại, hãy tạo tệp.

Cách định cấu hình quyền truy cập TLS vào API quản lý:

  1. Tạo tệp JKS trong kho khoá chứa chứng chỉ TLS và khoá riêng tư của bạn. Để biết thêm thông tin, hãy xem bài viết Định cấu hình TLS/SSL cho Edge On Premises.
  2. Sao chép tệp JKS của kho khoá vào một thư mục trên nút Máy chủ quản lý, chẳng hạn như /opt/apigee/customer/application.
  3. Thay đổi quyền sở hữu tệp JKS thành người dùng "apigee":
    chown apigee:apigee keystore.jks

    Trong đó keystore.jks là tên của tệp kho khoá.

  4. Chỉnh sửa /opt/apigee/customer/application/management-server.properties để đặt các thuộc tính sau. Nếu tệp đó không tồn tại, hãy tạo tệp:
    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

    Trong đó keyStore.jks là tệp kho khoá của bạn, còn obfuscatedPassword là mật khẩu kho khoá bị làm rối mã nguồn của bạn. Hãy xem phần Định cấu hình TLS/SSL cho Edge On Premises để biết thông tin về cách tạo mật khẩu được làm rối mã nguồn.

  5. Khởi động lại Máy chủ quản lý Edge bằng lệnh:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

API quản lý hiện hỗ trợ quyền truy cập qua TLS.

Định cấu hình giao diện người dùng Edge để sử dụng TLS truy cập vào API Edge

Trong quy trình trên, bạn nên rời khỏi conf_webserver_http.turn.off=false để giao diện người dùng Edge có thể tiếp tục thực hiện các lệnh gọi API Edge qua HTTP.

Hãy sử dụng quy trình sau để định cấu hình giao diện người dùng Edge để chỉ thực hiện các lệnh gọi này qua HTTPS:

  1. Định cấu hình quyền truy cập TLS vào API quản lý như mô tả ở trên.
  2. Sau khi xác nhận rằng TLS đang hoạt động cho API quản lý, hãy chỉnh sửa /opt/apigee/customer/application/management-server.properties để đặt thuộc tính sau:
    conf_webserver_http.turn.off=true
  3. Khởi động lại Máy chủ quản lý Edge bằng cách thực thi lệnh sau:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart 
  4. Chỉnh sửa /opt/apigee/customer/application/ui.properties để đặt thuộc tính sau cho giao diện người dùng Edge:
    conf_apigee_apigee.mgmt.baseurl="https://FQ_domain_name:port/v1"

    Trong đó, FQ_domain_name là tên miền đầy đủ, theo địa chỉ chứng chỉ của Máy chủ quản lý và port là cổng do conf_webserver_ssl.port chỉ định ở trên.

    Nếu ui.properties không tồn tại, hãy tạo nó.

  5. Chỉ khi bạn đã sử dụng chứng chỉ tự ký (không nên dùng trong môi trường chính thức) khi định cấu hình quyền truy cập TLS vào API quản lý ở trên, hãy thêm thuộc tính sau vào ui.properties:
    conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate=true

    Nếu không, giao diện người dùng Edge sẽ từ chối chứng chỉ tự ký.

  6. Khởi động lại giao diện người dùng Edge bằng cách thực thi lệnh sau:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Sử dụng kho khoá PKCS12 cho các hệ điều hành hỗ trợ FIPS

Nếu đang sử dụng Edge for Private Cloud trên một hệ điều hành hỗ trợ FIPS, bạn phải sử dụng kho khoá PKCS12. Bạn phải thực hiện việc này để tuân thủ các tiêu chuẩn FIPS. Ngoài các cấu hình tiêu chuẩn khác được đề cập trong bài viết này, hãy thêm cấu hình sau vào tệp management-server.properties:

conf/webserver.properties+keystore.type=PKCS12

Đừng quên áp dụng thay đổi này nếu môi trường của bạn có hỗ trợ FIPS để đảm bảo khả năng tương thích với các tiêu chuẩn mã hoá bắt buộc.

Thuộc tính TLS cho Máy chủ quản lý

Bảng sau đây liệt kê tất cả các thuộc tính TLS/SSL mà bạn có thể thiết lập trong management-server.properties:

Thuộc tính Mô tả

conf_webserver_http.port=8080

Giá trị mặc định là 8080.

conf_webserver_ssl.enabled=false

Cách bật/tắt TLS/SSL. Khi bật TLS/SSL (đúng), bạn cũng phải đặt thuộc tính ssl.port và keystore.path.

conf_webserver_http.turn.off=true

Cách bật/tắt http cùng với https. Nếu bạn chỉ muốn sử dụng HTTPS, hãy để giá trị mặc định là true.

conf_webserver_ssl.port=8443

Cổng TLS/SSL.

Bắt buộc khi bật TLS/SSL (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.path=path

Đường dẫn đến tệp kho khoá.

Bắt buộc khi bật TLS/SSL (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.password=password

Sử dụng mật khẩu được làm rối mã nguồn theo định dạng sau: OBF:xxxxxxxxxx

conf_webserver_cert.alias=alias

Bí danh chứng chỉ kho khoá (không bắt buộc)

conf_webserver_keymanager.password=password

Nếu trình quản lý khoá của bạn có mật khẩu, hãy nhập phiên bản mật khẩu đã làm rối mã nguồn theo định dạng sau:

OBF:xxxxxxxxxx

conf_webserver_trust.all=[false | true]

conf_webserver_trust.store.path=path

conf_webserver_trust.store.password=password

Định cấu hình chế độ cài đặt cho kho tin cậy. Xác định xem bạn có muốn chấp nhận tất cả chứng chỉ TLS/SSL hay không (ví dụ: để chấp nhận các loại không theo chuẩn). Giá trị mặc định là false. Cung cấp đường dẫn đến kho lưu trữ đáng tin cậy và nhập mật khẩu kho lưu trữ đáng tin cậy đã làm rối mã nguồn theo định dạng sau:

OBF:xxxxxxxxxx

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

conf_http_HTTPTransport.ssl.cipher.suites.whitelist=

Chỉ định mọi bộ mật mã mà bạn muốn đưa vào hoặc loại trừ. Ví dụ: nếu phát hiện lỗ hổng trong một thuật toán mã hoá, bạn có thể loại trừ thuật toán đó tại đây. Phân tách nhiều thuật toán mật mã bằng dấu phẩy.

Mọi thuật toán mã hoá mà bạn xoá thông qua danh sách đen sẽ được ưu tiên hơn mọi thuật toán mã hoá được đưa vào thông qua danh sách trắng.

Lưu ý: Theo mặc định, nếu bạn không chỉ định danh sách đen hoặc danh sách trắng, thì các thuật toán mã hoá khớp với biểu thức chính quy Java sau đây sẽ bị loại trừ theo mặc định.

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

Tuy nhiên, nếu bạn chỉ định danh sách đen, bộ lọc này sẽ bị ghi đè và bạn phải đưa tất cả các thuật toán mã hoá vào danh sách đen riêng lẻ.

Để biết thông tin về bộ cypher và kiến trúc mật mã học, hãy xem Tài liệu về nhà cung cấp Oracle kiến trúc mã hoá Java cho JDK 8.

conf_webserver_ssl.session.cache.size=

conf_webserver_ssl.session.timeout=

Số nguyên xác định:

  • Kích thước bộ nhớ đệm của phiên TLS/SSL (tính bằng byte) để lưu trữ thông tin về phiên cho nhiều ứng dụng.
  • Thời lượng của các phiên TLS/SSL có thể kéo dài trước khi hết thời gian chờ (tính bằng mili giây).