The Asgardeo OIDC SDK for Java enables software developers to integrate OIDC based SSO authentication with Java Web applications. The SDK is built on top of the NimbusDS OAuth 2.0 SDK with OpenID Connection extensions library which allows Java developers to develop cross-domain single sign-on and federated access control solutions with minimum hassle.
You can experience the end-to-end capabilities of Asgardeo Java OIDC SDK by trying out the sample application featured in Asgardeo OIDC tomcat agent getting started guide.
In this section, we would be looking at how you can embed the Asgardeo Java OIDC SDK to your existing Java web app.
This section covers the preliminary steps needed for getting the SDK ready to be used in your java webapp.
You can add the Asgardeo Java OIDC SDK to your java project by installing it as a maven dependency:
<dependency>
<groupId>io.asgardeo.java.oidc.sdk</groupId>
<artifactId>io.asgardeo.java.oidc.sdk</artifactId>
<version>0.1.30</version>
</dependency>You need to add the configuration properties which provide the set of required parameters specific to the OIDC flows as described by the OIDC Agent configuration catalog. For a sample configuration properties file, please refer to the one provided with the sample application in Asgardeo OIDC Tomcat Agent here.
You can use the default FileBasedOIDCConfigProvider for using file-based configurations. Or else, you have the
freedom to implement your own custom configuration provider by implementing the interface, OIDCConfigProvider.
For using the default FileBasedOIDCConfigProvider, you can use the following snippet.
// public FileBasedOIDCConfigProvider(InputStream fileInputStream)
File configFile = new File("path/to/config/file");
InputStream configStream = new FileInputStream(configFile);
OIDCConfigProvider configProvider = new FileBasedOIDCConfigProvider(configStream);Now, the next step would be to create an OIDCManager instance which would provide you with the basic actions you
want to perform in securing your Java webapp with OpenID Connect.
The OIDCManager interface provides a set of APIs which you can use to initiate a login flow, initiate a logout flow
, and handle the callback responses from the OpenID Provider. For using these APIs, you only would need a single
instance of a OIDCManager implementation. By default, Asgardeo Java OIDC SDK provides the DefaultOIDCManger which is an implementation of the OIDCManager interface.
For users who opt to use HTTP-session-based storage, the SDK provides an HTTP-session-based wrapper out of the box
which adds HTTP session specific storing mechanisms on top of the DefaultOIDCManager.
If you opt to use a different session storing system, you have the flexibility to write your own implementation of
the OIDCManager interface and integrate it with your webapp.
For this tutorial, we will be using the HTTPSessionBasedOIDCProcessor which is provided out of the box.
The constructor for the HTTPSessionBasedOIDCProcessor takes in OIDCAgentConfig type object.
public HTTPSessionBasedOIDCProcessor(OIDCAgentConfig oidcAgentConfig);
This can be obtained by the OIDCConfigProvider instance we created earlier. Add the following code snippet to
create the HTTPSessionBasedOIDCProcessor instance.
OIDCAgentConfig config = configProvider.getOidcAgentConfig();
HTTPSessionBasedOIDCProcessor oidcManager = new HTTPSessionBasedOIDCProcessor(config);
After creating one instance at the start, you can re-use the instance for sending every request and handling the
responses.
The HTTPSessionBasedOIDCProcessor provides you with the following APIs which can be used to initiate requests
and handle responses.
-
sendForLogin(HttpServletRequest request, HttpServletResponse response) -
handleOIDCCallback(HttpServletRequest request, HttpServletResponse response, RequestContext requestContext) -
logout(HttpServletRequest request, HttpServletResponse response)
In the following sections, we would look into these APIs in detail with the possible scenarios in which these can be used.
oidcmanager.sendForLogin(request, response);The following are the parameters to the API.
request : Incoming HttpServletRequest.
response : Outgoing HttpServletResponse.
This method can be used to send the user for authentication. The API would build an authentication request and redirect the user for authentication. Relevant information regarding the authentication session would be written to the http session.
oidcManager.handleOIDCCallback(request, response, requestContext);The following are the parameters to the API.
request : Incoming HttpServletRequest.
response : Outgoing HttpServletResponse.
requestContext : RequestContext object containing the authentication request related information.
This method should be used to process the OIDC callback response. It would obtain access tokens and refresh tokens, validate the ID token issued by the OpenID Provider, and redirect the user to secured pages.
oidcManager.logout(request, response);The following are the parameters to the API.
request : Incoming HttpServletRequest.
response : Outgoing HttpServletResponse.
This method can be used to logout the user from the session. The API would build a logout request and log out the user from the authenticated session at the OpenID Provider.
Asgardeo Java OIDC SDK provides utils to process the incoming HTTP requests and resolve them to be certain types
. You can determine whether a request is a callback response, a logout request, an error request, etc. by using the
provided OIDCRequestResover in places where the webapp is intercepting HTTP requests.
You can create a OIDCRequestResolver instance with the following snippet.
OIDCRequestResolver requestResolver = new OIDCRequestResolver(request, oidcAgentConfig);The following are the parameters.
oidcAgentConfig : OIDCAgentConfig object which can be obtained through the OIDCConfigProvider implementation as
previously shown.
response : Outgoing HttpServletResponse.
The provided util methods are as follows:
| Method | Description | Returns |
|---|---|---|
| isCallbackResponse() | Checks if the request is a callback response. | boolean |
| isLogoutURL() | Checks if the request is a logout request. | boolean |
| isSkipURI() | Checks if the request is a URI to skip. | boolean |
| isAuthorizationCodeResponse() | Checks if the request is an Authorization Code response. | boolean |
| isError() | Checks if the request contains a parameter, "error". | boolean |
The SDK is hosted on github. You can download it from:
- Latest release: https://github.com/asgardeo/asgardeo-java-oidc-sdk/releases/latest
- Master repo: https://github.com/asgardeo/asgardeo-java-oidc-sdk/tree/master/
If you want to build asgardeo-java-oidc-sdk from the source code:
- Install Java 8
- Install Apache Maven 3.x.x (https://maven.apache.org/download.cgi#)
- Get a clone or download the source from this repository (https://github.com/asgardeo/asgardeo-java-oidc-sdk.git)
- Run the Maven command
mvn clean installfrom theasgardeo-java-oidc-sdkdirectory.
Please read Contributing to the Code Base for details on our code of conduct, and the process for submitting pull requests to us.
We encourage you to report issues, improvements, and feature requests creating Git Issues.
Important: Please be advised that security issues must be reported to [email protected], not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.
For the versions available, see the tags on this repository.
This project is licensed under the Apache License 2.0 under which WSO2 Carbon is distributed. See the LICENSE file for details.