sdk/linux

Statut

L’état du package est Implémenté et vérifié localement. La suite de tests unitaires Rust réussit. Le stockage Secret Service via D-Bus, xdg-open, le callback loopback complet et un aller-retour réel avec un IdP nécessitent encore un environnement d’intégration Linux de bureau. Cette page documente le comportement implémenté; elle ne constitue pas une déclaration d’aptitude à la production.

Statut du registre : UNPUBLISHED. Installez ce SDK uniquement depuis un checkout du code source du dépôt ; n’utilisez pas de registre de paquets externe.

Prérequis

• Rust (stable, édition 2021)
• runtime async tokio
• Linux bureau avec xdg-open (xdg-utils) pour lancer le navigateur systèmeet une session D-Bus active avec gnome-keyring ou kwallet pour le stockageSecret Service
• Environnements headless / CI : utilisez la fonctionnalitéin-memory-storage ou injectez InMemoryStorage directement

Installation

Ajoutez xid-linux dans Cargo.toml :

[dependencies]
xid-linux = { path = "../xid/sdk/linux" }
tokio = { version = "1", features = ["full"] }

Démarrage rapide

use xid_linux::{XidClient, XidConfigBuilder};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // 1. Build config. offline_access is rejected until DPoP is implemented.
    let config = XidConfigBuilder::new()
        .issuer("https://xid.dev")
        .client_id("your_client_id")
        .redirect_uri("http://127.0.0.1:51234/callback")
        .redirect_port(51234)
        .build()?;

    // 2. Create client (default: Secret Service storage)
    let client = XidClient::configure(config)?;

    // 3. Sign in. xdg-open launches the browser and loopback TCP receives the callback.
    let session = client.sign_in(None).await?;
    println!("user: {}", session.user.sub);

    // 4. Get the current unexpired access token. Expiry returns SessionExpired.
    let token = client.get_access_token(None).await?;

    // 5. Clear local token and guest state. No revoke request is sent.
    client.sign_out().await?;
    Ok(())
}

Utilisation headless / CI

Quand aucun démon D-Bus Secret Service n’est disponible, passezInMemoryStorage pour éviter une erreur d’exécution :

use xid_linux::{XidClient, XidConfigBuilder};
use xid_linux::storage::InMemoryStorage;
use std::sync::Arc;

let config = XidConfigBuilder::new()
    .issuer("https://xid.dev")
    .client_id("your_client_id")
    .redirect_uri("http://127.0.0.1:51234/callback")
    .build()?;

let client = XidClient::configure_with_storage(config, Arc::new(InMemoryStorage::new()))?;

API principale

Adaptateurs de stockage

Sécurité

• Client public — aucun secret client stocké ni transmis.
• PKCE S256 uniquement. Le serveur rejette la méthode plain challenge.
• État OAuth validé sur le callback loopback pour prévenir le CSRF(redirection loopback RFC 8252).
• Secret Service chiffre les jetons au repos via le démon de trousseau dubureau — l’application ne gère pas directement les clés de chiffrement.
• Le SDK rejette offline_access tant que DPoP n’est pas implémenté; les champs de réponse refresh_token inattendus ne sont pas persistés.

Limites connues

• La vérification des jetons d’identité adossée à JWKS, la validation du nonce et le renouvellement du cache JWKS sont implémentés et testés localement. Un Secret Service de bureau et un aller-retour réel avec un IdP restent requis avant le support L4.
• Le port de redirection est fixe et doit correspondre au redirect_urienregistré dans la console XID. La randomisation dynamique du port (RFC8252) nécessite la prise en charge de l’enregistrement dynamique declient.
• La redirection du navigateur systeme et le stockage Secret Service necessitent une preuve d environnement de bureau.