Định cấu hình cổng Dịch vụ dành cho nhà phát triển để sử dụng SAML nhằm giao tiếp với Edge

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

Cổng dịch vụ dành cho nhà phát triển hoạt động như một khách hàng 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 đó, phần lớn thông tin mà cổng sử dụng thực sự được lưu trữ trên Edge. Khi cần, cổng thông tin sẽ 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 này luôn liên kết với một tổ chức duy nhất Edge. Khi định cấu hình cổng thông tin, 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 tài khoản trong tổ chức mà cổng thông tin sử dụng để giao tiếp với Edge.

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

Tính năng hỗ trợ SAML cho cổng thông tin yêu cầu 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ý cạnh. Quy trình chung để bật SAML cho cổng thông tin là:

  1. Định cấu hình SAML trên Edge theo mô tả trong bài viết 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 cổng thông tin. Khô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 và đảm bảo rằng bản cài đặt của bạn đang hoạt động đúng cách. Xem bài viết Cài đặt Edge cho cổng Dịch vụ đám mây riêng tư dành cho nhà phát triển.
  3. Định cấu hình SAML trên cổng.
  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 bạn bật SAML, Edge sẽ hỗ trợ việc 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 phải chỉ định mật mã. Điều đó có nghĩa là bạn có thể hoàn toàn tự động hoá 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 được liên kết với cổng thông tin. Sau đó, cổng thông tin sẽ dùng tài khoản người dùng trên máy này để kết nối với Edge. Để biết thêm thông tin về người dùng máy, hãy xem phần Sử dụng SAML với thao tác 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ổng thông tin

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 dùng SAML để xác thực với Edge. Nhờ đó, cổng thông tin có thể gửi yêu cầu tới Edge. Tuy nhiên, cổng thông tin này cũng hỗ trợ một loại người dùng có tên là nhà phát triển.

Nhà phát triển tạo nên 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 dùng cổng thông tin này để tìm hiểu về API của bạn, đăng ký ứng dụng dùng API đó, 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 trên trang tổng quan.

Khi nhà phát triển đăng nhập vào cổng thông tin, cổng này 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 này sẽ 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 và Edge. Để biết thêm thông tin, hãy xem bài viết Giao tiếp giữa cổng thông tin và Edge.

Bạn cũng có thể định cấu hình cổng để sử dụng SAML nhằm xác thực nhà phát triển. Để xem ví dụ về cách bật SAML bằng các mô-đun Drupal bên thứ ba, hãy truy cập vào https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-cổng.html.

Đị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, bạn phải tạo tệp cấu hình để định cấu hình cổng:

# 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:

  1. Trong giao diện người dùng Edge, hãy thêm người dùng máy mà DEVPORTAL_ADMIN_EMAIL chỉ định vào tổ chức liên kết với cổng với tư cách là Quản trị viên tổ chức.
    Lưu ý: Người dùng máy chưa tồn tại nhưng sẽ được tạo tự động trong bước tiếp theo.
  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-devgate configuration-sso -f samlConfigFile

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

    Xin lưu ý rằng bạn đã đánh dấu vào hộp This org is SAML-enabled (Tổ chức này có hỗ trợ SAML), điểm cuối của mô-đun SSO của Edge sẽ được điền, trường Khoá API và các trường Bí mật của người tiêu dùng cho ứng dụng Oauth cổng thông tin được điền và thông báo Connection Success (Kết nối thành công) sẽ xuất hiện bên dưới nút Test Connection (Kiểm tra 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 vào lúc khác, hãy cập nhật tệp cấu hình rồi 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 tới Edge được 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.

Thận trọng: Nếu tắt SAML, bạn nên định cấu hình lại cổng thông tin để sử dụng SAML hoặc nếu Edge vẫn được định cấu hình để hỗ trợ tính năng Xác thực cơ bản, hãy định cấu hình cổng thông tin để giao tiếp với Edge bằng phương thức Xác thực cơ bản. Để biết thêm về cách sử dụng tính năng Xác thực cơ bản, hãy xem phần Giao tiếp giữa cổng thông tin và Edge.

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

  1. Chỉnh sửa tệp cấu hình mà bạn đã dùng để định cấu hình SAM cần đặ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-devgate configuration-sso -f configFile