From 713460db4b63a038dba77541a757b6d40fb4dd74 Mon Sep 17 00:00:00 2001 From: Bharat saraswal Date: Thu, 21 Sep 2017 21:03:47 +0530 Subject: Removed below sonar issues: Redudant variables. reduced method complexity by introducting new inner methods. rename variable to follow guidelines. Issue-Id:AAI-215 Change-Id: I3174daf62e38934207b87797f633f1cbd44b7502 Signed-off-by: Bharat saraswal --- .../src/main/java/org/openecomp/auth/Auth.java | 47 ++-- .../src/main/java/org/openecomp/auth/AuthCore.java | 300 +++++++++++---------- .../java/org/openecomp/util/AuthConstants.java | 16 +- 3 files changed, 180 insertions(+), 183 deletions(-) diff --git a/aai-auth/src/main/java/org/openecomp/auth/Auth.java b/aai-auth/src/main/java/org/openecomp/auth/Auth.java index 4d112887..3c5c3bee 100644 --- a/aai-auth/src/main/java/org/openecomp/auth/Auth.java +++ b/aai-auth/src/main/java/org/openecomp/auth/Auth.java @@ -28,36 +28,29 @@ package org.openecomp.auth; import org.apache.http.cookie.Cookie; public class Auth { - private AuthCore authCore; - public Auth(String filename) throws Exception { - this.authCore = new AuthCore(filename); - } + private AuthCore authCore; - public boolean auth_basic(String username, String authFunction) throws Exception { - return authCore.authorize(username, authFunction); - } + public Auth(String filename) throws Exception { + this.authCore = new AuthCore(filename); + } + + public boolean authBasic(String username, String authFunction) throws Exception { + return authCore.authorize(username, authFunction); + } - public boolean auth_cookie(Cookie cookie, String authFunction, StringBuilder username) - throws Exception { - if (cookie == null) { - return false; + public boolean authCookie(Cookie cookie, String authFunction, StringBuilder username) throws Exception { + return cookie != null && authCore.authorize(username.toString(), authFunction); } - return authCore.authorize(username.toString(), authFunction); - } - - /** - * Returns true if the user is allowed to access a function. - * @param authUser - * - String value of the user. - * @param authAction - * - String value of the function. - */ - public boolean validateRequest(String authUser, String authAction) throws Exception { - - if (authUser == null || authAction == null) { - return false; + + /** + * Returns true if the user is allowed to access a function. + * @param authUser + * - String value of the user. + * @param authAction + * - String value of the function. + */ + public boolean validateRequest(String authUser, String authAction) throws Exception { + return authUser != null && authAction != null && authCore.authorize(authUser, authAction); } - return authCore.authorize(authUser, authAction); - } } diff --git a/aai-auth/src/main/java/org/openecomp/auth/AuthCore.java b/aai-auth/src/main/java/org/openecomp/auth/AuthCore.java index 27de5c04..f1712e78 100644 --- a/aai-auth/src/main/java/org/openecomp/auth/AuthCore.java +++ b/aai-auth/src/main/java/org/openecomp/auth/AuthCore.java @@ -26,194 +26,198 @@ package org.openecomp.auth; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; -import org.openecomp.util.AuthConstants; - import java.io.File; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; +import org.openecomp.util.AuthConstants; public class AuthCore { - private String authFilename; - public ObjectMapper mapper; - - private static enum HTTP_METHODS { - POST, GET, PUT, DELETE, PATCH - } - - public AuthCore(String filename) throws Exception { - this.authFilename = filename; - loadUsers(filename); - } - - private static boolean usersInitialized = false; - private static HashMap users; - - public String getConfigFile() { - return this.authFilename; - } - - /** - * Loads the auth file and caches a list of authorized users. - * @param authFilename - * - Absolute path of the file where authorized users are listed. - */ - public synchronized void loadUsers(String authFilename) throws Exception { - users = new HashMap(); - - mapper = new ObjectMapper(); // can reuse, share globally - JsonNode rootNode = mapper.readTree(new File(authFilename)); - JsonNode rolesNode = rootNode.path(AuthConstants.rolesNodePath); - - for (JsonNode roleNode : rolesNode) { - String roleName = roleNode.path(AuthConstants.roleNamePath).asText(); - - AuthRole role = new AuthRole(); - JsonNode usersNode = roleNode.path(AuthConstants.usersNodePath); - JsonNode functionsNode = roleNode.path(AuthConstants.functionsNodePath); - for (JsonNode functionNode : functionsNode) { - String function = functionNode.path(AuthConstants.functionNamePath).asText(); - JsonNode methodsNode = functionNode.path(AuthConstants.methodsNodePath); - boolean hasMethods = false; - for (JsonNode methodNode : methodsNode) { - String methodName = methodNode.path(AuthConstants.methodNamePath).asText(); - hasMethods = true; - String thisFunction = methodName + ":" + function; + private String authFilename; + public ObjectMapper mapper; + + private enum HTTP_METHODS { + POST, GET, PUT, DELETE, PATCH + } + + public AuthCore(String filename) throws Exception { + this.authFilename = filename; + loadUsers(filename); + } + + private static boolean usersInitialized = false; + private static HashMap users; + + public String getConfigFile() { + return this.authFilename; + } - role.addAllowedFunction(thisFunction); + /** + * Loads the auth file and caches a list of authorized users. + * @param authFilename + * - Absolute path of the file where authorized users are listed. + */ + public synchronized void loadUsers(String authFilename) throws Exception { + users = new HashMap<>(); + + mapper = new ObjectMapper(); // can reuse, share globally + JsonNode rootNode = mapper.readTree(new File(authFilename)); + JsonNode rolesNode = rootNode.path(AuthConstants.ROLES_NODE_PATH); + + for (JsonNode roleNode : rolesNode) { + String roleName = roleNode.path(AuthConstants.ROLE_NAME_PATH).asText(); + + AuthRole role = new AuthRole(); + JsonNode usersNode = roleNode.path(AuthConstants.USERS_NODE_PATH); + JsonNode functionsNode = roleNode.path(AuthConstants.FUNCTIONS_NODE_PATH); + for (JsonNode functionNode : functionsNode) { + String function = functionNode.path(AuthConstants.FUNCTION_NAME_PATH).asText(); + JsonNode methodsNode = functionNode.path(AuthConstants.METHODS_NODE_PATH); + boolean hasMethods = handleMethodNode(methodsNode, role, function); + + if (!hasMethods) { + // iterate the list from HTTP_METHODS + for (HTTP_METHODS meth : HTTP_METHODS.values()) { + String thisFunction = meth.toString() + ":" + function; + + role.addAllowedFunction(thisFunction); + } + } + } + + handleUserNode(usersNode, roleName, role); } - if (hasMethods == false) { - // iterate the list from HTTP_METHODS - for (HTTP_METHODS meth : HTTP_METHODS.values()) { - String thisFunction = meth.toString() + ":" + function; + usersInitialized = true; + } + + private boolean handleMethodNode(JsonNode methodsNode, AuthRole role, String function) { + boolean hasMethods = false; + for (JsonNode methodNode : methodsNode) { + String methodName = methodNode.path(AuthConstants.METHOD_NAME_PATH).asText(); + hasMethods = true; + String thisFunction = methodName + ":" + function; role.addAllowedFunction(thisFunction); - } - } - } - - for (JsonNode userNode : usersNode) { - // make the user lower case - String node = userNode.path(AuthConstants.userNodePath).asText().toLowerCase(); - AuthUser user = null; - if (users.containsKey(node)) { - user = users.get(node); - } else { - user = new AuthUser(); } + return hasMethods; + } - user.setUser(node); - user.addRole(roleName, role); - users.put(node, user); - } + private void handleUserNode(JsonNode usersNode, String roleName, AuthRole role) { + for (JsonNode userNode : usersNode) { + // make the user lower case + String node = userNode.path(AuthConstants.USER_NODE_PATH).asText().toLowerCase(); + AuthUser user; + if (users.containsKey(node)) { + user = users.get(node); + } else { + user = new AuthUser(); + } + + user.setUser(node); + user.addRole(roleName, role); + users.put(node, user); + } } - usersInitialized = true; + public class AuthUser { - } + public AuthUser() { + this.roles = new HashMap<>(); + } - public class AuthUser { - public AuthUser() { - this.roles = new HashMap(); - } + private String username; + private HashMap roles; - private String username; - private HashMap roles; + public String getUser() { + return this.username; + } - public String getUser() { - return this.username; - } + public Map getRoles() { + return this.roles; + } - public HashMap getRoles() { - return this.roles; - } + public void addRole(String roleName, AuthRole role) { + this.roles.put(roleName, role); + } - public void addRole(String roleName, AuthRole role) { - this.roles.put(roleName, role); - } + /** + * Returns true if the user has permissions for the function, otherwise returns false. + * @param checkFunc + * - String value of the function. + */ + public boolean checkAllowed(String checkFunc) { + for (Map.Entry roleEntry : this.roles.entrySet()) { + AuthRole role = roleEntry.getValue(); + if (role.hasAllowedFunction(checkFunc)) { + // break out as soon as we find it + return true; + } + } + // we would have got positive confirmation had it been there + return false; + } - /** - * Returns true if the user has permissions for the function, otherwise returns false. - * @param checkFunc - * - String value of the function. - */ - public boolean checkAllowed(String checkFunc) { - for (Map.Entry roleEntry : this.roles.entrySet()) { - AuthRole role = roleEntry.getValue(); - if (role.hasAllowedFunction(checkFunc)) { - // break out as soon as we find it - return true; + public void setUser(String myuser) { + this.username = myuser; } - } - // we would have got positive confirmation had it been there - return false; } - public void setUser(String myuser) { - this.username = myuser; - } + public static class AuthRole { - } + public AuthRole() { + this.allowedFunctions = new ArrayList<>(); + } - public static class AuthRole { - public AuthRole() { - this.allowedFunctions = new ArrayList(); - } + private List allowedFunctions; + + public void addAllowedFunction(String func) { + this.allowedFunctions.add(func); + } - private List allowedFunctions; + /** + * Remove the function from the user's list of allowed functions. + * @param delFunc + * - String value of the function. + */ + public void delAllowedFunction(String delFunc) { + if (this.allowedFunctions.contains(delFunc)) { + this.allowedFunctions.remove(delFunc); + } + } - public void addAllowedFunction(String func) { - this.allowedFunctions.add(func); + /** + * Returns true if the user has permissions to use the function, otherwise returns false. + * @param afunc + * - String value of the function. + */ + public boolean hasAllowedFunction(String afunc) { + return this.allowedFunctions.contains(afunc); + } } /** - * Remove the function from the user's list of allowed functions. - * @param delFunc - * - String value of the function. + * Returns a hash-map of all users which have been loaded and initialized. */ - public void delAllowedFunction(String delFunc) { - if (this.allowedFunctions.contains(delFunc)) { - this.allowedFunctions.remove(delFunc); - } + public Map getUsers(String key) throws Exception { + if (!usersInitialized || (users == null)) { + loadUsers(this.authFilename); + } + return users; } /** - * Returns true if the user has permissions to use the function, otherwise returns false. - * @param afunc + * Returns true if the user is allowed to access a function. + * @param username + * - String value of user + * @param authFunction * - String value of the function. */ - public boolean hasAllowedFunction(String afunc) { - if (this.allowedFunctions.contains(afunc)) { - return true; - } else { - return false; - } - } - } - - /** - * Returns a hash-map of all users which have been loaded and initialized. - */ - public HashMap getUsers(String key) throws Exception { - if (!usersInitialized || (users == null)) { - loadUsers(this.authFilename); + public boolean authorize(String username, String authFunction) { + AuthUser user = users.get(username); + return user != null && user.checkAllowed(authFunction); } - return users; - } - - /** - * Returns true if the user is allowed to access a function. - * @param username - * - String value of user - * @param authFunction - * - String value of the function. - */ - public boolean authorize(String username, String authFunction) throws Exception { - AuthUser user = users.get(username); - return user != null && user.checkAllowed(authFunction); - } } diff --git a/aai-auth/src/main/java/org/openecomp/util/AuthConstants.java b/aai-auth/src/main/java/org/openecomp/util/AuthConstants.java index 8f4f60b9..e202615b 100644 --- a/aai-auth/src/main/java/org/openecomp/util/AuthConstants.java +++ b/aai-auth/src/main/java/org/openecomp/util/AuthConstants.java @@ -26,19 +26,19 @@ package org.openecomp.util; public class AuthConstants { - public static final String rolesNodePath = "roles"; + public static final String ROLES_NODE_PATH = "roles"; - public static final String roleNamePath = "name"; + public static final String ROLE_NAME_PATH = "name"; - public static final String usersNodePath = "users"; + public static final String USERS_NODE_PATH = "users"; - public static final String functionsNodePath = "functions"; + public static final String FUNCTIONS_NODE_PATH = "functions"; - public static final String functionNamePath = "name"; + public static final String FUNCTION_NAME_PATH = "name"; - public static final String methodsNodePath = "methods"; + public static final String METHODS_NODE_PATH = "methods"; - public static final String methodNamePath = "name"; + public static final String METHOD_NAME_PATH = "name"; - public static final String userNodePath = "username"; + public static final String USER_NODE_PATH = "username"; } -- cgit 1.2.3-korg