-
Notifications
You must be signed in to change notification settings - Fork 214
/
PoliciesRoute.java
executable file
·320 lines (283 loc) · 15.4 KB
/
PoliciesRoute.java
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.gateway.service.endpoints.routes.policies;
import static org.eclipse.ditto.base.model.exceptions.DittoJsonException.wrapJsonRuntimeException;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.gateway.service.endpoints.routes.AbstractRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.RouteBaseProperties;
import org.eclipse.ditto.gateway.service.security.authentication.AuthenticationResult;
import org.eclipse.ditto.gateway.service.security.authentication.jwt.JwtAuthenticationResult;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.jwt.model.JsonWebToken;
import org.eclipse.ditto.placeholders.UnresolvedPlaceholderException;
import org.eclipse.ditto.policies.model.Label;
import org.eclipse.ditto.policies.model.PoliciesModelFactory;
import org.eclipse.ditto.policies.model.Policy;
import org.eclipse.ditto.policies.model.PolicyId;
import org.eclipse.ditto.policies.model.Subject;
import org.eclipse.ditto.policies.model.SubjectAnnouncement;
import org.eclipse.ditto.policies.model.SubjectExpiry;
import org.eclipse.ditto.policies.model.SubjectId;
import org.eclipse.ditto.policies.model.signals.commands.actions.ActivateTokenIntegration;
import org.eclipse.ditto.policies.model.signals.commands.actions.DeactivateTokenIntegration;
import org.eclipse.ditto.policies.model.signals.commands.actions.TopLevelPolicyActionCommand;
import org.eclipse.ditto.policies.model.signals.commands.exceptions.PolicyActionFailedException;
import org.eclipse.ditto.policies.model.signals.commands.exceptions.PolicyIdNotExplicitlySettableException;
import org.eclipse.ditto.policies.model.signals.commands.modify.CreatePolicy;
import org.eclipse.ditto.policies.model.signals.commands.modify.DeletePolicy;
import org.eclipse.ditto.policies.model.signals.commands.modify.ModifyPolicy;
import org.eclipse.ditto.policies.model.signals.commands.query.RetrievePolicy;
import org.apache.pekko.http.javadsl.server.PathMatchers;
import org.apache.pekko.http.javadsl.server.RequestContext;
import org.apache.pekko.http.javadsl.server.Route;
/**
* Builder for creating Akka HTTP routes for {@code /policies}.
*/
public final class PoliciesRoute extends AbstractRoute {
private static final String PATH_ACTIONS = "actions";
public static final String PATH_POLICIES = "policies";
private static final String PATH_IMPORTS = "imports";
private static final String PATH_ENTRIES = "entries";
private static final Label DUMMY_LABEL = Label.of("-");
private static final JsonFieldDefinition<JsonObject> ACTION_ACTIVATE_TOKEN_INTEGRATION_ANNOUNCEMENT =
Subject.JsonFields.ANNOUNCEMENT;
private final PolicyEntriesRoute policyEntriesRoute;
private final PolicyImportsRoute policyImportsRoute;
private final TokenIntegrationSubjectIdFactory tokenIntegrationSubjectIdFactory;
/**
* Constructs a {@code PoliciesRoute} object.
*
* @param routeBaseProperties the base properties of the route.
* @param tokenIntegrationSubjectIdFactory factory of resolvers for placeholders.
* @throws NullPointerException if any argument is {@code null}.
*/
public PoliciesRoute(final RouteBaseProperties routeBaseProperties,
final TokenIntegrationSubjectIdFactory tokenIntegrationSubjectIdFactory) {
super(routeBaseProperties);
policyEntriesRoute = new PolicyEntriesRoute(routeBaseProperties, tokenIntegrationSubjectIdFactory);
policyImportsRoute = new PolicyImportsRoute(routeBaseProperties);
this.tokenIntegrationSubjectIdFactory = tokenIntegrationSubjectIdFactory;
}
/**
* Builds the {@code /policies} route.
*
* @return the {@code /policies} route.
*/
public Route buildPoliciesRoute(final RequestContext ctx, final DittoHeaders dittoHeaders,
final AuthenticationResult authenticationResult) {
return rawPathPrefix(PathMatchers.slash().concat(PATH_POLICIES), () ->
concat(
policies(ctx, dittoHeaders),
rawPathPrefix(PathMatchers.slash().concat(PathMatchers.segment()), policyId ->
// /policies/<policyId>
policyRoute(ctx, dittoHeaders, PolicyId.of(policyId), authenticationResult)
)
)
);
}
/*
* Describes {@code /policies} route.
*
* @return {@code /policies} route.
*/
private Route policies(final RequestContext ctx, final DittoHeaders dittoHeaders) {
return pathEndOrSingleSlash(() ->
// POST /policies
post(() -> buildPostPoliciesRoute(ctx, dittoHeaders))
);
}
private Route buildPostPoliciesRoute(final RequestContext ctx, final DittoHeaders dittoHeaders) {
return ensureMediaTypeJsonWithFallbacksThenExtractDataBytes(ctx, dittoHeaders,
payloadSource ->
handlePerRequest(ctx, dittoHeaders, payloadSource, policyJson ->
CreatePolicy.of(createPolicyForPost(policyJson), dittoHeaders)
)
);
}
private Route policyRoute(final RequestContext ctx, final DittoHeaders dittoHeaders, final PolicyId policyId,
final AuthenticationResult authenticationResult) {
return concat(
policyId(ctx, dittoHeaders, policyId),
policyImports(ctx, dittoHeaders, policyId),
policyEntries(ctx, dittoHeaders, policyId, authenticationResult),
policyActions(ctx, dittoHeaders, policyId, authenticationResult)
);
}
/*
* Describes {@code /policies/<policyId>} route.
* @return {@code /policies/<policyId>} route.
*/
private Route policyId(final RequestContext ctx, final DittoHeaders dittoHeaders, final PolicyId policyId) {
return pathEndOrSingleSlash(() ->
concat(
// GET /policies/<policyId>?fields=<fieldsString>
get(() -> parameterList(PoliciesParameter.FIELDS.toString(), fields ->
handlePerRequest(ctx, RetrievePolicy.of(policyId, dittoHeaders,
calculateSelectedFields(fields).orElse(null)))
)),
put(() -> // PUT /policies/<policyId>
ensureMediaTypeJsonWithFallbacksThenExtractDataBytes(ctx, dittoHeaders,
payloadSource ->
handlePerRequest(ctx, dittoHeaders, payloadSource,
policyJson -> ModifyPolicy
.of(policyId, PoliciesModelFactory.newPolicy(
createPolicyJsonObjectForPut(policyJson,
policyId)),
dittoHeaders)
)
)
),
delete(() -> // DELETE /policies/<policyId>
handlePerRequest(ctx, DeletePolicy.of(policyId, dittoHeaders))
)
)
);
}
private static Policy createPolicyForPost(final String jsonString) {
final JsonObject policyJsonObject = wrapJsonRuntimeException(() -> JsonFactory.newObject(jsonString));
if (policyJsonObject.contains(Policy.JsonFields.ID.getPointer())) {
throw PolicyIdNotExplicitlySettableException.forPostMethod().build();
}
return PoliciesModelFactory.newPolicy(policyJsonObject)
.toBuilder()
.setId(PolicyId.generateRandom())
.build();
}
private static JsonObject createPolicyJsonObjectForPut(final String jsonString, final PolicyId policyId) {
final JsonObject policyJsonObject = wrapJsonRuntimeException(() -> JsonFactory.newObject(jsonString));
policyJsonObject.getValue(Policy.JsonFields.ID.getPointer())
.ifPresent(policyIdJsonValue -> {
if (!policyIdJsonValue.isString() || !policyId.toString().equals(policyIdJsonValue.asString())) {
throw PolicyIdNotExplicitlySettableException.newBuilder().build();
}
});
return policyJsonObject.setValue(Policy.JsonFields.ID.getPointer(), JsonValue.of(policyId));
}
/*
* Describes {@code /policies/<policyId>/imports} route.
*
* @return {@code /policies/<policyId>/imports} route.
*/
private Route policyImports(final RequestContext ctx, final DittoHeaders dittoHeaders, final PolicyId policyId) {
return rawPathPrefix(PathMatchers.slash().concat(PATH_IMPORTS), () -> // /policies/<policyId>/imports
policyImportsRoute.buildPolicyImportsRoute(ctx, dittoHeaders, policyId)
);
}
/*
* Describes {@code /policies/<policyId>/entries} route.
*
* @return {@code /policies/<policyId>/entries} route.
*/
private Route policyEntries(final RequestContext ctx, final DittoHeaders dittoHeaders, final PolicyId policyId,
final AuthenticationResult authResult) {
return rawPathPrefix(PathMatchers.slash().concat(PATH_ENTRIES), () -> // /policies/<policyId>/entries
policyEntriesRoute.buildPolicyEntriesRoute(ctx, dittoHeaders, policyId, authResult)
);
}
/*
* Describes{@code /policies/<policyId>/actions} route.
*/
private Route policyActions(final RequestContext ctx, final DittoHeaders dittoHeaders, final PolicyId policyId,
final AuthenticationResult authenticationResult) {
return rawPathPrefix(PathMatchers.slash().concat(PATH_ACTIONS), () -> concat(
// POST /policies/<policyId>/actions/activateTokenIntegration
rawPathPrefix(PathMatchers.slash().concat(ActivateTokenIntegration.NAME), () ->
pathEndOrSingleSlash(() ->
extractJwt(dittoHeaders, authenticationResult, ActivateTokenIntegration.NAME, jwt ->
post(() -> handleSubjectAnnouncement(this, dittoHeaders, sa ->
topLevelActivateTokenIntegration(dittoHeaders, policyId, jwt, sa))
)
)
)
),
// POST /policies/<policyId>/actions/deactivateTokenIntegration
rawPathPrefix(PathMatchers.slash().concat(DeactivateTokenIntegration.NAME), () ->
pathEndOrSingleSlash(() ->
extractJwt(dittoHeaders, authenticationResult, DeactivateTokenIntegration.NAME, jwt ->
post(() -> handlePerRequest(ctx, topLevelDeactivateTokenIntegration(
dittoHeaders, policyId, jwt)))
)
)
)
));
}
private TopLevelPolicyActionCommand topLevelActivateTokenIntegration(final DittoHeaders dittoHeaders,
final PolicyId policyId, final JsonWebToken jwt, @Nullable final SubjectAnnouncement subjectAnnouncement) {
final Set<SubjectId> subjectIds = resolveSubjectIdsForActivateTokenIntegrationAction(dittoHeaders, jwt);
final SubjectExpiry expiry = SubjectExpiry.newInstance(jwt.getExpirationTime());
final ActivateTokenIntegration activateTokenIntegration =
ActivateTokenIntegration.of(policyId, DUMMY_LABEL, subjectIds, expiry, subjectAnnouncement,
dittoHeaders);
return TopLevelPolicyActionCommand.of(activateTokenIntegration, List.of());
}
private TopLevelPolicyActionCommand topLevelDeactivateTokenIntegration(final DittoHeaders dittoHeaders,
final PolicyId policyId, final JsonWebToken jwt) {
final Set<SubjectId> subjectIds = resolveSubjectIdsForActivateTokenIntegrationAction(dittoHeaders, jwt);
final DeactivateTokenIntegration deactivateTokenIntegration =
DeactivateTokenIntegration.of(policyId, DUMMY_LABEL, subjectIds, dittoHeaders);
return TopLevelPolicyActionCommand.of(deactivateTokenIntegration, List.of());
}
private Set<SubjectId> resolveSubjectIdsForActivateTokenIntegrationAction(final DittoHeaders dittoHeaders,
final JsonWebToken jwt) {
try {
return tokenIntegrationSubjectIdFactory.getSubjectIds(dittoHeaders, jwt);
} catch (final UnresolvedPlaceholderException e) {
throw PolicyActionFailedException.newBuilder()
.action(ActivateTokenIntegration.NAME)
.status(HttpStatus.BAD_REQUEST)
.description("Mandatory placeholders could not be resolved, in detail: " + e.getMessage())
.dittoHeaders(dittoHeaders)
.build();
}
}
@Nullable
private static SubjectAnnouncement toSubjectAnnouncement(final String body) {
if (body.isEmpty()) {
return null;
} else {
final Optional<JsonObject> announcement = JsonObject.of(body)
.getValue(ACTION_ACTIVATE_TOKEN_INTEGRATION_ANNOUNCEMENT);
return announcement.map(SubjectAnnouncement::fromJson).orElse(null);
}
}
static Route extractJwt(final DittoHeaders dittoHeaders,
final AuthenticationResult authResult,
final String actionName,
final Function<JsonWebToken, Route> inner) {
if (authResult instanceof JwtAuthenticationResult jwtAuthenticationResult) {
final Optional<JsonWebToken> jwtOptional = jwtAuthenticationResult.getJwt();
if (jwtOptional.isPresent()) {
return inner.apply(jwtOptional.get());
}
}
throw PolicyActionFailedException.newBuilderForInappropriateAuthenticationMethod(actionName)
.dittoHeaders(dittoHeaders)
.build();
}
static Route handleSubjectAnnouncement(final AbstractRoute route, final DittoHeaders dittoHeaders,
final Function<SubjectAnnouncement, Command<?>> commandConstructor) {
return route.extractRequestContext(context ->
route.handlePerRequest(context, dittoHeaders, context.getRequest().entity().getDataBytes(),
body -> commandConstructor.apply(toSubjectAnnouncement(body))));
}
}