Bật xác thực bên ngoài

Edge for Private Cloud phiên bản 4.18.05

Phần này giải thích cách lấy, cài đặt và định cấu hình các thành phần cần thiết để tích hợp dịch vụ LDAP vào Apigee Edge nhằm xác thực người dùng.

Điều kiện tiên quyết

  • Bạn phải cài đặt Apigee Edge để cài đặt Private Cloud 4.18.05.
  • Bạn phải có thông tin đăng nhập của quản trị viên hệ thống chung trên Apigee Edge dành cho Private Cloud để thực hiện việc cài đặt này.
  • Bạn cần biết thư mục gốc của quá trình cài đặt Apigee Edge cho Private Cloud. Thư mục gốc mặc định là /opt.
  • Bạn phải thêm thông tin đăng nhập của quản trị viên hệ thống toàn cầu Edge vào LDAP bên ngoài. Hãy nhớ rằng theo mặc định, thông tin đăng nhập của quản trị viên hệ thống được lưu trữ trong LDAP nội bộ của Edge. Sau khi bạn chuyển sang LDAP ngoài, thông tin đăng nhập của quản trị viên hệ thống sẽ được xác thực tại đó. Do đó, bạn phải cấp thông tin xác thực cho hệ thống bên ngoài trước khi bật tính năng xác thực bên ngoài trong Edge.

    Ví dụ: nếu bạn đã định cấu hình và cài đặt Apigee Edge cho Private Cloud bằng thông tin xác thực của quản trị viên hệ thống toàn cục như sau:

    username: edgeuser@mydomain.com
    password: Secret123

    Sau đó, người dùng edgeuser@mydomain.com có mật khẩu Secret123 cũng phải có trong LDAP bên ngoài.

  • Nếu đang chạy cụm Máy chủ quản lý, hãy lưu ý rằng bạn phải thực hiện tất cả các bước trong tài liệu này cho từng Máy chủ quản lý.

Định cấu hình xác thực bên ngoài

Hoạt động chính bạn sẽ thực hiện là định cấu hình tệp management-server.properties. Hoạt động này bao gồm việc dừng và khởi động Máy chủ quản lý Edge, quyết định xem bạn có muốn sử dụng tính năng liên kết trực tiếp hay gián tiếp, mã hoá thông tin xác thực nhạy cảm và các tác vụ liên quan khác hay không.

  1. Lưu ý quan trọng: Hãy quyết định ngay xem bạn có ý định sử dụng phương thức xác thực liên kết gián tiếp hay trực tiếp. Quyết định này sẽ ảnh hưởng đến một số khía cạnh của cấu hình. Hãy xem phần Xác thực bên ngoài.
  2. Lưu ý quan trọng: Bạn phải thực hiện các bước định cấu hình này trên mỗi Máy chủ quản lý Apigee Edge (nếu đang chạy nhiều máy chủ).
  3. Mở /opt/apigee/customer/application/management-server.properties trong trình chỉnh sửa văn bản. Nếu tệp không tồn tại, hãy tạo tệp đó.
  4. Thêm dòng sau:
    conf_security_authentication.user.store=externalized.authentication

    Dòng này sẽ thêm tính năng xác thực bên ngoài vào quá trình cài đặt Edge for Private Cloud.

  5. Để giúp bạn dễ dàng thực hiện bước này, chúng tôi đã tạo hai cấu hình mẫu có chú thích rõ ràng – một cấu hình cho xác thực liên kết trực tiếp và một cấu hình cho xác thực liên kết gián tiếp. Hãy xem các mẫu bên dưới để biết mối liên kết mà bạn muốn sử dụng và hoàn tất cấu hình:
  6. Khởi động lại Máy chủ quản lý:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  7. Xác minh rằng máy chủ đang chạy:
    /opt/apigee/apigee-service/bin/apigee-all status
  8. Lưu ý quan trọng: Bạn phải định cấu hình bổ sung trong một (hoặc cả hai) trường hợp sau:
    1. Nếu bạn muốn người dùng đăng nhập bằng tên người dùng không phải là địa chỉ email. Trong trường hợp này, người dùng quản trị hệ thống cũng phải xác thực bằng tên người dùng.

      VÀ/HOẶC

    2. Nếu mật khẩu cho tài khoản người dùng quản trị hệ thống trong LDAP bên ngoài khác với mật khẩu bạn đã định cấu hình khi cài đặt Apigee Edge cho Private Cloud lần đầu tiên. Xem phần Cấu hình cần thiết cho nhiều thông tin đăng nhập của quản trị viên hệ thống.

Mẫu cấu hình DIRECT BINDING (LIÊN KẾT TRỰC TIẾP)

## The first property is always required to enable the external authorization feature.
## Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl

## Identify the type of binding:
## Set to "true" for direct binding
## Set to "false" for indirect binding.
conf_security_externalized.authentication.bind.direct.type=true

## The next seven properties are needed regardless of direct or indirect binding. You need to
## configure these per your external authentication installation.
## The IP or domain for your external LDAP instance. 
conf_security_externalized.authentication.server.url=ldap://localhost:389

## Your external LDAP server version.
conf_security_externalized.authentication.server.version=3

## The server timeout in milliseconds. 
conf_security_externalized.authentication.server.conn.timeout=50000

## Change these baseDN values to match your external LDAP service. This attribute value will be
## provided by your external LDAP administrator, and may have more or fewer dc elements depending
## on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com

## Do not change this search string. It is used internally. 
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))

## Identifies the external LDAP property you want to bind against for Authentication. For
## example if you are binding against an email address in Microsoft Active Directory, this would be
## the userPrincipalName property in your external LDAP instance. Alternatively if you are binding
## against the user's ID, this would typically be in the sAMAccountName property:
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName

## The LDAP attribute where the user email value is stored. For direct binding with AD, set it to
## userPrincipalName.
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName

## ONLY needed for DIRECT binding.
## The direct.bind.user.directDN property defines the string that is used for the bind against the
## external authentication service. Ensure it is set as follows:
conf_security_externalized.authentication.direct.bind.user.directDN=${userDN}

Mẫu cấu hình KẾT NỐI DIRECT

## Required to enable the external authorization feature. Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl

## Identifies the type of binding:
## Set to "true" for direct binding
## Set to "false" for indirect binding.
conf_security_externalized.authentication.bind.direct.type=false

## The next seven properties are needed regardless of direct or indirect binding. You need to
## configure these per your external LDAP installation.
## The IP or domain for your external LDAP instance.
conf_security_externalized.authentication.server.url=ldap://localhost:389

## Replace with your external LDAP server version.
conf_security_externalized.authentication.server.version=3

## Set the server timeout in milliseconds. 
conf_security_externalized.authentication.server.conn.timeout=50000

## Change these baseDN values to match your external LDAP service. This attribute value will be
# provided by your external LDAP administrator, and may have more or fewer dc elements
# depending on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com

## Do not change this search string. It is used internally. 
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))

## Identifies the external LDAP property you want to bind against for Authentication. For example
## if you are binding against an email address, this would typically be in the
## userPrincipalName property in your external LDAP instance. Alternatively if you are binding
## against the user's ID, this would typically be in the sAMAccountName property.
## See also "Configuration required for different sysadmin credentials".
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName

## Used by Apigee to perform the Authorization step and currently, Apigee only supports email
## address for Authorization. Make sure to set it to the attribute in your external LDAP that
## stores the user's email address. Typically this will be in the userPrincipalName property.
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName

## The external LDAP username (for a user with search privileges on the external LDAP) and
## password and whether the password is encrypted. You must also set the attribute
## externalized.authentication.bind.direct.type to false.
## The password attribute can be encrypted or in plain text. See
## "Indirect binding only: Encrypting the external LDAP user's password"
## for encryption instructions. Set the password.encrypted attribute to "true" if the password is
## encrypted. Set it to "false" if the password is in plain text.
conf_security_externalized.authentication.indirect.bind.server.admin.dn=myExtLdapUsername
conf_security_externalized.authentication.indirect.bind.server.admin.password=myExtLdapPassword
conf_security_externalized.authentication.indirect.bind.server.admin.password.encrypted=true

Kiểm thử quá trình cài đặt

  1. Xác minh rằng máy chủ đang chạy:
    /opt/apigee/apigee-service/bin/apigee-all status
  2. Thực thi lệnh này, cung cấp một bộ thông tin xác thực của quản trị viên hệ thống toàn cầu Apigee Edge. Lệnh gọi API mà chúng ta sắp kiểm thử chỉ có thể được thực thi bởi quản trị viên hệ thống Edge.
    curl -v http://management-server-IP:8080/v1/o -u sysadmin_username

    Ví dụ:

    curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com
  3. Nhập mật khẩu của bạn khi được nhắc.

    Nếu lệnh trả về trạng thái 200 và danh sách các tổ chức, thì cấu hình đã chính xác. Lệnh này xác minh rằng lệnh gọi API đến Máy chủ quản lý Edge đã được xác thực thành công thông qua hệ thống LDAP bên ngoài.