1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/*-
* ============LICENSE_START=======================================================
* ONAP CLAMP
* ================================================================================
* Copyright (C) 2019 AT&T Intellectual Property. All rights
* reserved.
* ================================================================================
* Modifications Copyright (c) 2019 Samsung
* ================================================================================
* 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
* limitations under the License.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.policy.clamp.authorization;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import java.util.Date;
import org.apache.camel.Exchange;
import org.onap.policy.clamp.clds.config.ClampProperties;
import org.onap.policy.clamp.clds.exception.NotAuthorizedException;
import org.onap.policy.clamp.clds.model.ClampInformation;
import org.onap.policy.clamp.clds.util.LoggingUtils;
import org.springframework.beans.factory.annotation.Autowired;
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;
import org.springframework.stereotype.Component;
/**
* Verify user has right permissions.
*/
@Component
public class AuthorizationController {
protected static final EELFLogger logger =
EELFManager.getInstance().getLogger(AuthorizationController.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
@Autowired
private ClampProperties refProp;
private SecurityContext securityContext = SecurityContextHolder.getContext();
public static final String PERM_PREFIX = "security.permission.type.";
private static final String PERM_INSTANCE = "security.permission.instance";
private static String retrieveUserName(SecurityContext securityContext) {
if (securityContext == null || securityContext.getAuthentication() == null) {
return null;
}
if ((securityContext.getAuthentication().getPrincipal()) instanceof String) {
// anonymous case
return ((String) securityContext.getAuthentication().getPrincipal());
} else {
return ((UserDetails) securityContext.getAuthentication().getPrincipal()).getUsername();
}
}
/**
* Get the principal name.
*
* @return The principal name
*/
public static String getPrincipalName(SecurityContext securityContext) {
String principal = AuthorizationController.retrieveUserName(securityContext);
String name = "Not found";
if (principal != null) {
name = principal;
}
return name;
}
/**
* Insert authorize the api based on the permission.
*
* @param camelExchange The Camel Exchange object containing the properties
* @param typeVar The type of the permissions
* @param instanceVar The instance of the permissions. e.g. dev
* @param action The action of the permissions. e.g. read
*/
public void authorize(Exchange camelExchange, String typeVar, String instanceVar,
String action) {
String type = refProp.getStringValue(PERM_PREFIX + typeVar);
String instance = refProp.getStringValue(PERM_INSTANCE);
if (null == type || type.isEmpty()) {
// authorization is turned off, since the permission is not defined
return;
}
if (null != instanceVar && !instanceVar.isEmpty()) {
instance = instanceVar;
}
String principalName = AuthorizationController.getPrincipalName(this.securityContext);
SecureServicePermission perm = SecureServicePermission.create(type, instance, action);
Date startTime = new Date();
LoggingUtils.setTargetContext("Clamp", "authorize");
LoggingUtils.setTimeContext(startTime, new Date());
securityLogger.debug("checking if {} has permission: {}", principalName, perm);
if (!isUserPermitted(perm)) {
String msg = principalName + " does not have permission: " + perm;
LoggingUtils.setErrorContext("100", "Authorization Error");
securityLogger.warn(msg);
throw new NotAuthorizedException(msg);
}
}
/**
* Insert authorize the api based on the permission.
*
* @param inPermission Security permission in input
* @return True if user is permitted
*/
public boolean isUserPermitted(SecureServicePermission inPermission) {
String principalName = AuthorizationController.getPrincipalName(this.securityContext);
// 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()) || hasRole(inPermission.getKeyAllInstance())) {
auditLogger.info("{} authorized because user has permission with * for instance: {}",
principalName, inPermission.getKey().replace("|", ":"));
return true;
// the rest of these don't seem to be required - isUserInRole method
// appears to take * as a wildcard
} else if (hasRole(inPermission.getKeyAllInstanceAction())) {
auditLogger.info(
"{} authorized because user has permission with * for instance and * for action: {}",
principalName, inPermission.getKey().replace("|", ":"));
return true;
} else if (hasRole(inPermission.getKeyAllAction())) {
auditLogger.info("{} authorized because user has permission with * for action: {}",
principalName, inPermission.getKey().replace("|", ":"));
return true;
} else {
return false;
}
}
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;
}
/**
* Gets clds info. CLDS IFO service will return 3 things 1. User Name 2. CLDS
* code version that is currently installed from pom.xml file 3. User
* permissions
*
* @return the clds info
*/
public ClampInformation getClampInformation() {
ClampInformation clampInfo = new ClampInformation();
Authentication authentication = securityContext.getAuthentication();
if (authentication == null) {
return new ClampInformation();
}
clampInfo.setUserName(AuthorizationController.getPrincipalName(this.securityContext));
for (GrantedAuthority auth : authentication.getAuthorities()) {
clampInfo.getAllPermissions().add(auth.getAuthority());
}
return clampInfo;
}
}
|
