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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.restapi.controller;
import com.yahoo.component.Version;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.zone.ZoneId;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.container.jdisc.HttpResponse;
import com.yahoo.container.jdisc.ThreadedHttpRequestHandler;
import com.yahoo.container.jdisc.secretstore.SecretStore;
import com.yahoo.restapi.ErrorResponse;
import com.yahoo.restapi.MessageResponse;
import com.yahoo.restapi.Path;
import com.yahoo.restapi.ResourceResponse;
import com.yahoo.restapi.RestApiException;
import com.yahoo.security.X509CertificateUtils;
import com.yahoo.slime.Inspector;
import com.yahoo.slime.SlimeUtils;
import com.yahoo.text.Text;
import com.yahoo.vespa.athenz.api.AthenzUser;
import com.yahoo.vespa.hosted.controller.Controller;
import com.yahoo.vespa.hosted.controller.api.identifiers.DeploymentId;
import com.yahoo.vespa.hosted.controller.api.integration.deployment.JobId;
import com.yahoo.vespa.hosted.controller.auditlog.AuditLoggingRequestHandler;
import com.yahoo.vespa.hosted.controller.config.CoreDumpTokenResealingConfig;
import com.yahoo.vespa.hosted.controller.maintenance.ControllerMaintenance;
import com.yahoo.vespa.hosted.controller.maintenance.Upgrader;
import com.yahoo.vespa.hosted.controller.restapi.ErrorResponses;
import com.yahoo.vespa.hosted.controller.support.access.SupportAccess;
import com.yahoo.vespa.hosted.controller.versions.VespaVersion.Confidence;
import com.yahoo.yolean.Exceptions;
import java.io.InputStream;
import java.security.Principal;
import java.security.cert.X509Certificate;
import java.time.Instant;
import java.util.Optional;
import java.util.Scanner;
import static com.yahoo.vespa.hosted.controller.restapi.controller.RequestUtils.requireField;
import static com.yahoo.vespa.hosted.controller.restapi.controller.RequestUtils.toJsonBytes;
/**
* This implements the controller/v1 API which provides operators with information about,
* and control over the Controller.
*
* @author bratseth
*/
@SuppressWarnings("unused") // Created by injection
public class ControllerApiHandler extends AuditLoggingRequestHandler {
private final ControllerMaintenance maintenance;
private final Controller controller;
private final SecretStore secretStore;
private final CoreDumpTokenResealingConfig tokenResealingConfig;
public ControllerApiHandler(ThreadedHttpRequestHandler.Context parentCtx,
Controller controller,
ControllerMaintenance maintenance,
SecretStore secretStore,
CoreDumpTokenResealingConfig tokenResealingConfig) {
super(parentCtx, controller.auditLogger());
this.controller = controller;
this.maintenance = maintenance;
this.secretStore = secretStore;
this.tokenResealingConfig = tokenResealingConfig;
}
@Override
public HttpResponse auditAndHandle(HttpRequest request) {
try {
return switch (request.getMethod()) {
case GET -> get(request);
case POST -> post(request);
case DELETE -> delete(request);
case PATCH -> patch(request);
default -> ErrorResponse.methodNotAllowed("Method '" + request.getMethod() + "' is not supported");
};
}
catch (IllegalArgumentException e) {
return ErrorResponse.badRequest(Exceptions.toMessageString(e));
}
catch (RuntimeException e) {
return ErrorResponses.logThrowing(request, log, e);
}
}
private HttpResponse get(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/controller/v1/")) return root(request);
if (path.matches("/controller/v1/auditlog/")) return new AuditLogResponse(controller.auditLogger().readLog());
if (path.matches("/controller/v1/maintenance/")) return new JobsResponse(controller.jobControl());
if (path.matches("/controller/v1/stats")) return new StatsResponse(controller);
if (path.matches("/controller/v1/jobs/upgrader")) return new UpgraderResponse(maintenance.upgrader());
if (path.matches("/controller/v1/metering/tenant/{tenant}/month/{month}")) return new MeteringResponse(controller.serviceRegistry().resourceDatabase(), path.get("tenant"), path.get("month"));
return notFound(path);
}
private HttpResponse post(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/controller/v1/jobs/upgrader/confidence/{version}")) return overrideConfidence(request, path.get("version"));
if (path.matches("/controller/v1/access/requests/{user}")) return approveMembership(request, path.get("user"));
if (path.matches("/controller/v1/access/grants/{user}")) return grantAccess(request, path.get("user"));
if (path.matches("/controller/v1/access/cores/reseal")) return DecryptionTokenResealer.handleResealRequest(request, tokenResealingConfig.resealingPrivateKeyName(), secretStore);
return notFound(path);
}
private HttpResponse approveMembership(HttpRequest request, String user) {
AthenzUser athenzUser = AthenzUser.fromUserId(user);
byte[] jsonBytes = toJsonBytes(request.getData());
Inspector inspector = SlimeUtils.jsonToSlime(jsonBytes).get();
ApplicationId applicationId = requireField(inspector, "applicationId", ApplicationId::fromSerializedForm);
ZoneId zone = requireField(inspector, "zone", ZoneId::from);
if(controller.supportAccess().allowDataplaneMembership(athenzUser, new DeploymentId(applicationId, zone))) {
return new AccessRequestResponse(controller.serviceRegistry().accessControlService().listMembers());
} else {
return new MessageResponse(400, "Unable to approve membership request");
}
}
private HttpResponse grantAccess(HttpRequest request, String user) {
Principal principal = requireUserPrincipal(request);
Instant now = controller.clock().instant();
byte[] jsonBytes = toJsonBytes(request.getData());
Inspector requestObject = SlimeUtils.jsonToSlime(jsonBytes).get();
X509Certificate certificate = requireField(requestObject, "certificate", X509CertificateUtils::fromPem);
ApplicationId applicationId = requireField(requestObject, "applicationId", ApplicationId::fromSerializedForm);
ZoneId zone = requireField(requestObject, "zone", ZoneId::from);
DeploymentId deployment = new DeploymentId(applicationId, zone);
// Register grant
SupportAccess supportAccess = controller.supportAccess().registerGrant(deployment, principal.getName(), certificate);
// Trigger deployment to include operator cert
Optional<JobId> jobId = controller.applications().deploymentTrigger().reTriggerOrAddToQueue(deployment, "re-triggered to grant access, by " + request.getJDiscRequest().getUserPrincipal().getName());
return new MessageResponse(
jobId.map(id -> Text.format("Operator %s granted access and job %s triggered", principal.getName(), id.type().jobName()))
.orElseGet(() -> Text.format("Operator %s granted access and job trigger queued", principal.getName())));
}
private HttpResponse delete(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/controller/v1/jobs/upgrader/confidence/{version}")) return removeConfidenceOverride(path.get("version"));
return notFound(path);
}
private HttpResponse patch(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/controller/v1/jobs/upgrader")) return configureUpgrader(request);
return notFound(path);
}
private HttpResponse notFound(Path path) { return ErrorResponse.notFoundError("Nothing at " + path); }
private HttpResponse root(HttpRequest request) {
return new ResourceResponse(request, "auditlog", "maintenance", "stats", "jobs/upgrader", "metering/tenant");
}
private HttpResponse configureUpgrader(HttpRequest request) {
String upgradesPerMinuteField = "upgradesPerMinute";
byte[] jsonBytes = toJsonBytes(request.getData());
Inspector inspect = SlimeUtils.jsonToSlime(jsonBytes).get();
Upgrader upgrader = maintenance.upgrader();
if (inspect.field(upgradesPerMinuteField).valid()) {
upgrader.setUpgradesPerMinute(inspect.field(upgradesPerMinuteField).asDouble());
} else {
return ErrorResponse.badRequest("No such modifiable field(s)");
}
return new UpgraderResponse(maintenance.upgrader());
}
private HttpResponse removeConfidenceOverride(String version) {
maintenance.upgrader().removeConfidenceOverride(Version.fromString(version));
return new UpgraderResponse(maintenance.upgrader());
}
private HttpResponse overrideConfidence(HttpRequest request, String version) {
Confidence confidence = Confidence.valueOf(asString(request.getData()).trim());
maintenance.upgrader().overrideConfidence(Version.fromString(version), confidence);
return new UpgraderResponse(maintenance.upgrader());
}
private static String asString(InputStream in) {
Scanner scanner = new Scanner(in).useDelimiter("\\A");
if (scanner.hasNext()) {
return scanner.next();
}
return "";
}
private static Principal requireUserPrincipal(HttpRequest request) {
Principal principal = request.getJDiscRequest().getUserPrincipal();
if (principal == null) throw new RestApiException.InternalServerError("Expected a user principal");
return principal;
}
}
|
