Configurer les fournisseurs de connexion
Les personnes se connectent à Excubius avec le compte de leur organisation, depuis Microsoft Entra ID ou Google. Excubius ne stocke jamais de mot de passe d'annuaire : il reçoit un jeton signé du fournisseur, le vérifie, puis enregistre le compte sous la forme du fournisseur et de l'identifiant de la personne chez ce fournisseur, jamais sous la seule forme d'une adresse e-mail. Ce guide explique comment inscrire Excubius auprès de chaque fournisseur et comment décider qui obtient un compte.
Avant de commencer
- Connaissez l'adresse publique du serveur,
https://<primary name>. Toutes les adresses de redirection ci-dessous commencent par celle-ci. Les personnes qui ouvrent Excubius par un alias sont redirigées vers le nom principal pour se connecter ; une seule adresse de redirection par fournisseur suffit donc. Consultez Configurer les noms et TLS. - Utilisez HTTPS. Microsoft Entra ID n'accepte
httpque pourlocalhost. - Vous devez avoir accès au fichier de configuration du serveur,
/opt/excubius/.env, ou au programme d'installation :sudo ./install.sh --reconfiguredemande de nouveau les valeurs Entra ID. - Pour activer ou désactiver la connexion avec Google, vous devez disposer du rôle Super admin. Pour choisir qui obtient un compte sur une entité, vous devez disposer du rôle Entity admin sur celle-ci.
Comment une première connexion est décidée
Les rôles ne sont attribués qu'à la création du compte ou à l'acceptation d'une invitation. Un compte existant se connecte avec les rôles qu'il possède ; un rôle retiré par un administrateur n'est donc pas réattribué à la connexion suivante.
Inscrire Excubius dans Microsoft Entra ID
La connexion avec Microsoft Entra ID fait partie des plans Core, Pro et Enterprise.
Créez une inscription d'application par installation, pour un seul locataire. Les inscriptions multilocataires (common ou organizations) ne sont pas prises en charge.
- Dans le Microsoft Entra admin center, ouvrez App registrations et sélectionnez New registration.
- Name : ce que les personnes verront dans la demande de consentement, par exemple le nom sous lequel elles connaissent la surveillance.
- Supported account types : Accounts in this organizational directory only (single tenant).
- Redirect URI : plateforme Web,
https://<primary name>/api/v1/auth/entra/callback.
- Dans Overview, copiez le Directory (tenant) ID et l'Application (client) ID.
- Sous Certificates & secrets › Client secrets, sélectionnez New client secret et copiez sa Value, pas son ID. Elle n'est affichée qu'une seule fois. Notez la date d'expiration : la connexion cesse de fonctionner lorsque le secret expire ; créez donc le suivant avant cette date et remplacez la valeur.
- Sous Authentication, laissez désactivés Access tokens et ID tokens pour les flux implicites et hybrides, et laissez Front-channel logout URL vide. Excubius utilise le flux de code d'autorisation avec PKCE.
- Sous API permissions, conservez les autorisations déléguées Microsoft Graph
openid,profileetemail.User.Read, ajoutée par défaut, ne pose aucun problème. Accordez le consentement administrateur si votre locataire ne permet pas aux utilisateurs de donner leur consentement eux-mêmes. - Sous Token configuration, sélectionnez Add optional claim, type de jeton ID, revendication
email, et acceptez l'invite qui ajoute l'autorisation Graphemail. Sans elle, Excubius utilisepreferred_username, ce qui convient lorsque les noms d'utilisateur principaux sont des adresses e-mail. - Si vous souhaitez attribuer des rôles à des groupes de l'annuaire, sélectionnez Add groups claim sous Token configuration :
- Choisissez Groups assigned to the application, puis attribuez les groupes sous Enterprise applications › votre application › Users and groups. Les jetons restent ainsi légers et ne transportent que les groupes que vous mappez. Security groups fonctionne aussi.
- Pour le jeton ID, choisissez Group ID. Excubius compare les ID d'objet des groupes ; les noms ne correspondent pas.
- Un jeton transporte au maximum 200 groupes. Au-delà, Entra ID n'envoie aucun groupe, et Excubius considère que la personne n'appartient à aucun groupe de l'annuaire.
- Si vous le souhaitez, sous Enterprise applications › votre application › Properties, définissez Assignment required ? sur Yes. Seuls les utilisateurs et les groupes attribués à l'application peuvent alors se connecter, avant même qu'Excubius applique ses propres règles.
Transmettez ensuite les valeurs à Excubius :
-
Connectez-vous au serveur, prenez l'identité du compte de service avec
sudo -iu excubiuset ajoutez les trois valeurs à/opt/excubius/.env:ENTRA_TENANT_ID=8f6a1c2e-4b3d-4e5f-9a8b-7c6d5e4f3a2bENTRA_CLIENT_ID=11111111-2222-3333-4444-555555555555ENTRA_CLIENT_SECRET=<the secret value> -
Redémarrez la plateforme :
export XDG_RUNTIME_DIR=/run/user/$(id -u)systemctl --user restart excubius.service
La page de connexion affiche Sign in with Microsoft dès que les trois valeurs sont définies. Le secret client n'est lu que depuis le fichier de configuration : il n'est jamais écrit dans la base de données, jamais renvoyé par l'API et jamais journalisé.
Inscrire Excubius auprès de Google
- Dans la Google Cloud console, ouvrez Google Auth Platform.
- Audience : Internal lorsque tout le monde dispose d'un compte Google Workspace de votre organisation ; External dans le cas contraire. Publiez l'application, ou ajoutez des utilisateurs de test pendant vos essais.
- Data access : les étendues
openid,.../auth/userinfo.emailet.../auth/userinfo.profile.
- Sous Clients, sélectionnez Create client, type Web application, et ajoutez l'URI de redirection autorisé
https://<primary name>/api/v1/auth/google/callback. Les origines JavaScript ne sont pas nécessaires. - Copiez le Client ID et le Client secret dans
/opt/excubius/.envsous les nomsGOOGLE_CLIENT_IDetGOOGLE_CLIENT_SECRET, puis redémarrez la plateforme comme dans les étapes Entra ID. - Vérifiez que la fonctionnalité
access.google_loginest activée dans Settings › Instance. Elle est activée par défaut.
La page de connexion affiche Sign in with Google. Tant que access.google_login est désactivée, la connexion avec Google est refusée, et pas seulement masquée.
N'importe qui peut créer un compte Google personnel avec n'importe quelle adresse e-mail sur laquelle il reçoit du courrier. Une connexion avec Google ne compte donc pour un domaine autorisé que lorsque Google fait autorité pour l'adresse : un compte Google Workspace de ce domaine précis, avec une adresse vérifiée. Les comptes Google personnels nécessitent toujours une invitation, et pour une invitation, Google doit indiquer que l'adresse est vérifiée.
Choisir qui obtient un compte
Chaque entité possède un mode d'inscription qui s'applique à elle et à tout ce qui se trouve en dessous, jusqu'à ce qu'une entité inférieure définisse le sien.
| Mode | Première connexion sans invitation | Rôle attribué |
|---|---|---|
| By invitation (par défaut) | Refusée | — |
| Allowed domains | Acceptée lorsque le domaine de l'adresse e-mail figure dans la liste. La correspondance est exacte ; les sous-domaines ne comptent pas | Le Default role (Viewer sauf si vous en choisissez un autre ; jamais Super admin) sur l'entité qui définit l'inscription, hérité en dessous comme n'importe quel rôle |
Pour le définir :
- Ouvrez Settings › Users and roles et choisissez l'entité dans le sélecteur, par exemple Combray SA.
- Sélectionnez l'onglet Registration. La page indique d'où provient le paramètre actuel : de cette entité, d'une entité supérieure ou de l'installation.
- Choisissez By invitation ou Allowed domains.
- Pour Allowed domains, saisissez les Domains, séparés par des virgules ou des espaces (50 au maximum), par exemple
ciguapa.example, et choisissez le Default role. - Sélectionnez Save.
Pour qu'une entité inférieure suive de nouveau son parent, sélectionnez Inherit from above again.
- Une personne dont le domaine est autorisé sur plusieurs entités reçoit le rôle par défaut de chacune d'elles.
- Sur l'entité racine, le paramètre
ALLOWED_SIGNUP_DOMAINSde l'installation s'applique tant qu'aucune inscription n'y est enregistrée. Il équivaut à Allowed domains avec ces domaines et le rôle Viewer sur la racine. L'enregistrement de l'inscription de la racine, même en By invitation, le remplace. - Une entité définie sur By invitation cesse elle-même d'attribuer des rôles par domaine, mais elle ne peut pas retirer un rôle hérité de l'inscription d'une entité ancêtre.
- Pour bloquer l'accès de quelqu'un, désactivez la personne. La suppression du domaine n'affecte pas les comptes existants. Consultez Gérer les utilisateurs et les rôles.
Invitations et connexion
Une invitation est un lien, https://<primary name>/invite/<token>, qu'un administrateur d'entité crée pour une adresse e-mail, un rôle et une entité ; consultez Inviter une personne. Lorsque la personne l'ouvre :
- La page affiche l'entité, le rôle, l'auteur de l'invitation et une adresse masquée, puis les boutons de connexion. Le fournisseur est invité à présélectionner l'adresse invitée.
- L'adresse du compte avec lequel la personne se connecte doit être l'adresse invitée, comparée sans tenir compte de la casse.
- Le compte est créé, ou un compte existant du même fournisseur est associé, et le rôle est attribué sur l'entité de l'invitation. Un rôle inférieur déjà présent sur cette entité est relevé ; un rôle supérieur est conservé.
- Ouvrir de nouveau le lien plus tard connecte simplement cette personne.
Lorsque la connexion est refusée
Le navigateur revient à la page de connexion avec une explication en clair, et chaque refus est consigné dans le journal d'audit sous la forme login.failed avec son motif.
| Code | Signification | Que faire |
|---|---|---|
not_invited | Aucune invitation, et aucune entité n'accepte l'inscription par domaine ; ou le lien d'invitation est inconnu | Invitez la personne ou autorisez son domaine |
domain_not_allowed | L'inscription par domaine existe, mais pas pour ce domaine, ou le fournisseur ne fait pas autorité pour celui-ci, comme avec un compte Google personnel | Ajoutez le domaine ou invitez la personne |
account_disabled | Le compte existe et il est désactivé | Activez-le dans Users and roles |
email_mismatch | L'adresse du compte n'est pas l'adresse invitée, ou Google ne l'a pas vérifiée | Connectez-vous avec le compte invité ou invitez la bonne adresse |
invite_expired | L'invitation a expiré, ou quelqu'un d'autre l'a déjà utilisée | Envoyez une nouvelle invitation |
invalid_state | La connexion a pris plus de 10 minutes, a été lancée dans un autre navigateur ou onglet, ou la réponse ne correspondait pas à la demande | Recommencez depuis la page de connexion |
provider_error | Le fournisseur a refusé (consentement refusé ou annulé), n'est pas configuré ou est désactivé, ou sa réponse n'a pas passé la validation | Vérifiez les paramètres du fournisseur ci-dessus et l'entrée auth.login_refused du journal du back-end |
La déconnexion d'Excubius ne déconnecte pas la personne de Microsoft ni de Google.