Định cấu hình apigee-sso để truy cập HTTPS

Edge cho đám mây riêng tư phiên bản 4.18.01

Cài đặt và định cấu hình SSO của Edge mô tả cách cài đặt và định cấu hình mô-đun SSO của Edge để sử dụng HTTP trên cổng 9099, như được chỉ định bởi thuộc tính sau trong tệp cấu hình:

SSO_TOMCAT_PROFILE=DEFAULT

Ngoài ra, bạn có thể đặt SSO_TOMCAT_PROFILE thành một trong các giá trị sau để bật quyền truy cập HTTPS:

  • SSL_PROXY – Định cấu hình apigee-sso ở chế độ proxy, nghĩa là bạn đã cài đặt trình cân bằng tải trước apigee-sso và chấm dứt TLS trên trình cân bằng tải. Sau đó, bạn chỉ định cổng được dùng trên apigee-sso cho các yêu cầu từ trình cân bằng tải.
  • SSL_TERMINATION – Đã bật quyền truy cập TLS vào apigee-sso, mô-đun SSO của Edge, trên cổng mà bạn chọn. Bạn phải chỉ định một kho khoá cho chế độ này, trong đó có chứa chứng chỉ do một CA ký. Bạn không thể sử dụng chứng chỉ tự ký.

Bạn có thể chọn bật HTTPS tại thời điểm cài đặt và định cấu hình apigee-sso ban đầu hoặc có thể bật sau.

Việc bật quyền truy cập HTTPS vào apigee-sso bằng một trong hai chế độ sẽ tắt quyền truy cập HTTP. Tức là bạn không thể truy cập đồng thời vào apigee-sso bằng cả HTTP và HTTPS.

Bật chế độ SSL_PROXY

Ở chế độ SSL_PROXY, hệ thống của bạn sử dụng trình cân bằng tải trước mô-đun SSO của Edge và chấm dứt TLS trên trình cân bằng tải. Trong hình sau, trình cân bằng tải chấm dứt TLS trên cổng 443, sau đó chuyển tiếp các yêu cầu đến mô-đun SSO của Edge trên cổng 9099:

Trong cấu hình này, bạn tin tưởng kết nối từ trình cân bằng tải đến mô-đun SSO của Edge, vì vậy, bạn không cần sử dụng TLS cho kết nối đó. Tuy nhiên, các thực thể bên ngoài, chẳng hạn như IDP SAML, hiện phải truy cập vào mô-đun SSO của Edge trên cổng 443, chứ không phải trên cổng không được bảo vệ là 9099.

Lý do để định cấu hình mô-đun SSO của Edge ở chế độ SSL_PROXY là mô-đun SSO của Edge được tạo tự động URL chuyển hướng được IDP sử dụng bên ngoài trong quá trình xác thực. Do đó, các URL chuyển hướng này phải chứa số cổng bên ngoài trên trình cân bằng tải (443 trong ví dụ này) chứ không phải cổng nội bộ trên mô-đun SSO của Edge (9099).

Lưu ý: Bạn không cần tạo chứng chỉ và khoá TLS cho chế độ SSL_PROXY vì kết nối từ trình cân bằng tải đến mô-đun SSO của Edge sử dụng HTTP.

Cách định cấu hình mô-đun SSO của Edge cho chế độ SSL_PROXY:

  1. Thêm các chế độ cài đặt sau vào tệp cấu hình:
    # Bật chế độ SSL_PROXY.
    SSO_TOMCAT_PROFILE=SSL_PROXY

    # Chỉ định cổng apigee-sso, thường là từ 1025 đến 65535.
    # Thông thường, các cổng 1024 trở xuống yêu cầu quyền truy cập thư mục gốc của apigee-sso.
    # Giá trị mặc định là 9099.
    SSO_TOMCAT_PORT=9099

    # Chỉ định số cổng trên trình cân bằng tải để chấm dứt TLS.
    # This port number is necessary for apigee-sso to auto-generate redirect URLs.
    SSO_TOMCAT_PROXY_PORT=443
    SSO_PUBLIC_URL_PORT=443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. Định cấu hình mô-đun SSO của Edge:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Cập nhật cấu hình IDP để tạo yêu cầu HTTPS trên cổng 443 của trình cân bằng tải nhằm truy cập vào Edge SSO. Hãy xem bài viết Định cấu hình nhà cung cấp danh tính (IDP) SAML để biết thêm thông tin.
  4. Cập nhật cấu hình giao diện người dùng Edge cho HTTPS bằng cách đặt các thuộc tính sau:
    SSO_PUBLIC_URL_PORT=443
    SSO_PUBLIC_URL_SCHEME=https

    Xem phần Bật SAML trên giao diện người dùng Edge để biết thêm thông tin.
  5. Nếu bạn đã cài đặt cổng Dịch vụ dành cho nhà phát triển hoặc API BaaS, hãy cập nhật các cổng này để sử dụng HTTPS nhằm truy cập vào Ede SSO. Để biết thêm thông tin, hãy xem:

Bật chế độ SSL_TERMINATION

Đối với chế độ SSL_TERMINATION, bạn phải:

  • Tạo chứng chỉ và khoá TLS rồi lưu trữ trong tệp kho khoá. Bạn không thể sử dụng chứng chỉ tự ký. Bạn phải tạo chứng chỉ từ một CA.
  • Cập nhật chế độ cài đặt cấu hình cho apigee-sso.

Cách tạo tệp kho khoá từ chứng chỉ và khoá:

  1. Tạo thư mục cho tệp JKS:
    > sudo mkdir -p /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  2. Thay đổi thành thư mục mới:
    > cd /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  3. Tạo tệp JKS chứa chứng chỉ và khoá. Bạn phải chỉ định một kho khoá cho chế độ này, trong đó có chứa chứng chỉ do CA ký. Bạn không thể sử dụng chứng chỉ tự ký. Để biết ví dụ về cách tạo tệp JKS, hãy xem phần Định cấu hình TLS/SSL cho Edge On Premises.
  4. Đặt người dùng "apigee" làm chủ sở hữu tệp JKS:
    > sudo chown -R apigee:apigee /opt/apigee/customer/application/apigee-sso/tomcat-ssl

Cách định cấu hình mô-đun SSO của Edge:

  1. Thêm các chế độ cài đặt sau vào tệp cấu hình:
    # Bật chế độ SSL_TERMINATION.
    SSO_TOMCAT_PROFILE=SSL_TERMINATION

    # Chỉ định đường dẫn đến tệp kho khoá.
    SSO_TOMCAT_KEYSTORE_FILEPATH=/opt/apigee/customer/application/apigee-sso/tomcat-ssl/keystore.jks
    SSO_TOMCAT_KEYSTORE_ALIAS=sso

    # The password specified when you created the keystore.
    SSO_TOMCAT_KEYSTORE_PASSWORD=keystorePassword

    # Chỉ định số cổng HTTPS từ 1025 đến 65535.
    # Thông thường, các cổng 1024 trở xuống yêu cầu quyền truy cập thư mục gốc của apigee-sso.
    # Giá trị mặc định là 9099.
    SSO_TOMCAT_PORT=9443
    SSO_PUBLIC_URL_PORT=9443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. Định cấu hình mô-đun SSO của Edge:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Cập nhật cấu hình IDP để gửi yêu cầu HTTPS trên cổng 9443 của trình cân bằng tải nhằm truy cập vào Edge SSO. Hãy xem bài viết Định cấu hình nhà cung cấp danh tính (IDP) SAML để biết thêm thông tin.
  4. Cập nhật cấu hình giao diện người dùng Edge cho HTTPS bằng cách đặt các thuộc tính sau:
    SSO_PUBLIC_URL_PORT=9443
    SSO_PUBLIC_URL_SCHEME=https

    Xem phần Bật SAML trên giao diện người dùng Edge để biết thêm thông tin.
  5. Nếu bạn đã cài đặt cổng Dịch vụ dành cho nhà phát triển hoặc API BaaS, hãy cập nhật các cổng này để sử dụng HTTPS nhằm truy cập vào Ede SSO. Để biết thêm thông tin, hãy xem:

Đặt SSO_TOMCAT_PROXY_PORT khi sử dụng chế độ SSL_TERMINATION

Bạn có thể có một trình cân bằng tải trước mô-đun SSO của Edge để chấm dứt TLS trên trình cân bằng tải, nhưng cũng bật TLS giữa trình cân bằng tải và SSO của Edge. Trong hình trên, đối với chế độ SSL_PROXY, điều này có nghĩa là kết nối từ trình cân bằng tải đến Edge SSO sử dụng TLS.

Trong trường hợp này, bạn định cấu hình TLS trên Edge SSO giống như cách bạn đã làm ở trên cho chế độ SSL_TERMINATION. Tuy nhiên, nếu trình cân bằng tải sử dụng số cổng TLS khác với số cổng TLS mà Edge SSO sử dụng cho TLS, thì bạn cũng phải chỉ định thuộc tính SSO_TOMCAT_PROXY_PORT trong tệp cấu hình. Ví dụ:

  • Trình cân bằng tải chấm dứt TLS trên cổng 443
  • Edge SSO chấm dứt TLS trên cổng 9443

Hãy nhớ thêm chế độ cài đặt sau vào tệp cấu hình:

# Chỉ định số cổng trên trình cân bằng tải để chấm dứt TLS.
# This port number is necessary for apigee-sso to generate redirect URLs.
SSO_TOMCAT_PROXY_PORT=443
SSO_PUBLIC_URL_PORT=443

Định cấu hình IDP và giao diện người dùng Edge để gửi yêu cầu HTTPS trên cổng 443.