SSO
Единый вход (через SAML2) доступен только в OpenReplay Enterprise Edition.
Настройка поставщика удостоверений (IDP)
Section titled Настройка поставщика удостоверений (IDP)В панели управления вашего поставщика удостоверений создайте новое приложение под названием openreplay (вы можете использовать эту иконку). На странице конфигурации обязательно задайте следующее значение (убедитесь, что вы заменили YOUR_DOMAIN:PORT на правильное значение, например https://openreplay.mycompany.com:443; для PORT используйте 443, если вы используете https, 8080, если вы используете http, или укажите свой пользовательский номер порта):
| Переменная | Значение |
|---|---|
| URL ACS (также называется URL единого входа или Consumer URL) | |
| Entity ID (также называется Audience) | |
| URL единого выхода (также называется URL SLO) | (необязательно) |
| 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 | Внутренний ID или 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 перейдите в ‘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 и перейдите в ‘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 перейдите в ‘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: необязательно, если это постоянное значение для всех пользователей, вам следует определить его на следующем шаге; в противном случае вам нужно добавить новый булев атрибут в группу 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 или загляните на наш Форум.