* Copyright (C) 2017 AT&T Intellectual Property. All rights
* reserved.
* ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
* 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 org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+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 java.security.Principal;
+
+import org.onap.clamp.clds.util.LoggingUtils;
/**
- * Base/abstract Service class.
- * Implements shared security methods.
+ * Base/abstract Service class. Implements shared security methods.
*/
public abstract class SecureServiceBase {
- private static final Logger logger = LoggerFactory.getLogger(SecureServiceBase.class);
+ 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;
+
+ /**
+ * Get the userId from AAF/CSP.
+ *
+ * @return
+ */
+ public String getUserId() {
+ return getUserName();
+ }
/**
- * Get the userid
+ * Get the Full name.
*
* @return
*/
- public String getUserid() {
- return getPrincipalName();
+ public String getUserName() {
+ String name = userNameHandler.retrieveUserName(securityContext);
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "getUserName");
+ LoggingUtils.setTimeContext(startTime, new Date());
+ securityLogger.debug("User logged into the CLDS system={}", name);
+ return name;
}
/**
* @return
*/
public String getPrincipalName() {
- Principal p = securityContext.getUserPrincipal();
+ Principal principal = securityContext.getUserPrincipal();
String name = "Not found";
- if (p != null) {
- name = p.getName();
+ if (principal != null) {
+ name = principal.getName();
}
logger.debug("userPrincipal.getName()={}", name);
return name;
}
/**
- * Check if user is authorized for the given the permission.
- * Allow matches if user has a permission with an "*" in permission instance
- * or permission action even if the permission to check has a specific value
- * in those fields. For example:
- * if the user has this permission: app-perm-type|*|*
- * it will be authorized if the inPermission to check is: app-perm-type|dev|read
+ * Check if user is authorized for the given the permission. Allow matches
+ * if user has a permission with an "*" in permission instance or permission
+ * action even if the permission to check has a specific value in those
+ * fields. For example: if the user has this permission: app-perm-type|*|*
+ * it will be authorized if the inPermission to check is:
+ * app-perm-type|dev|read
*
* @param inPermission
- * @return
+ * The permission to validate
+ * @return A boolean to indicate if the user has the permission to do
+ * execute the inPermission
* @throws NotAuthorizedException
+ * In case of issues with the permission test, error is returned
+ * 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.
+
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "isAuthorized");
+ LoggingUtils.setTimeContext(startTime, new Date());
+
+ securityLogger.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());
+ 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
+ // 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());
+ securityLogger.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());
+ securityLogger.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());
+ securityLogger.info("{} authorized because user has permission with * for action: {}", getPrincipalName(), inPermission.getKey());
authorized = true;
} else {
String msg = getPrincipalName() + " does not have permission: " + inPermission;
- logger.warn(msg);
+ LoggingUtils.setErrorContext("100", "Authorization Error");
+ securityLogger.warn(msg);
throw new NotAuthorizedException(msg);
}
return authorized;
}
+ /**
+ * Check if user is authorized for the given aaf permission. Allow matches
+ * if user has a permission with an "*" in permission instance or permission
+ * action even if the permission to check has a specific value in those
+ * fields. For example: if the user has this permission: app-perm-type|*|*
+ * it will be authorized if the inPermission to check is:
+ * app-perm-type|dev|read
+ *
+ * @param inPermission
+ * The permission to validate
+ * @return A boolean to indicate if the user has the permission to do
+ * execute the inPermission
+ */
+ public boolean isAuthorizedNoException(SecureServicePermission inPermission) {
+ boolean authorized = false;
+
+ securityLogger.debug("checking if {} has permission: {}", getPrincipalName(), inPermission);
+ Date startTime = new Date();
+ LoggingUtils.setTargetContext("CLDS", "isAuthorizedNoException");
+ LoggingUtils.setTimeContext(startTime, new Date());
+
+ // 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())) {
+ 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 (securityContext.isUserInRole(inPermission.getKeyAllInstance())) {
+ securityLogger.info("{} authorized because user has permission with * for instance: {}", getPrincipalName(),inPermission.getKey());
+ authorized = true;
+ } else if (securityContext.isUserInRole(inPermission.getKeyAllInstanceAction())) {
+ securityLogger.info("{} authorized because user has permission with * for instance and * for action: {}", getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ } else if (securityContext.isUserInRole(inPermission.getKeyAllAction())) {
+ securityLogger.info("{} authorized because user has permission with * for action: {}", getPrincipalName(), inPermission.getKey());
+ authorized = true;
+ } else {
+ String msg = getPrincipalName() + " does not have permission: " + inPermission;
+ LoggingUtils.setErrorContext("100", "Authorization Error");
+ securityLogger.warn(msg);
+ logger.warn(msg);
+ }
+ return authorized;
+ }
+
+ /**
+ * 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
+ */
+ public static final void setUserNameHandler(UserNameHandler handler) {
+ if (handler != null) {
+ userNameHandler = handler;
+ }
+ }
+
+ public void setSecurityContext(SecurityContext securityContext) {
+ this.securityContext = securityContext;
+ }
+
}
Code Review / clamp.git / blobdiff