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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
// Copyright 2018 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.http.filter.security.athenz;
import com.google.inject.Inject;
import com.yahoo.jdisc.Metric;
import com.yahoo.jdisc.http.filter.DiscFilterRequest;
import com.yahoo.jdisc.http.filter.security.athenz.RequestResourceMapper.ResourceNameAndAction;
import com.yahoo.jdisc.http.filter.security.base.JsonSecurityRequestFilterBase;
import com.yahoo.log.LogLevel;
import com.yahoo.vespa.athenz.api.AthenzAccessToken;
import com.yahoo.vespa.athenz.api.AthenzIdentity;
import com.yahoo.vespa.athenz.api.AthenzPrincipal;
import com.yahoo.vespa.athenz.api.ZToken;
import com.yahoo.vespa.athenz.tls.AthenzX509CertificateUtils;
import com.yahoo.vespa.athenz.utils.AthenzIdentities;
import com.yahoo.vespa.athenz.zpe.AuthorizationResult;
import com.yahoo.vespa.athenz.zpe.DefaultZpe;
import com.yahoo.vespa.athenz.zpe.Zpe;
import java.security.cert.X509Certificate;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import static com.yahoo.jdisc.Response.Status.FORBIDDEN;
import static com.yahoo.jdisc.Response.Status.UNAUTHORIZED;
import static com.yahoo.jdisc.http.filter.security.athenz.AthenzAuthorizationFilterConfig.EnabledCredentials;
import static com.yahoo.jdisc.http.filter.security.athenz.AthenzAuthorizationFilterConfig.EnabledCredentials.ACCESS_TOKEN;
import static com.yahoo.jdisc.http.filter.security.athenz.AthenzAuthorizationFilterConfig.EnabledCredentials.ROLE_CERTIFICATE;
import static com.yahoo.jdisc.http.filter.security.athenz.AthenzAuthorizationFilterConfig.EnabledCredentials.ROLE_TOKEN;
/**
* An Athenz security filter that uses a configured action and resource name to control access.
*
* @author bjorncs
*/
public class AthenzAuthorizationFilter extends JsonSecurityRequestFilterBase {
private static final String ATTRIBUTE_PREFIX = "jdisc-security-filters.athenz-authorization-filter";
public static final String RESULT_ATTRIBUTE = ATTRIBUTE_PREFIX + ".result";
public static final String MATCHED_ROLE_ATTRIBUTE = ATTRIBUTE_PREFIX + ".matched-role";
public static final String IDENTITY_NAME_ATTRIBUTE = ATTRIBUTE_PREFIX + ".identity-name";
public static final String MATCHED_CREDENTIAL_TYPE_ATTRIBUTE = ATTRIBUTE_PREFIX + ".credentials-type";
private static final String ACCEPTED_METRIC_NAME = "jdisc.http.filter.athenz.accepted_requests";
private static final String REJECTED_METRIC_NAME = "jdisc.http.filter.athenz.rejected_requests";
private static final Logger log = Logger.getLogger(AthenzAuthorizationFilter.class.getName());
private final String roleTokenHeaderName;
private final EnumSet<EnabledCredentials.Enum> enabledCredentials;
private final Zpe zpe;
private final RequestResourceMapper requestResourceMapper;
private final Metric metric;
@Inject
public AthenzAuthorizationFilter(AthenzAuthorizationFilterConfig config, RequestResourceMapper resourceMapper, Metric metric) {
this(config, resourceMapper, new DefaultZpe(), metric);
}
public AthenzAuthorizationFilter(AthenzAuthorizationFilterConfig config,
RequestResourceMapper resourceMapper,
Zpe zpe,
Metric metric) {
this.roleTokenHeaderName = config.roleTokenHeaderName();
List<EnabledCredentials.Enum> enabledCredentials = config.enabledCredentials();
this.enabledCredentials = enabledCredentials.isEmpty()
? EnumSet.allOf(EnabledCredentials.Enum.class)
: EnumSet.copyOf(enabledCredentials);
this.requestResourceMapper = resourceMapper;
this.zpe = zpe;
this.metric = metric;
}
@Override
public Optional<ErrorResponse> filter(DiscFilterRequest request) {
try {
Optional<ResourceNameAndAction> resourceMapping =
requestResourceMapper.getResourceNameAndAction(request.getMethod(), request.getRequestURI(), request.getQueryString());
log.log(LogLevel.DEBUG, () -> String.format("Resource mapping for '%s': %s", request, resourceMapping));
if (resourceMapping.isEmpty()) {
incrementAcceptedMetrics(request, false);
return Optional.empty();
}
Result result = checkAccessAllowed(request, resourceMapping.get());
AuthorizationResult.Type resultType = result.zpeResult.type();
setAttribute(request, RESULT_ATTRIBUTE, resultType.name());
if (resultType == AuthorizationResult.Type.ALLOW) {
populateRequestWithResult(request, result);
incrementAcceptedMetrics(request, true);
return Optional.empty();
}
log.log(LogLevel.DEBUG, () -> String.format("Forbidden (403) for '%s': %s", request, resultType.name()));
incrementRejectedMetrics(request, FORBIDDEN, resultType.name());
return Optional.of(new ErrorResponse(FORBIDDEN, "Access forbidden: " + resultType.getDescription()));
} catch (IllegalArgumentException e) {
log.log(LogLevel.DEBUG, () -> String.format("Unauthorized (401) for '%s': %s", request, e.getMessage()));
incrementRejectedMetrics(request, UNAUTHORIZED, "Unauthorized");
return Optional.of(new ErrorResponse(UNAUTHORIZED, e.getMessage()));
}
}
private Result checkAccessAllowed(DiscFilterRequest request, ResourceNameAndAction resourceAndAction) {
// Note: the ordering of the if-constructs determines the precedence of the credential types
if (enabledCredentials.contains(ACCESS_TOKEN)
&& isAccessTokenPresent(request)
&& isClientCertificatePresent(request)) {
return checkAccessWithAccessToken(request, resourceAndAction);
} else if (enabledCredentials.contains(ROLE_CERTIFICATE)
&& isClientCertificatePresent(request)) {
return checkAccessWithRoleCertificate(request, resourceAndAction);
} else if (enabledCredentials.contains(ROLE_TOKEN)
&& isRoleTokenPresent(request)) {
return checkAccessWithRoleToken(request, resourceAndAction);
} else {
throw new IllegalArgumentException(
"Not authorized - request did not contain any of the allowed credentials: " + toPrettyString(enabledCredentials));
}
}
private Result checkAccessWithAccessToken(DiscFilterRequest request, ResourceNameAndAction resourceAndAction) {
AthenzAccessToken accessToken = getAccessToken(request);
X509Certificate identityCertificate = getClientCertificate(request);
var zpeResult = zpe.checkAccessAllowed(
accessToken, identityCertificate, resourceAndAction.resourceName(), resourceAndAction.action());
return new Result(ACCESS_TOKEN, AthenzIdentities.from(identityCertificate), zpeResult);
}
private Result checkAccessWithRoleCertificate(DiscFilterRequest request, ResourceNameAndAction resourceAndAction) {
X509Certificate roleCertificate = getClientCertificate(request);
var zpeResult = zpe.checkAccessAllowed(roleCertificate, resourceAndAction.resourceName(), resourceAndAction.action());
AthenzIdentity identity = AthenzX509CertificateUtils.getIdentityFromRoleCertificate(roleCertificate);
return new Result(ROLE_CERTIFICATE, identity, zpeResult);
}
private Result checkAccessWithRoleToken(DiscFilterRequest request, ResourceNameAndAction resourceAndAction) {
ZToken roleToken = getRoleToken(request);
var zpeResult = zpe.checkAccessAllowed(roleToken, resourceAndAction.resourceName(), resourceAndAction.action());
return new Result(ROLE_TOKEN, roleToken.getIdentity(), zpeResult);
}
private static boolean isAccessTokenPresent(DiscFilterRequest request) {
return request.getHeader(AthenzAccessToken.HTTP_HEADER_NAME) != null;
}
private static boolean isClientCertificatePresent(DiscFilterRequest request) {
return !request.getClientCertificateChain().isEmpty();
}
private boolean isRoleTokenPresent(DiscFilterRequest request) {
return request.getHeader(roleTokenHeaderName) != null;
}
private static AthenzAccessToken getAccessToken(DiscFilterRequest request) {
return new AthenzAccessToken(request.getHeader(AthenzAccessToken.HTTP_HEADER_NAME));
}
private static X509Certificate getClientCertificate(DiscFilterRequest request) {
return request.getClientCertificateChain().get(0);
}
private ZToken getRoleToken(DiscFilterRequest request) {
return new ZToken(request.getHeader(roleTokenHeaderName));
}
private static String toPrettyString(EnumSet<EnabledCredentials.Enum> enabledCredentialSet) {
return enabledCredentialSet.stream()
.map(AthenzAuthorizationFilter::toPrettyString)
.collect(Collectors.joining(", ", "[", "]"));
}
private static String toPrettyString(EnabledCredentials.Enum enabledCredential) {
switch (enabledCredential) {
case ACCESS_TOKEN:
return "Athenz access token with X.509 identity certificate";
case ROLE_TOKEN:
return "Athenz role token (ZToken)";
case ROLE_CERTIFICATE:
return "Athenz X.509 role certificate";
default:
throw new IllegalArgumentException("Unknown credential type: " + enabledCredential);
}
}
private static void populateRequestWithResult(DiscFilterRequest request, Result result) {
request.setUserPrincipal(
new AthenzPrincipal(result.identity, result.zpeResult.matchedRole().map(List::of).orElse(List.of())));
result.zpeResult.matchedRole().ifPresent(role -> {
request.setUserRoles(new String[]{role.roleName()});
setAttribute(request, MATCHED_ROLE_ATTRIBUTE, role.roleName());
});
setAttribute(request, IDENTITY_NAME_ATTRIBUTE, result.identity.getFullName());
setAttribute(request, MATCHED_CREDENTIAL_TYPE_ATTRIBUTE, result.credentialType.name());
}
private static void setAttribute(DiscFilterRequest request, String name, String value) {
log.log(LogLevel.DEBUG, () -> String.format("Setting attribute on '%s': '%s' = '%s'", request, name, value));
request.setAttribute(name, value);
}
private void incrementAcceptedMetrics(DiscFilterRequest request, boolean authzRequired) {
String hostHeader = request.getHeader("Host");
Metric.Context context = metric.createContext(Map.of(
"endpoint", hostHeader != null ? hostHeader : "",
"authz-required", Boolean.toString(authzRequired)));
metric.add(ACCEPTED_METRIC_NAME, 1L, context);
}
private void incrementRejectedMetrics(DiscFilterRequest request, int statusCode, String zpeCode) {
String hostHeader = request.getHeader("Host");
Metric.Context context = metric.createContext(Map.of(
"endpoint", hostHeader != null ? hostHeader : "",
"status-code", Integer.toString(statusCode),
"zpe-status", zpeCode));
metric.add(REJECTED_METRIC_NAME, 1L, context);
}
private static class Result {
final EnabledCredentials.Enum credentialType;
final AthenzIdentity identity;
final AuthorizationResult zpeResult;
Result(EnabledCredentials.Enum credentialType, AthenzIdentity identity, AuthorizationResult zpeResult) {
this.credentialType = credentialType;
this.identity = identity;
this.zpeResult = zpeResult;
}
}
}
|
