Nimbus OAuth 2.0 SDK with OpenID Connect extensions

  • Comprehensive Java library for developing OAuth 2.0 and OpenID Connect clients and servers
  • Standards compliant, robust and extensible
  • Open source (Apache 2.0 licence)

This library is your starting point for developing OAuth 2.0 / 2.1 and OpenID Connect applications in Java. It provides ready and simple to use classes for dealing with tokens and representing the protocol messages, ensuring standards compliance and thus interoperability.

The OAuth 2.0 and OpenID Connect standards permit application-specific profiles and extensions, and this library also caters for that, with suitable interfaces and base classes where required.

OAuth 2.0

Supported endpoints:

  • Authorisation Server Metadata

  • Pushed Authorisation Request (PAR) endpoint

  • Authorisation Endpoint

  • Token Endpoint

  • Token Introspection Endpoint

  • Token Revocation Endpoint

  • Client Registration and Management Endpoint

  • Client-Initiated Back-channel Authentication (CIBA) Endpoint

  • Client Notification Endpoint (for CIBA)

  • Request Object Endpoint (obsoleted by PAR)

  • Resource protected with an OAuth 2.0 access token

OpenID Connect

Supported endpoints:

  • OpenID Provider Metadata

  • Authorisation Endpoint for OpenID Authentication requests

  • Token Endpoint

  • UserInfo Endpoint

  • End-Session (Logout) Endpoint

  • Back-Channel Logout Endpoint

  • Federation Entity Configuration Endpoint

  • Federation API Endpoint

Additional features

  • Process plain, signed and encrypted JSON Web Tokens (JWTs) with help of the Nimbus JOSE + JWT library.

  • Full OpenID Connect UserInfo i10n and l10n support with help of the Nimbus Language Tags library.

Specifications

Implemented standards and drafts:

  • The OAuth 2.0 Authorization Framework (RFC 6749)

  • The OAuth 2.1 Authorization Framework (draft-ietf-oauth-v2-1-02)

  • The OAuth 2.0 Authorization Framework: Bearer Token Usage (RFC 6750)

  • OAuth 2.0 Token Introspection (RFC 7662)

  • OAuth 2.0 Token Revocation (RFC 7009)

  • OAuth 2.0 Authorization Server Metadata (RFC 8414)

  • OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591)

  • OAuth 2.0 Dynamic Client Registration Management Protocol (RFC 7592)

  • Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants (RFC 7521)

  • JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC 7523)

  • SAML 2.0 Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC 7522)

  • Proof Key for Code Exchange by OAuth Public Clients (RFC 7636)

  • Authentication Method Reference Values (RFC 8176)

  • OAuth 2.0 Authorization Server Metadata (RFC 8414)

  • OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (RFC 8705)

  • OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP) (draft-ietf-oauth-dpop-03)

  • Resource Indicators for OAuth 2.0 (RFC 8707)

  • OAuth 2.0 Device Authorization Grant (RFC 8628)

  • OAuth 2.0 Token Exchange (RFC 8693)

  • OAuth 2.0 Incremental Authorization (draft-ietf-oauth-incremental-authz-04)

  • The OAuth 2.0 Authorization Framework: JWT Secured Authorization Request (JAR) (RFC 9101)

  • OAuth 2.0 Pushed Authorization Requests (RFC 9126)

  • OAuth 2.0 Authorization Server Issuer Identifier in Authorization Response (draft-ietf-oauth-iss-auth-resp-00)

  • OpenID Connect Core 1.0 (2014-02-25)

  • OpenID Connect Core Unmet Authentication Requirements 1.0 (2019-05-08)

  • OpenID Connect Discovery 1.0 (2014-02-25)

  • OpenID Connect Dynamic Registration 1.0 (2014-02-25)

  • OpenID Connect Session Management 1.0 (2017-01-25)

  • OpenID Connect Front-Channel Logout 1.0 (2017-01-25)

  • OpenID Connect Back-Channel Logout 1.0 (2017-01-25)

  • OpenID Connect Extended Authentication Profile (EAP) ACR Values 1.0 - draft 00

  • OpenID Connect for Identity Assurance 1.0 - draft 11

  • OpenID Connect Federation 1.0 - draft 13

  • Initiating User Registration via OpenID Connect (draft 03)

  • OAuth 2.0 Multiple Response Type Encoding Practices 1.0 (2014-02-25)

  • Financial Services – Financial API - Part 1: Read Only API Security Profile (2018-10-17)

  • Financial Services – Financial API - Part 2: Read and Write API Security Profile (2018-10-17)

  • Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM) (2018-10-17)

  • OpenID Connect Client Initiated Backchannel Authentication (CIBA) Flow - Core 1.0 (draft 03)

JavaDocs

The SDK code comes with excellent JavaDocs. These are available from Maven Central just as the code JARs are. You can also browse them online.

Licensing

This library is free and made available under the terms of the open source Apache 2.0 license.

Acknowledgements