การเปิดใช้การตรวจสอบสิทธิ์ภายนอก

Edge for Private Cloud เวอร์ชัน 4.17.01

ส่วนนี้จะอธิบายวิธีรับ ติดตั้ง และกำหนดค่าคอมโพเนนต์ที่จําเป็นสําหรับการผสานรวมบริการ LDAP ภายนอกเข้ากับ Apigee Edge สําหรับการตรวจสอบสิทธิ์ผู้ใช้

ข้อกำหนดเบื้องต้น

  • คุณต้องมีการติดตั้ง Apigee Edge สำหรับ Private Cloud 4.17.01
  • คุณต้องมีข้อมูลเข้าสู่ระบบของผู้ดูแลระบบระบบส่วนกลางใน Apigee Edge สำหรับ Private Cloud จึงจะทำการนี้
  • คุณจำเป็นต้องทราบไดเรกทอรีรูทของ Apigee Edge สำหรับการติดตั้ง Private Cloud ไดเรกทอรีรูทเริ่มต้นคือ /opt
  • คุณต้องเพิ่มข้อมูลเข้าสู่ระบบของผู้ดูแลระบบระบบส่วนกลางของ Edge ลงใน LDAP ภายนอก โปรดทราบว่าโดยค่าเริ่มต้น ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบจะจัดเก็บอยู่ใน LDAP ภายในของ Edge เมื่อเปลี่ยนไปใช้ LDAP ภายนอก ระบบจะตรวจสอบสิทธิ์ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบใน LDAP นั้นแทน ดังนั้น คุณต้องจัดสรรข้อมูลเข้าสู่ระบบให้กับระบบภายนอกก่อนเปิดใช้การตรวจสอบสิทธิ์ภายนอกใน Edge

    เช่น หากคุณกําหนดค่าและติดตั้ง Apigee Edge สําหรับ Private Cloud ด้วยข้อมูลเข้าสู่ระบบของผู้ดูแลระบบทั่วโลกดังนี้

    ชื่อผู้ใช้: edgeuser@mydomain.com
    รหัสผ่าน: Secret123

    ผู้ใช้ edgeuser@mydomain.com ที่มีรหัสผ่าน Secret123 จะต้องอยู่ใน LDAP ภายนอกด้วย
  • หากคุณใช้คลัสเตอร์เซิร์ฟเวอร์การจัดการ โปรดทราบว่าคุณต้องทําตามขั้นตอนทั้งหมดในเอกสารนี้สําหรับเซิร์ฟเวอร์การจัดการแต่ละเครื่อง

การกำหนดค่าการตรวจสอบสิทธิ์ภายนอก

กิจกรรมหลักที่คุณจะดำเนินการคือการกำหนดค่าไฟล์ management-server.properties กิจกรรมนี้รวมถึงการหยุดและเริ่มเซิร์ฟเวอร์การจัดการ Edge การเลือกว่าต้องการใช้การเชื่อมโยงโดยตรงหรือโดยอ้อม การเข้ารหัสข้อมูลเข้าสู่ระบบที่ละเอียดอ่อน และงานอื่นๆ ที่เกี่ยวข้อง

  1. สำคัญ: ตัดสินใจตอนนี้ว่าคุณต้องการใช้วิธีการตรวจสอบสิทธิ์การเชื่อมโยงแบบอ้อมหรือแบบตรง การตัดสินใจนี้จะส่งผลต่อการกำหนดค่าบางแง่มุม โปรดดูการตรวจสอบสิทธิ์ภายนอก
  2. สำคัญ: คุณต้องทําตามขั้นตอนการกําหนดค่าเหล่านี้ในเซิร์ฟเวอร์การจัดการ Apigee Edge แต่ละเซิร์ฟเวอร์ (หากมีมากกว่า 1 เซิร์ฟเวอร์)
  3. เปิด /opt/apigee/customer/application/management-server.properties ในตัวแก้ไขข้อความ หากไม่มีไฟล์ดังกล่าว ให้สร้างไฟล์
  4. เพิ่มบรรทัดต่อไปนี้ หมายเหตุ: ตรวจสอบว่าไม่มีเว้นวรรคต่อท้ายบรรทัด

    conf_security_authentication.user.store=externalized.authentication

    บรรทัดนี้จะเพิ่มฟีเจอร์การตรวจสอบสิทธิ์ภายนอกลงในการติดตั้ง Edge สำหรับ Private Cloud
  5. เราได้สร้างการกำหนดค่าตัวอย่าง 2 รายการพร้อมคำอธิบายประกอบที่ชัดเจนเพื่อให้ขั้นตอนนี้ง่ายขึ้น 1 รายการสำหรับการตรวจสอบสิทธิ์การเชื่อมโยงโดยตรงและอีก 1 รายการสำหรับการตรวจสอบสิทธิ์การเชื่อมโยงโดยอ้อม ดูตัวอย่างการเชื่อมโยงที่ต้องการใช้ด้านล่าง และดำเนินการกำหนดค่าให้เสร็จสิ้น

    ตัวอย่างการกำหนดค่าการเชื่อมโยงทางตรง
    ตัวอย่างการกำหนดค่าการเชื่อมโยงทางอ้อม
  6. รีสตาร์ทเซิร์ฟเวอร์การจัดการ:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server start
  7. ตรวจสอบว่าเซิร์ฟเวอร์ทํางานอยู่
    > /opt/apigee/apigee-service/bin/apigee-all status
  8. สำคัญ: คุณต้องทำการกําหนดค่าเพิ่มเติมในกรณีต่อไปนี้ (ก) หากต้องการให้ผู้ใช้เข้าสู่ระบบโดยใช้ชื่อผู้ใช้ที่ไม่ใช่อีเมล ในกรณีนี้ ผู้ใช้ระบบต้องตรวจสอบสิทธิ์ด้วยชื่อผู้ใช้และ/หรือ (ข) หากรหัสผ่านของบัญชีผู้ใช้ระบบใน LDAP ภายนอกแตกต่างจากรหัสผ่านที่คุณกําหนดค่าไว้เมื่อติดตั้ง Apigee Edge สําหรับ Private Cloud เป็นครั้งแรก โปรดดูต้องมีการกำหนดค่าสำหรับข้อมูลเข้าสู่ระบบอื่นของผู้ดูแลระบบ

DIRECT BINDING ตัวอย่างการกําหนดค่า

## 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, 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:
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName

## The LDAP attribute where the user email value is stored. For direct binding, 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}

BINDING INDIRECT ตัวอย่างการกําหนดค่า

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

การทดสอบการติดตั้ง

  1. ตรวจสอบว่าเซิร์ฟเวอร์ทำงานอยู่
    > /opt/apigee/apigee-service/bin/apigee-all status
  2. เรียกใช้คําสั่งนี้โดยระบุชุดข้อมูลเข้าสู่ระบบของผู้ดูแลระบบระบบส่วนกลางของ Apigee Edge การเรียก API ที่เรากำลังจะทดสอบจะดำเนินการได้เฉพาะโดยผู้ดูแลระบบ Edge เท่านั้น

    สำคัญ: ข้อมูลเข้าสู่ระบบที่เหมือนกันจะต้องมีอยู่ในบัญชี LDAP ภายนอกของคุณ หากยังไม่มี คุณต้องเพิ่มตอนนี้ โปรดทราบว่าโดยปกติแล้วชื่อผู้ใช้จะเป็นอีเมล แต่ทั้งนี้ขึ้นอยู่กับวิธีที่คุณกำหนดค่าการตรวจสอบสิทธิ์ภายนอก ตามที่อธิบายไว้ก่อนหน้านี้ในเอกสารนี้
    > curl -v http://<management-server-ip>:8080/v1/o -u <Sysadmin Username>

    เช่น
    > curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com
  3. ป้อนรหัสผ่านเมื่อได้รับข้อความแจ้ง

    หากคําสั่งแสดงสถานะ 200 และรายการองค์กร แสดงว่ากําหนดค่าถูกต้อง คำสั่งนี้จะยืนยันว่าการเรียก API ไปยังเซิร์ฟเวอร์การจัดการ Edge ผ่านการตรวจสอบสิทธิ์ผ่านระบบ LDAP ภายนอกสำเร็จแล้ว