Skip to content

authlete/java-oauth-server

Repository files navigation

Authorization Server Implementation in Java

Overview

This is an authorization server implementation in Java which supports OAuth 2.0 and OpenID Connect.

This implementation is written using JAX-RS 2.0 API and authlete-java-jaxrs library. JAX-RS is The Java API for RESTful Web Services. JAX-RS 2.0 API has been standardized by JSR 339 and it is included in Java EE 7. On the other hand, authlete-java-jaxrs library is an open source library which provides utility classes for developers to implement an authorization server and a resource server. authlete-java-jaxrs in turn uses authlete-java-common library which is another open source library to communicate with Authlete Web APIs.

This implementation is DB-less. What this means is that you don't have to have a database server that stores authorization data (e.g. access tokens), settings of the authorization server itself and settings of client applications. This is achieved by using Authlete as a backend service.

Access tokens issued by this authorization server can be used at a resource server which uses Authlete as a backend service. java-resource-server is such a resource server implementation. It includes an example implementation of protected resource endpoint.

License

Apache License, Version 2.0

JSON files under src/main/resources/ekyc-ida have been copied from https://bitbucket.org/openid/ekyc-ida/src/master/examples/response/ . Regarding their license, ask the eKYC-IDA WG of OpenID Foundation.

Source Code

https://github.com/authlete/java-oauth-server

About Authlete

Authlete is a cloud service that provides an implementation of OAuth 2.0 & OpenID Connect (overview). You can easily get the functionalities of OAuth 2.0 and OpenID Connect either by using the default implementation provided by Authlete or by implementing your own authorization server using Authlete Web APIs as this implementation (java-oauth-server) does.

To use this authorization server implementation, you need to get API credentials from Authlete and set them in authlete.properties. The steps to get API credentials are very easy. All you have to do is just to register your account (sign up). See Getting Started for details.

How To Run

  1. Download the source code of this authorization server implementation.

     $ git clone https://github.com/authlete/java-oauth-server.git
     $ cd java-oauth-server
    
  2. Edit the configuration file to set the API credentials of yours.

     $ vi authlete.properties
    
  3. Make sure that you have installed maven and set JAVA_HOME properly.

  4. Start the authorization server on http://localhost:8080.

     $ mvn jetty:run &
    

Run With Docker

If you would prefer to use Docker, just hit the following command after the step 2.

$ docker-compose up

Configuration File

java-oauth-server refers to authlete.properties as a configuration file. If you want to use another different file, specify the name of the file by the system property authlete.configuration.file like the following.

$ mvn -Dauthlete.configuration.file=local.authlete.properties jetty:run &

Endpoints

This implementation exposes endpoints as listed in the table below.

Endpoint Path
Authorization Endpoint /api/authorization
Token Endpoint /api/token
JWK Set Endpoint /api/jwks
Discovery Endpoint /.well-known/openid-configuration
Revocation Endpoint /api/revocation
Introspection Endpoint /api/introspection
UserInfo Endpoint /api/userinfo
Dynamic Client Registration Endpoint /api/register
Pushed Authorization Request Endpoint /api/par
Grant Management Endpoint /api/gm/{grantId}
Federation Configuration Endpoint /.well-known/openid-federation
Federation Registration Endpoint /api/federation/register
Credential Issuer Metadata Endpoint /.well-known/openid-credential-issuer
JWT Issuer Metadata Endpoint /.well-known/jwt-issuer

The authorization endpoint and the token endpoint accept parameters described in RFC 6749, OpenID Connect Core 1.0, OAuth 2.0 Multiple Response Type Encoding Practices, RFC 7636 (PKCE) and other specifications.

The JWK Set endpoint exposes a JSON Web Key Set document (JWK Set) so that client applications can (1) verify signatures by this OpenID Provider and (2) encrypt their requests to this OpenID Provider.

The configuration endpoint exposes the configuration information of this OpenID Provider in the JSON format defined in OpenID Connect Discovery 1.0.

The revocation endpoint is a Web API to revoke access tokens and refresh tokens. Its behavior is defined in RFC 7009.

The introspection endpoint is a Web API to get information about access tokens and refresh tokens. Its behavior is defined in RFC 7662.

The userinfo endpoint is a Web API to get information about an end-user. Its behavior is defined in Section 5.3. UserInfo Endpoint of OpenID Connect Core 1.0.

The dynamic client registration endpoint is a Web API to register and update client applications. Its behavior is defined in RFC 7591 and RFC 7592.

The pushed authorization request endpoint (a.k.a. PAR endpoint) is a Web API to register an authorization request in advance and obtain a request URI. Its behavior is defined in RFC 9126.

The grant management endpoint is a Web API to get information about a grant ID and revoke a grant ID. Its behavior is defined in Grant Management for OAuth 2.0.

The federation configuration endpoint is a Web API that publishes the entity configuration of the authorization server in the JWT format. Its behavior is defined in OpenID Federation 1.0.

Authorization Request Example

The following is an example to get an access token from the authorization endpoint using Implicit Flow. Don't forget to replace {client-id} in the URL with the real client ID of one of your client applications. As for client applications, see Getting Started and the document of Developer Console.

http://localhost:8080/api/authorization?client_id={client-id}&response_type=token

The request above will show you an authorization page. The page asks you to input login credentials and click "Authorize" button or "Deny" button. Use one of the following as login credentials.

Login ID Password
john john
jane jane
max max
inga inga

Of course, these login credentials are dummy data, so you need to replace the user database implementation with your own.

The account max is for the old draft of OpenID Connect for Identity Assurance 1.0 (IDA). The account holds verified claims in the old format. Authlete 2.2 accepts the old format but Authlete 2.3 onwards will reject it.

The account inga is for the third Implementer's Draft of IDA onwards. Use inga for testing the latest IDA specification. However, note that the third Implementer's Draft onwards is supported from Authlete 2.3. Older Authlete versions do not support the latest IDA specification.

Customization

How to customize this implementation is described in CUSTOMIZATION.md. Basically, you need to do programming for end-user authentication because Authlete does not manage end-user accounts. This is by design. The architecture of Authlete carefully separates authorization from authentication so that you can add OAuth 2.0 and OpenID Connect functionalities seamlessly into even an existing web service which may already have a mechanism for end-user authentication.

Implementation Note

This implementation uses Viewable class to implement the authorization page. The class is included in Jersey (the reference implementation of JAX-RS), but it is not a part of JAX-RS 2.0 API.

Related Specifications

See Also

Contact

Purpose Email Address
General info@authlete.com
Sales sales@authlete.com
PR pr@authlete.com
Technical support@authlete.com

About

Authorization Server Implementation in Java supporting OAuth 2.0 & OpenID Connect

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages