Identité signée

Shayan TaslimMis à jour

Un appel uj.identify classique provient du navigateur : n’importe qui peut donc le modifier. L’identité signée empêche l’usurpation : votre serveur signe un JWT HS256 à courte durée de validité qui prouve l’identité de l’utilisateur, puis le widget transmet ce jeton à UserJot.

Tout ce qui figure dans le jeton (ID utilisateur, adresse e-mail, nom, avatar, attributs et entreprises) est considéré comme vérifié.

Quand en avez-vous besoin ?

  • Vous voulez vérifier que les commentaires, les votes et les conversations proviennent bien du compte connecté.

  • Vous souhaitez permettre aux clients de modifier et supprimer leurs propres publications de feedback et leurs commentaires dans le widget (les sessions non signées uj.identify ne peuvent pas modifier ni supprimer de contenu dans le widget).

  • Vous avez activé Exiger des jetons signés dans Paramètres → Connexion (disponible avec les forfaits Starter et Professional une fois la Connexion automatique activée). Cette option rejette les appels identify non signés et exige également que les appartenances à des entreprises soient incluses dans le jeton signé (les companies côté client non signés sont ignorés et un avertissement UNSIGNED_COMPANY_IGNORED s’affiche).

  • Un administrateur ou propriétaire de l’espace de travail utilise le widget. Les comptes privilégiés ne sont jamais acceptés sans identification signée. Un jeton signé applique ses attributs et ses entreprises ; son nom, son avatar et son adresse e-mail restent gérés dans le tableau de bord et déclenchent un avertissement PRIVILEGED_PROFILE_IGNORED s’ils sont transmis.

Note

Si votre produit utilise à la fois le widget Web et le Swift SDK, l’activation de Exiger des jetons signés impose la vérification sur les deux. Le widget Web utilise un JWT HS256 (token), tandis que le Swift SDK utilise un signature HMAC-SHA256 signé avec le même secret d’espace de travail.

1. Créer le jeton sur votre serveur

Signez un JWT avec HS256 à l’aide du secret de votre espace de travail. Vous trouverez l’ID du projet et le Secret du projet dans Paramètres → Connexion, sous Secrets.

Ne signez jamais de jetons dans le navigateur. Conservez le secret sur votre serveur.

Réclamations obligatoires

Revendication

Valeur

sub

L’ID stable de l’utilisateur dans votre système. Obligatoire.

iss

L’ID de votre projet UserJot. Obligatoire.

aud

La chaîne exacte userjot. Obligatoire.

iat

Horodatage d’émission au format Unix, en secondes. Obligatoire.

exp

Horodatage d’expiration au format Unix, en secondes. Obligatoire. Maximum d’une heure (3600 secondes) après iat.

Réclamations facultatives vérifiées

Vous pouvez également inclure email, firstName, lastName, avatar, traits et companies. Chaque entrée de companies prend en charge les éléments suivants :

JSON
{
  "companies": [
    {
      "id": "acme",
      "name": "ACME Inc.",
      "domain": "acme.com",
      "logo": "https://acme.com/logo.png",
      "traits": { "plan": "enterprise" }
    }
  ]
}

Exemples côté serveur

Node.js

JavaScript
import jwt from 'jsonwebtoken';

export function createUserJotToken(user, secret, projectId) {
  return jwt.sign(
    {
      sub: user.id,
      email: user.email,
      firstName: user.firstName,
      lastName: user.lastName,
      iss: projectId,
      aud: 'userjot'
    },
    secret,
    { algorithm: 'HS256', expiresIn: '1h' }
  );
}

Python

Python
import time
import jwt

def create_userjot_token(user, secret, project_id):
    now = int(time.time())
    return jwt.encode(
        {
            "sub": user["id"],
            "email": user["email"],
            "firstName": user["first_name"],
            "lastName": user["last_name"],
            "iss": project_id,
            "aud": "userjot",
            "iat": now,
            "exp": now + 3600,
        },
        secret,
        algorithm="HS256",
    )

PHP

PHP
<?php

use Firebase\JWT\JWT;

function createUserJotToken(array $user, string $secret, string $projectId): string
{
    $now = time();

    return JWT::encode([
        'sub' => $user['id'],
        'email' => $user['email'],
        'firstName' => $user['firstName'],
        'lastName' => $user['lastName'],
        'iss' => $projectId,
        'aud' => 'userjot',
        'iat' => $now,
        'exp' => $now + 3600,
    ], $secret, 'HS256');
}

Ruby

Ruby
require 'jwt'

def create_userjot_token(user, secret, project_id)
  now = Time.now.to_i

  payload = {
    sub: user[:id],
    email: user[:email],
    firstName: user[:first_name],
    lastName: user[:last_name],
    iss: project_id,
    aud: 'userjot',
    iat: now,
    exp: now + 3600
  }

  JWT.encode(payload, secret, 'HS256')
end

Émettez un nouveau jeton à chaque chargement de page ou depuis un point de terminaison de backend authentifié. Comme les jetons expirent au bout d’une heure maximum, ne les mettez pas en cache au-delà de cette durée.

2. Transmettre le jeton pour identifier l’utilisateur

Transmettez le JWT dans le champ token :

JavaScript
uj.identify({
  token: 'TOKEN_FROM_YOUR_SERVER'
});

Vous pouvez également transmettre user et companies avec token pour ajouter des champs non vérifiés. Si un champ apparaît dans les deux, le jeton signé prévaut (sauf si Exiger des jetons signés est activé, auquel cas les entreprises non signées sont ignorées). Vérifiez que la vérification a réussi à l’aide de la promesse renvoyée :

JavaScript
const result = await uj.identify({ token });
result.identityTrust; // 'signed'

Les jetons invalides échouent au lieu de déclencher un repli

Si un jeton a expiré, est mal formé ou a été signé avec le mauvais secret, uj.identify est rejeté avec IDENTIFY_FAILED, au lieu de revenir silencieusement à une session non signée.

Identité signée et conversations

  • Si un visiteur anonyme commence une conversation en tant qu’invité, puis s’identifie à l’aide d’un jeton signé, sa conversation en tant qu’invité est transférée vers son compte membre vérifié.

  • Les conversations commencées avec une identité signée restent protégées. Si le visiteur les rouvre sans session signée, il doit vérifier son identité avant de consulter l’historique.

  • L’activation de Exiger des jetons signés permet toujours aux visiteurs anonymes de commencer des conversations en tant qu’invités, limitées au navigateur ; elle empêche uniquement les appels identify non signés d’associer ces visiteurs à des comptes membres.

L’identité est conservée sur vos pages publiques

Une fois l’utilisateur identifié, le widget transmet automatiquement la session aux liens vers vos pages UserJot publiques (tableau, feuille de route, journal des modifications ou centre d’aide). Pour que les visiteurs accèdent à ces pages en étant déjà connectés, activez la Connexion automatique dans Paramètres → Connexion (forfait Starter ou Professional). Consultez la page Connexion automatique.

Dépannage

L’appel identify est rejeté avec IDENTIFY_FAILED

  • Vérifiez que le jeton est signé avec HS256 et votre Secret du projet actuel.

  • Vérifiez que iss correspond à votre ID du projet et que aud est exactement égal à userjot.

  • Vérifiez que iat et exp sont tous deux présents, exprimés en secondes Unix, et que exp - iat <= 3600 est valide.

  • Vérifiez que l’horloge de votre serveur est exacte (les jetons émis dans le futur sont rejetés si l’écart dépasse 60 secondes).

L’identification non signée ne fonctionne plus

Exiger des jetons signés est activé dans Paramètres → Connexion (cette option s’affiche lorsque la Connexion automatique est activée). Une fois l’option activée, chaque appel identify doit inclure un token signé valide.

Cet article a-t-il répondu à votre question ?