• Deutsch

      • JWT-Authentifizierung

      JWT (JSON Web Token) ist ein offener Standard (RFC 7519) zur sicheren Übertragung von Informationen zwischen Parteien. Es handelt sich um eine kompakte, URL-sichere Methode zur Darstellung von Ansprüchen im JSON-Objektformat, die häufig für Authentifizierung und Informationsaustausch verwendet wird.

      Ein JWT besteht aus drei Teilen:

      • Header – Gibt den Tokentyp und den verwendeten Signaturalgorithmus an
      • Payload – Enthält Ansprüche wie Benutzer-ID, Rollen, Ablaufzeit usw.
      • Signatur – Dient zur Überprüfung, ob die Nachricht während der Übertragung verändert wurde

      Typische Verwendung von JWT im Authentifizierungsablauf:

      1. Nach der Benutzeranmeldung generiert der Server ein JWT-Token
      2. Das Token wird an den Client zurückgegeben und gespeichert (üblicherweise in localStorage oder Cookies)
      3. Bei nachfolgenden Anfragen fügt der Client dieses Token in den Authorization-Header ein
      4. Der Server validiert die Authentizität des Tokens und gewährt Zugriff

      Bietet Middleware für JWT-Authentifizierung.

      Auswahl eines Kryptografie-Providers

      Salvo 0.95 bietet zwei alternative JWT-Features:

      • jwt-auth verwendet den AWS-LC-Provider.
      • jwt-auth-ring verwendet den RustCrypto-Provider.

      In normalen Builds sollte nur eines davon aktiviert werden. Das separate ring-Feature wählt ring für Salvos rustls-Integration aus und aktiviert keine JWT-Authentifizierung. Das folgende Beispiel verwendet jwt-auth. Für RustCrypto verwenden Sie stattdessen:

      salvo = { version = "0.95", default-features = false, features = ["server", "http1", "ring", "jwt-auth-ring"] }

      Wenn die Cargo-Feature-Zusammenführung beide JWT-Provider aktiviert, rufen Sie salvo::jwt_auth::install_crypto_provider() ganz am Anfang von main auf, bevor Sie jsonwebtoken direkt verwenden oder die JWT-Middleware einrichten. Das folgende Beispiel tut dies, damit die Provider-Auswahl deterministisch ist.

      Beispielcode

      main.rs
      Cargo.toml
      use jsonwebtoken::{self, EncodingKey};
use salvo::http::{Method, StatusError};
use salvo::jwt_auth::{ConstDecoder, QueryFinder};
use salvo::prelude::*;
use serde::{Deserialize, Serialize};
use time::{Duration, OffsetDateTime};

const SECRET_KEY: &str = "YOUR SECRET_KEY";

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct JwtClaims {
    username: String,
    exp: i64,
}

#[tokio::main]
async fn main() {
    tracing_subscriber::fmt().init();
    salvo::jwt_auth::install_crypto_provider()
        .expect("install the JWT crypto provider before first use");

    let auth_handler: JwtAuth<JwtClaims, _> =
        JwtAuth::new(ConstDecoder::from_secret(SECRET_KEY.as_bytes()))
            .finders(vec![
                // Box::new(HeaderFinder::new()),
                Box::new(QueryFinder::new("jwt_token")),
                // Box::new(CookieFinder::new("jwt_token")),
            ])
            .force_passed(true);

    let acceptor = TcpListener::new("0.0.0.0:8698").bind().await;
    Server::new(acceptor)
        .serve(Router::with_hoop(auth_handler).goal(index))
        .await;
}
#[handler]
async fn index(req: &mut Request, depot: &mut Depot, res: &mut Response) -> anyhow::Result<()> {
    if req.method() == Method::POST {
        let (username, password) = (
            req.form::<String>("username").await.unwrap_or_default(),
            req.form::<String>("password").await.unwrap_or_default(),
        );
        if !validate(&username, &password) {
            res.render(Text::Html(LOGIN_HTML));
            return Ok(());
        }
        let exp = OffsetDateTime::now_utc() + Duration::days(14);
        let claim = JwtClaims {
            username,
            exp: exp.unix_timestamp(),
        };
        let token = jsonwebtoken::encode(
            &jsonwebtoken::Header::default(),
            &claim,
            &EncodingKey::from_secret(SECRET_KEY.as_bytes()),
        )?;
        res.render(Redirect::other(format!("/?jwt_token={token}")));
    } else {
        match depot.jwt_auth_state() {
            JwtAuthState::Authorized => {
                let data = depot.jwt_auth_data::<JwtClaims>().unwrap();
                res.render(Text::Plain(format!(
                    "Hi {}, have logged in successfully!",
                    data.claims.username
                )));
            }
            JwtAuthState::Unauthorized => {
                res.render(Text::Html(LOGIN_HTML));
            }
            JwtAuthState::Forbidden => {
                res.render(StatusError::forbidden());
            }
        }
    }
    Ok(())
}

fn validate(username: &str, password: &str) -> bool {
    username == "root" && password == "pwd"
}

static LOGIN_HTML: &str = r#"<!DOCTYPE html>
<html>
    <head>
        <title>JWT Auth Demo</title>
    </head>
    <body>
        <h1>JWT Auth</h1>
        <form action="/" method="post">
        <label for="username"><b>Username</b></label>
        <input type="text" placeholder="Enter Username" name="username" required>

        <label for="password"><b>Password</b></label>
        <input type="password" placeholder="Enter Password" name="password" required>

        <button type="submit">Login</button>
    </form>
    </body>
</html>
"#;