SSO
L’authentification unique (via SAML2) est disponible uniquement dans OpenReplay Enterprise Edition.
Configuration du fournisseur d’identité (IDP)
Section titled Configuration du fournisseur d’identité (IDP)Dans le tableau de bord de votre fournisseur d’identité, créez une nouvelle application appelée openreplay (vous pouvez utiliser cette icône). Sur la page de configuration, veillez à définir les valeurs suivantes (assurez-vous de remplacer YOUR_DOMAIN par la valeur correcte, par exemple https://openreplay.mycompany.com) :
| Variable | Valeur |
|---|---|
| ACS URL (aussi appelée Single Sign On URL ou Consumer URL) | |
| Entity ID (aussi appelée Audience) | |
| Single Logout URL (aussi appelée SLO URL) | (facultatif) |
| Name ID (parfois configurable dans la section ‘Attribute Statements’ ou ‘Parameters’) | Email ou EmailAddress ou urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, selon votre fournisseur d’identité |
| SAML initiator | Définissez-le sur Service Provider (facultatif) |
Dans la section ‘Attribute Statements’ ou ‘Parameters’, veillez à définir les champs suivants :
| Champ | Valeur |
|---|---|
| tenantKey | sa valeur se trouve dans le Dashboard, sous ‘Preferences’ > ‘Account’ (cet attribut ne doit pas être ajouté si vous utilisez notre offre Cloud Dedicated) |
| firstName | user.firstName |
| lastName | user.lastName |
| internalId | ID interne ou user.email (l’ID de l’utilisateur dans votre système de gestion des identités) (facultatif) |
| groups | Représente le rôle et le privilège d’administrateur de l’utilisateur dans OpenReplay ; selon votre fournisseur d’identité, il peut s’agir de user.role ou de group, etc. (facultatif, valeur par défaut = member sans privilège d’administrateur). Pour simplifier la gestion des rôles OpenReplay du côté de l’IdP, vous pouvez créer un groupe appelé OpenReplay-admin où vous placez les utilisateurs disposant du privilège d’administrateur, et un groupe appelé OpenReplay-member où vous placez les utilisateurs ayant le rôle ‘member’ |
Vous devriez maintenant disposer de toutes les valeurs requises pour l’étape/section suivante.
Configuration du SSO (SAML2)
Section titled Configuration du SSO (SAML2)Si vous utilisez notre offre Cloud dedicated, accédez à la Console, puis cliquez sur l’instance et définissez les variables dans la section SSO.
Sinon, si vous exécutez notre Enterprise Edition, exécutez openreplay -e, décommentez puis mettez à jour les variables d’environnement ci-dessous dans la section chalice :
| Variable | Description |
|---|---|
| idp_entityId | L’entityId de votre fournisseur d’identité, également appelé Issuer URL |
| idp_sso_url | Le singleSignOnService de votre fournisseur d’identité, également appelé SAML 2.0 Endpoint (HTTP) |
| idp_x509cert | Le x509cert, doit être une chaîne sur une seule ligne, sans sauts de ligne. Vous pouvez utiliser cet outil pour formater votre valeur |
| idp_name | Le nom du fournisseur d’identité (facultatif) |
| idp_sls_url | Le singleLogoutService de votre fournisseur d’identité, également appelé SLO Endpoint (HTTP) (facultatif) |
| enforce_SSO | S’il est défini sur true, toutes les connexions avec nom d’utilisateur et mot de passe seront bloquées (facultatif, valeur par défaut=false) |
| idp_group_prefixes | Les préfixes du nom de groupe de l’IdP (facultatif, valeur par défaut=OpenReplay-,or-) |
Ensuite, enregistrez et quittez à l’aide de :wq pour que les modifications prennent effet :
Certificat OpenReplay
Section titled Certificat OpenReplayCeci est facultatif, vous pouvez ajouter un certificat x509 pour une sécurité SSO supplémentaire :
- exécutez cette commande sur votre serveur ou sur votre machine sécurisée (vous pouvez modifier la durée de validité de votre certificat selon vos besoins) :
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout openreplay-sso.key -out openreplay-sso.crt
- Sur votre serveur, exécutez
openreplay -e - Dans la section
chalice, ajoutez les variables d’environnement suivantes :
- sp_crt : doit être une chaîne sur une seule ligne, sans sauts de ligne, du fichier ‘openreplay-sso.crt’ généré (vous pouvez utiliser cet outil pour formater votre valeur)
- sp_key : doit être une chaîne sur une seule ligne, sans sauts de ligne, du fichier ‘openreplay-sso.key’ généré
- Enregistrez et quittez à l’aide de
:wqpour que les modifications prennent effet - Ajoutez le fichier ‘openreplay-sso.crt’ généré à la configuration de l’application de votre fournisseur d’identité
Exemple avec Okta
Section titled Exemple avec Okta- Connectez-vous à votre tableau de bord d’administration Okta et accédez à ‘Applications’ > ‘Applications’
- Appuyez sur ‘Create new app integration’, puis sélectionnez SAML 2.0 et appuyez sur ‘Next’
- Définissez le ‘App Name’ sur OpenReplay (vous pouvez téléverser cette icône) pour votre application) puis appuyez sur ‘Next’
- Définissez :
- Single sign on URL sur
/api/sso/saml2/acs/YOUR_DOMAIN - Audience URI (SP Entity ID) sur
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format sur
EmailAddress
- Appuyez sur Next, sélectionnez ‘This is an internal app that we have created’ puis appuyez sur ‘Finish’
- Dans l’onglet Sign On, faites défiler vers le bas et appuyez sur ‘Show legacy configuration’ puis sur ‘Edit’
- Définissez les champs ci-dessous dans ‘Profile Attribute Statements’ :
- tenantKey : format
Basicet définissez la valeur sur, qui se trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’ (cet attribut ne doit pas être ajouté si vous utilisez notre offre Cloud Dedicated)TENANT_KEY - firstName : format
Basicet définissez la valeur suruser.firstName - lastName : format
Basicet définissez la valeur suruser.lastName - internalId : format
Basicet définissez la valeur suruser.email
- Définissez le champ ci-dessous dans ‘Group Attribute Statement’ (ceci est facultatif) :
- groups : format
Basic, filtreMatch Regex, valeurOpenReplay-*(ou vous pouvez spécifier un filtre et une expression régulière différents selon vos besoins)
- Appuyez sur ‘save’ et faites défiler vers le haut à droite et appuyez sur ‘View Setup Instructions’ pour voir votre configuration SAML2
Si vous utilisez notre offre Cloud dedicated, accédez à la Console, puis cliquez sur l’instance et définissez les variables dans la section SSO.
Sinon, si vous exécutez notre Enterprise Edition :
- Connectez-vous en SSH à votre installation OpenReplay et exécutez
openreplay -e - Dans la section
chalice, décommentez puis définissez les variables d’environnement suivantes :
- idp_entityId : Identity Provider Issuer
- idp_sso_url : Identity Provider Single Sign-On URL
- idp_x509cert : certificat X.509, doit être une chaîne sur une seule ligne, sans sauts de ligne (vous pouvez utiliser cet outil pour formater votre valeur)
- idp_name : Okta
- Enfin, enregistrez et quittez à l’aide de
:wqpour que les modifications prennent effet
Exemple avec Azure Active Directory
Section titled Exemple avec Azure Active Directory- Connectez-vous à votre portail Azure et accédez à ‘Azure Active Directory’
- Appuyez sur ’+ Add’, sélectionnez ‘Enterprise application’ puis cliquez sur ‘Create your own application’
- Définissez le ‘App Name’ sur OpenReplay, puis sélectionnez ‘Integrate any other application you don’t find in the gallery (Non-gallery)’ et appuyez sur ‘Create’
- Accédez à ‘Single sign-on’ dans le menu de gauche et définissez les valeurs ci-dessous dans le bloc ‘Basic SAML Configuration’ :
- Identifier (Entity ID) sur
/api/sso/saml2/metadata/YOUR_DOMAIN - Reply URL (Assertion Consumer Service URL) sur
/api/sso/saml2/acs/YOUR_DOMAIN - Logout URL sur
/api/sso/saml2/sls/YOUR_DOMAIN
- Ajoutez les revendications (claims) ci-dessous dans le bloc ‘Attribute & Claims’ et veillez à laisser le champ ‘Namespace’ vide pour chacune d’elles :
- tenantKey : définissez la valeur sur
, qui se trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’ (cet attribut/claim ne doit pas être ajouté si vous utilisez notre offre Cloud Dedicated)TENANT_KEY - firstName : définissez la valeur sur
user.givenname - lastName : définissez la valeur sur
user.surname - internalId : définissez la valeur sur
user.mail
- Accédez à ‘Users and groups’ et affectez les utilisateurs que vous sélectionnez à l’application
Si vous utilisez notre offre Cloud dedicated, accédez à la Console, puis cliquez sur l’instance et définissez les variables dans la section SSO (les valeurs se trouvent dans ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’).
Sinon, si vous exécutez notre Enterprise Edition :
- Connectez-vous en SSH à votre installation OpenReplay et exécutez
openreplay -e - Dans la section
chalice, décommentez puis définissez les variables d’environnement suivantes (les valeurs se trouvent dans ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’) :
- idp_entityId : Azure AD Identifier
- idp_sso_url : Login URL
- idp_sls_url : Logout URL
- idp_x509cert : certificat X.509, doit être une chaîne sur une seule ligne, sans sauts de ligne (vous pouvez utiliser cet outil pour formater votre valeur)
- idp_name : Active Directory
- Enfin, enregistrez et quittez à l’aide de
:wqpour que les modifications prennent effet
Exemple avec Google Workspace (anciennement G Suite)
Section titled Exemple avec Google Workspace (anciennement G Suite)Ajouter des attributs personnalisés :
Section titled Ajouter des attributs personnalisés :- Dans la console d’administration Google, accédez à ‘Directory’ > ‘Users’ > ‘More options’ > ‘Manage custom attributes’.
- Cliquez sur ‘Add Custom Attribute’.
- Définissez les champs suivants :
- 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’
- Cliquez sur ‘Add’
- Pour ajouter des valeurs aux nouveaux attributs personnalisés, accédez à ‘Users’
- Sélectionnez le ou les utilisateurs souhaités
- Cliquez sur ‘User information’ puis modifiez la section ‘OpenReplay’
- Modifiez la valeur de role pour le rôle souhaité dans ‘OpenReplay’ (le rôle doit correspondre à celui créé dans le dashboard OpenReplay sous ‘Preferences’ > ‘Roles’)
- Modifiez la valeur de adminPrivileges sur ‘Yes’ si l’utilisateur est autorisé à disposer de privilèges d’administrateur dans OpenReplay
- Cliquez sur ‘Save’
Configuration :
Section titled Configuration :- Connectez-vous à votre console d’administration Google et accédez à ‘Apps’
- Appuyez sur ‘Web and mobile apps’ puis cliquez sur ‘Add app’ > ‘Add custom SAML app’
- Définissez le ‘App name’ sur OpenReplay (vous pouvez téléverser cette icône pour ‘App icon”) puis appuyez sur ‘Continue’
- Copiez ‘SSO URL’, ‘Entity ID’ et ‘Certificate’ puis cliquez sur ‘Continue’ (nous utiliserons ces valeurs à l’étape 11)
- Définissez :
- ACS URL sur
( /api/sso/saml2/acs/YOUR_DOMAIN /TENANT_KEYTENANT_KEYse trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’, mais si vous utilisez notre offre Cloud Dedicated, laissez la valeur de tenantKey vide) - Entity ID sur
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format sur
Email - Name ID sur
Basic information > Primary Email
- Cliquez sur ‘Continue’ puis appuyez sur ‘Add Mapping’ pour ajouter les attributs ci-dessous :
Basic information > First Name-> firstNameBasic information > Last Name-> lastNameBasic information > Primary Email-> internalIdOpenReplay > groups-> groups
- Cliquez sur ‘Finish’
- Dans la console d’administration Google, accédez à ‘Apps’ > ‘Web and mobile apps’ et sélectionnez ‘OpenReplay’
- Cliquez sur ‘User access’, sélectionnez ‘ON for everyone’ puis appuyez sur ‘Save’
Si vous utilisez notre offre Cloud dedicated, accédez à la Console, puis cliquez sur l’instance et définissez les variables dans la section SSO.
Sinon, si vous exécutez notre Enterprise Edition :
- Connectez-vous en SSH à votre installation OpenReplay et exécutez
openreplay -e - Dans la section
chalice > env, décommentez et définissez les attributs suivants à l’aide des valeurs de l’étape 4 :
- idp_sso_url : collez la valeur de ‘SSO URL’
- idp_entityId : collez la valeur de ‘Entity ID’
- idp_x509cert : utilisez cet outil pour formater le certificat copié/téléchargé
- idp_name : définissez la valeur sur
G-Suite - idp_tenantKey :
qui se trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’TENANT_KEY
- Enfin, enregistrez et quittez à l’aide de
:wqpour que les modifications prennent effet
Exemple avec JumpCloud
Section titled Exemple avec JumpCloud- Connectez-vous à votre tableau de bord d’administration JumpCloud et, dans le menu de gauche, accédez à ‘SSO’
- Appuyez sur ’+ Add New Application’, puis sélectionnez ‘Custom SAML App’
- Définissez le ‘Display Label’ sur OpenReplay (vous pouvez téléverser cette icône pour votre application) puis accédez à l’onglet ‘SSO’
- Définissez :
- IdP Entity ID sur
openreplay/(TENANT_KEYTENANT_KEYse trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’, mais si vous utilisez notre offre Cloud Dedicated, laissez la valeur de tenantKey vide) - SP Entity ID sur
/api/sso/saml2/metadata/YOUR_DOMAIN - ACS URL sur
/api/sso/saml2/acs/YOUR_DOMAIN - SAMLSubject NameID sur
email - SAMLSubject NameID Format: sur
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - Signature Algorithm sur
RSA-SHA256 - Cochez Sign Assertion
- IDP URL afin qu’elle se termine par
openreplay-(cette valeur ne peut pas être modifiée ultérieurement ; si vous utilisez notre offre Cloud Dedicated, laissez la partie tenantKey vide)TENANT_KEY
- Si vous avez suivi les instructions du Certificat OpenReplay, vous pouvez téléverser le fichier ‘openreplay-sso.crt’ généré en appuyant sur ‘Upload SP Certificate’ ; sinon, ignorez cette étape
- Définissez les champs ci-dessous dans ‘USER ATTRIBUTE MAPPING’ en appuyant sur le bouton ‘add attribute’ :
- firstName : définissez la valeur sur
firstname - lastName : définissez la valeur sur
lastname - internalId : définissez la valeur sur
email - groups : facultatif, le rôle et le privilège d’administrateur de l’utilisateur dans OpenReplay ; s’il s’agit d’une valeur constante pour tous les utilisateurs, vous devez le définir à l’étape suivante ; sinon, vous devez ajouter un nouvel attribut de type string au groupe JumpCloud, l’appeler
OpenReplay-groupset définir la valeur sur le nom du rôle, puis, dans la configuration SSO, sélectionner ‘Custom User or Group Attribute’ et définir la valeur surOpenReplay-groups.
- Définissez les champs ci-dessous dans ‘CONSTANT ATTRIBUTES’ en appuyant sur le bouton ‘add attribute’ :
- tenantKey : définissez la valeur sur
, qui se trouve dans le dashboard OpenReplay sous ‘Preferences’ > ‘Account’ (cet attribut ne doit pas être ajouté si vous utilisez notre offre Cloud Dedicated)TENANT_KEY - groups : facultatif, ignorez-le si vous l’avez défini à l’étape précédente ; le rôle et le privilège d’administrateur de l’utilisateur dans OpenReplay doivent correspondre au nom de rôle déjà défini dans OpenReplay (valeur par défaut =
membersans privilège d’administrateur)
- À ce stade, vous pouvez accéder à l’onglet ‘User Groups’ et sélectionner le groupe d’utilisateurs qui aura accès à OpenReplay, ou vous pouvez le faire plus tard
- Appuyez sur ‘activate’ et ‘continue’ dans la fenêtre contextuelle de confirmation
- Appuyez sur l’icône de la nouvelle application OpenReplay, puis dans le menu déroulant de gauche ‘IDP Certificate Valid’, choisissez ‘Download certificate’
Si vous utilisez notre offre Cloud dedicated, accédez à la Console, puis cliquez sur l’instance et définissez les variables dans la section SSO.
Sinon, si vous exécutez notre Enterprise Edition :
- Connectez-vous en SSH à votre installation OpenReplay et exécutez
openreplay -e - Dans la section
chalice, décommentez puis définissez les variables d’environnement suivantes :
- idp_entityId :
openreplay/TENANT_KEY - idp_sso_url :
https://sso.jumpcloud.com/saml2/openreplay-TENANT_KEY - idp_x509cert : le certificat téléchargé, doit être une chaîne sur une seule ligne, sans sauts de ligne (vous pouvez utiliser cet outil pour formater votre valeur)
- idp_name : JumpCloud
- Enfin, enregistrez et quittez à l’aide de
:wqpour que les modifications prennent effet
Provisionnement SCIM (System for Cross-domain Identity Management)
Section titled Provisionnement SCIM (System for Cross-domain Identity Management)Openreplay prend en charge l’option de provisionner des identités d’utilisateurs dans l’Enterprise Edition.
Pour vous intégrer au service SCIM d’Openreplay, activez simplement le provisionnement SCIM dans le tableau de bord de votre fournisseur d’identité. Veillez à définir les valeurs suivantes pour une intégration sans accroc :
| Variable | Description |
|---|---|
| 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 | sa valeur se trouve dans le Dashboard, sous ‘Preferences’ > ‘Account’ |
| Client secret | Sa valeur peut être trouvée en exécutant cette requête dans votre base de données Postgres : SELECT tenant_secret FROM tenants WHERE tenant_key = ' |
Après avoir défini ces valeurs, suivez les invites du tableau de bord de votre fournisseur d’identité afin de tester l’intégration et d’autoriser l’application.
Ensuite, vous pourrez provisionner des identités d’utilisateurs en utilisant Openreplay comme fournisseur de services SCIM.
Remarque : Bien qu’Openreplay agisse en tant que fournisseur de services SCIM, il ne prend pas en charge la répartition des utilisateurs dans plusieurs groupes (c’est-à-dire que chaque utilisateur ne peut appartenir qu’à un seul groupe). Si cela n’est pas respecté, un utilisateur pourrait être affecté à moins ou à plus de projets que prévu et pourrait disposer de moins ou de plus de permissions dans l’application d’Openreplay.
Exemple avec Okta
Section titled Exemple avec OktaDans votre application SAML 2.0, procédez comme suit
Ajouter le provisionnement SCIM
Section titled Ajouter le provisionnement SCIM- Cliquez sur l’onglet General
- Dans la section App Settings, cliquez sur Edit
- Dans le champ Provisioning, sélectionnez SCIM, puis cliquez sur Save
Choisir les options de provisionnement
Section titled Choisir les options de provisionnement- Cliquez sur l’onglet Provisioning. Les paramètres de connexion SCIM apparaissent sous Settings > Integration.
- Dans Settings > Integration, cliquez sur Edit.
- Spécifiez le SCIM connector base URL et le nom du champ de l’identifiant unique de vos utilisateurs mentionné ci-dessus.
- Sous Supported provisioning actions, choisissez les actions de provisionnement mentionnées ci-dessus.
- Définissez le menu déroulant Authentication Mode sur la valeur mentionnée ci-dessus.
- Définissez le Access token endpoint, l’Authorization endpoint, le Client id et le Client secret comme mentionné ci-dessus.
- Cliquez sur Save.
- Cliquez sur Authenticate application.
- Dans l’onglet Provisioning, cliquez sur To App.
- Cliquez sur Edit, activez
Create Users,Update User Attributes,Deactivate Userset enregistrez les modifications (assurez-vous que ces options sont bien sélectionnées après avoir appuyé sur enregistrer ; sinon, actualisez la page et recommencez cette étape).
- Avant de commencer l’étape suivante, nous recommandons de créer de nouveaux groupes dans Okta, appelés
OpenReplay-adminoù vous listez les utilisateurs disposant du privilège d’administrateur dans OpenReplay, etOpenReplay-membersoù vous listez les utilisateurs ayant le rôlememberdans OpenReplay, …
- Accédez à l’onglet Push Groups, cliquez sur + Push Groups (par nom ou par règle), sélectionnez le groupe que vous souhaitez envoyer à OpenReplay, puis appuyez sur save
- À ce stade, les groupes envoyés représentent les rôles et le privilège d’administrateur dans OpenReplay, et ils ne comportent pas la liste des utilisateurs provisionnés pour OpenReplay.
- Accédez à l’onglet Assignmets et ajoutez des utilisateurs de la manière qui vous convient (en utilisant des personnes ou des groupes)
Erreurs
Section titled ErreursLa réponse a été reçue en http au lieu de https
Section titled La réponse a été reçue en http au lieu de httpsCeci est très courant et est dû à l’absence de l’en-tête ‘X-Forwarded-Proto’ dans la requête. Pour résoudre ce problème, assurez-vous que l’équilibreur de charge transmet correctement l’en-tête au backend OpenReplay, et exécutez openreplay -e ; dans la section ingress-nginx > config, décommentez la ligne use-forwarded-headers: true.