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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.http.filter.security.cloud;
import com.yahoo.container.jdisc.AclMapping.Action;
import com.yahoo.container.jdisc.HttpMethodAclMapping;
import com.yahoo.container.jdisc.RequestHandlerSpec;
import com.yahoo.container.jdisc.RequestHandlerTestDriver.MockResponseHandler;
import com.yahoo.container.logging.AccessLogEntry;
import com.yahoo.jdisc.http.HttpRequest.Method;
import com.yahoo.jdisc.http.filter.security.cloud.CloudDataPlaneFilter.ClientPrincipal;
import com.yahoo.jdisc.http.filter.security.cloud.config.CloudDataPlaneFilterConfig;
import com.yahoo.jdisc.http.filter.util.FilterTestUtils;
import com.yahoo.security.KeyUtils;
import com.yahoo.security.X509CertificateBuilder;
import com.yahoo.security.X509CertificateUtils;
import com.yahoo.security.token.Token;
import com.yahoo.security.token.TokenCheckHash;
import com.yahoo.security.token.TokenDomain;
import com.yahoo.security.token.TokenGenerator;
import org.junit.jupiter.api.Test;
import javax.security.auth.x500.X500Principal;
import java.math.BigInteger;
import java.security.cert.X509Certificate;
import java.util.List;
import java.util.Set;
import static com.yahoo.jdisc.Response.Status.FORBIDDEN;
import static com.yahoo.jdisc.Response.Status.UNAUTHORIZED;
import static com.yahoo.jdisc.http.filter.security.cloud.CloudDataPlaneFilter.Permission.READ;
import static com.yahoo.jdisc.http.filter.security.cloud.CloudDataPlaneFilter.Permission.WRITE;
import static com.yahoo.security.KeyAlgorithm.EC;
import static com.yahoo.security.SignatureAlgorithm.SHA256_WITH_ECDSA;
import static java.time.Instant.EPOCH;
import static java.time.temporal.ChronoUnit.DAYS;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
/**
* @author bjorncs
*/
class CloudDataPlaneFilterTest {
private static final X509Certificate FEED_CERT = certificate("my-feed-client");
private static final X509Certificate SEARCH_CERT = certificate("my-search-client");
private static final X509Certificate LEGACY_CLIENT_CERT = certificate("my-legacy-client");
private static final X509Certificate REVERSE_PROXY_CERT = certificate("nginx");
private static final String FEED_CLIENT_ID = "feed-client";
private static final String MTLS_SEARCH_CLIENT_ID = "mtls-search-client";
private static final String TOKEN_SEARCH_CLIENT = "token-search-client";
private static final String TOKEN_CONTEXT = "my-token-context";
private static final String TOKEN_ID = "my-token-id";
private static final Token VALID_TOKEN =
TokenGenerator.generateToken(TokenDomain.of("fp-ctx", TOKEN_CONTEXT), "vespa_token_", 32);
private static final Token UNKNOWN_TOKEN =
TokenGenerator.generateToken(TokenDomain.of("fp-ctx", TOKEN_CONTEXT), "vespa_token_", 32);
@Test
void accepts_any_trusted_client_certificate_in_legacy_mode() {
var req = FilterTestUtils.newRequestBuilder().withClientCertificate(LEGACY_CLIENT_CERT).build();
var responseHandler = new MockResponseHandler();
newFilterWithLegacyMode().filter(req, responseHandler);
assertNull(responseHandler.getResponse());
assertEquals(new ClientPrincipal(Set.of(), Set.of(READ, WRITE)), req.getUserPrincipal());
}
@Test
void fails_on_missing_certificate_in_legacy_mode() {
var req = FilterTestUtils.newRequestBuilder().build();
var responseHandler = new MockResponseHandler();
newFilterWithLegacyMode().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(UNAUTHORIZED, responseHandler.getResponse().getStatus());
}
@Test
void accepts_client_with_valid_certificate() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.POST)
.withClientCertificate(FEED_CERT)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNull(responseHandler.getResponse());
assertEquals(new ClientPrincipal(Set.of(FEED_CLIENT_ID), Set.of(WRITE)), req.getUserPrincipal());
}
@Test
void fails_on_client_with_invalid_permissions() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.POST)
.withClientCertificate(SEARCH_CERT)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void supports_handler_with_custom_request_spec() {
// Spec that maps POST as action 'read'
var spec = RequestHandlerSpec.builder()
.withAclMapping(HttpMethodAclMapping.standard()
.override(Method.POST, Action.READ).build())
.build();
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.POST)
.withClientCertificate(SEARCH_CERT)
.withAttribute(RequestHandlerSpec.ATTRIBUTE_NAME, spec)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNull(responseHandler.getResponse());
assertEquals(new ClientPrincipal(Set.of(MTLS_SEARCH_CLIENT_ID), Set.of(READ)), req.getUserPrincipal());
}
@Test
void fails_on_handler_with_custom_request_spec_with_invalid_action() {
// Spec that maps POST as action 'read'
var spec = RequestHandlerSpec.builder()
.withAclMapping(HttpMethodAclMapping.standard()
.override(Method.GET, Action.custom("custom")).build())
.build();
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withClientCertificate(SEARCH_CERT)
.withAttribute(RequestHandlerSpec.ATTRIBUTE_NAME, spec)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void accepts_reverse_proxy_with_token() {
var entry = new AccessLogEntry();
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withAccessLogEntry(entry)
.withClientCertificate(REVERSE_PROXY_CERT)
.withHeader("Authorization", "Bearer " + VALID_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNull(responseHandler.getResponse());
assertEquals(new ClientPrincipal(Set.of(TOKEN_SEARCH_CLIENT), Set.of(READ)), req.getUserPrincipal());
assertEquals(TOKEN_ID, entry.getKeyValues().get("token.id").get(0));
assertEquals(VALID_TOKEN.fingerprint().toDelimitedHexString(), entry.getKeyValues().get("token.hash").get(0));
}
@Test
void fails_for_reverse_proxy_with_token_wrong_permission() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.POST)
.withClientCertificate(REVERSE_PROXY_CERT)
.withHeader("Authorization", "Bearer " + VALID_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void fails_for_reverse_proxy_without_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withClientCertificate(REVERSE_PROXY_CERT)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void fails_for_reverse_proxy_with_unknown_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withClientCertificate(REVERSE_PROXY_CERT)
.withHeader("Authorization", "Bearer " + UNKNOWN_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void fails_for_reverse_proxy_without_configured_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withClientCertificate(REVERSE_PROXY_CERT)
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void fails_for_missing_certificate_with_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withHeader("Authorization", "Bearer " + VALID_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(UNAUTHORIZED, responseHandler.getResponse().getStatus());
}
@Test
void fails_for_unknown_certificate_with_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.GET)
.withClientCertificate(LEGACY_CLIENT_CERT)
.withHeader("Authorization", "Bearer " + VALID_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNotNull(responseHandler.getResponse());
assertEquals(FORBIDDEN, responseHandler.getResponse().getStatus());
}
@Test
void certificate_has_precedence_over_token() {
var req = FilterTestUtils.newRequestBuilder()
.withMethod(Method.POST)
.withClientCertificate(FEED_CERT)
.withHeader("Authorization", "Bearer " + VALID_TOKEN.secretTokenString())
.build();
var responseHandler = new MockResponseHandler();
newFilterWithClientsConfig().filter(req, responseHandler);
assertNull(responseHandler.getResponse());
assertEquals(new ClientPrincipal(Set.of(FEED_CLIENT_ID), Set.of(WRITE)), req.getUserPrincipal());
}
private static CloudDataPlaneFilter newFilterWithLegacyMode() {
return new CloudDataPlaneFilter(
new CloudDataPlaneFilterConfig.Builder()
.legacyMode(true).build(), (X509Certificate) null);
}
private static CloudDataPlaneFilter newFilterWithClientsConfig() {
return new CloudDataPlaneFilter(
new CloudDataPlaneFilterConfig.Builder()
.tokenContext(TOKEN_CONTEXT)
.clients(List.of(
new CloudDataPlaneFilterConfig.Clients.Builder()
.certificates(X509CertificateUtils.toPem(FEED_CERT))
.permissions(WRITE.asString())
.id(FEED_CLIENT_ID),
new CloudDataPlaneFilterConfig.Clients.Builder()
.certificates(X509CertificateUtils.toPem(SEARCH_CERT))
.permissions(READ.asString())
.id(MTLS_SEARCH_CLIENT_ID),
new CloudDataPlaneFilterConfig.Clients.Builder()
.tokens(new CloudDataPlaneFilterConfig.Clients.Tokens.Builder()
.id(TOKEN_ID)
.checkAccessHashes(TokenCheckHash.of(VALID_TOKEN, 32).toHexString())
.fingerprints(VALID_TOKEN.fingerprint().toDelimitedHexString()))
.permissions(READ.asString())
.id(TOKEN_SEARCH_CLIENT)))
.build(),
REVERSE_PROXY_CERT);
}
private static X509Certificate certificate(String name) {
var key = KeyUtils.generateKeypair(EC);
var subject = new X500Principal("CN=%s".formatted(name));
return X509CertificateBuilder
.fromKeypair(key, subject, EPOCH, EPOCH.plus(1, DAYS), SHA256_WITH_ECDSA, BigInteger.ONE).build();
}
}
|
