إعداد بوابة خدمات المطوّرين لاستخدام SAML للتواصل مع Edge

Edge for Private Cloud - الإصدار 4.17.09

تعمل بوابة "خدمات المطوِّرين" كعميل لخدمة Apigee Edge. وهذا يعني أنّ البوابة لا تعمل كنظام مستقل. بدلاً من ذلك، يتم في الواقع تخزين الكثير من المعلومات التي تستخدمها البوابة على Edge. عند الضرورة، تُجري البوابة طلبًا لاسترداد المعلومات من Edge أو إرسال المعلومات إلى Edge.

ترتبط البوابة دائمًا بمؤسسة Edge واحدة. وعند ضبط البوابة، يمكنك تحديد بيانات اعتماد المصادقة الأساسية (اسم المستخدم وكلمة المرور) لحساب في المؤسسة التي تستخدمها البوابة للتواصل مع Edge.

إذا اخترت تفعيل مصادقة SAML لتطبيق Edge، يمكنك حينئذٍ ضبط البوابة لاستخدام مصادقة SAML عند إجراء طلبات إلى Edge. تؤدي ضبط البوابة لاستخدام SAML إلى إنشاء حساب جديد لمستخدم الجهاز تلقائيًا في مؤسسة Edge التي تستخدمها البوابة بعد ذلك لإرسال الطلبات إلى Edge. لمزيد من المعلومات عن مستخدمي الأجهزة، يُرجى الاطّلاع على استخدام SAML مع المهام المبرمَجة.

يتطلب دعم SAML للبوابة تثبيت وحدة الدخول الموحّد (SSO) إلى Edge وضبطها في عقدة Edge Management Server. تتمثل العملية العامة لتفعيل SAML للبوابة في ما يلي:

  1. اضبط SAML على Edge كما هو موضح في تثبيت وإعداد SAML على Edge. ملاحظة: يجب أن تظل المصادقة الأساسية مفعّلة على Edge لتثبيت البوابة. لا توقِف المصادقة الأساسية على Edge إلا بعد إعداد البوابة لاستخدام SAML.
  2. ثبِّت البوابة وتأكَّد من أنّ عملية التثبيت تعمل بشكل صحيح. راجِع تثبيت بوابة "خدمات مطوّري برامج السحابة الإلكترونية الخاصة" في Edge.
  3. ضبط SAML على البوابة
  4. يمكنك الآن إيقاف المصادقة الأساسية على Edge.

إنشاء مستخدم جهاز للبوابة

عند تفعيل SAML، يتيح متصفّح Edge إنشاء الرمز المميز لبروتوكول OAuth2 تلقائيًا من خلال استخدام مستخدمي الجهاز. يمكن لمستخدم الجهاز الحصول على رموز OAuth2 المميزة بدون الحاجة إلى تحديد رمز مرور. وهذا يعني أنّ عملية الحصول على رموز OAuth2 المميّزة وإعادة تحميلها تتيح لك تنفيذها بشكل مبرمَج.

تؤدي عملية إعداد SAML للبوابة تلقائيًا إلى إنشاء مستخدم جهاز في المؤسسة المرتبطة بالبوابة. بعد ذلك، تستخدم البوابة بعد ذلك حساب مستخدم الجهاز هذا للاتصال بخدمة Edge. لمزيد من المعلومات عن مستخدمي الأجهزة، يُرجى الاطّلاع على استخدام SAML مع المهام المبرمَجة.

لمحة عن المصادقة لحسابات مطوّري البوابة

عند ضبط البوابة لاستخدام SAML، يتم السماح للبوابة باستخدام SAML للمصادقة مع Edge بحيث تتمكن البوابة من إجراء طلبات إلى Edge. في المقابل، تتيح البوابة أيضًا نوعًا من المستخدمين يُسمى المطورون.

يشكّل المطوّرون منتدى المستخدمين الذين ينشئون التطبيقات باستخدام واجهات برمجة التطبيقات. يستخدم مطوّرو التطبيقات البوابة للتعرّف على واجهات برمجة التطبيقات، ولتسجيل التطبيقات التي تستخدم واجهات برمجة التطبيقات الخاصة بك، والتفاعل مع منتدى المطوّرين، وعرض معلومات إحصائية حول استخدام تطبيقاتهم على لوحة بيانات.

وعندما يسجّل مطوّر البرامج الدخول إلى البوابة، تكون البوابة هي المسؤولة عن مصادقة مطوّر البرامج وفرض الأذونات المستندة إلى الدور. ستواصل البوابة استخدام المصادقة الأساسية مع المطوّرين حتى بعد تفعيل SAML بين البوابة وEdge. لمزيد من المعلومات، يُرجى الاطّلاع على التواصل بين البوابة وEdge.

من الممكن أيضًا ضبط البوابة لاستخدام SAML لمصادقة المطوّرين. للاطّلاع على مثال حول تفعيل SAML باستخدام وحدات Drupal التابعة لجهات خارجية، يُرجى الانتقال إلى https://community.apigee.com/articles/29201/sso-integration-via-SAML-with-developer-مدخل.html.

ضبط SAML على البوابة للتواصل مع Edge

لضبط SAML للبوابة، عليك إنشاء ملف إعداد لإعداد البوابة:

# 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

لتفعيل دعم SAML على البوابة:

  1. في واجهة مستخدم Edge، أضِف مستخدم الجهاز الذي تم تحديده من قِبل DEVPORTAL_ADMIN_EMAIL إلى المؤسسة المرتبطة بالبوابة بصفته مشرف مؤسسة.
    ملاحظة: مستخدم الجهاز غير متوفر بعد، ولكن يتم إنشاؤه تلقائيًا في الخطوة التالية.
  2. نفِّذ الأمر التالي لضبط SAML على البوابة:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devمدخل Configuration-sso -f samlConfigFile

    حيث يكون samlConfigFile هو ملف إعداد SAML.
  3. سجّل الدخول إلى البوابة بصفتك مشرف البوابة.
  4. في قائمة Drupal الرئيسية، اختَر الإعداد > بوابة مطوّري البرامج. ستظهر شاشة ضبط البوابة، بما في ذلك إعدادات SAML:

    تجدر الإشارة إلى أنّه قد تم وضع علامة في مربّع هذه المؤسسة مفعّلة مع SAML، وأنّه يتم ملء نقطة النهاية لوحدة تسجيل الدخول المُوحَّد (SSO) في Edge، ويتم ملء حقلي مفتاح واجهة برمجة التطبيقات وسر العميل لعميل Oauth الخاص بالبوابة، وستظهر رسالة تم الاتصال بنجاح أسفل الزر اختبار الاتصال.

  5. يمكنك الضغط على الزر اختبار الاتصال لإعادة اختبار الاتصال في أي وقت.

لتغيير هذه القيم لاحقًا، عليك تعديل ملف الإعداد وتشغيل الأمر مرة أخرى.

إيقاف SAML على البوابة

إذا اخترت إيقاف SAML للاتصالات بين البوابة وEdge، لن تتمكّن البوابة من إرسال طلبات إلى Edge. يمكن للمطوّرين تسجيل الدخول إلى المنصة، ولكن لن يتمكنوا من عرض المنتج أو إنشاء التطبيقات.

تنبيه: إذا أوقفت SAML، يجب إعادة ضبط البوابة إما لاستخدام SAML، أو إذا كان متصفّح Edge لا يزال يتيح استخدام المصادقة الأساسية، اضبط البوابة للتواصل مع Edge باستخدام المصادقة الأساسية. لمزيد من المعلومات حول استخدام المصادقة الأساسية، يُرجى الاطّلاع على التواصل بين البوابة وEdge.

لإيقاف SAML على البوابة:

  1. عدِّل ملف الإعداد الذي استخدمته لضبط SAM من أجل الضبط على ما يلي:
    DEVPORTAL_SSO_ENABLED=n
  2. اضبط البوابة:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devمدخل Configuration-sso -f configFile