Configuration d'un backend personnalisé

Configurez un écran de connexion personnalisé pour les visiteurs de vos docs

Ce guide vous explique comment configurer un écran de connexion protégé pour vos docs. Avant de suivre ce guide, assurez-vous d'abord d'avoir effectué le processus de activation de l'accès authentifié.

Ce guide vous guide pour configurer un écran de connexion protégé pour votre site de documentation GitBook en utilisant votre propre personnalisé backend d'authentification.

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

Aperçu

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

Mettez en œuvre un backend qui invite les utilisateurs à se connecter et les authentifie.

2

Signez et transmettez un token JWT à GitBook

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

3

Configurez une URL de secours

Configurez une URL à utiliser lorsqu'un visiteur non authentifié accède à votre site.

4

Configurez un accès authentifié multitenant (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 puissent visiter 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 informations d'identification des utilisateurs et les authentifier.

• Générer et signer un JSON Web Token (JWT) lors d'une authentification réussie.

• Rediriger les utilisateurs vers GitBook avec le JWT inclus dans l'URL.

2. Signez et transmettez un token JWT à GitBook

Une fois que votre backend authentifie un utilisateur, il doit générer un JWT et le transmettre à GitBook lors de leur redirection vers votre site. Le token doit être signé en utilisant la clé privée fourni dans les paramètres d'audience de votre site après activation de l'accès authentifié.

L'exemple suivant devrait montrer à quoi pourrait ressembler un gestionnaire de requête 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érification des identifiants et authentification de l'utilisateur
    //
    // 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 token JWT dans l'URL
    const redirectURL = `${GITBOOK_DOCS_URL}/?jwt_token=${gitbookVisitorJWT}`;
    res.redirect(redirectURL);
}

3. Configurez une URL de secours

L'URL de secours 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 leur demander de se connecter, les authentifier puis les 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 secours.

Vous pouvez configurer cette URL de secours dans les paramètres d'audience de votre site sous l'onglet "Accès authentifié".

Configurez une URL de secours

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

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 des docs GitBook avec le JWT inclus en tant que paramètre de requête jwt_token
// Si une location est fournie, 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 paramètre de paramètre de recherche - vous ne pouvez pas l'utiliser dans votre URL de secours. Par exemple, https://auth.gitbook.com/?location=something n'est pas une URL de secours valide.

4. Configurez un accès authentifié multitenant (facultatif)

Si vous utilisez GitBook comme plateforme pour fournir du contenu à vos différents clients, vous aurez probablement besoin de configurer un accès authentifié multitenant. 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 locataires à 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 que votre code d'authentification stocke une telle correspondance :

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'
};

Fournir 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 secours. Cette URL pointe vers votre backend d'authentification, qui est responsable d'authentifier l'utilisateur et de le rediriger vers le contenu demandé.

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

Ainsi, par exemple, vous pourriez configurer les URL de secours pour chaque site comme suit :

Site GitBook	URL de secours
Site du client A	https://auth-backend.acme.org/login?site=customer-a
Site du client B	https://auth-backend.acme.org/login?site=customer-b

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 des docs GitBook avec le JWT inclus en tant que paramètre de requête jwt_token
// Si une location est fournie, 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 d'utilisateur supplémentaires (claims) dans la charge utile du JWT que votre backend personnalisé génère et inclut 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 résumer, l'exemple de code suivant montre comment vous pourriez inclure ces claims dans le JWT, lesquels peuvent ensuite être utilisés par GitBook pour adapter le contenu pour 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érification des identifiants et authentification de l'utilisateur
    //
    // 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 la 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 utilisateur en tant que 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 token 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 continuer à configurer votre site.