ضبط البوابة لاستخدام SAML للتواصل مع Edge

Edge for Private Cloud ‏v4.18.05

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

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

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

يتطلب استخدام بروتوكول SAML في البوابة أن تكون قد ثبَّتَت وحدة الدخول المُوحَّد في Edge وضبطتها على عقدة Edge Management Server. في ما يلي العملية العامة لتفعيل بروتوكول SAML لبوابة:

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

إنشاء مستخدم آلة للبوابة

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

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

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

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

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

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

من الممكن أيضًا ضبط البوابة لاستخدام SAML لمصادقة المطوّرين. للحصول على مثال على تفعيل لغة SAML باستخدام وحدات Drupal التابعة لجهات خارجية، اطّلِع على دمج الدخول المُوحَّد عبر لغة SAML مع "بوابة المطوّرين".

ضبط لغة 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-devportal configure-sso -f samlConfigFile

    حيث يكون samlConfigFile هو ملف إعدادات SAML.

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

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

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

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

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

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

لإيقاف بروتوكول SAML في البوابة:

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