https://github.com/auth0/auth0-java-mvc-common
Contains common helper classes and api client logic that are used across our Java MVC libraries
https://github.com/auth0/auth0-java-mvc-common
dx-sdk hacktoberfest
Last synced: 6 months ago
JSON representation
Contains common helper classes and api client logic that are used across our Java MVC libraries
- Host: GitHub
- URL: https://github.com/auth0/auth0-java-mvc-common
- Owner: auth0
- License: mit
- Created: 2016-08-08T17:48:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T03:52:35.000Z (7 months ago)
- Last Synced: 2025-03-29T06:08:28.578Z (7 months ago)
- Topics: dx-sdk, hacktoberfest
- Language: Java
- Homepage:
- Size: 551 KB
- Stars: 43
- Watchers: 15
- Forks: 39
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://codecov.io/github/auth0/auth0-java-mvc-common)
[](https://doge.mit-license.org/)
[](https://mvnrepository.com/artifact/com.auth0/mvc-auth-commons)
[](https://javadoc.io/doc/com.auth0/mvc-auth-commons)
> **Note**
> As part of our ongoing commitment to best security practices, we have rotated the signing keys used to sign previous releases of this SDK. As a result, new patch builds have been released using the new signing key. Please upgrade at your earliest convenience.
>
> While this change won't affect most developers, if you have implemented a dependency signature validation step in your build process, you may notice a warning that past releases can't be verified. This is expected, and a result of the key rotation process. Updating to the latest version will resolve this for you.
:books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :computer: [API Reference](#api-reference) :speech_balloon: [Feedback](#feedback)
## Documentation
- [Quickstart](https://auth0.com/docs/quickstart/webapp/java) - our interactive guide for quickly adding login, logout and user information to a Java Servlet application using Auth0.
- [Sample App](https://github.com/auth0-samples/auth0-servlet-sample/tree/master/01-Login) - a sample Java Servlet application integrated with Auth0.
- [Examples](./EXAMPLES.md) - code samples for common scenarios.
- [Docs site](https://www.auth0.com/docs) - explore our docs site and learn more about Auth0.
## Getting Started
### Requirements
Java 8 or above and `javax.servlet` version 3.
> If you are using Spring, we recommend leveraging Spring's OIDC and OAuth2 support, as demonstrated by the [Spring Boot Quickstart](https://auth0.com/docs/quickstart/webapp/java-spring-boot).
### Installation
Add the dependency via Maven:
```xml
com.auth0
mvc-auth-commons
1.11.0
```
or Gradle:
```gradle
implementation 'com.auth0:mvc-auth-commons:1.11.0'
```
### Configure Auth0
Create a **Regular Web Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications). Verify that the "Token Endpoint Authentication Method" is set to `POST`.
Next, configure the callback and logout URLs for your application under the "Application URIs" section of the "Settings" page:
- **Allowed Callback URLs**: The URL of your application where Auth0 will redirect to during authentication, e.g., `http://localhost:3000/callback`.
- **Allowed Logout URLs**: The URL of your application where Auth0 will redirect to after user logout, e.g., `http://localhost:3000/login`.
Note the **Domain**, **Client ID**, and **Client Secret**. These values will be used later.
### Add login to your application
Create a new `AuthenticationController` using your Auth0 domain, and Auth0 application client ID and secret.
Configure the builder with a `JwkProvider` for your Auth0 domain.
```java
public class AuthenticationControllerProvider {
private String domain = "YOUR-AUTH0-DOMAIN";
private String clientId = "YOUR-CLIENT-ID";
private String clientSecret = "YOUR-CLIENT-SECRET";
private AuthenticationController authenticationController;
static {
JwkProvider jwkProvider = new JwkProviderBuilder("YOUR-AUTH0-DOMAIN").build();
authenticationController = AuthenticationController.newBuilder(domain, clientId, clientSecret)
.withJwkProvider(jwkProvider)
.build();
}
public getInstance() {
return authenticationController;
}
}
```
> Note: The `AuthenticationController.Builder` is not to be reused, and an `IllegalStateException` will be thrown if `build()` is called more than once.
Redirect users to the Auth0 login page using the `AuthenticationController`:
```java
@WebServlet(urlPatterns = {"/login"})
public class LoginServlet extends HttpServlet {
@Override
protected void doGet(final HttpServletRequest req, final HttpServletResponse res) throws ServletException, IOException {
// Where your application will handle the authoriztion callback
String redirectUrl = "http://localhost:3000/callback";
String authorizeUrl = AuthenticationControllerProvider
.getInstance()
.buildAuthorizeUrl(req, res, redirectUrl)
.build();
res.sendRedirect(authorizeUrl);
}
}
```
Finally, complete the authentication and obtain the tokens by calling `handle()` on the `AuthenticationController`.
```java
@WebServlet(urlPatterns = {"/callback"})
public class CallbackServlet extends HttpServlet {
@Override
public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {
try {
// authentication complete; the tokens can be stored as needed
Tokens tokens = AuthenticationControllerProvider
.getInstance()
.handle(req, res);
res.sendRedirect("URL-AFTER-AUTHENTICATED");
} catch (IdentityVerificationException e) {
// handle authentication error
}
}
}
```
That's it! You have authenticated the user using Auth0.
## API Reference
- [JavaDocs](https://javadoc.io/doc/com.auth0/mvc-auth-commons)
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
### Raise an issue
To provide feedback or report a bug, [please raise an issue on our issue tracker](https://github.com/auth0/auth0-java-mvc-common/issues).
### Vulnerability Reporting
Please do not report security vulnerabilities on the public Github issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
---
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.