* limitations under the License.
* ============LICENSE_END============================================
* ===================================================================
- * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ *
*/
package org.onap.clamp.clds.service;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
-import java.security.Principal;
-
+import java.util.Date;
import javax.ws.rs.NotAuthorizedException;
-import javax.ws.rs.core.Context;
-import javax.ws.rs.core.SecurityContext;
import org.onap.clamp.clds.util.LoggingUtils;
+import org.onap.clamp.clds.util.OnapLogConstants;
+import org.slf4j.event.Level;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.context.SecurityContext;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.userdetails.UserDetails;
/**
* Base/abstract Service class. Implements shared security methods.
public abstract class SecureServiceBase {
protected static final EELFLogger logger = EELFManager.getInstance().getLogger(SecureServiceBase.class);
protected static final EELFLogger auditLogger = EELFManager.getInstance().getAuditLogger();
+ protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
// By default we'll set it to a default handler
private static UserNameHandler userNameHandler = new DefaultUserNameHandler();
- @Context
- private SecurityContext securityContext;
+
+ private SecurityContext securityContext = SecurityContextHolder.getContext();
/**
* Get the userId from AAF/CSP.
*
- * @return
+ * @return user ID
*/
public String getUserId() {
return getUserName();
/**
* Get the Full name.
*
- * @return
+ * @return user name
*/
public String getUserName() {
String name = userNameHandler.retrieveUserName(securityContext);
- logger.debug("userName={}", name);
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "getUserName");
+ LoggingUtils.setTimeContext(startTime, new Date());
+ securityLogger.debug("User logged into the CLDS system={}", name);
return name;
}
/**
* Get the principal name.
*
- * @return
+ * @return the principal name
*/
public String getPrincipalName() {
- Principal principal = securityContext.getUserPrincipal();
+ String principal = ((UserDetails)securityContext.getAuthentication().getPrincipal()).getUsername();
String name = "Not found";
if (principal != null) {
- name = principal.getName();
+ name = principal;
}
logger.debug("userPrincipal.getName()={}", name);
return name;
* in this exception
*/
public boolean isAuthorized(SecureServicePermission inPermission) throws NotAuthorizedException {
- boolean authorized = false;
- logger.debug("checking if {} has permission: {}", getPrincipalName(), inPermission);
- // check if the user has the permission key or the permission key with a
- // combination of all instance and/or all action.
- if (securityContext.isUserInRole(inPermission.getKey())) {
- logger.info("{} authorized for permission: {}", getPrincipalName(), inPermission.getKey());
- authorized = true;
- // the rest of these don't seem to be required - isUserInRole method
- // appears to take * as a wildcard
- } else if (securityContext.isUserInRole(inPermission.getKeyAllInstance())) {
- logger.info("{} authorized because user has permission with * for instance: {}", getPrincipalName(),
- inPermission.getKey());
- authorized = true;
- } else if (securityContext.isUserInRole(inPermission.getKeyAllInstanceAction())) {
- logger.info("{} authorized because user has permission with * for instance and * for action: {}",
- getPrincipalName(), inPermission.getKey());
- authorized = true;
- } else if (securityContext.isUserInRole(inPermission.getKeyAllAction())) {
- logger.info("{} authorized because user has permission with * for action: {}", getPrincipalName(),
- inPermission.getKey());
- authorized = true;
- } else {
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "isAuthorized");
+ LoggingUtils.setTimeContext(startTime, new Date());
+ securityLogger.debug("checking if {} has permission: {}", getPrincipalName(), inPermission);
+ try {
+ return isUserPermitted(inPermission);
+ } catch (NotAuthorizedException nae) {
String msg = getPrincipalName() + " does not have permission: " + inPermission;
LoggingUtils.setErrorContext("100", "Authorization Error");
- logger.warn(msg);
+ securityLogger.warn(msg);
throw new NotAuthorizedException(msg);
}
- return authorized;
}
/**
* execute the inPermission
*/
public boolean isAuthorizedNoException(SecureServicePermission inPermission) {
- boolean authorized = false;
- logger.debug("checking if {} has permission: {}", getPrincipalName(), inPermission);
- // check if the user has the permission key or the permission key with a
- // combination of all instance and/or all action.
- if (securityContext.isUserInRole(inPermission.getKey())) {
- logger.info("{} authorized for permission: {}", getPrincipalName(), inPermission.getKey());
- authorized = true;
- // the rest of these don't seem to be required - isUserInRole method
- // appears to take * as a wildcard
- } else if (securityContext.isUserInRole(inPermission.getKeyAllInstance())) {
- logger.info("{} authorized because user has permission with * for instance: {}", getPrincipalName(),
- inPermission.getKey());
- authorized = true;
- } else if (securityContext.isUserInRole(inPermission.getKeyAllInstanceAction())) {
- logger.info("{} authorized because user has permission with * for instance and * for action: {}",
- getPrincipalName(), inPermission.getKey());
- authorized = true;
- } else if (securityContext.isUserInRole(inPermission.getKeyAllAction())) {
- logger.info("{} authorized because user has permission with * for action: {}", getPrincipalName(),
- inPermission.getKey());
- authorized = true;
- } else {
+ securityLogger.debug("checking if {} has permission: {}", getPrincipalName(), inPermission);
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "isAuthorizedNoException");
+ LoggingUtils.setTimeContext(startTime, new Date());
+ try {
+ return isUserPermitted(inPermission);
+ } catch (NotAuthorizedException nae) {
String msg = getPrincipalName() + " does not have permission: " + inPermission;
LoggingUtils.setErrorContext("100", "Authorization Error");
- logger.warn(msg);
+ securityLogger.warn(msg);
}
- return authorized;
+ return false;
}
/**
* This method can be used by the Application.class to set the
* UserNameHandler that must be used in this class. The UserNameHandler
* where to get the User name
- *
+ *
* @param handler
* The Handler impl to use
*/
this.securityContext = securityContext;
}
-}
+ private boolean isUserPermitted(SecureServicePermission inPermission) {
+ boolean authorized = false;
+ // check if the user has the permission key or the permission key with a
+ // combination of all instance and/or all action.
+ if (hasRole(inPermission.getKey())) {
+ securityLogger.info("{} authorized for permission: {}", getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ // the rest of these don't seem to be required - isUserInRole method
+ // appears to take * as a wildcard
+ } else if (hasRole(inPermission.getKeyAllInstance())) {
+ securityLogger.info("{} authorized because user has permission with * for instance: {}",
+ getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ } else if (hasRole(inPermission.getKeyAllInstanceAction())) {
+ securityLogger.info("{} authorized because user has permission with * for instance and * for action: {}",
+ getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ } else if (hasRole(inPermission.getKeyAllAction())) {
+ securityLogger.info("{} authorized because user has permission with * for action: {}",
+ getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ } else {
+ throw new NotAuthorizedException("");
+ }
+ return authorized;
+ }
+
+ protected boolean hasRole(String role) {
+ Authentication authentication = securityContext.getAuthentication();
+ if (authentication == null) {
+ return false;
+ }
+
+ for (GrantedAuthority auth : authentication.getAuthorities()) {
+ if (role.equals(auth.getAuthority())) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ protected void auditLogInfo(LoggingUtils util, String actionDescription, Date startTime) {
+ LoggingUtils.setTimeContext(startTime, new Date());
+ auditLogger.info(actionDescription + " completed");
+ util.exiting("200", actionDescription + " success", Level.INFO,
+ OnapLogConstants.ResponseStatus.COMPLETED);
+ }
+
+ protected void auditLogInfo(String actionDescription, Date startTime) {
+
+ LoggingUtils.setTimeContext(startTime, new Date());
+ LoggingUtils.setResponseContext("0", actionDescription + " success",
+ this.getClass().getName());
+ auditLogger.info(actionDescription + " completed");
+ }
+}
\ No newline at end of file
Code Review / clamp.git / blobdiff