SSO
الدخول الموحّد (عبر SAML2) متاح في OpenReplay Enterprise Edition فقط.
إعداد موفّر الهوية (IDP)
Section titled إعداد موفّر الهوية (IDP)في لوحة تحكم موفّر الهوية الخاص بك، أنشئ تطبيقًا جديدًا باسم openreplay (يمكنك استخدام هذه الأيقونة). في صفحة الإعداد، تأكّد من ضبط القيمة التالية (يرجى التأكّد من استبدال YOUR_DOMAIN:PORT بالقيمة الصحيحة، مثال https://openreplay.mycompany.com:443؛ بالنسبة إلى PORT يرجى استخدام 443 إذا كنت تستخدم https، أو 8080 إذا كنت تستخدم http، أو استخدم رقم المنفذ المخصّص الخاص بك):
| المتغيّر | القيمة |
|---|---|
| عنوان ACS URL (يُسمّى أيضًا Single Sign On URL أو Consumer URL) | |
| Entity ID (يُسمّى أيضًا Audience) | |
| عنوان الخروج الموحّد Single Logout URL (يُسمّى أيضًا SLO URL) | (اختياري) |
| Name ID (يمكن أحيانًا تهيئته في قسم ‘Attribute Statements’ أو ‘Parameters’) | Email أو EmailAddress أو urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress، حسب موفّر الهوية الخاص بك |
| مُهيئ SAML | اضبطه على Service Provider (اختياري) |
في قسم ‘Attribute Statements’ أو ‘Parameters’، يرجى التأكّد من تعريف الحقول التالية:
| الحقل | القيمة |
|---|---|
| tenantKey | يمكن العثور على قيمته في الـ Dashboard، ضمن ‘Preferences’ > ‘Account’ |
| firstName | user.firstName |
| lastName | user.lastName |
| internalId | المعرّف الداخلي أو user.email (معرّف المستخدم في نظام إدارة الهويات الخاص بك) (اختياري) |
| role | دور المستخدم؛ حسب موفّر الهوية الخاص بك قد يكون user.role أو group، إلخ. (اختياري، القيمة الافتراضية = member) |
| adminPrivileges | ما إذا كان المستخدم يملك امتيازات المسؤول أم لا؛ إذا احتوى هذا الحقل على أي قيمة مختلفة عن false، فسيُعتبر true. (اختياري، القيمة الافتراضية = false) |
ينبغي أن تكون لديك الآن جميع القيم المطلوبة للخطوة/القسم التالي.
إعداد SSO (SAML2)
Section titled إعداد SSO (SAML2)لتفعيل SSO، شغّل 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 كي تدخل التغييرات حيّز التنفيذ:
شهادة OpenReplay
Section titled شهادة OpenReplayهذا اختياري؛ بدءًا من الإصدار v1.10.0، يمكنك إضافة شهادة x509 لمزيد من الأمان في SSO:
- شغّل هذا الأمر على خادمك أو على جهازك الآمن (يمكنك تغيير مدة صلاحية شهادتك وفقًا لاحتياجاتك):
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout openreplay-sso.key -out openreplay-sso.crt
- على خادمك، شغّل
openreplay -e - ضمن قسم
chalice، أضف متغيّرات البيئة التالية:
- sp_crt: يجب أن تكون سلسلة من سطر واحد، بدون فواصل أسطر، من ملف ‘openreplay-sso.crt’ المُولّد (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- sp_key: يجب أن تكون سلسلة من سطر واحد، بدون فواصل أسطر، من ملف ‘openreplay-sso.key’ المُولّد
- احفظ واخرج باستخدام
:wqكي تدخل التغييرات حيّز التنفيذ - أضف ملف ‘openreplay-sso.crt’ المُولّد إلى إعداد تطبيق موفّر الهوية الخاص بك
مثال باستخدام Okta
Section titled مثال باستخدام Okta- سجّل الدخول إلى لوحة إدارة Okta وانتقل إلى ‘Applications’ > ‘Applications’
- اضغط ‘Create new app integration’، ثم اختر SAML 2.0 واضغط ‘Next’
- اضبط ‘App Name’ على OpenReplay (يمكنك رفع هذه الأيقونة) لتطبيقك) ثم اضغط ‘Next’
- اضبط:
- Single sign on URL على
:YOUR_DOMAIN /api/sso/saml2/acs/PORT - Audience URI (SP Entity ID) على
:YOUR_DOMAIN /api/sso/saml2/metadata/PORT - Name ID format على
EmailAddress
- عرّف الحقول أدناه في ‘Attribute Statements’:
- tenantKey: التنسيق
Basicواضبط القيمة على، وتُوجد في لوحة OpenReplay ضمن ‘Preferences’ > ‘Account’TENANT_KEY - firstName: التنسيق
Basicواضبط القيمة علىuser.firstName - lastName: التنسيق
Basicواضبط القيمة علىuser.lastName - internalId: التنسيق
Basicواضبط القيمة علىuser.email
- عرّف الحقل أدناه في ‘Group Attribute Statements’:
- role: التنسيق
Basic، عامل التصفيةMatch Regex، القيمة.*(أو يمكنك تحديد عامل تصفية وتعبير منتظم مختلف وفقًا لاحتياجاتك) - adminPrivileges: التنسيق
Basic، عامل التصفيةMatch Regex، القيمةadmin(سيحصل المستخدم الحالي علىadmin privilegesإذا كان جزءًا من مجموعة admin)
- اضغط Next، اختر ‘I’m an Okta customer adding an internal app’ و’This is an internal app that we have created’ ثم اضغط ‘Finish’
- في علامة التبويب Sign On، مرّر للأسفل واضغط ‘View Setup Instructions’ لرؤية إعداد SAML2 الخاص بك
- على خادمك، شغّل
openreplay -e - ضمن قسم
chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
- idp_entityId: Identity Provider Issuer
- idp_sso_url: Identity Provider Single Sign-On URL
- idp_x509cert: X.509 Certificate، يجب أن تكون سلسلة من سطر واحد، بدون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- idp_name: Okta
- أخيرًا، احفظ واخرج باستخدام
:wqكي تدخل التغييرات حيّز التنفيذ.
مثال باستخدام Azure Active Directory
Section titled مثال باستخدام Azure Active Directory- سجّل الدخول إلى بوابة Azure الخاصة بك وانتقل إلى ‘Azure Active Directory’
- اضغط ’+ Add’، اختر ‘Enterprise application’ ثم انقر ‘Create your own application’
- اضبط ‘App Name’ على OpenReplay ثم اختر ‘Integrate any other application you don’t find in the gallery (Non-gallery)’ واضغط ‘Create’
- انتقل إلى ‘Single sign-on’ في القائمة الجانبية اليسرى واضبط القيم أدناه في كتلة ‘Basic SAML Configuration’:
- Identifier (Entity ID) على
:YOUR_DOMAIN /api/sso/saml2/metadata/PORT - Reply URL (Assertion Consumer Service URL) على
:YOUR_DOMAIN /api/sso/saml2/acs/PORT - Logout URL على
:YOUR_DOMAIN /api/sso/saml2/sls/PORT
- أضف المطالبات (claims) أدناه في كتلة ‘Attribute & Claims’:
- tenantKey: اضبط القيمة على
، وتُوجد في لوحة OpenReplay ضمن ‘Preferences’ > ‘Account’TENANT_KEY - firstName: اضبط القيمة على
user.givenname - lastName: اضبط القيمة على
user.surname - internalId: اضبط القيمة على
user.mail
- انتقل إلى ‘Users and groups’ وعيّن المستخدمين الذين تختارهم للتطبيق
- الآن اتصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل
openreplay -e - ضمن قسم
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
- أخيرًا، احفظ واخرج باستخدام
:wqكي تدخل التغييرات حيّز التنفيذ
مثال باستخدام Google Workspace (المعروف سابقًا بـ G Suite)
Section titled مثال باستخدام Google Workspace (المعروف سابقًا بـ G Suite)إضافة سمات مخصّصة:
Section titled إضافة سمات مخصّصة:- في وحدة تحكم Google Admin، انتقل إلى ‘Directory’ > ‘Users’ > ‘More options’ > ‘Manage custom attributes’.
- انقر ‘Add Custom Attribute’.
- اضبط الحقول التالية:
- 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’
- انقر ‘Add’
- لإضافة قيم إلى السمات المخصّصة الجديدة، انتقل إلى ‘Users’
- اختر المستخدم (المستخدمين) المطلوب
- انقر ‘User information’ ثم عدّل قسم ‘OpenReplay’
- غيّر قيمة role إلى الدور المطلوب في ‘OpenReplay’ (يجب أن يتطابق الدور مع الدور المُنشأ في لوحة OpenReplay ضمن ‘Preferences’ > ‘Roles’)
- غيّر قيمة adminPrivileges إلى ‘Yes’ إذا كان مسموحًا للمستخدم أن يملك امتيازات المسؤول في OpenReplay
- انقر ‘Save’
الإعداد:
Section titled الإعداد:- سجّل الدخول إلى وحدة تحكم Google Admin وانتقل إلى ‘Apps’
- اضغط ‘Web and mobile apps’ ثم انقر ‘Add app’ > ‘Add custom SAML app’
- اضبط ‘App name’ على OpenReplay (يمكنك رفع هذه الأيقونة لـ ‘App icon”) ثم اضغط ‘Continue’
- انسخ ‘SSO URL’ و’Entity ID’ و’Certificate’ ثم انقر ‘Continue’ (سنستخدم هذه القيم في الخطوة 11)
- اضبط:
- ACS URL على
( :YOUR_DOMAIN /api/sso/saml2/acs/PORT /TENANT_KEYTENANT_KEYيُوجد في لوحة OpenReplay ضمن ‘Preferences’ > ‘Account’) - Entity ID على
:YOUR_DOMAIN /api/sso/saml2/metadata/PORT - Name ID format على
Email - Name ID على
Basic information > Primary Email
- انقر ‘Continue’ ثم اضغط ‘Add Mapping’ لإضافة السمات أدناه:
Basic information > First Name-> firstNameBasic information > Last Name-> lastNameBasic information > Primary Email-> internalIdOpenReplay > role-> roleOpenReplay > adminPrivileges-> adminPrivileges
- انقر ‘Finish’
- في وحدة تحكم Google Admin، انتقل إلى ‘Apps’ > ‘Web and mobile apps’ واختر ‘OpenReplay’
- انقر ‘User access’، اختر ‘ON for everyone’ ثم اضغط ‘Save’
- على خادمك، شغّل
openreplay -e - ضمن قسم
chalice > env، أزل التعليق واضبط السمات التالية باستخدام القيم من الخطوة 4:
- idp_sso_url: الصق قيمة ‘SSO URL’
- idp_entityId: الصق قيمة ‘Entity ID’
- idp_x509cert: استخدم هذه الأداة لتنسيق الشهادة المنسوخة/المُنزّلة
- idp_name: اضبط القيمة على
G-Suite - idp_tenantKey:
يُوجد في لوحة OpenReplay ضمن ‘Preferences’ > ‘Account’TENANT_KEY
- أخيرًا، احفظ واخرج باستخدام
:wqكي تدخل التغييرات حيّز التنفيذ.
مثال باستخدام JumpCloud
Section titled مثال باستخدام JumpCloud- سجّل الدخول إلى لوحة إدارة JumpCloud، وفي القائمة اليسرى، انتقل إلى ‘SSO’
- اضغط ’+ Add New Application’، ثم اختر ‘Custom SAML App’
- اضبط ‘Display Label’ على OpenReplay (يمكنك رفع هذه الأيقونة لتطبيقك) ثم انتقل إلى علامة التبويب ‘SSO’
- اضبط:
- IdP Entity ID على
openreplay/TENANT_KEY - SP Entity ID على
:YOUR_DOMAIN /api/sso/saml2/metadata/PORT - ACS URL على
:YOUR_DOMAIN /api/sso/saml2/acs/PORT - 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
- إذا اتّبعت تعليمات OpenReplay-Certificate، فيمكنك رفع ملف ‘openreplay-sso.crt’ المُولّد بالضغط على ‘Upload SP Certificate’، وإلا فتجاهل هذه الخطوة
- عرّف الحقول أدناه في ‘USER ATTRIBUTE MAPPING’ بالضغط على زر ‘add attribute’:
- firstName: اضبط القيمة على
firstname - lastName: اضبط القيمة على
lastname - internalId: اضبط القيمة على
email - role: اختياري، دور المستخدم في OpenReplay؛ إذا كان قيمة ثابتة لجميع المستخدمين، فيجب عليك تعريفه في الخطوة التالية،
وإلا فعليك إضافة سمة نصّية جديدة إلى مجموعة JumpCloud، وتسميتها
OpenReplayRoleوضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة علىOpenReplayRole. - adminPrivileges: اختياري، إذا كان قيمة ثابتة لجميع المستخدمين، فيجب عليك تعريفه في الخطوة التالية؛ وإلا فعليك إضافة سمة منطقية (boolean) جديدة إلى مجموعة JumpCloud، وتسميتها
OpenReplayAdminPrivilegesوضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة علىOpenReplayAdminPrivileges.
- عرّف الحقول أدناه في ‘CONSTANT ATTRIBUTES’ بالضغط على زر ‘add attribute’:
- tenantKey: اضبط القيمة على
، وتُوجد في لوحة OpenReplay ضمن ‘Preferences’ > ‘Account’TENANT_KEY - role: اختياري، تجاهله إذا عُرّف في الخطوة السابقة؛ دور المستخدم في OpenReplay، يجب أن يتطابق مع اسم دور مُعرّف بالفعل في OpenReplay (القيمة الافتراضية =
member) - adminPrivileges: اختياري، تجاهله إذا عُرّف في الخطوة السابقة؛ اضبط القيمة على
trueإذا كنت تريد منح المستخدمين الجدد امتياز المسؤول، أوfalseإذا لم ترغب في ذلك (القيمة الافتراضية =false)
- في هذه المرحلة، يمكنك الانتقال إلى علامة التبويب ‘User Groups’، واختيار مجموعة المستخدمين الذين سيكون لديهم وصول إلى OpenReplay، أو يمكنك القيام بذلك لاحقًا
- اضغط ‘activate’ و’continue’ في النافذة المنبثقة للتأكيد
- اضغط على أيقونة تطبيق OpenReplay الجديد، ثم في القائمة المنسدلة اليسرى ‘IDP Certificate Valid’ اختر ‘Download certificate’
- على خادمك، شغّل
openreplay -e - ضمن قسم
chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
- idp_entityId:
openreplay/TENANT_KEY - idp_sso_url:
https://sso.jumpcloud.com/saml2/openreplay-TENANT_KEY - idp_x509cert: الشهادة المُنزّلة، يجب أن تكون سلسلة من سطر واحد، بدون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- idp_name: JumpCloud
- أخيرًا، احفظ واخرج باستخدام
:wqكي تدخل التغييرات حيّز التنفيذ.
هل لديك أسئلة؟
Section titled هل لديك أسئلة؟إذا كانت لديك أي أسئلة حول هذه العملية، فلا تتردّد في التواصل معنا عبر Slack الخاص بنا أو الاطّلاع على المنتدى الخاص بنا.