javier/Stirling-PDF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added UsernameAttribute enum for useAsUsername

Browse Source
This commit is contained in:
DarioGii
2025-01-31 13:20:31 +00:00
committed by Dario Ghunney Ware
parent 8954990afb
commit 704da399d4
11 changed files with 157 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/main/java/stirling/software/SPDF/model/UsernameAttribute.java Normal file
View File

@@ -0,0 +1,21 @@
package stirling.software.SPDF.model;
import lombok.Getter;
@Getter
public enum UsernameAttribute {
NAME("name"),
EMAIL("email"),
GIVEN_NAME("given_name"),
PREFERRED_NAME("preferred_name"),
PREFERRED_USERNAME("preferred_username"),
LOGIN("login"),
FAMILY_NAME("family_name"),
NICKNAME("nickname");
private final String name;
UsernameAttribute(final String name) {
this.name = name;
}
}

7
src/main/java/stirling/software/SPDF/model/exception/UnsupportedUsernameAttribute.java Normal file
View File

@@ -0,0 +1,7 @@
package stirling.software.SPDF.model.exception;
public class UnsupportedUsernameAttribute extends RuntimeException {
public UnsupportedUsernameAttribute(String message) {
super(message);
}
}

8
src/main/java/stirling/software/SPDF/model/provider/GitHubProvider.java
View File

@@ -4,6 +4,7 @@ import java.util.ArrayList;
import java.util.Collection;
import lombok.NoArgsConstructor;
import stirling.software.SPDF.model.UsernameAttribute;
@NoArgsConstructor
public class GitHubProvider extends Provider {
@@ -15,7 +16,10 @@ public class GitHubProvider extends Provider {
private static final String USER_INFO_URI = "https://api.github.com/user";
public GitHubProvider(
String clientId, String clientSecret, Collection<String> scopes, String useAsUsername) {
String clientId,
String clientSecret,
Collection<String> scopes,
UsernameAttribute useAsUsername) {
super(
null,
NAME,
@@ -23,7 +27,7 @@ public class GitHubProvider extends Provider {
clientId,
clientSecret,
scopes,
useAsUsername != null ? useAsUsername : "login",
useAsUsername != null ? useAsUsername : UsernameAttribute.LOGIN,
AUTHORIZATION_URI,
TOKEN_URI,
USER_INFO_URI);

6
src/main/java/stirling/software/SPDF/model/provider/GoogleProvider.java
View File

@@ -4,6 +4,7 @@ import java.util.ArrayList;
import java.util.Collection;
import lombok.NoArgsConstructor;
import stirling.software.SPDF.model.UsernameAttribute;
@NoArgsConstructor
public class GoogleProvider extends Provider {
@@ -16,7 +17,10 @@ public class GoogleProvider extends Provider {
"https://www.googleapis.com/oauth2/v3/userinfo?alt=json";
public GoogleProvider(
String clientId, String clientSecret, Collection<String> scopes, String useAsUsername) {
String clientId,
String clientSecret,
Collection<String> scopes,
UsernameAttribute useAsUsername) {
super(
null,
NAME,

3
src/main/java/stirling/software/SPDF/model/provider/KeycloakProvider.java
View File

@@ -4,6 +4,7 @@ import java.util.ArrayList;
import java.util.Collection;
import lombok.NoArgsConstructor;
import stirling.software.SPDF.model.UsernameAttribute;
@NoArgsConstructor
public class KeycloakProvider extends Provider {
@@ -16,7 +17,7 @@ public class KeycloakProvider extends Provider {
String clientId,
String clientSecret,
Collection<String> scopes,
String useAsUsername) {
UsernameAttribute useAsUsername) {
super(
issuer,
NAME,

74
src/main/java/stirling/software/SPDF/model/provider/Provider.java
View File

@@ -1,6 +1,6 @@
package stirling.software.SPDF.model.provider;
import static stirling.software.SPDF.utils.validation.Validator.isStringEmpty;
import static stirling.software.SPDF.model.UsernameAttribute.EMAIL;
import java.util.ArrayList;
import java.util.Arrays;
@@ -9,6 +9,8 @@ import java.util.stream.Collectors;
import lombok.Data;
import lombok.NoArgsConstructor;
import stirling.software.SPDF.model.UsernameAttribute;
import stirling.software.SPDF.model.exception.UnsupportedUsernameAttribute;
@Data
@NoArgsConstructor
@@ -20,7 +22,7 @@ public class Provider {
private String clientId;
private String clientSecret;
private Collection<String> scopes;
private String useAsUsername;
private UsernameAttribute useAsUsername;
private String authorizationUri;
private String tokenUri;
private String userInfoUri;
@@ -32,7 +34,7 @@ public class Provider {
String clientId,
String clientSecret,
Collection<String> scopes,
String useAsUsername,
UsernameAttribute useAsUsername,
String authorizationUri,
String tokenUri,
String userInfoUri) {
@@ -42,7 +44,8 @@ public class Provider {
this.clientId = clientId;
this.clientSecret = clientSecret;
this.scopes = scopes == null ? new ArrayList<>() : scopes;
this.useAsUsername = isStringEmpty(useAsUsername) ? "email" : useAsUsername;
this.useAsUsername =
useAsUsername != null ? validateUsernameAttribute(useAsUsername) : EMAIL;
this.authorizationUri = authorizationUri;
this.tokenUri = tokenUri;
this.userInfoUri = userInfoUri;
@@ -55,6 +58,69 @@ public class Provider {
}
}
private UsernameAttribute validateUsernameAttribute(UsernameAttribute usernameAttribute) {
switch (name) {
case "google" -> {
return validateGoogleUsernameAttribute(usernameAttribute);
}
case "github" -> {
return validateGitHubUsernameAttribute(usernameAttribute);
}
case "keycloak" -> {
return validateKeycloakUsernameAttribute(usernameAttribute);
}
default -> {
return usernameAttribute;
}
}
}
private UsernameAttribute validateKeycloakUsernameAttribute(
UsernameAttribute usernameAttribute) {
switch (usernameAttribute) {
case EMAIL, PREFERRED_NAME -> {
return usernameAttribute;
}
default ->
throw new UnsupportedUsernameAttribute(
"The attribute "
+ usernameAttribute
+ "is not supported for "
+ clientName
+ ".");
}
}
private UsernameAttribute validateGoogleUsernameAttribute(UsernameAttribute usernameAttribute) {
switch (usernameAttribute) {
case EMAIL, NAME, GIVEN_NAME, PREFERRED_NAME -> {
return usernameAttribute;
}
default ->
throw new UnsupportedUsernameAttribute(
"The attribute "
+ usernameAttribute
+ "is not supported for "
+ clientName
+ ".");
}
}
private UsernameAttribute validateGitHubUsernameAttribute(UsernameAttribute usernameAttribute) {
switch (usernameAttribute) {
case EMAIL, NAME, LOGIN -> {
return usernameAttribute;
}
default ->
throw new UnsupportedUsernameAttribute(
"The attribute "
+ usernameAttribute
+ "is not supported for "
+ clientName
+ ".");
}
}
@Override
public String toString() {
return "Provider [name="