Zum Inhalt springen

sdk/java

Java-17+-Server-SDK für netzwerklose JWT-Prüfung,HTTP-Anfrage-Authentifizierung und Webhook-Signaturvalidierung.

Als Markdown anzeigen

Zustand

Implementiert und lokal verifiziert. Die echteIdP-Round-Trip-Verifizierung (JWKS-Abruf, Token-Signierung/Prüfung gegeneine Live-XID-Instanz) wurde noch nicht durchgeführt und muss vor demProduktionseinsatz abgeschlossen werden.

Installieren

Java 17+ und Maven erforderlich.

<dependency>
  <groupId>dev.xid</groupId>
  <artifactId>xid-sdk-java</artifactId>
  <version>0.1.0-SNAPSHOT</version>
</dependency>

Schnellstart

Erstellen Sie beim Anwendungsstart einen XidClient und verwendenSie ihn als Singleton.

import dev.xid.sdk.XidClient;
import dev.xid.sdk.XidClientOptions;
import dev.xid.sdk.XidClaims;
import dev.xid.sdk.XidTokenException;
import dev.xid.sdk.XidJwksException;

XidClient xid = XidClient.create(
    XidClientOptions.builder()
        .issuer("https://xid.dev")
        .audience("your-client-id")
        .webhookSecret("whsec_xxx")
        .build()
);

try {
    XidClaims claims = xid.verifyToken(accessToken);
    String userId = claims.getSub();
    String scope  = claims.getScope();
} catch (XidTokenException e) {
    response.sendError(401, "Unauthorized: " + e.getReason());
} catch (XidJwksException e) {
    response.sendError(503, "Service unavailable");
}

HTTP-Anfrage authentifizieren

import dev.xid.sdk.AuthResult;

// Option A: pass Authorization header value directly
AuthResult result = xid.authenticateRequest(authHeader, null);

// Option B: pass a headers Map (Spring MVC example)
Map<String, String> headers = Collections.list(request.getHeaderNames())
    .stream()
    .collect(Collectors.toMap(h -> h, request::getHeader));
AuthResult result = xid.authenticateRequest(headers);

if (result.isAuthenticated()) {
    String userId = result.getClaims().get().getSub();
} else {
    response.sendError(401);
}

Webhook prüfen

import dev.xid.sdk.XidWebhookException;

byte[] rawBody = request.getInputStream().readAllBytes();
Map<String, String> headers = Map.of(
    "svix-id",        request.getHeader("svix-id"),
    "svix-timestamp", request.getHeader("svix-timestamp"),
    "svix-signature", request.getHeader("svix-signature")
);

try {
    xid.verifyWebhook(headers, rawBody);
} catch (XidWebhookException e) {
    response.sendError(400, "Invalid webhook: " + e.getReason());
}

XidClientOptions

Methode Standard Beschreibung
.issuer(String) erforderlich OIDC-Issuer; muss exakt mit dem Token-iss übereinstimmen
.audience(String) null Erwarteter aud; null überspringt die Validierung
.webhookSecret(String) null Webhook-Secret (whsec_-Prefix oder rohes Base64)
.jwksCacheDuration(Duration) 1 Stunde JWKS-In-Memory-Cache-TTL
.clockSkewTolerance(Duration) 30 Sekunden exp/nbf-Taktversatztoleranz
.connectTimeout(Duration) 5 Sekunden HTTP-Verbindungs-Timeout für den JWKS-Abruf
.readTimeout(Duration) 10 Sekunden HTTP-Lese-Timeout für den JWKS-Abruf

Plattformhinweise

  • Verwendet nimbus-jose-jwt für JWT/JWKS-Parsing. ES256 ist primär;RS256 und PS256 werden unterstützt.
  • Alle öffentlichen APIs sind synchron und threadsicher.
  • Logging über die SLF4J-Fassade; bringen Sie Ihre eigene Implementierungmit (Logback, Log4j2).
  • Ausnahmehierarchie: XidException -> XidTokenException,XidJwksException, XidWebhookException.
Navigation

Suchbegriff eingeben...

Mit den Pfeiltasten navigierenEingabetaste zum AuswählenEscape zum Schließen