Định cấu hình cổng thông tin để sử dụng SAML để giao tiếp với Edge

Edge for Private Cloud v4.18.05

Cổng thông tin Dịch vụ dành cho nhà phát triển Apigee (hoặc đơn giản là cổng thông tin) đóng vai trò là ứng dụng khách của Apigee Edge. Điều đó có nghĩa là cổng thông tin không hoạt động như một hệ thống độc lập. Thay vào đó, hầu hết thông tin mà cổng thông tin sử dụng thực sự được lưu trữ trên Edge. Khi cần, cổng sẽ đưa ra yêu cầu truy xuất thông tin từ Edge hoặc gửi thông tin đến Edge.

Cổng thông tin luôn được liên kết với một tổ chức Edge duy nhất. Khi định cấu hình trang web, bạn có thể chỉ định thông tin xác thực cơ bản (tên người dùng và mật khẩu) cho một tài khoản trong tổ chức mà trang web sử dụng để giao tiếp với Edge.

Nếu chọn bật SAML để xác thực Edge, bạn có thể định cấu hình cổng thông tin để sử dụng phương thức xác thực SAML khi gửi yêu cầu đến Edge. Việc định cấu hình cổng để sử dụng SAML sẽ tự động tạo một tài khoản người dùng máy mới trong tổ chức Edge mà sau đó cổng sẽ sử dụng để gửi yêu cầu đến Edge. Để biết thêm về người dùng máy, hãy xem phần Sử dụng SAML với các tác vụ tự động.

Để hỗ trợ SAML cho cổng thông tin, bạn phải cài đặt và định cấu hình mô-đun SSO của Edge trên nút Máy chủ quản lý Edge. Quy trình chung để bật SAML cho trang web là:

  1. Định cấu hình SAML trên Edge như mô tả trong phần Cài đặt và định cấu hình SAML cho Edge. Lưu ý: Bạn vẫn phải bật tính năng Xác thực cơ bản trên Edge để cài đặt trang web. Đừng tắt tính năng Xác thực cơ bản trên Edge cho đến khi bạn đã định cấu hình cổng thông tin để sử dụng SAML.
  2. Cài đặt cổng thông tin và đảm bảo rằng quá trình cài đặt của bạn đang hoạt động đúng cách. Xem phần Cài đặt cổng thông tin Edge for Private Cloud.
  3. Định cấu hình SAML trên cổng thông tin.
  4. Giờ đây, bạn có thể tắt tính năng Xác thực cơ bản trên Edge.

Tạo người dùng máy cho cổng thông tin

Khi SAML được bật, Edge hỗ trợ tạo mã thông báo OAuth2 tự động thông qua việc sử dụng người dùng máy. Người dùng máy có thể lấy mã thông báo OAuth2 mà không cần chỉ định mã xác thực. Điều đó có nghĩa là bạn có thể tự động hoá hoàn toàn quy trình lấy và làm mới mã thông báo OAuth2.

Quy trình định cấu hình SAML cho cổng thông tin sẽ tự động tạo một người dùng máy trong tổ chức liên kết với cổng thông tin. Sau đó, cổng thông tin sẽ sử dụng tài khoản người dùng máy này để kết nối với Edge. Để biết thêm về người dùng máy, hãy xem phần Sử dụng SAML với các tác vụ tự động.

Giới thiệu về quy trình xác thực cho tài khoản nhà phát triển của trang web

Khi định cấu hình cổng thông tin để sử dụng SAML, bạn cho phép cổng thông tin sử dụng SAML để xác thực bằng Edge để cổng thông tin có thể gửi yêu cầu đến Edge. Tuy nhiên, cổng thông tin này cũng hỗ trợ một loại người dùng là nhà phát triển.

Nhà phát triển là cộng đồng người dùng xây dựng ứng dụng bằng cách sử dụng API của bạn. Nhà phát triển ứng dụng sử dụng cổng thông tin này để tìm hiểu về API của bạn, đăng ký ứng dụng sử dụng API của bạn, tương tác với cộng đồng nhà phát triển và xem thông tin thống kê về mức sử dụng ứng dụng của họ trên trang tổng quan.

Khi nhà phát triển đăng nhập vào cổng thông tin, cổng thông tin sẽ chịu trách nhiệm xác thực nhà phát triển và thực thi các quyền dựa trên vai trò. Cổng thông tin tiếp tục sử dụng phương thức xác thực cơ bản với nhà phát triển ngay cả sau khi bạn bật SAML giữa cổng thông tin và Edge. Để biết thêm thông tin, hãy xem phần Giao tiếp giữa cổng thông tin và Edge.

Bạn cũng có thể định cấu hình trang web để sử dụng SAML nhằm xác thực nhà phát triển. Để biết ví dụ về cách bật SAML bằng các mô-đun Drupal của bên thứ ba, hãy xem phần Tích hợp SSO thông qua SAML bằng Cổng thông tin dành cho nhà phát triển.

Định cấu hình SAML trên cổng thông tin để giao tiếp với Edge

Để định cấu hình SAML cho cổng thông tin, bạn phải tạo một tệp cấu hình để định cấu hình cổng thông tin:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

Cách bật tính năng hỗ trợ SAML trên cổng thông tin:

  1. Trong giao diện người dùng Edge, hãy thêm người dùng máy do DEVPORTAL_ADMIN_EMAIL chỉ định vào tổ chức liên kết với cổng thông tin với tư cách là Quản trị viên tổ chức.
  2. Chạy lệnh sau để định cấu hình SAML trên cổng thông tin: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Trong đó samlConfigFile là tệp cấu hình SAML.

  3. Đăng nhập vào cổng thông tin với tư cách là quản trị viên cổng thông tin.
  4. Trong trình đơn Drupal chính, hãy chọn Configuration > Dev Portal (Cấu hình > Cổng thông tin dành cho nhà phát triển). Màn hình cấu hình của cổng thông tin sẽ xuất hiện, bao gồm cả chế độ cài đặt SAML:

    Lưu ý rằng hộp This org is SAML-enabled (Tổ chức này đã bật SAML) được đánh dấu, điểm cuối cho mô-đun Edge SSO được điền sẵn, các trường API key (Khoá API) và Consumer secret (Mật khẩu người dùng) cho ứng dụng Oauth của cổng thông tin được điền sẵn và thông báo Connection Successful (Kết nối thành công) xuất hiện bên dưới nút Test Connection (Kiểm thử kết nối).

  5. Bạn có thể nhấn nút Test Connection (Kiểm tra kết nối) để kiểm tra lại kết nối bất cứ lúc nào.

Để thay đổi các giá trị này sau này, hãy cập nhật tệp cấu hình và chạy lại lệnh.

Tắt SAML trên cổng thông tin

Nếu bạn chọn tắt SAML cho hoạt động giao tiếp giữa cổng thông tin và Edge, thì cổng thông tin sẽ không thể gửi yêu cầu đến Edge nữa. Nhà phát triển có thể đăng nhập vào cổng thông tin nhưng sẽ không thể xem sản phẩm hoặc tạo ứng dụng.

Cách tắt SAML trên cổng thông tin:

  1. Chỉnh sửa tệp cấu hình mà bạn đã dùng để định cấu hình SAM để đặt: 
    DEVPORTAL_SSO_ENABLED=n
  2. Định cấu hình cổng thông tin: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile