Skip to content

README.md

Latest commit

 

History

History
113 lines (75 loc) · 4.1 KB

README.md

File metadata and controls

113 lines (75 loc) · 4.1 KB

Auth0 Springboot Authentication Library

Auth0 API SDK for securing your Java API Server using tokens from Auth0

Build Status Java Version License

A comprehensive Java library for Auth0 JWT authentication with built-in DPoP (Demonstration of Proof-of-Possession) and Multi-Custom Domain (MCD) support. This project provides Spring Boot integration for secure API development.

🏗️ Architecture Overview

This repository contains multiple modules designed for different use cases:

Core Modules

Module Description Java Version
auth0-springboot-api Spring Boot auto-configuration and filters Java 17+
auth0-springboot-api-playground Working example application Java 17+

Module Relationship

auth0-springboot-api (Published)
    ↳ bundles auth0-api-java (Internal - not published separately)
    ↳ examples in auth0-springboot-api-playground

Getting Started

For Spring Boot Applications (Recommended)

If you're building a Spring Boot application, use the Spring Boot integration:

<dependency>
    <groupId>com.auth0</groupId>
    <artifactId>auth0-springboot-api</artifactId>
    <version>1.0.0-beta.1</version>
</dependency>

👉 Get started with Spring Boot integration →

For Core Java Applications

It provides:

  • JWT validation with Auth0 JWKS integration
  • DPoP proof validation per RFC 9449
  • Multiple Custom Domain (MCD) support — static domain lists, or dynamic resolution at request time
  • Extensible caching — pluggable AuthCache interface for distributed backends (Redis, Memcached)
  • Flexible authentication strategies

📚 Documentation

🛠️ Development

This project uses Gradle with a multi-module setup:

# Build all modules
./gradlew build

# Build module
./gradlew :auth0-springboot-api:build

# Run tests
./gradlew test

# Run playground application
./gradlew :auth0-springboot-api-playground:bootRun

📦 Publishing

Spring Boot integration module is published as a public artifact:

Module Group ID Artifact ID Version Status
auth0-springboot-api com.auth0 auth0-springboot-api 1.0.0-beta.1 📦 Published

The core library (auth0-api-java) is bundled as an internal dependency within the Spring Boot module and is not published separately.

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make changes in the appropriate module
  4. Add tests for new functionality
  5. Ensure all tests pass: ./gradlew test
  6. Ensure your commits are signed
  7. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

🎯 New to Auth0? Sign up for a free Auth0 account →