# fusionauth/fusionauth-jwt architecture

> Architecture diagram of the GitHub repository fusionauth/fusionauth-jwt, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fusionauth/fusionauth-jwt
- Repository: https://github.com/fusionauth/fusionauth-jwt

## Overview

##### Relationships and Data Flow

a. Input/Output flow:
- Raw JWT String → Decoder → JWT Object
- JWT Object → Encoder → Signed JWT String

b. Verification flow:
- Signed JWT → Verifier → Validation Result

c. Key Management flow:
- PEM Files → PEM Decoder → Keys
- Keys → Signers/Verifiers

##### Integration Points

External interfaces:
- JWKS Endpoint Integration
- OpenID Connect Integration
- Jackson JSON Processing

##### Component Details

For each major component, include:
- Supported Algorithms (HS256, HS384, HS512, RS256, etc.)
- Key Types (RSA, EC, HMAC)
- Security Provider Integration Points

##### Notes Section

Important notes about:
- FIPS compliance capabilities
- Minimum Java version requirements
- Security considerations
- Clock skew handling

- The modular nature of the crypto provider system
- The separation between signing and verification operations
- The flexibility in key format support (PEM, JWK, raw keys)
- The integration capabilities with external systems

Remember to include version information (5.3.3 as per README) and note the single external dependency on Jackson, as these are important architectural considerations.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core JWT Processing"]
        JWTEncoder["JWT Encoder"]
        JWTDecoder["JWT Decoder"]
        SignerInterface["Signer Interface"]
        VerifierInterface["Verifier Interface"]
        JWT["JWT Domain"]
    end

    subgraph Implementations["Implementation Layer"]
        subgraph HMAC["HMAC Implementation"]
            HMACSigner["HMAC Signer"]
            HMACVerifier["HMAC Verifier"]
        end

        subgraph RSA["RSA Implementation"]
            RSASigner["RSA Signer"]
            RSAVerifier["RSA Verifier"]
            RSAPSSSigner["RSAPSS Signer"]
            RSAPSSVerifier["RSAPSS Verifier"]
        end

        subgraph EC["EC Implementation"]
            ECSigner["EC Signer"]
            ECVerifier["EC Verifier"]
        end
    end

    subgraph Support["Supporting Components"]
        subgraph PEM["PEM Processing"]
            PEMEncoder["PEM Encoder"]
            PEMDecoder["PEM Decoder"]
        end

        subgraph Crypto["Crypto Components"]
            DER["DER Processing"]
            CryptoProvider["Crypto Provider"]
            DefaultProvider["Default Provider"]
        end

        subgraph JWK["JWK Processing"]
            JWKBuilder["JWK Builder"]
            JWKParser["JWK Parser"]
        end
    end

    subgraph Integration["Integration Points"]
        OIDC["OpenID Connect"]
        OAuth2["OAuth2"]
        JWKS["JWKS Endpoint"]
        Jackson["Jackson JSON"]
    end

    %% Core Relationships
    JWTEncoder --> JWT
    JWTDecoder --> JWT
    SignerInterface --> JWTEncoder
    VerifierInterface --> JWTDecoder

    %% Implementation Relationships
    HMACSigner --> SignerInterface
    HMACVerifier --> VerifierInterface
    RSASigner --> SignerInterface
    RSAVerifier --> VerifierInterface
    RSAPSSSigner --> SignerInterface
    RSAPSSVerifier --> VerifierInterface
    ECSigner --> SignerInterface
    ECVerifier --> VerifierInterface

    %% Support Relationships
    PEMEncoder --> Implementations
    PEMDecoder --> Implementations
    DER --> PEM
    CryptoProvider --> Implementations
    DefaultProvider --> CryptoProvider
    JWKBuilder --> Implementations
    JWKParser --> Implementations

    %% Integration Relationships
    OIDC --> JWT
    OAuth2 --> JWT
    JWKS --> JWK
    Jackson --> JWT

    classDef core fill:#2374ab
    classDef impl fill:#ff7f50
    classDef support fill:#48a9a6
    classDef integration fill:#9370db

    class JWTEncoder,JWTDecoder,SignerInterface,VerifierInterface,JWT core
    class HMACSigner,HMACVerifier,RSASigner,RSAVerifier,RSAPSSSigner,RSAPSSVerifier,ECSigner,ECVerifier impl
    class PEMEncoder,PEMDecoder,DER,CryptoProvider,DefaultProvider,JWKBuilder,JWKParser support
    class OIDC,OAuth2,JWKS,Jackson integration

    %% Click Events
    click JWTEncoder "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/JWTEncoder.java"
    click JWTDecoder "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/JWTDecoder.java"
    click SignerInterface "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/Signer.java"
    click VerifierInterface "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/Verifier.java"
    click HMACSigner "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/hmac/HMACSigner.java"
    click HMACVerifier "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/hmac/HMACVerifier.java"
    click RSASigner "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/rsa/RSASigner.java"
    click RSAVerifier "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/rsa/RSAVerifier.java"
    click RSAPSSSigner "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/rsa/RSAPSSSigner.java"
    click RSAPSSVerifier "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/rsa/RSAPSSVerifier.java"
    click ECSigner "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/ec/ECSigner.java"
    click ECVerifier "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/ec/ECVerifier.java"
    click PEMEncoder "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/pem/PEMEncoder.java"
    click PEMDecoder "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/pem/PEMDecoder.java"
    click DER "https://github.com/FusionAuth/fusionauth-jwt/tree/main/src/main/java/io/fusionauth/der"
    click CryptoProvider "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/security/CryptoProvider.java"
    click DefaultProvider "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/security/DefaultCryptoProvider.java"
    click JWKBuilder "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwks/JSONWebKeyBuilder.java"
    click JWKParser "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwks/JSONWebKeyParser.java"
    click JWT "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/domain/JWT.java"
    click OIDC "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/jwt/OpenIDConnect.java"
    click OAuth2 "https://github.com/FusionAuth/fusionauth-jwt/blob/main/src/main/java/io/fusionauth/oauth2/ServerMetaDataHelper.java"
```
