تفعيل المصادقة الخارجية

Edge for Private Cloud‏ 4.17.01

يوضّح هذا القسم كيفية الحصول على المكوّنات المطلوبة وتثبيتها وضبطها لدمج خدمة LDAP خارجية في Apigee Edge لمصادقة المستخدم.

المتطلبات الأساسية

  • يجب أن يكون لديك إصدار 4.17.01 من Apigee Edge for Private Cloud مثبّتًا.
  • يجب أن تكون لديك بيانات اعتماد مشرف النظام العام على Apigee Edge for Private Cloud لكي تتمكّن من تنفيذ عملية التثبيت هذه.
  • يجب معرفة الدليل الجذر لعملية تثبيت Apigee Edge for Private Cloud. دليل الجذر التلقائي هو /opt.
  • يجب إضافة بيانات اعتماد مشرف النظام العام في Edge إلى LDAP الخارجي. يُرجى العلم أنّه يتم تلقائيًا تخزين بيانات اعتماد مشرف النظام في LDAP الداخلي لـ Edge. بعد التبديل إلى LDAP الخارجي، سيتم مصادقة بيانات اعتماد مشرف النظام هناك بدلاً من ذلك. لذلك، يجب توفير بيانات الاعتماد لل النظام الخارجي قبل تفعيل المصادقة الخارجية في Edge.

    على سبيل المثال، في حال ضبط وتثبيت Apigee Edge for Private Cloud باستخدام بيانات اعتماد مشرف النظام العامة على النحو التالي:

    اسم المستخدم: edgeuser@mydomain.com
    كلمة المرور: Secret123

    بعد ذلك، يجب أن يكون المستخدم edgeuser@mydomain.com مع كلمة المرور Secret123 موجودًا أيضًا في الجهاز الخارجي.
  • إذا كنت تستخدم مجموعة إدارة، يُرجى العلم أنّه عليك تنفيذ جميع الخطوات الواردة في هذا المستند لكلّ خادم إدارة.

ضبط المصادقة الخارجية

يتمثل النشاط الرئيسي الذي ستُجريه في ضبط ملف management-server.properties. يتضمن هذا النشاط إيقاف وتشغيل خادم إدارة Edge، وتحديد ما إذا كنت تريد استخدام الربط المباشر أو غير المباشر، وتشفير بيانات الاعتماد الحساسة، والمهام الأخرى ذات الصلة.

  1. ملاحظة مهمة: عليك الآن تحديد ما إذا كنت تريد استخدام طريقة المصادقة المباشرة أو غير المباشرة للربط. سيؤثّر هذا القرار في بعض جوانب الإعداد. راجِع مقالة المصادقة الخارجية.
  2. ملاحظة مهمّة: يجب تنفيذ خطوات الإعداد هذه على كل خادم من خوادم إدارة Apigee Edge (إذا كنت تشغّل أكثر من خادم).
  3. افتح /opt/apigee/customer/application/management-server.properties في محرِّر نصوص. إذا لم يكن الملف متوفّرًا، أنشِئه.
  4. أضِف السطر التالي. ملاحظة: تأكَّد من عدم وجود مسافات لاحقة في نهاية السطر.

    conf_security_authentication.user.store=externalized.authentication

    يضيف هذا السطر ميزة المصادقة الخارجية إلى عملية تثبيت Edge for Private Cloud.
  5. لتسهيل هذه الخطوة، أنشأنا نموذجَين للإعدادات مصحوبَين بتعليقات توضيحية جيدًا، أحدهما للمصادقة المباشرة والآخر للمصادقة غير المباشرة. اطّلِع على النماذج أدناه لمعرفة عملية الربط التي تريد استخدامها، وأكمِل عملية الضبط:

    نموذج ضبط الربط المباشر
    نموذج ضبط الربط المباشر
  6. إعادة تشغيل خادم الإدارة:
    > ‎/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  7. تأكَّد من أنّ الخادم قيد التشغيل:
    > ‎/opt/apigee/apigee-service/bin/apigee-all status
  8. ملاحظة مهمة: يجب إجراء عملية ضبط إضافية في أيّ (أو كليهما) من الحالتَين التاليتَين: (أ) إذا كنت تريد أن يسجّل المستخدمون الدخول باستخدام أسماء مستخدمين ليست بعنوانات بريد إلكتروني. في هذه الحالة، على مستخدم مشرف النظم أيضًا المصادقة باستخدام اسم مستخدم و/أو (ب) إذا كانت كلمة مرور حساب مستخدم مسؤول إدارة النظم في بروتوكول LDAP الخارجي مختلفة عن كلمة المرور التي تم إعدادها عند تثبيت Apigee Edge for Private Cloud. راجِع الضبط المطلوب لبيانات اعتماد مشرف النظم المختلفة.

نموذج الضبط لميزة "الربط المباشر"

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

نموذج ضبط الربط غير المباشر

## 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 حالة
  2. نفِّذ هذا الأمر، مع تقديم مجموعة من بيانات اعتماد مشرف النظام العام في Apigee Edge. لا يمكن تنفيذ طلب البيانات من واجهة برمجة التطبيقات الذي سنختبره إلا من خلال مشرف Edge.

    ملاحظة مهمة: يجب أن تكون بيانات الاعتماد متطابقة في حساب LDAP الخارجي. إذا لم يكن كذلك، عليك إضافته الآن. يُرجى العِلم أنّ اسم المستخدم يكون عادةً عنوان بريد إلكتروني، ومع ذلك، يعتمد ذلك على كيفية ضبط المصادقة الخارجية، كما هو موضّح سابقًا في هذا المستند.
    > curl -v http://<عنوان IP لخادم الإدارة>:8080/v1/o -u <اسم مستخدم مشرف النظام>

    على سبيل المثال:
    > curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com
  3. أدخِل كلمة المرور عندما يُطلب منك ذلك.

    إذا عرض الأمر حالة 200 وقائمة بالمؤسسات، يعني ذلك أنّ الإعدادات صحيحة. يُحقِّق هذا الأمر من أنّه تمت مصادقة طلب البيانات من واجهة برمجة التطبيقات إلى "خادم إدارة Edge" بنجاح من خلال نظام LDAP الخارجي.