Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/casdoor/casdoor-java-sdk
Java client SDK for Casdoor
https://github.com/casdoor/casdoor-java-sdk
auth authentication authn casdoor java jwt keycloak oauth oidc sdk sso
Last synced: about 16 hours ago
JSON representation
Java client SDK for Casdoor
- Host: GitHub
- URL: https://github.com/casdoor/casdoor-java-sdk
- Owner: casdoor
- License: apache-2.0
- Created: 2021-05-13T09:34:21.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T16:49:23.000Z (about 1 month ago)
- Last Synced: 2024-10-16T23:25:52.586Z (29 days ago)
- Topics: auth, authentication, authn, casdoor, java, jwt, keycloak, oauth, oidc, sdk, sso
- Language: Java
- Homepage: https://github.com/casdoor/casdoor
- Size: 238 KB
- Stars: 27
- Watchers: 4
- Forks: 45
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# casdoor-java-sdk
[](https://github.com/casdoor/casdoor-java-sdk/actions/workflows/maven-ci.yml)
[](https://codebeat.co/projects/github-com-casdoor-casdoor-java-sdk-master)
[](https://codecov.io/gh/casdoor/casdoor-java-sdk)
[](https://www.javadoc.io/doc/org.casbin/casdoor-java-sdk)
[](https://mvnrepository.com/artifact/org.casbin/casdoor-java-sdk/latest)
[](https://github.com/casdoor/casdoor-java-sdk/releases/latest)
[](https://discord.gg/5rPsrAzK7S)
This is Casdoor's SDK for java, which will allow you to easily connect your application to the Casdoor authentication system without having to implement it from scratch.
Casdoor SDK is very simple to use. We will show you the steps below.
## Step1. Init Config
Initialization requires 5 parameters, which are all string type:
| Name (in order) | Must | Description |
|------------------|------|-----------------------------------------------------|
| endpoint | Yes | Casdoor Server Url, such as `http://localhost:8000` |
| clientId | Yes | Client ID for the Casdoor application |
| clientSecret | Yes | Client secret for the Casdoor application |
| certificate | Yes | The public key for the Casdoor application's cert |
| organizationName | Yes | The name for the Casdoor organization |
| applicationName | No | The name for the Casdoor application |
```java
CasdoorConfig config = new CasdoorConfig(endpoint, clientId, clientSecret, certificate, organizationName, applicationName);
```
## Step2. Get Service and use
Now provide two services: ``CasdoorUserService``, ``CasdoorAuthService``
You can create them like
```Java
CasdoorUserService casdoorUserService = new CasdoorUserService(config);
```
## UserService
``CasdoorUserService`` support basic user operations, like:
- `GetUser(name string)`, get one user by user name.
- `GetUsers()`, get all users.
- `UpdateUser(auth.User)/AddUser(auth.User)/DeleteUser(auth.User)`, write user to database.
## AuthService
1. **Get token and parse**
After casdoor verification passed, it will be redirected to your application with code and state, like `http://forum.casbin.org?code=xxx&state=yyyy`.
Your web application can get the `code`,`state` and call `GetOAuthToken(code, state)`, then parse out jwt token.
The general process is as follows:
```java
String token = authService.getOAuthToken(code, state);
CasdoorUser user = authService.parseJwtToken(token);
```
2. **Set Session in your app**
`user` contains the basic information about the user provided by casdoor, you can use it as a keyword to set the session in your application, like this:
```java
HttpSession session = request.getSession();
session.setAttribute("user", user);
```
## SpringBoot Support
If you use SpingBoot for your application, you can use [casdoor-spring-boot-starter](https://github.com/casdoor/casdoor-spring-boot-starter)