casdoor / casdoor-java-sdk

Java client SDK for Casdoor

casdoor-java-sdk

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

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

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:

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:

HttpSession session = request.getSession();
session.setAttribute("user", user);

SpringBoot Support

If you use SpingBoot for your application, you can use casdoor-spring-boot-starter

casdoor-java-sdk's Issues

java SDK updateUser interface cannot change the user password

feat: add all missing APIs for all objects, fix the response format

Like: casdoor/casdoor-go-sdk#76

Fix: #57 and casdoor/casdoor#2233

Update the parameter from jwtPublicKey to certificate

See:

• https://github.com/casdoor/casdoor-go-sdk
• https://github.com/casdoor/casdoor-nodejs-sdk

There is no api "/api/login/oauth/authorize"

Dear,

I tested to integrate use java sdk. It has error 403 when get the token. I checked, it dose not have api: "/api/login/oauth/authorize" Please check again help me.

Thanks!

Add methods such as getSigninUrl(), getSignupUrl() etc.

Currently, developers using Casdoor must import casdoor-js-sdk on the front-end while importing casdoor-java-sdk on the back-end. If not, they must construct URLs for the signin and signup pages by themselves.

I‘m considering providing constructed URLs from the SDK so that developers can redirect pages on the back-end.

getUserProfileUrl format is wrong

https://github.com/casdoor/casdoor-java-sdk/blob/master/src/main/java/org/casbin/casdoor/service/CasdoorAuthService.java#L151

https://github.com/casdoor/casdoor-go-sdk/blob/v0.20.1/casdoorsdk/url.go#L46

/users/<org>/<username>

Should the version of casdoor-java-sdk in the pom need to be updated?

In the master branch, the version in pom.xml is still 1.0. Should it be updated?

The interface update frequency of sdk cannot keep up with the main branch of casdoor.

The API interface in the latest version of casdoor-java-sdk does not match the casdoor interface. For example: the attributes of the object "CasdoorResponse" returned by the api interface in sdk is inconsistent with the "Response" attributes of casdoor.

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Deployment to maven failed.

The deployment to maven failed for an unknown reason.

Please check the logs on the CI server to see what happened.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Add missing badges like jCasbin

See: https://github.com/casbin/jcasbin

Access token not found in JWT payload

Is there any issue with my jwttoken ? i'm upgrade the spring-starter version to 1.9.0 and the sdk version is 1.16.1

parse the jwttoken it has 60 size claims
but haven't access_token
#54 #53 #

[feature] How to get group tree? maybe need to add API

Similar to: casdoor/casdoor-nodejs-sdk#53

The group tree means this part: https://door.casdoor.com/trees/built-in

The group tree mainly relies on the data returned by the get-groups API. But the returned data is a list. The Casdoor frontend code will build the tree from the list. We may need to do so too. There are two ways:

1. Build the tree in Casdoor Go backend: https://github.com/casdoor/casdoor/blob/master/controllers/group.go#L31
2. Build the tree in the SDK (like this casdoor-java-sdk)

feat: add test cases for all objects and all operations

Issue: casdoor/casdoor-go-sdk#80

Port to Java from Go: casdoor/casdoor-go-sdk#84

Is a more generic service required?

I found a lot of duplicated codes in each services. IMO we can provide a more generic service ( Maybe named CasdoorCrudService ) to achive the common crud actions of entities.

public class CasdoorCrudService<T> extends CasdoorService {
    public CasdoorResponse<List<T>, Integer> query(String action, Map<String, String> queryParams) { }
    
    public T get(String action) { }

    public T get(String action, String id) {}

    public boolean create(String action, T t) {}

    public boolean update(String action, String id, T t) {}

    public boolean delete(String action, T t) {}
}

Add semantic-release

Like jCasbin or this one: jcasbin/redis-watcher#7

please support get role info API in Java SDK

hi，developer!
user login by oauth2.0，but can't get role info。
please support the sdk to method of get role info！

why not check the exp time when parse token

The api "parseJwtToken" need return the JWT exp time or check the exp.
The jwt exp time setted is no use now.

casdoor-java-sdk/src/main/java/org/casbin/casdoor/service/AuthService.java

Lines 71 to 106 in 26b92ec

	public User parseJwtToken(String token) {
	// parse jwt token
	SignedJWT parseJwt = null;
	try {
	parseJwt = SignedJWT.parse(token);
	} catch (ParseException e) {
	throw new AuthException("Cannot parse jwt token.", e);
	}
	// verify the jwt public key
	try {
	CertificateFactory cf = CertificateFactory.getInstance("X.509");
	X509Certificate cert = (X509Certificate) cf.generateCertificate(new ByteArrayInputStream(config.certificate.getBytes()));
	RSAPublicKey publicKey = (RSAPublicKey) cert.getPublicKey();
	JWSVerifier verifier = new RSASSAVerifier(publicKey);
	boolean verify = parseJwt.verify(verifier);
	if (!verify) {
	throw new AuthException("Cannot verify signature.");
	}
	} catch (CertificateException | JOSEException e) {
	throw new AuthException("Cannot verify signature.", e);
	}
	// read "access_token" from payload and convert to CasdoorUser
	try {
	JWTClaimsSet claimsSet = parseJwt.getJWTClaimsSet();
	String userJson = claimsSet == null ? null : claimsSet.toString();
	if (userJson == null || userJson.isEmpty()) {
	throw new AuthException("Cannot get claims from JWT payload");
	}
	return objectMapper.readValue(userJson, User.class);
	} catch (JsonProcessingException | java.text.ParseException e) {
	throw new AuthException("Cannot convert claims to User", e);
	}
	}

The API /api/get-tokens to get the list of tokens is also always empty

The API /api/get-tokens to get the list of tokens is also always empty

Add README

feat: Enhance and improve basic features to support casdoor-springboot-starter development

ref: casdoor-spring-boot-starter README

casdoor-springboot-starter depends on this sdk, so it must wait for the completion of this sdk

[feature] port new APIs from casdoor-go-sdk

Use GPT