DWN-39926 : validate create and update scope directly

pull/1601/head
Harry Smith 2023-01-18 13:46:40 +00:00
parent 32240a5c5c
commit 9325917ce2
3 changed files with 37 additions and 12 deletions

View File

@ -24,6 +24,7 @@ import java.util.Set;
import org.mitre.oauth2.model.SystemScope;
import org.mitre.oauth2.service.SystemScopeService;
import org.mitre.openid.connect.exception.ScopeException;
import org.mitre.openid.connect.view.HttpCodeView;
import org.mitre.openid.connect.view.JsonEntityView;
import org.mitre.openid.connect.view.JsonErrorView;
@ -33,6 +34,7 @@ import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.security.access.method.P;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
@ -54,6 +56,8 @@ public class ScopeAPI {
public static final String URL = RootController.API_URL + "/scopes";
private static final String characterMatcher = "[a-zA-Z]+";
@Autowired
private SystemScopeService scopeService;
@ -101,7 +105,14 @@ public class ScopeAPI {
SystemScope existing = scopeService.getById(id);
SystemScope scope = gson.fromJson(json, SystemScope.class);
try {
validateScope(scope);
} catch (ScopeException e) {
logger.error("updateScope failed due to ScopeException. {}", e.getMessage());
m.put(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
m.put(JsonErrorView.ERROR_MESSAGE, "Could not update scope. The server encountered a scope exception. Contact a system administrator for assistance.");
return JsonErrorView.VIEWNAME;
}
if (existing != null && scope != null) {
if (existing.getId().equals(scope.getId())) {
@ -138,6 +149,14 @@ public class ScopeAPI {
SystemScope scope = gson.fromJson(json, SystemScope.class);
SystemScope alreadyExists = scopeService.getByValue(scope.getValue());
try {
validateScope(scope);
} catch (ScopeException e) {
logger.error("createScope failed due to ScopeException. {}", e.getMessage());
m.put(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
m.put(JsonErrorView.ERROR_MESSAGE, "Could not create scope. The server encountered a scope exception. Contact a system administrator for assistance.");
return JsonErrorView.VIEWNAME;
}
if (alreadyExists != null) {
//Error, cannot save a scope with the same value as an existing one
logger.error("Error: attempting to save a scope with a value that already exists: " + scope.getValue());
@ -163,6 +182,12 @@ public class ScopeAPI {
}
}
private void validateScope(SystemScope scope) throws ScopeException {
if (!scope.getValue().matches(characterMatcher)) {
throw new ScopeException(scope.getValue());
}
}
@PreAuthorize("hasRole('ROLE_ADMIN')")
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
public String deleteScope(@PathVariable("id") Long id, ModelMap m) {

View File

@ -10,11 +10,11 @@ package org.mitre.openid.connect.exception;
/**
* @author hwsmith
*/
public class WhitelistScopesException extends Exception {
public class ScopeException extends Exception {
private final String invalidScope;
public WhitelistScopesException(String invalidScope) {
public ScopeException(String invalidScope) {
this.invalidScope = invalidScope;
}

View File

@ -24,7 +24,7 @@ import java.security.Principal;
import java.util.Collection;
import java.util.Set;
import org.mitre.openid.connect.exception.WhitelistScopesException;
import org.mitre.openid.connect.exception.ScopeException;
import org.mitre.openid.connect.model.WhitelistedSite;
import org.mitre.openid.connect.service.WhitelistedSiteService;
import org.mitre.openid.connect.view.HttpCodeView;
@ -104,10 +104,10 @@ public class WhitelistAPI {
json = parser.parse(jsonString).getAsJsonObject();
whitelist = gson.fromJson(json, WhitelistedSite.class);
validateWhitelistScopes(whitelist.getAllowedScopes());
} catch (WhitelistScopesException e) {
logger.error("addNewWhitelistedSite failed due to WhitelistScopesException. {}", e.getMessage());
} catch (ScopeException e) {
logger.error("addNewWhitelistedSite failed due to ScopeException. {}", e.getMessage());
m.addAttribute(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
m.addAttribute(JsonErrorView.ERROR_MESSAGE, "Could not save new whitelisted site. The server encountered a whitelist scopes exception. Contact a system administrator for assistance.");
m.addAttribute(JsonErrorView.ERROR_MESSAGE, "Could not save new whitelisted site. The server encountered a scopes exception. Contact a system administrator for assistance.");
return JsonErrorView.VIEWNAME;
} catch (JsonParseException e) {
logger.error("addNewWhitelistedSite failed due to JsonParseException", e);
@ -146,10 +146,10 @@ public class WhitelistAPI {
json = parser.parse(jsonString).getAsJsonObject();
whitelist = gson.fromJson(json, WhitelistedSite.class);
validateWhitelistScopes(whitelist.getAllowedScopes());
} catch (WhitelistScopesException e) {
logger.error("updateWhitelistedSite failed due to WhitelistScopesException. {}", e.getMessage());
} catch (ScopeException e) {
logger.error("updateWhitelistedSite failed due to ScopeException. {}", e.getMessage());
m.put(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
m.put(JsonErrorView.ERROR_MESSAGE, "Could not update whitelisted site. The server encountered a whitelist scopes exception. Contact a system administrator for assistance.");
m.put(JsonErrorView.ERROR_MESSAGE, "Could not update whitelisted site. The server encountered a scope exception. Contact a system administrator for assistance.");
return JsonErrorView.VIEWNAME;
} catch (JsonParseException e) {
logger.error("updateWhitelistedSite failed due to JsonParseException", e);
@ -180,10 +180,10 @@ public class WhitelistAPI {
}
}
private void validateWhitelistScopes(Set<String> scopes) throws WhitelistScopesException {
private void validateWhitelistScopes(Set<String> scopes) throws ScopeException {
for (String s : scopes) {
if (!s.matches(characterMatcher)) {
throw new WhitelistScopesException(s);
throw new ScopeException(s);
}
}
}