SSO

كيفية إعداد الدخول الموحّد (SSO) عبر SAML2.

SSO

الدخول الموحّد (عبر SAML2) متاح فقط في إصدار OpenReplay Enterprise Edition.

إعداد موفّر الهوية (IDP)

Section titled إعداد موفّر الهوية (IDP)

في لوحة تحكم موفّر الهوية الخاص بك، أنشئ تطبيقًا جديدًا باسم openreplay (يمكنك استخدام هذه الأيقونة). في صفحة الإعداد، تأكّد من ضبط القيم التالية (يُرجى التأكّد من استبدال YOUR_DOMAIN بالقيمة الصحيحة، على سبيل المثال https://openreplay.mycompany.com):

المتغيّرالقيمة
عنوان ACS URL (ويُسمّى أيضًا Single Sign On URL أو Consumer URL)YOUR_DOMAIN/api/sso/saml2/acs/
Entity ID (ويُسمّى أيضًا Audience)YOUR_DOMAIN/api/sso/saml2/metadata/
عنوان تسجيل الخروج الموحّد (ويُسمّى أيضًا SLO URL)YOUR_DOMAIN/api/sso/saml2/sls/ (اختياري)
Name ID (يكون أحيانًا قابلًا للتهيئة في قسم ‘Attribute Statements’ أو ‘Parameters’)Email أو EmailAddress أو urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress، حسب موفّر الهوية الخاص بك
مُهيِّئ SAMLاضبطه على Service Provider (اختياري)

في قسم ‘Attribute Statements’ أو قسم ‘Parameters’، يُرجى التأكّد من تعريف الحقول التالية:

الحقلالقيمة
tenantKeyTENANT_KEY يمكن العثور على قيمته في Dashboard، ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)
firstNameuser.firstName
lastNameuser.lastName
internalIdالمعرّف الداخلي أو user.email (معرّف المستخدم في نظام إدارة الهوية الخاص بك) (اختياري)
roleدور المستخدم؛ وحسب موفّر الهوية الخاص بك قد يكون user.role أو group وما إلى ذلك. (اختياري، القيمة الافتراضية = member)
adminPrivilegesما إذا كان المستخدم يملك صلاحيات المسؤول أم لا؛ إذا احتوى هذا الحقل على أي قيمة مختلفة عن false، فسيُعتبر true. (اختياري، القيمة الافتراضية = false)

ينبغي الآن أن تكون لديك جميع القيم المطلوبة للخطوة/القسم التالي.

إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.

وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا، فشغّل openreplay -e وأزل التعليق ثم حدّث متغيّرات البيئة أدناه في قسم chalice:

المتغيّرالوصف
idp_entityIdالـ entityId الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ Issuer URL
idp_sso_urlالـ singleSignOnService الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ SAML 2.0 Endpoint (HTTP)
idp_x509certالـ x509cert، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر. يمكنك استخدام هذه الأداة لتنسيق قيمتك
idp_nameاسم موفّر الهوية (اختياري)
idp_sls_urlالـ singleLogoutService الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ SLO Endpoint (HTTP) (اختياري)
enforce_SSOإذا ضُبط على true، فستُحظَر جميع عمليات الاتصال باسم المستخدم وكلمة المرور (اختياري، القيمة الافتراضية=false)

ثم احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ:

هذا اختياري؛ يمكنك إضافة شهادة x509 لمزيد من الأمان في SSO:

  1. شغّل هذا الأمر في خادمك أو في جهازك الآمن (يمكنك تغيير مدّة صلاحية شهادتك وفقًا لاحتياجاتك):
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout openreplay-sso.key -out openreplay-sso.crt
  1. في خادمك، شغّل openreplay -e
  2. ضمن قسم chalice، أضف متغيّرات البيئة التالية:
  • sp_crt: يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر، من ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
  • sp_key: يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر، من ملف ‘openreplay-sso.key’ الذي تمّ إنشاؤه
  1. احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ
  2. أضف ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه إلى إعداد تطبيق موفّر الهوية الخاص بك

مثال باستخدام Okta

Section titled مثال باستخدام Okta
  1. سجّل الدخول إلى لوحة تحكم إدارة Okta الخاصة بك وانتقل إلى ‘Applications’ > ‘Applications’
  2. اضغط ‘Create new app integration’، ثم اختر SAML 2.0 واضغط ‘Next’
  3. اضبط ‘App Name’ على OpenReplay (يمكنك رفع هذه الأيقونة) لتطبيقك) ثم اضغط ‘Next’
  4. اضبط:
  • Single sign on URL على YOUR_DOMAIN/api/sso/saml2/acs/
  • Audience URI (SP Entity ID) على YOUR_DOMAIN/api/sso/saml2/metadata/
  • Name ID format على EmailAddress
  1. عرّف الحقول أدناه في ‘Attribute Statements’:
  • tenantKey: التنسيق Basic واضبط القيمة على TENANT_KEY، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)
  • firstName: التنسيق Basic واضبط القيمة على user.firstName
  • lastName: التنسيق Basic واضبط القيمة على user.lastName
  • internalId: التنسيق Basic واضبط القيمة على user.email
  1. عرّف الحقل أدناه في ‘Group Attribute Statements’:
  • role: التنسيق Basic، المرشّح Match Regex، القيمة .* (أو يمكنك تحديد مرشّح وتعبير نمطي مختلفَين وفقًا لاحتياجاتك)
  • adminPrivileges: التنسيق Basic، المرشّح Match Regex، القيمة admin (سيحصل المستخدم الحالي على admin privileges إذا كان جزءًا من مجموعة admin)
  1. اضغط Next، اختر ‘I’m an Okta customer adding an internal app’ و ‘This is an internal app that we have created’ ثم اضغط ‘Finish’
  2. في علامة التبويب Sign On، مرّر للأسفل واضغط ‘View Setup Instructions’ لرؤية إعداد SAML2 الخاص بك

إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.

وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:

  1. اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل openreplay -e
  2. ضمن قسم chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
  • idp_entityId: Identity Provider Issuer
  • idp_sso_url: Identity Provider Single Sign-On URL
  • idp_x509cert: X.509 Certificate، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
  • idp_name: Okta
  1. أخيرًا، احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ

مثال باستخدام Azure Active Directory

Section titled مثال باستخدام Azure Active Directory
  1. سجّل الدخول إلى بوّابة Azure الخاصة بك وانتقل إلى ‘Azure Active Directory’
  2. اضغط ’+ Add’، اختر ‘Enterprise application’ ثم انقر ‘Create your own application’
  3. اضبط ‘App Name’ على OpenReplay ثم اختر ‘Integrate any other application you don’t find in the gallery (Non-gallery)’ واضغط ‘Create’
  4. انتقل إلى ‘Single sign-on’ في القائمة الجانبية اليسرى واضبط القيم أدناه في كتلة ‘Basic SAML Configuration’:
  • Identifier (Entity ID) على YOUR_DOMAIN/api/sso/saml2/metadata/
  • Reply URL (Assertion Consumer Service URL) على YOUR_DOMAIN/api/sso/saml2/acs/
  • Logout URL على YOUR_DOMAIN/api/sso/saml2/sls/
  1. أضف المطالبات (claims) أدناه في كتلة ‘Attribute & Claims’ وتأكّد من ترك حقل ‘Namespace’ فارغًا لكلٍّ منها:
  • tenantKey: اضبط القيمة على TENANT_KEY، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة/المطالبة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)
  • firstName: اضبط القيمة على user.givenname
  • lastName: اضبط القيمة على user.surname
  • internalId: اضبط القيمة على user.mail
  1. انتقل إلى ‘Users and groups’ وعيّن المستخدمين الذين تختارهم للتطبيق

إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO (توجد القيم في ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’).

وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:

  1. اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل openreplay -e
  2. ضمن قسم chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية (توجد القيم في ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’):
    • idp_entityId: Azure AD Identifier
    • idp_sso_url: Login URL
    • idp_sls_url: Logout URL
    • idp_x509cert: X.509 Certificate، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
    • idp_name: Active Directory
  3. أخيرًا، احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ

مثال باستخدام Google Workspace (المعروف سابقًا باسم G Suite)

Section titled مثال باستخدام Google Workspace (المعروف سابقًا باسم G Suite)

إضافة سمات مخصّصة:

Section titled إضافة سمات مخصّصة:
  1. في وحدة تحكم مسؤول Google، انتقل إلى ‘Directory’ > ‘Users’ > ‘More options’ > ‘Manage custom attributes’.
  2. انقر ‘Add Custom Attribute’.
  3. اضبط الحقول التالية:
  • Category: ‘OpenReplay’
  • Custom fields:
  • Name: ‘role’
  • Info type: ‘Text’
  • Visibility: ‘Visible to user and admin’
  • No. of values: ‘Single-value’
  • Custom fields:
  • Name: ‘adminPrivileges’
  • Info type: ‘Yes or No’
  • Visibility: ‘Visible to user and admin’
  • No. of values: ‘Single-value’
  1. انقر ‘Add’
  2. لإضافة قيم إلى السمات المخصّصة الجديدة، انتقل إلى ‘Users’
  3. اختر المستخدم (أو المستخدمين) المطلوب
  4. انقر ‘User information’ ثم حرّر قسم ‘OpenReplay’
  5. غيّر قيمة role إلى الدور المطلوب في ‘OpenReplay’ (يجب أن يتطابق الدور مع الدور الذي تمّ إنشاؤه في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Roles’)
  6. غيّر قيمة adminPrivileges إلى ‘Yes’ إذا كان المستخدم مسموحًا له بامتلاك صلاحيات المسؤول في OpenReplay
  7. انقر ‘Save’
  1. سجّل الدخول إلى وحدة تحكم مسؤول Google الخاصة بك وانتقل إلى ‘Apps’
  2. اضغط ‘Web and mobile apps’ ثم انقر ‘Add app’ > ‘Add custom SAML app’
  3. اضبط ‘App name’ على OpenReplay (يمكنك رفع هذه الأيقونة لـ ‘App icon”) ثم اضغط ‘Continue’
  4. انسخ ‘SSO URL’ و ‘Entity ID’ و ‘Certificate’ ثم انقر ‘Continue’ (سنستخدم هذه القيم في الخطوة 11)
  5. اضبط:
  • ACS URL على YOUR_DOMAIN/api/sso/saml2/acs/TENANT_KEY/ (توجد TENANT_KEY في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’، لكن إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك قيمة tenantKey فارغة)
  • Entity ID على YOUR_DOMAIN/api/sso/saml2/metadata/
  • Name ID format على Email
  • Name ID على Basic information > Primary Email
  1. انقر ‘Continue’ ثم اضغط ‘Add Mapping’ لإضافة السمات أدناه:
  • Basic information > First Name -> firstName
  • Basic information > Last Name -> lastName
  • Basic information > Primary Email -> internalId
  • OpenReplay > role -> role
  • OpenReplay > adminPrivileges -> adminPrivileges
  1. انقر ‘Finish’
  2. في وحدة تحكم مسؤول Google، انتقل إلى ‘Apps’ > ‘Web and mobile apps’ واختر ‘OpenReplay’
  3. انقر ‘User access’، اختر ‘ON for everyone’ ثم اضغط ‘Save’

إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.

وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:

  1. اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل openreplay -e
  2. ضمن قسم chalice > env، أزل التعليق واضبط السمات التالية باستخدام القيم من الخطوة 4:
  • idp_sso_url: الصق قيمة ‘SSO URL’
  • idp_entityId: الصق قيمة ‘Entity ID’
  • idp_x509cert: استخدم هذه الأداة لتنسيق الشهادة المنسوخة/المُنزَّلة
  • idp_name: اضبط القيمة على G-Suite
  • idp_tenantKey: TENANT_KEY الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’
  1. أخيرًا، احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ

مثال باستخدام JumpCloud

Section titled مثال باستخدام JumpCloud
  1. سجّل الدخول إلى لوحة تحكم إدارة JumpCloud الخاصة بك وفي القائمة اليسرى، انتقل إلى ‘SSO’
  2. اضغط ’+ Add New Application’، ثم اختر ‘Custom SAML App’
  3. اضبط ‘Display Label’ على OpenReplay (يمكنك رفع هذه الأيقونة لتطبيقك) ثم انتقل إلى علامة التبويب ‘SSO’
  4. اضبط:
  • IdP Entity ID على openreplay/TENANT_KEY (توجد TENANT_KEY في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’، لكن إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك قيمة tenantKey فارغة)
  • SP Entity ID على YOUR_DOMAIN/api/sso/saml2/metadata/
  • ACS URL على YOUR_DOMAIN/api/sso/saml2/acs/
  • SAMLSubject NameID على email
  • SAMLSubject NameID Format: على urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
  • Signature Algorithm على RSA-SHA256
  • حدّد Sign Assertion
  • IDP URL بحيث ينتهي بـ openreplay-TENANT_KEY (لا يمكن تغيير هذه القيمة لاحقًا؛ إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك جزء tenantKey فارغًا)
  1. إذا اتبعت تعليمات OpenReplay-Certificate، يمكنك رفع ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه بالضغط على ‘Upload SP Certificate’، وإلّا تجاهل هذه الخطوة
  2. عرّف الحقول أدناه في ‘USER ATTRIBUTE MAPPING’ بالضغط على زرّ ‘add attribute’:
  • firstName: اضبط القيمة على firstname
  • lastName: اضبط القيمة على lastname
  • internalId: اضبط القيمة على email
  • role: اختياري، دور المستخدم في OpenReplay؛ إذا كان قيمة ثابتة لجميع المستخدمين، فعليك تعريفه في الخطوة التالية، وإلّا فعليك إضافة سمة نصّية (string) جديدة إلى مجموعة JumpCloud، وتسميتها OpenReplayRole وضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة على OpenReplayRole.
  • adminPrivileges: اختياري، إذا كان قيمة ثابتة لجميع المستخدمين، فعليك تعريفه في الخطوة التالية، وإلّا فعليك إضافة سمة منطقية (boolean) جديدة إلى مجموعة JumpCloud، وتسميتها OpenReplayAdminPrivileges وضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة على OpenReplayAdminPrivileges.
  1. عرّف الحقول أدناه في ‘CONSTANT ATTRIBUTES’ بالضغط على زرّ ‘add attribute’:
  • tenantKey: اضبط القيمة على TENANT_KEY، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)
  • role: اختياري، تجاهله إذا تمّ تعريفه في الخطوة السابقة، دور المستخدم في OpenReplay، يجب أن يتطابق مع اسم دور مُعرَّف مسبقًا في OpenReplay (القيمة الافتراضية = member)
  • adminPrivileges: اختياري، تجاهله إذا تمّ تعريفه في الخطوة السابقة، اضبط القيمة على true إذا كنت تريد منح المستخدمين الجدد صلاحية المسؤول، و false إذا لم تكن تريد ذلك (القيمة الافتراضية = false)
  1. في هذه المرحلة، يمكنك الانتقال إلى علامة التبويب ‘User Groups’، واختيار مجموعة المستخدمين الذين سيكون لديهم وصول إلى OpenReplay، أو يمكنك فعل ذلك لاحقًا
  2. اضغط ‘activate’ و ‘continue’ في النافذة المنبثقة للتأكيد
  3. اضغط على أيقونة تطبيق OpenReplay الجديد، ثم في القائمة المنسدلة اليسرى ‘IDP Certificate Valid’ اختر ‘Download certificate’

إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.

وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:

  1. اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل openreplay -e
  2. ضمن قسم chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
  • idp_entityId: openreplay/TENANT_KEY
  • idp_sso_url: https://sso.jumpcloud.com/saml2/openreplay-TENANT_KEY
  • idp_x509cert: الشهادة المُنزَّلة، يجب أن تكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
  • idp_name: JumpCloud
  1. أخيرًا، احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ

The response was received at http instead of http

Section titled The response was received at http instead of http

هذا أمر شائع جدًّا، ويعود إلى عدم وجود ترويسة ‘X-Forwarded-Proto’ في الطلب. ولحلّ ذلك، تأكّد من أنّ موازن التحميل (Load Balancer) يقوم بإعادة توجيه الترويسة بشكل صحيح إلى الواجهة الخلفية (backend) لـ OpenReplay.