Signierte Identität

Shayan TaslimAktualisiert

Ein einfacher uj.identify-Aufruf kommt vom Browser, sodass ihn jeder bearbeiten kann. Eine signierte Identität verhindert Identitätsfälschungen: Dein Server signiert ein kurzlebiges HS256-JWT, das die Identität des Nutzers bestätigt, und das Widget übergibt dieses Token an UserJot.

Alle Angaben im Token (Nutzer-ID, E-Mail-Adresse, Name, Avatar, Eigenschaften und Unternehmen) gelten als verifiziert.

Wann Sie das benötigen

  • Du möchtest sicherstellen, dass Feedback, Abstimmungen und Unterhaltungen vom tatsächlich angemeldeten Konto stammen.

  • Sie möchten, dass Kunden ihre eigenen Feedback-Beiträge und Kommentare im Widget bearbeiten und löschen können (nicht signierte uj.identify-Sitzungen können keine Inhalte im Widget bearbeiten oder löschen).

  • Sie haben Signierte Token erforderlich unter Einstellungen → Anmeldung aktiviert (verfügbar in den Starter- und Professional-Tarifen, sobald Automatische Anmeldung aktiviert ist). Dadurch werden nicht signierte identify-Aufrufe abgelehnt und Unternehmensmitgliedschaften müssen außerdem im signierten Token enthalten sein (nicht signierte clientseitige companies werden mit einer UNSIGNED_COMPANY_IGNORED-Warnung ignoriert).

  • Ein Workspace-Administrator oder -Inhaber verwendet das Widget. Nicht signierte Identifizierungen werden für Konten mit erweiterten Berechtigungen niemals akzeptiert. Ein signiertes Token übernimmt die Eigenschaften und Unternehmen dieser Person; Name, Avatar und E-Mail-Adresse werden weiterhin im Dashboard verwaltet und lösen eine PRIVILEGED_PROFILE_IGNORED-Warnung aus, wenn sie mitgesendet werden.

Note

Wenn dein Produkt sowohl das Web-Widget als auch das Swift SDK verwendet, wird durch Aktivieren von Signierte Tokens voraussetzen die Verifizierung für beide erzwungen. Das Web-Widget verwendet ein HS256-JWT (token), während das Swift SDK einen HMAC-SHA256-signature verwendet, der mit demselben Workspace-Secret signiert wird.

1. Token auf Ihrem Server erstellen

Signiere ein JWT mit HS256 und deinem Workspace-Secret. Du findest sowohl die Projekt-ID als auch das Projekt-Secret unter Einstellungen → Anmeldung im Bereich Secrets.

Signiere Tokens niemals im Browser. Bewahre das Secret auf deinem Server auf.

Erforderliche Claims

Claim

Wert

sub

Die stabile ID des Nutzers in deinem System. Erforderlich.

iss

Deine UserJot-Projekt-ID. Erforderlich.

aud

Die exakte Zeichenfolge userjot. Erforderlich.

iat

Zeitstempel der Ausstellung in Unix-Sekunden. Erforderlich.

exp

Ablaufzeitstempel in Unix-Sekunden. Erforderlich. Höchstens 1 Stunde (3600 Sekunden) nach iat.

Optionale verifizierte Claims

Du kannst auch email, firstName, lastName, avatar, traits und companies angeben. Jeder Eintrag in companies unterstützt:

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

Serverbeispiele

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

Erstelle bei jedem Laden einer Seite oder über einen authentifizierten Backend-Endpunkt ein neues Token. Da Tokens höchstens 1 Stunde gültig sind, solltest du sie nicht länger zwischenspeichern.

2. Token zur Identifizierung übergeben

Übergib das JWT im Feld token:

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

Sie können zusätzlich user und companies zusammen mit token für weitere nicht verifizierte Felder übergeben. Falls ein Feld in beiden vorkommt, hat das signierte Token Vorrang (sofern Signierte Token erforderlich nicht aktiviert ist; in diesem Fall werden nicht signierte Unternehmen ignoriert). Bestätigen Sie die Verifizierung über das zurückgegebene Promise:

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

Ungültige Tokens führen zu einem Fehler, statt auf eine andere Methode zurückzufallen

Wenn ein Token abgelaufen oder fehlerhaft formatiert ist oder mit dem falschen Secret signiert wurde, wird uj.identify mit IDENTIFY_FAILED abgelehnt, statt stillschweigend auf eine nicht signierte Sitzung zurückzufallen.

Signierte Identität und Konversationen

  • Wenn ein anonymer Besucher eine Gastunterhaltung beginnt und sich später mit einem signierten Token identifiziert, wird die Gastunterhaltung auf das verifizierte Mitgliederkonto übertragen.

  • Unterhaltungen, die mit einer signierten Identität begonnen wurden, bleiben geschützt. Wird eine solche Unterhaltung ohne signierte Sitzung erneut geöffnet, muss der Besucher seine Identität verifizieren, bevor er den Verlauf ansehen kann.

  • Wenn du Signierte Tokens voraussetzen aktivierst, können anonyme Besucher weiterhin browsergebundene Gastunterhaltungen starten. Dadurch wird lediglich verhindert, dass nicht signierte identify-Aufrufe mit Mitgliederkonten verknüpft werden.

Die Identität wird auf Ihre öffentlichen Seiten übertragen

Nach der Identifizierung übergibt das Widget die Sitzung automatisch an Links zu deinen öffentlichen UserJot-Seiten (Board, Roadmap, Changelog oder Help Center). Damit Besucher diese Seiten bereits angemeldet aufrufen, aktiviere Automatische Anmeldung unter Einstellungen → Anmeldung (Tarif Starter oder Professional). Siehe Automatische Anmeldung.

Fehlerbehebung

Der Identify-Aufruf wird mit IDENTIFY_FAILED abgelehnt

  • Prüfe, ob das Token mit HS256 und deinem aktuellen Projekt-Secret signiert wurde.

  • Prüfe, ob iss mit deiner Projekt-ID übereinstimmt und aud genau userjot ist.

  • Prüfe, ob sowohl iat als auch exp als Unix-Sekunden angegeben sind und exp - iat <= 3600.

  • Prüfe, ob die Uhr deines Servers korrekt geht (Tokens, die mehr als 60 Sekunden in der Zukunft ausgestellt wurden, werden aufgrund der Uhrzeitabweichung abgelehnt).

Nicht signierte Identify-Aufrufe funktionieren nicht mehr

Die Option Signierte Tokens voraussetzen ist unter Einstellungen → Anmeldung aktiviert (wird angezeigt, wenn Automatische Anmeldung eingeschaltet ist). Nach der Aktivierung muss jeder identify-Aufruf ein gültiges signiertes token enthalten.

Hat das Ihre Frage beantwortet?