Configuration d’un backend personnalisé

Configurez un écran de connexion personnalisé pour les visiteurs de votre documentation

Ce guide vous accompagne dans la configuration d’un écran de connexion protégé pour vos docs. Avant de suivre ce guide, assurez-vous d’avoir d’abord suivi le processus de l’activation de l’accès authentifié.

Ce guide vous accompagne dans la configuration d’un écran de connexion protégé pour votre site de documentation GitBook à l’aide de votre propre personnalisé backend d’authentification.

Si vous utilisez l’un des fournisseurs d’authentification que nous prenons en charge ou si vous avez un OpenID Connect (OIDC) compatible, consultez nos guides d’intégration pour une configuration plus simple : Auth0 | Azure AD | Okta | AWS Cognito | OIDC

Vue d’ensemble

Pour configurer un système d’authentification personnalisé pour votre site GitBook, suivez ces étapes clés :

1

Créez un backend personnalisé pour authentifier vos utilisateurs

Implémentez un backend qui invite les utilisateurs à se connecter et les authentifie.

2

Signez et transmettez un JWT à GitBook

Créez un jeton JWT et signez-le avec la clé privée de votre site.

3

Configurez une URL de connexion

Configurez une URL qui sera utilisée lorsqu’un visiteur non authentifié accède à votre site.

4

Configurez un accès authentifié multi-tenant (facultatif)

Configurez votre backend pour gérer l’authentification sur plusieurs sites GitBook.

5

Configurez votre backend pour le contenu adaptatif (facultatif)

Configurez votre backend pour fonctionner avec le contenu adaptatif dans GitBook.

1. Créez un backend personnalisé pour authentifier vos utilisateurs

Afin de commencer à authentifier les utilisateurs avant qu’ils ne puissent consulter votre documentation, vous devrez mettre en place un serveur capable de gérer la connexion et l’authentification des utilisateurs.

Votre backend doit :

• Inviter les utilisateurs à se connecter en utilisant votre méthode d’authentification préférée.
• Valider les identifiants des utilisateurs et les authentifier.
• Générer et signer un jeton Web JSON (JWT) une fois l’authentification réussie.
• Rediriger les utilisateurs vers GitBook avec le JWT inclus dans l’URL.

2. Signez et transmettez un jeton JWT à GitBook

Une fois que votre backend a authentifié un utilisateur, il doit générer un JWT et le transmettre à GitBook lorsqu’il les redirige vers votre site. Le jeton doit être signé à l’aide de la clé privée fournie dans les paramètres d’audience de votre site après l’activation de l’accès authentifié.

L’exemple suivant devrait montrer à quoi pourrait ressembler un gestionnaire de requêtes de connexion dans votre backend personnalisé :

index.ts

import { Request, Response } from 'express';
import * as jose from 'jose';

import { getUserInfo } from '../services/user-info-service';
import { getFeatureFlags } from '../services/feature-flags-service';

const GITBOOK_VISITOR_SIGNING_KEY = process.env.GITBOOK_VISITOR_SIGNING_KEY!;
const GITBOOK_DOCS_URL = 'https://mycompany.gitbook.io/myspace';

export async function handleAppLoginRequest(req: Request, res: Response) {
    // Votre logique métier pour traiter la requête de connexion
    // Par exemple, vérifier les identifiants et authentifier l’utilisateur
    //
    // par ex. :
    // const loggedInUser = await authenticateUser(req.body.username, req.body.password);
    
    // Générer un JWT signé
    const gitbookVisitorJWT = await new jose.SignJWT({})
        .setProtectedHeader({ alg: 'HS256' })
        .setIssuedAt()
        .setExpirationTime('2h') // Expiration arbitraire de 2 heures
        .sign(new TextEncoder().encode(GITBOOK_VISITOR_SIGNING_KEY));
    
    // Rediriger l’utilisateur vers GitBook avec le jeton JWT dans l’URL
    const redirectURL = `${GITBOOK_DOCS_URL}/?jwt_token=${gitbookVisitorJWT}`;
    res.redirect(redirectURL);
}

Déconnexion des visiteurs de leur session GitBook

Pour déconnecter un visiteur de sa session GitBook, redirigez-le vers l’URL de votre site avec ~gitbook/auth/logout ajouté :

https://mycompany.gitbook.io/myspace/~gitbook/auth/logout

Ce point de terminaison ne déconnecte le visiteur que de GitBook. Si vous souhaitez également le déconnecter de votre propre fournisseur d’identité, gérez cela séparément dans votre propre flux de déconnexion.

3. Configurez une URL de connexion

L’URL de connexion est utilisée lorsqu’un visiteur non authentifié tente d’accéder à votre site protégé. GitBook le redirigera alors vers cette URL.

Cette URL doit pointer vers un gestionnaire dans votre backend personnalisé, où vous pouvez lui demander de se connecter, l’authentifier, puis le rediriger vers votre site avec le JWT inclus dans l’URL.

Par exemple, si votre écran de connexion se trouve à https://example.com/login, vous devez inclure cette valeur comme URL de connexion.

Vous pouvez configurer cette URL de connexion dans les paramètres d’audience de votre site, sous l’onglet « Accès authentifié ».

Configurez une URL de connexion

Utilisez le point de terminaison de connexion de GitBook

Si vous souhaitez un lien de connexion sur votre site publié, créez un lien vers <publishedSiteURL>/~gitbook/auth/login.

Ce point de terminaison redirige le visiteur vers le backend d’authentification configuré pour le site. Il ajoute également un location paramètre de requête qui correspond à la page à partir de laquelle il a commencé.

C’est utile pour les liens d’en-tête et autres points d’entrée où vous souhaitez renvoyer les visiteurs vers la même page après la connexion.

Lors de la redirection vers l’URL de connexion, GitBook inclut un location paramètre de requête à l’URL de connexion que vous pouvez exploiter dans votre gestionnaire pour rediriger l’utilisateur vers l’emplacement d’origine de l’utilisateur :

const gitbookVisitorJWT = await new jose.SignJWT({})
    .setProtectedHeader({ alg: 'HS256' })
    .setIssuedAt()
    .setExpirationTime('2h') // Expiration arbitraire de 2 heures
    .sign(new TextEncoder().encode(GITBOOK_VISITOR_SIGNING_KEY));
    
// Rediriger vers l’URL d’origine de la documentation GitBook avec le JWT inclus comme paramètre de requête jwt_token
// Si un emplacement est fourni, l’utilisateur sera redirigé vers sa destination d’origine
const redirectURL = `${GITBOOK_DOCS_URL}/${req.query.location || ''}?jwt_token=${gitbookVisitorJWT}`;
res.redirect(redirectURL);

Parce que GitBook s’appuie sur le location paramètre de requête - vous ne pouvez pas l’utiliser dans votre URL de connexion. Par exemple, https://auth.gitbook.com/?location=something n’est pas une URL de connexion valide.

Utilisez le point de terminaison de déconnexion de GitBook

Si vous souhaitez un lien de déconnexion sur votre site publié, créez un lien vers <publishedSiteURL>/~gitbook/auth/logout.

Ce point de terminaison déconnecte le visiteur de sa session GitBook.

4. Configurez un accès authentifié multi-tenant (facultatif)

Si vous utilisez GitBook comme plateforme pour fournir du contenu à vos différents clients, vous devez probablement configurer un accès authentifié multi-tenant. Votre backend d’authentification doit être responsable de la gestion de l’authentification sur plusieurs sites différents. C’est possible dans GitBook avec quelques petits ajustements dans le code de votre backend d’authentification personnalisé.

Ajouter tous les tenants à votre serveur d’authentification

Votre backend d’authentification devra connaître les clés de signature JWT et les URL de tous les sites GitBook qu’il est censé gérer. Si vous avez deux sites dans votre organisation pour le client A et le client B, vous pouvez imaginer votre code d’authentification stockant un tel mappage :

const CUSTOMER_A = {
  jwtSigningKey: 'aaa-aaa-aaa-aaa',
  url: 'https://mycompany.gitbook.io/customer-a'
};

const CUSTOMER_B = {
  jwtSigningKey: 'bbb-bbb-bbb-bbb',
  url: 'https://mycompany.gitbook.io/customer-b'
};

Donner un contexte supplémentaire à votre serveur d’authentification

Lorsque GitBook n’est pas en mesure d’authentifier la requête d’un utilisateur, il le redirige vers l’URL de connexion. Cette URL pointe vers votre backend d’authentification, qui est chargé d’authentifier l’utilisateur et de le rediriger vers le contenu demandé.

Pour prendre en charge plusieurs tenants, votre backend d’authentification doit savoir à quel site GitBook l’utilisateur est censé accéder. Cette information peut être transmise dans l’URL de connexion.

Par exemple, vous pourriez configurer les URL de connexion de chaque site comme suit :

Votre backend d’authentification peut alors vérifier cette information et gérer la redirection vers le bon site en conséquence :

const customerInfo = req.query.site === 'customer-a' ? CUSTOMER_A : CUSTOMER_B;
  
const gitbookVisitorJWT = await new jose.SignJWT({})
    .setProtectedHeader({ alg: 'HS256' })
    .setIssuedAt()
    .setExpirationTime('2h') // Expiration arbitraire de 2 heures
    .sign(new TextEncoder().encode(customerInfo.jwtSigningKey));
    
// Rediriger vers l’URL d’origine de la documentation GitBook avec le JWT inclus comme paramètre de requête jwt_token
// Si un emplacement est fourni, l’utilisateur sera redirigé vers sa destination d’origine
const redirectURL = `${customerInfo.url}/${req.query.location || ''}?jwt_token=${gitbookVisitorJWT}`;
res.redirect(redirectURL);

5. Configurez votre backend pour le contenu adaptatif (facultatif)

Pour tirer parti de la fonctionnalité de contenu adaptatif dans votre configuration d’accès authentifié, vous pouvez inclure des attributs utilisateur supplémentaires (claims) dans la charge utile du JWT que votre backend personnalisé génère, puis les inclure dans l’URL lors de la redirection de l’utilisateur vers le site.

Ces claims, lorsqu’ils sont inclus dans le JWT, sont utilisés par GitBook pour adapter le contenu dynamiquement pour les visiteurs de votre site.

Pour tout assembler, l’exemple de code suivant montre comment vous pourriez inclure ces claims dans le JWT, qui pourra ensuite être utilisé par GitBook pour adapter le contenu à vos visiteurs :

index.ts

import { Request, Response } from 'express';
import * as jose from 'jose';

import { getUserInfo } from '../services/user-info-service';
import { getFeatureFlags } from '../services/feature-flags-service';

const GITBOOK_VISITOR_SIGNING_KEY = process.env.GITBOOK_VISITOR_SIGNING_KEY!;
const GITBOOK_DOCS_URL = 'https://mycompany.gitbook.io/myspace';

export async function handleAppLoginRequest(req: Request, res: Response) {
    // Votre logique métier pour traiter la requête de connexion
    // Par exemple, vérifier les identifiants et authentifier l’utilisateur
    //
    // par ex. :
    // const loggedInUser = await authenticateUser(req.body.username, req.body.password);
    
    // Pour les besoins de cet exemple, supposons un objet utilisateur connecté
    const loggedInUser = { id: '12345' }; // Remplacez par une logique d’authentification réelle

    // Récupérer les informations utilisateur à transmettre à GitBook
    const userInfo = await getUserInfo(loggedInUser.id);
    
    // Générer un JWT signé et inclure les attributs de l’utilisateur comme claims
    const gitbookVisitorClaims = {
        firstName: userInfo.firstName,
        lastName: userInfo.lastName,
        isBetaUser: userInfo.isBetaUser,
        products: userInfo.products.map((product) => product.name),
        featureFlags: await getFeatureFlags({ userId: loggedInUser.id })
    };
    
    const gitbookVisitorJWT = await new jose.SignJWT(gitbookVisitorClaims)
        .setProtectedHeader({ alg: 'HS256' })
        .setIssuedAt()
        .setExpirationTime('2h') // Expiration arbitraire de 2 heures
        .sign(new TextEncoder().encode(GITBOOK_VISITOR_SIGNING_KEY));
    
    // Rediriger l’utilisateur vers GitBook avec le jeton JWT dans l’URL
    const redirectURL = `${GITBOOK_DOCS_URL}/?jwt_token=${gitbookVisitorJWT}`;
    res.redirect(redirectURL);
}

Après avoir configuré et défini les bons claims à envoyer à GitBook, rendez-vous dans «Adapter votre contenu» pour poursuivre la configuration de votre site.