moduleauthapi v1.0.7

Module Auth API

Ce module npm fournit une solution pratique pour sécuriser les routes de votre API associée. Il permet de récupérer les informations de l'utilisateur à partir du jeton JWT présent dans l'en-tête de la requête, puis les compare aux exigences de la route spécifiée. Si les informations de l'utilisateur satisfont aux critères requis, le module renvoie ces informations, ce qui permet de poursuivre le traitement associé à la route de l'API.

En utilisant ce module, vous pouvez facilement intégrer une protection des routes de votre API en vous basant sur les autorisations définies pour chaque utilisateur. Il garantit que seuls les utilisateurs disposant des autorisations appropriées peuvent accéder aux ressources spécifiques des routes protégées.

Ce module offre une solution pratique et sécurisée pour la gestion des autorisations et contribue ainsi à renforcer la sécurité de votre application en s'assurant que seules les requêtes autorisées sont traitées

Pour faire cela, il expose la methode :

• authenticateJWT(authorizedRoles: string[]): elle permet de sécuriser les routes de votre API en vérifiant les autorisations de l'utilisateur. Elle prend un argument authorizedRoles qui est un tableau de chaînes de caractères représentant les autorisations requises pour accéder à la route

Configuration

Pour que le module fonctionne correctement, vous devez configurer les variables d'environnement suivantes :

• authApi : L'URL de l'API d'authentification native/custom. Cette URL est utilisée pour récupérer les informations de l'utilisateur dans la base de données en utilisant le jeton JWT. Cette variable est obligatoire.
• azureGatewayApi : L'URL de l'API Azure Gateway qui permet d'interagir avec les outils de Microsoft. Cette URL est utilisée pour récupérer les informations de l'utilisateur qui se connecte à l'aide de son compte Microsoft. Cette variable est obligatoire.
• azureAppId : L'ID de l'application Azure qui permet de se connecter à Azure. Cet ID est utilisé pour identifier la provenance du jeton JWT. Cette variable est obligatoire.

Assurez-vous de fournir les valeurs correctes pour ces variables d'environnement avant d'utiliser le module.

Installation

Pour installer le module de auth API, utilisez npm en exécutant la commande suivante :

npm install moduleauthapi

Utilisation

Voici un exemple simple d'utilisation du module Auth API dans une application Express.js :

const express = require('express');
const ModuleAuthAPI = require('moduleauthapi');

// Création de l'application Express
const app = express();


// Définition des routes protégées
app.get('/api/protected', ModuleAuthAPI.authenticateJWT(['ROLE_ADMIN']), (req, res) => {
  // Le module a vérifié les autorisations de l'utilisateur
  // Effectuez ici le traitement associé à la route protégée
  res.send('Route protégée');
});

// Démarrage du serveur
app.listen(3000, () => {
  console.log('Serveur démarré sur le port 3000');
});

Dans cet exemple, le module ModuleAuthAPI est utilisé comme middleware pour sécuriser les routes de l'API. La méthode authenticateJWT est utilisée pour spécifier les autorisations requises pour chaque route. Elle prend un tableau d'autorisations en argument, par exemple 'ROLE_ADMIN' ou 'ROLE_USER'. Si l'utilisateur ne possède pas les autorisations nécessaires, une réponse d'erreur est renvoyée.

Support

Nous espérons que le module Auth API sera utile pour securiser les routes de votre API associée. Si vous avez des questions ou des commentaires, n'hésitez pas à nous contacter à s.cao@m-energies.fr

Note Assure-toi de remplacer les valeurs authApi, azureGatewayApi, azureAppId