SSO
El inicio de sesión único (mediante SAML2) está disponible únicamente en OpenReplay Enterprise Edition.
Configuración del proveedor de identidad (IDP)
Section titled Configuración del proveedor de identidad (IDP)En el panel de tu proveedor de identidad, crea una nueva aplicación llamada openreplay (puedes usar este icono). En la página de configuración, asegúrate de establecer los siguientes valores (asegúrate de reemplazar YOUR_DOMAIN por el valor correcto, por ejemplo https://openreplay.mycompany.com):
| Variable | Valor |
|---|---|
| ACS URL (también llamada Single Sign On URL o Consumer URL) | |
| Entity ID (también llamada Audience) | |
| Single Logout URL (también llamada SLO URL) | (opcional) |
| Name ID (a veces es configurable en la sección ‘Attribute Statements’ o ‘Parameters’) | Email o EmailAddress o urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, según tu proveedor de identidad |
| SAML initiator | Establécelo en Service Provider (opcional) |
En la sección ‘Attribute Statements’ o ‘Parameters’, asegúrate de definir los siguientes campos:
| Campo | Valor |
|---|---|
| tenantKey | su valor se encuentra en el Dashboard, en ‘Preferences’ > ‘Account’ (este atributo no debe añadirse si utilizas nuestro plan Cloud Dedicated) |
| firstName | user.firstName |
| lastName | user.lastName |
| internalId | ID interno o user.email (el ID del usuario en tu sistema de gestión de identidades) (opcional) |
| groups | Representa el rol y el privilegio de administrador del usuario en OpenReplay, según tu proveedor de identidad puede ser user.role o group, etc. (opcional, valor predeterminado = member sin privilegio de administrador). Para simplificar la gestión de roles de OpenReplay desde el lado del IdP, puedes crear un grupo llamado OpenReplay-admin donde tengas a los usuarios con privilegio de administrador, y un grupo llamado OpenReplay-member donde tengas a los usuarios que tienen el rol ‘member’ |
Ahora deberías tener todos los valores requeridos para el siguiente paso/sección.
Configuración de SSO (SAML2)
Section titled Configuración de SSO (SAML2)Si utilizas nuestro plan Cloud dedicated, ve a la Consola, luego haz clic en la instancia y establece las variables en la sección SSO.
De lo contrario, si ejecutas nuestra Enterprise Edition, ejecuta openreplay -e, descomenta y luego actualiza las siguientes variables de entorno en la sección chalice:
| Variable | Descripción |
|---|---|
| idp_entityId | El entityId de tu proveedor de identidad, también denominado Issuer URL |
| idp_sso_url | El singleSignOnService de tu proveedor de identidad, también denominado SAML 2.0 Endpoint (HTTP) |
| idp_x509cert | El x509cert, debe ser una cadena de una sola línea, sin saltos de línea. Puedes usar esta herramienta para formatear tu valor |
| idp_name | El nombre del proveedor de identidad (opcional) |
| idp_sls_url | El singleLogoutService de tu proveedor de identidad, también denominado SLO Endpoint (HTTP) (opcional) |
| enforce_SSO | Si se establece en true, todas las conexiones con nombre de usuario y contraseña se bloquearán (opcional, valor predeterminado=false) |
| idp_group_prefixes | Los prefijos del nombre del grupo del IdP (opcional, valor predeterminado=OpenReplay-,or-) |
Luego, guarda y sal usando :wq para que los cambios surtan efecto:
Certificado de OpenReplay
Section titled Certificado de OpenReplayEsto es opcional, puedes añadir un certificado x509 para mayor seguridad de SSO:
- ejecuta este comando en tu servidor o en tu máquina segura (puedes cambiar el tiempo de validez de tu certificado según tus necesidades):
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout openreplay-sso.key -out openreplay-sso.crt
- En tu servidor, ejecuta
openreplay -e - En la sección
chalice, añade las siguientes variables de entorno:
- sp_crt: debe ser una cadena de una sola línea, sin saltos de línea, del archivo ‘openreplay-sso.crt’ generado (puedes usar esta herramienta para formatear tu valor)
- sp_key: debe ser una cadena de una sola línea, sin saltos de línea, del archivo ‘openreplay-sso.key’ generado
- Guarda y sal usando
:wqpara que los cambios surtan efecto - Añade el archivo ‘openreplay-sso.crt’ generado a la configuración de la aplicación de tu proveedor de identidad
Ejemplo usando Okta
Section titled Ejemplo usando Okta- Inicia sesión en tu panel de administración de Okta y ve a ‘Applications’ > ‘Applications’
- Pulsa ‘Create new app integration’, luego selecciona SAML 2.0 y pulsa ‘Next’
- Establece el ‘App Name’ en OpenReplay (puedes subir este icono) para tu aplicación) y luego pulsa ‘Next’
- Establece:
- Single sign on URL en
/api/sso/saml2/acs/YOUR_DOMAIN - Audience URI (SP Entity ID) en
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format en
EmailAddress
- Pulsa Next, selecciona ‘This is an internal app that we have created’ y luego pulsa ‘Finish’
- En la pestaña Sign On, desplázate hacia abajo y pulsa ‘Show legacy configuration’, luego pulsa ‘Edit’
- Define los siguientes campos en ‘Profile Attribute Statements’:
- tenantKey: formato
Basicy establece el valor en, que se encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’ (este atributo no debe añadirse si utilizas nuestro plan Cloud Dedicated)TENANT_KEY - firstName: formato
Basicy establece el valor enuser.firstName - lastName: formato
Basicy establece el valor enuser.lastName - internalId: formato
Basicy establece el valor enuser.email
- Define el siguiente campo en ‘Group Attribute Statement’ (esto es opcional):
- groups: formato
Basic, filtroMatch Regex, valorOpenReplay-*(o puedes especificar un filtro y una expresión regular diferentes según tus necesidades)
- Pulsa ‘save’ y desplázate hacia arriba a la derecha y pulsa ‘View Setup Instructions’ para ver tu configuración de SAML2
Si utilizas nuestro plan Cloud dedicated, ve a la Consola, luego haz clic en la instancia y establece las variables en la sección SSO.
De lo contrario, si ejecutas nuestra Enterprise Edition:
- Conéctate por SSH a tu instalación de OpenReplay y ejecuta
openreplay -e - En la sección
chalice, descomenta y luego establece las siguientes variables de entorno:
- idp_entityId: Identity Provider Issuer
- idp_sso_url: Identity Provider Single Sign-On URL
- idp_x509cert: certificado X.509, debe ser una cadena de una sola línea, sin saltos de línea (puedes usar esta herramienta para formatear tu valor)
- idp_name: Okta
- Por último, guarda y sal usando
:wqpara que los cambios surtan efecto
Ejemplo usando Azure Active Directory
Section titled Ejemplo usando Azure Active Directory- Inicia sesión en tu portal de Azure y ve a ‘Azure Active Directory’
- Pulsa ’+ Add’, selecciona ‘Enterprise application’ y luego haz clic en ‘Create your own application’
- Establece el ‘App Name’ en OpenReplay, luego selecciona ‘Integrate any other application you don’t find in the gallery (Non-gallery)’ y pulsa ‘Create’
- Navega a ‘Single sign-on’ en el menú lateral izquierdo y establece los siguientes valores en el bloque ‘Basic SAML Configuration’:
- Identifier (Entity ID) en
/api/sso/saml2/metadata/YOUR_DOMAIN - Reply URL (Assertion Consumer Service URL) en
/api/sso/saml2/acs/YOUR_DOMAIN - Logout URL en
/api/sso/saml2/sls/YOUR_DOMAIN
- Añade las siguientes reclamaciones (claims) en el bloque ‘Attribute & Claims’ y asegúrate de dejar vacío el campo ‘Namespace’ en cada una de ellas:
- tenantKey: establece el valor en
, que se encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’ (este atributo/claim no debe añadirse si utilizas nuestro plan Cloud Dedicated)TENANT_KEY - firstName: establece el valor en
user.givenname - lastName: establece el valor en
user.surname - internalId: establece el valor en
user.mail
- Navega a ‘Users and groups’ y asigna los usuarios que selecciones a la aplicación
Si utilizas nuestro plan Cloud dedicated, ve a la Consola, luego haz clic en la instancia y establece las variables en la sección SSO (los valores se encuentran en ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’).
De lo contrario, si ejecutas nuestra Enterprise Edition:
- Conéctate por SSH a tu instalación de OpenReplay y ejecuta
openreplay -e - En la sección
chalice, descomenta y luego establece las siguientes variables de entorno (los valores se encuentran en ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’):
- idp_entityId: Azure AD Identifier
- idp_sso_url: Login URL
- idp_sls_url: Logout URL
- idp_x509cert: certificado X.509, debe ser una cadena de una sola línea, sin saltos de línea (puedes usar esta herramienta para formatear tu valor)
- idp_name: Active Directory
- Por último, guarda y sal usando
:wqpara que los cambios surtan efecto
Ejemplo usando Google Workspace (anteriormente G Suite)
Section titled Ejemplo usando Google Workspace (anteriormente G Suite)Añadir atributos personalizados:
Section titled Añadir atributos personalizados:- En la consola de administración de Google, ve a ‘Directory’ > ‘Users’ > ‘More options’ > ‘Manage custom attributes’.
- Haz clic en ‘Add Custom Attribute’.
- Establece los siguientes campos:
- 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’
- Haz clic en ‘Add’
- Para añadir valores a los nuevos atributos personalizados, ve a ‘Users’
- Selecciona el o los usuarios deseados
- Haz clic en ‘User information’ y luego edita la sección ‘OpenReplay’
- Cambia el valor de role al rol deseado en ‘OpenReplay’ (el rol debe coincidir con el creado en el dashboard de OpenReplay en ‘Preferences’ > ‘Roles’)
- Cambia el valor de adminPrivileges a ‘Yes’ si el usuario está autorizado a tener privilegios de administrador en OpenReplay
- Haz clic en ‘Save’
Configuración:
Section titled Configuración:- Inicia sesión en tu consola de administración de Google y ve a ‘Apps’
- Pulsa ‘Web and mobile apps’, luego haz clic en ‘Add app’ > ‘Add custom SAML app’
- Establece el ‘App name’ en OpenReplay (puedes subir este icono en ‘App icon”) y luego pulsa ‘Continue’
- Copia ‘SSO URL’, ‘Entity ID’ y ‘Certificate’, luego haz clic en ‘Continue’ (usaremos estos valores en el paso 11)
- Establece:
- ACS URL en
( /api/sso/saml2/acs/YOUR_DOMAIN /TENANT_KEYTENANT_KEYse encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’, pero si utilizas nuestro plan Cloud Dedicated, deja vacío el valor de tenantKey) - Entity ID en
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format en
Email - Name ID en
Basic information > Primary Email
- Haz clic en ‘Continue’, luego pulsa ‘Add Mapping’ para añadir los siguientes atributos:
Basic information > First Name-> firstNameBasic information > Last Name-> lastNameBasic information > Primary Email-> internalIdOpenReplay > groups-> groups
- Haz clic en ‘Finish’
- En la consola de administración de Google, ve a ‘Apps’ > ‘Web and mobile apps’ y selecciona ‘OpenReplay’
- Haz clic en ‘User access’, selecciona ‘ON for everyone’ y luego pulsa ‘Save’
Si utilizas nuestro plan Cloud dedicated, ve a la Consola, luego haz clic en la instancia y establece las variables en la sección SSO.
De lo contrario, si ejecutas nuestra Enterprise Edition:
- Conéctate por SSH a tu instalación de OpenReplay y ejecuta
openreplay -e - En la sección
chalice > env, descomenta y establece los siguientes atributos usando los valores del paso 4:
- idp_sso_url: pega el valor de ‘SSO URL’
- idp_entityId: pega el valor de ‘Entity ID’
- idp_x509cert: usa esta herramienta para formatear el certificado copiado/descargado
- idp_name: establece el valor en
G-Suite - idp_tenantKey:
que se encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’TENANT_KEY
- Por último, guarda y sal usando
:wqpara que los cambios surtan efecto
Ejemplo usando JumpCloud
Section titled Ejemplo usando JumpCloud- Inicia sesión en tu panel de administración de JumpCloud y, en el menú de la izquierda, ve a ‘SSO’
- Pulsa ’+ Add New Application’, luego selecciona ‘Custom SAML App’
- Establece el ‘Display Label’ en OpenReplay (puedes subir este icono para tu aplicación) y luego ve a la pestaña ‘SSO’
- Establece:
- IdP Entity ID en
openreplay/(TENANT_KEYTENANT_KEYse encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’, pero si utilizas nuestro plan Cloud Dedicated, deja vacío el valor de tenantKey) - SP Entity ID en
/api/sso/saml2/metadata/YOUR_DOMAIN - ACS URL en
/api/sso/saml2/acs/YOUR_DOMAIN - SAMLSubject NameID en
email - SAMLSubject NameID Format: en
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - Signature Algorithm en
RSA-SHA256 - Marca Sign Assertion
- IDP URL para que termine en
openreplay-(este valor no se puede cambiar más adelante; si utilizas nuestro plan Cloud Dedicated, deja vacía la parte de tenantKey)TENANT_KEY
- Si seguiste las instrucciones de Certificado de OpenReplay, puedes subir el archivo ‘openreplay-sso.crt’ generado pulsando ‘Upload SP Certificate’; de lo contrario, ignora este paso
- Define los siguientes campos en ‘USER ATTRIBUTE MAPPING’ pulsando el botón ‘add attribute’:
- firstName: establece el valor en
firstname - lastName: establece el valor en
lastname - internalId: establece el valor en
email - groups: opcional, el rol y el privilegio de administrador del usuario en OpenReplay; si es un valor constante para todos los usuarios, deberías definirlo en el siguiente paso; de lo contrario, tienes que añadir un nuevo atributo de tipo string al grupo de JumpCloud, llamarlo
OpenReplay-groupsy establecer el valor con el nombre del rol, y luego, en la configuración de SSO, seleccionar ‘Custom User or Group Attribute’ y establecer el valor enOpenReplay-groups.
- Define los siguientes campos en ‘CONSTANT ATTRIBUTES’ pulsando el botón ‘add attribute’:
- tenantKey: establece el valor en
, que se encuentra en el dashboard de OpenReplay en ‘Preferences’ > ‘Account’ (este atributo no debe añadirse si utilizas nuestro plan Cloud Dedicated)TENANT_KEY - groups: opcional, ignóralo si lo definiste en el paso anterior; el rol y el privilegio de administrador del usuario en OpenReplay, debe coincidir con el nombre de rol ya definido en OpenReplay (valor predeterminado =
membersin privilegio de administrador)
- En esta etapa, puedes ir a la pestaña ‘User Groups’ y seleccionar el grupo de usuarios que tendrá acceso a OpenReplay, o puedes hacerlo más tarde
- Pulsa ‘activate’ y ‘continue’ en la ventana emergente de confirmación
- Pulsa el icono de la nueva aplicación OpenReplay y luego, en el menú desplegable de la izquierda ‘IDP Certificate Valid’, elige ‘Download certificate’
Si utilizas nuestro plan Cloud dedicated, ve a la Consola, luego haz clic en la instancia y establece las variables en la sección SSO.
De lo contrario, si ejecutas nuestra Enterprise Edition:
- Conéctate por SSH a tu instalación de OpenReplay y ejecuta
openreplay -e - En la sección
chalice, descomenta y luego establece las siguientes variables de entorno:
- idp_entityId:
openreplay/TENANT_KEY - idp_sso_url:
https://sso.jumpcloud.com/saml2/openreplay-TENANT_KEY - idp_x509cert: el certificado descargado, debe ser una cadena de una sola línea, sin saltos de línea (puedes usar esta herramienta para formatear tu valor)
- idp_name: JumpCloud
- Por último, guarda y sal usando
:wqpara que los cambios surtan efecto
Aprovisionamiento SCIM (System for Cross-domain Identity Management)
Section titled Aprovisionamiento SCIM (System for Cross-domain Identity Management)Openreplay admite la opción de aprovisionar identidades de usuario en la Enterprise Edition.
Para integrarte con el servicio SCIM de Openreplay, simplemente habilita el aprovisionamiento SCIM en el panel de tu proveedor de identidad. Asegúrate de establecer los siguientes valores para una integración fluida:
| Variable | Descripción |
|---|---|
| SCIM connector base URL | /api/sso/scim/v2/ |
| User unique identifier field name | email |
| Support provisioning actions | Push new users, Push profile updates, Push groups |
| Authentication mode | OAuth2 |
| Access token endpoint | /api/sso/scim/v2/token/ |
| Authorization endpoint | /api/sso/scim/v2/authorize/ |
| Client id | su valor se encuentra en el Dashboard, en ‘Preferences’ > ‘Account’ |
| Client secret | Su valor se puede encontrar ejecutando esta consulta en tu base de datos Postgres: SELECT tenant_secret FROM tenants WHERE tenant_key = ' |
Después de establecer estos valores, sigue las instrucciones del panel de tu proveedor de identidad para probar la integración y autorizar la aplicación.
Tras esto, podrás aprovisionar identidades de usuario usando Openreplay como proveedor de servicios SCIM.
Nota: Aunque Openreplay actúa como proveedor de servicios SCIM, no admite la partición de usuarios en varios grupos (es decir, cada usuario solo puede pertenecer a un grupo). Si no se respeta esto, un usuario podría quedar asignado a menos o más proyectos de lo esperado y podría tener menos o más permisos en la aplicación de Openreplay.
Ejemplo usando Okta
Section titled Ejemplo usando OktaEn tu aplicación SAML 2.0, haz lo siguiente
Añadir aprovisionamiento SCIM
Section titled Añadir aprovisionamiento SCIM- Haz clic en la pestaña General
- En la sección App Settings, haz clic en Edit
- En el campo Provisioning, selecciona SCIM y haz clic en Save
Elegir las opciones de aprovisionamiento
Section titled Elegir las opciones de aprovisionamiento- Haz clic en la pestaña Provisioning. La configuración de la conexión SCIM aparece en Settings > Integration.
- En Settings > Integration, haz clic en Edit.
- Especifica el SCIM connector base URL y el nombre del campo del identificador único de tus usuarios mencionado anteriormente.
- En Supported provisioning actions, elige las acciones de aprovisionamiento mencionadas anteriormente.
- Establece el menú desplegable Authentication Mode en el valor mencionado anteriormente.
- Establece el Access token endpoint, Authorization endpoint, Client id y Client secret como se mencionó anteriormente.
- Haz clic en Save.
- Haz clic en Authenticate application.
- En la pestaña Provisioning, haz clic en To App.
- Haz clic en Edit, habilita
Create Users,Update User Attributes,Deactivate Usersy guarda los cambios (asegúrate de que estas opciones queden seleccionadas después de pulsar guardar; de lo contrario, actualiza la página y vuelve a realizar este paso).
- Antes de empezar el siguiente paso, te recomendamos crear nuevos grupos en Okta, llamados
OpenReplay-admin, donde enumeras a los usuarios con privilegio de administrador en OpenReplay, yOpenReplay-members, donde enumeras a los usuarios con el rolmemberen OpenReplay, …
- Ve a la pestaña Push Groups, haz clic en + Push Groups (por nombre o por regla), selecciona el grupo que quieres enviar a OpenReplay y pulsa save
- En este punto, los grupos enviados representan roles y privilegio de administrador en OpenReplay, y no incluyen la lista de usuarios aprovisionados para OpenReplay.
- Ve a la pestaña Assignmets y añade usuarios de la manera que te resulte conveniente (usando personas o grupos)
Errores
Section titled ErroresLa respuesta se recibió en http en lugar de https
Section titled La respuesta se recibió en http en lugar de httpsEsto es muy común y se debe a que el encabezado ‘X-Forwarded-Proto’ no está presente en la solicitud. Para resolverlo, asegúrate de que el balanceador de carga reenvíe correctamente el encabezado al backend de OpenReplay y ejecuta openreplay -e; en la sección ingress-nginx > config, descomenta la línea use-forwarded-headers: true.