1 /*******************************************************************************
2 * ============LICENSE_START==================================================
4 * * ===========================================================================
5 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * * ===========================================================================
7 * * Licensed under the Apache License, Version 2.0 (the "License");
8 * * you may not use this file except in compliance with the License.
9 * * You may obtain a copy of the License at
11 * * http://www.apache.org/licenses/LICENSE-2.0
13 * * Unless required by applicable law or agreed to in writing, software
14 * * distributed under the License is distributed on an "AS IS" BASIS,
15 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * * See the License for the specific language governing permissions and
17 * * limitations under the License.
18 * * ============LICENSE_END====================================================
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 ******************************************************************************/
25 package org.onap.dmaap.datarouter.node;
27 import static org.onap.dmaap.datarouter.node.NodeUtils.sendResponseError;
29 import com.att.eelf.configuration.EELFLogger;
30 import com.att.eelf.configuration.EELFManager;
32 import java.io.FileOutputStream;
33 import java.io.FileWriter;
34 import java.io.IOException;
35 import java.io.InputStream;
36 import java.io.OutputStream;
37 import java.io.Writer;
38 import java.nio.file.Files;
39 import java.nio.file.Path;
40 import java.nio.file.Paths;
41 import java.util.Enumeration;
42 import java.util.regex.Pattern;
43 import javax.servlet.http.HttpServlet;
44 import javax.servlet.http.HttpServletRequest;
45 import javax.servlet.http.HttpServletResponse;
46 import org.jetbrains.annotations.Nullable;
47 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
51 * Servlet for handling all http and https requests to the data router node.
53 * <p>Handled requests are:
55 * GET http://<i>node</i>/internal/fetchProv - fetch the provisioning data
57 * PUT/DELETE https://<i>node</i>/internal/publish/<i>fileid</i> - n2n transfer
59 * PUT/DELETE https://<i>node</i>/publish/<i>feedid</i>/<i>fileid</i> - publsh request
61 public class NodeServlet extends HttpServlet {
63 private static final String FROM = " from ";
64 private static final String INVALID_REQUEST_URI = "Invalid request URI. Expecting <feed-publishing-url>/<fileid>.";
65 private static final String IO_EXCEPTION = "IOException";
66 private static final String ON_BEHALF_OF = "X-DMAAP-DR-ON-BEHALF-OF";
67 private static NodeConfigManager config;
68 private static Pattern metaDataPattern;
69 private static EELFLogger eelfLogger = EELFManager.getInstance().getLogger(NodeServlet.class);
72 final String ws = "\\s*";
73 // assume that \\ and \" have been replaced by X
74 final String string = "\"[^\"]*\"";
75 final String number = "[+-]?(?:\\.\\d+|(?:0|[1-9]\\d*)(?:\\.\\d*)?)(?:[eE][+-]?\\d+)?";
76 final String value = "(?:" + string + "|" + number + "|null|true|false)";
77 final String item = string + ws + ":" + ws + value + ws;
78 final String object = ws + "\\{" + ws + "(?:" + item + "(?:" + "," + ws + item + ")*)?\\}" + ws;
79 metaDataPattern = Pattern.compile(object, Pattern.DOTALL);
82 private final Delivery delivery;
84 NodeServlet(Delivery delivery) {
85 this.delivery = delivery;
89 * Get the NodeConfigurationManager.
93 config = NodeConfigManager.getInstance();
94 eelfLogger.info("NODE0101 Node Servlet Configured");
97 private boolean down(HttpServletResponse resp) {
98 if (config.isShutdown() || !config.isConfigured()) {
99 sendResponseError(resp, HttpServletResponse.SC_SERVICE_UNAVAILABLE, eelfLogger);
100 eelfLogger.info("NODE0102 Rejecting request: Service is being quiesced");
107 * Handle a GET for /internal/fetchProv.
110 protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
111 NodeUtils.setIpAndFqdnForEelf("doGet");
112 NodeUtils.setRequestIdAndInvocationId(req);
113 eelfLogger.info(EelfMsgs.ENTRY);
115 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(ON_BEHALF_OF),
116 getIdFromPath(req) + "");
120 String path = req.getPathInfo();
121 String qs = req.getQueryString();
122 String ip = req.getRemoteAddr();
124 path = path + "?" + qs;
126 if ("/internal/fetchProv".equals(path)) {
128 resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
130 } else if (path.startsWith("/internal/resetSubscription/")) {
131 String subid = path.substring(28);
132 if (subid.length() != 0 && subid.indexOf('/') == -1) {
133 NodeMain.resetQueue(subid, ip);
134 resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
139 eelfLogger.info("NODE0103 Rejecting invalid GET of " + path + FROM + ip);
140 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, eelfLogger);
142 eelfLogger.info(EelfMsgs.EXIT);
147 * Handle all PUT requests.
150 protected void doPut(HttpServletRequest req, HttpServletResponse resp) {
151 NodeUtils.setIpAndFqdnForEelf("doPut");
152 NodeUtils.setRequestIdAndInvocationId(req);
153 eelfLogger.info(EelfMsgs.ENTRY);
154 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(ON_BEHALF_OF),
155 getIdFromPath(req) + "");
157 common(req, resp, true);
158 } catch (IOException ioe) {
159 eelfLogger.error(IO_EXCEPTION, ioe);
160 eelfLogger.info(EelfMsgs.EXIT);
165 * Handle all DELETE requests.
168 protected void doDelete(HttpServletRequest req, HttpServletResponse resp) {
169 NodeUtils.setIpAndFqdnForEelf("doDelete");
170 NodeUtils.setRequestIdAndInvocationId(req);
171 eelfLogger.info(EelfMsgs.ENTRY);
172 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(ON_BEHALF_OF),
173 getIdFromPath(req) + "");
175 common(req, resp, false);
176 } catch (IOException ioe) {
177 eelfLogger.error(IO_EXCEPTION, ioe);
178 eelfLogger.info(EelfMsgs.EXIT);
182 private void common(HttpServletRequest req, HttpServletResponse resp, boolean isput) throws IOException {
183 final String PUBLISH = "/publish/";
184 final String INTERNAL_PUBLISH = "/internal/publish/";
185 final String HTTPS = "https://";
186 final String USER = " user ";
187 String fileid = getFileId(req, resp);
188 if (fileid == null) {
191 String feedid = null;
193 String ip = req.getRemoteAddr();
194 String lip = req.getLocalAddr();
196 String rcvd = NodeUtils.logts(System.currentTimeMillis()) + ";from=" + ip + ";by=" + lip;
197 Target[] targets = null;
198 boolean isAAFFeed = false;
199 if (fileid.startsWith("/delete/")) {
200 deleteFile(req, resp, fileid, pubid);
203 String credentials = req.getHeader("Authorization");
204 if (credentials == null) {
205 eelfLogger.error("NODE0306 Rejecting unauthenticated PUT or DELETE of " + req.getPathInfo() + FROM + req
207 resp.sendError(HttpServletResponse.SC_FORBIDDEN, "Authorization header required");
208 eelfLogger.info(EelfMsgs.EXIT);
211 if (fileid.startsWith(PUBLISH)) {
212 fileid = fileid.substring(9);
213 int index = fileid.indexOf('/');
214 if (index == -1 || index == fileid.length() - 1) {
215 eelfLogger.error("NODE0205 Rejecting bad URI for PUT or DELETE of " + req.getPathInfo() + FROM + req
217 resp.sendError(HttpServletResponse.SC_NOT_FOUND,
218 "Invalid request URI. Expecting <feed-publishing-url>/<fileid>. Possible missing fileid.");
219 eelfLogger.info(EelfMsgs.EXIT);
222 feedid = fileid.substring(0, index);
224 if (config.getCadiEnabled()) {
225 String path = req.getPathInfo();
226 if (!path.startsWith("/internal") && feedid != null) {
227 String aafInstance = config.getAafInstance(feedid);
228 if (!("legacy".equalsIgnoreCase(aafInstance))) {
230 String permission = config.getPermission(aafInstance);
231 eelfLogger.info("NodeServlet.common() permission string - " + permission);
232 //Check in CADI Framework API if user has AAF permission or not
233 if (!req.isUserInRole(permission)) {
234 String message = "AAF disallows access to permission string - " + permission;
235 eelfLogger.error("NODE0307 Rejecting unauthenticated PUT or DELETE of " + req.getPathInfo()
236 + FROM + req.getRemoteAddr());
237 resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);
238 eelfLogger.info(EelfMsgs.EXIT);
245 fileid = fileid.substring(index + 1);
246 pubid = config.getPublishId();
247 targets = config.getTargets(feedid);
248 } else if (fileid.startsWith(INTERNAL_PUBLISH)) {
249 if (!config.isAnotherNode(credentials, ip)) {
250 eelfLogger.error("NODE0107 Rejecting unauthorized node-to-node transfer attempt from " + ip);
251 resp.sendError(HttpServletResponse.SC_FORBIDDEN);
252 eelfLogger.info(EelfMsgs.EXIT);
255 fileid = fileid.substring(18);
256 pubid = req.getHeader("X-DMAAP-DR-PUBLISH-ID");
257 user = "datartr"; // SP6 : Added usr as datartr to avoid null entries for internal routing
258 targets = config.parseRouting(req.getHeader("X-DMAAP-DR-ROUTING"));
260 eelfLogger.error("NODE0204 Rejecting bad URI for PUT or DELETE of " + req.getPathInfo() + FROM + req
262 resp.sendError(HttpServletResponse.SC_NOT_FOUND,
263 INVALID_REQUEST_URI);
264 eelfLogger.info(EelfMsgs.EXIT);
267 if (fileid.indexOf('/') != -1) {
268 eelfLogger.error("NODE0202 Rejecting bad URI for PUT or DELETE of " + req.getPathInfo() + FROM + req
270 resp.sendError(HttpServletResponse.SC_NOT_FOUND,
271 INVALID_REQUEST_URI);
272 eelfLogger.info(EelfMsgs.EXIT);
275 String qs = req.getQueryString();
277 fileid = fileid + "?" + qs;
279 String hp = config.getMyName();
280 int xp = config.getExtHttpsPort();
284 String logurl = HTTPS + hp + INTERNAL_PUBLISH + fileid;
285 if (feedid != null) {
286 logurl = HTTPS + hp + PUBLISH + feedid + "/" + fileid;
289 String reason = config.isPublishPermitted(feedid, credentials, ip);
290 if (reason != null) {
291 eelfLogger.error("NODE0111 Rejecting unauthorized publish attempt to feed " + PathUtil
292 .cleanString(feedid) + " fileid " + PathUtil.cleanString(fileid) + FROM + PathUtil
293 .cleanString(ip) + " reason " + PathUtil.cleanString(reason));
294 resp.sendError(HttpServletResponse.SC_FORBIDDEN, reason);
295 eelfLogger.info(EelfMsgs.EXIT);
298 user = config.getAuthUser(feedid, credentials);
300 String reason = config.isPublishPermitted(feedid, ip);
301 if (reason != null) {
302 eelfLogger.error("NODE0111 Rejecting unauthorized publish attempt to feed " + PathUtil
303 .cleanString(feedid) + " fileid " + PathUtil.cleanString(fileid) + FROM + PathUtil
304 .cleanString(ip) + " reason Invalid AAF user- " + PathUtil.cleanString(reason));
305 String message = "Invalid AAF user- " + PathUtil.cleanString(reason);
306 eelfLogger.info("NODE0308 Rejecting unauthenticated PUT or DELETE of " + PathUtil
307 .cleanString(req.getPathInfo()) + FROM + PathUtil.cleanString(req.getRemoteAddr()));
308 resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);
311 if ((req.getUserPrincipal() != null) && (req.getUserPrincipal().getName() != null)) {
312 String userName = req.getUserPrincipal().getName();
313 String[] attid = userName.split("@");
320 String newnode = config.getIngressNode(feedid, user, ip);
321 if (newnode != null) {
323 int iport = config.getExtHttpsPort();
327 String redirto = HTTPS + newnode + port + PUBLISH + feedid + "/" + fileid;
329 .info("NODE0108 Redirecting publish attempt for feed " + PathUtil.cleanString(feedid) + USER
330 + PathUtil.cleanString(user) + " ip " + PathUtil.cleanString(ip) + " to " + PathUtil
331 .cleanString(redirto)); //Fortify scan fixes - log forging
332 resp.sendRedirect(PathUtil.cleanString(redirto)); //Fortify scan fixes-open redirect - 2 issues
333 eelfLogger.info(EelfMsgs.EXIT);
336 resp.setHeader("X-DMAAP-DR-PUBLISH-ID", pubid);
338 if (req.getPathInfo().startsWith(INTERNAL_PUBLISH)) {
339 feedid = req.getHeader("X-DMAAP-DR-FEED-ID");
341 String fbase = PathUtil.cleanString(config.getSpoolDir() + "/" + pubid); //Fortify scan fixes-Path manipulation
342 File data = new File(fbase);
343 File meta = new File(fbase + ".M");
346 StringBuilder mx = new StringBuilder();
347 mx.append(req.getMethod()).append('\t').append(fileid).append('\n');
348 Enumeration hnames = req.getHeaderNames();
350 boolean hasRequestIdHeader = false;
351 boolean hasInvocationIdHeader = false;
352 while (hnames.hasMoreElements()) {
353 String hn = (String) hnames.nextElement();
354 String hnlc = hn.toLowerCase();
355 if ((isput && ("content-type".equals(hnlc)
356 || "content-language".equals(hnlc)
357 || "content-md5".equals(hnlc)
358 || "content-range".equals(hnlc)))
359 || "x-dmaap-dr-meta".equals(hnlc)
360 || (feedid == null && "x-dmaap-dr-received".equals(hnlc))
361 || (hnlc.startsWith("x-") && !hnlc.startsWith("x-dmaap-dr-"))) {
362 Enumeration hvals = req.getHeaders(hn);
363 while (hvals.hasMoreElements()) {
364 String hv = (String) hvals.nextElement();
365 if ("content-type".equals(hnlc)) {
368 if ("x-onap-requestid".equals(hnlc)) {
369 hasRequestIdHeader = true;
371 if ("x-invocationid".equals(hnlc)) {
372 hasInvocationIdHeader = true;
374 if ("x-dmaap-dr-meta".equals(hnlc)) {
375 if (hv.length() > 4096) {
376 eelfLogger.error("NODE0109 Rejecting publish attempt with metadata too long for feed "
377 + PathUtil.cleanString(feedid) + USER + PathUtil.cleanString(user) + " ip "
378 + PathUtil.cleanString(ip)); //Fortify scan fixes - log forging
379 resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "Metadata too long");
380 eelfLogger.info(EelfMsgs.EXIT);
383 if (!metaDataPattern.matcher(hv.replaceAll("\\\\.", "X")).matches()) {
384 eelfLogger.error("NODE0109 Rejecting publish attempt with malformed metadata for feed "
385 + PathUtil.cleanString(feedid) + USER + PathUtil.cleanString(user) + " ip "
386 + PathUtil.cleanString(ip)); //Fortify scan fixes - log forging
387 resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "Malformed metadata");
388 eelfLogger.info(EelfMsgs.EXIT);
392 mx.append(hn).append('\t').append(hv).append('\n');
396 if (!hasRequestIdHeader) {
397 mx.append("X-ONAP-RequestID\t").append(MDC.get("RequestId")).append('\n');
399 if (!hasInvocationIdHeader) {
400 mx.append("X-InvocationID\t").append(MDC.get("InvocationId")).append('\n');
402 mx.append("X-DMAAP-DR-RECEIVED\t").append(rcvd).append('\n');
403 String metadata = mx.toString();
404 long exlen = getExlen(req);
405 String message = writeInputStreamToFile(req, data);
406 if (message != null) {
407 StatusLog.logPubFail(pubid, feedid, logurl, req.getMethod(), ctype, exlen, data.length(), ip, user,
409 throw new IOException(message);
411 Path dpath = Paths.get(fbase);
412 for (Target t : targets) {
413 DestInfo di = t.getDestInfo();
415 // TODO: unknown destination
418 String dbase = PathUtil
419 .cleanString(di.getSpool() + "/" + pubid); //Fortify scan fixes-Path Manipulation
420 Files.createLink(Paths.get(dbase), dpath);
421 mw = new FileWriter(meta);
423 if (di.getSubId() == null) {
424 mw.write("X-DMAAP-DR-ROUTING\t" + t.getRouting() + "\n");
427 meta.renameTo(new File(dbase + ".M"));
429 resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
431 resp.getOutputStream().close();
432 } catch (IOException ioe) {
433 StatusLog.logPubFail(pubid, feedid, logurl, req.getMethod(), ctype, exlen, data.length(), ip, user,
435 //Fortify scan fixes - log forging
436 eelfLogger.error("NODE0110 IO Exception while closing IO stream " + PathUtil.cleanString(feedid)
437 + USER + PathUtil.cleanString(user) + " ip " + PathUtil.cleanString(ip) + " " + ioe
442 StatusLog.logPub(pubid, feedid, logurl, req.getMethod(), ctype, data.length(), ip, user,
443 HttpServletResponse.SC_NO_CONTENT);
444 } catch (IOException ioe) {
445 eelfLogger.error("NODE0110 IO Exception receiving publish attempt for feed " + feedid + USER + user
446 + " ip " + ip + " " + ioe.toString(), ioe);
447 eelfLogger.info(EelfMsgs.EXIT);
453 } catch (Exception e) {
454 eelfLogger.error("NODE0532 Exception common: " + e);
459 } catch (Exception e) {
460 eelfLogger.error("NODE0533 Exception common: " + e);
464 } catch (Exception e) {
465 eelfLogger.error("NODE0534 Exception common: " + e);
470 private String writeInputStreamToFile(HttpServletRequest req, File data) {
471 byte[] buf = new byte[1024 * 1024];
473 try (OutputStream dos = new FileOutputStream(data);
474 InputStream is = req.getInputStream()) {
475 while ((bytesRead = is.read(buf)) > 0) {
476 dos.write(buf, 0, bytesRead);
478 } catch (IOException ioe) {
479 eelfLogger.error("NODE0530 Exception common: " + ioe, ioe);
480 eelfLogger.info(EelfMsgs.EXIT);
481 return ioe.getMessage();
486 private long getExlen(HttpServletRequest req) {
489 exlen = Long.parseLong(req.getHeader("Content-Length"));
490 } catch (Exception e) {
491 eelfLogger.error("NODE0529 Exception common: " + e);
496 private void deleteFile(HttpServletRequest req, HttpServletResponse resp, String fileid, String pubid) {
497 final String FROM_DR_MESSAGE = ".M) from DR Node: ";
499 fileid = fileid.substring(8);
500 int index = fileid.indexOf('/');
501 if (index == -1 || index == fileid.length() - 1) {
502 eelfLogger.error("NODE0112 Rejecting bad URI for DELETE of " + req.getPathInfo() + FROM + req
504 resp.sendError(HttpServletResponse.SC_NOT_FOUND,
505 "Invalid request URI. Expecting <subId>/<pubId>.");
506 eelfLogger.info(EelfMsgs.EXIT);
509 String subscriptionId = fileid.substring(0, index);
510 int subId = Integer.parseInt(subscriptionId);
511 pubid = fileid.substring(index + 1);
512 String errorMessage = "Unable to delete files (" + pubid + ", " + pubid + FROM_DR_MESSAGE
513 + config.getMyName() + ".";
514 int subIdDir = subId - (subId % 100);
515 if (!isAuthorizedToDelete(resp, subscriptionId, errorMessage)) {
518 boolean result = delivery.markTaskSuccess(config.getSpoolBase() + "/s/" + subIdDir + "/" + subId, pubid);
520 eelfLogger.info("NODE0115 Successfully deleted files (" + pubid + ", " + pubid + FROM_DR_MESSAGE
521 + config.getMyName());
522 resp.setStatus(HttpServletResponse.SC_OK);
523 eelfLogger.info(EelfMsgs.EXIT);
525 eelfLogger.error("NODE0116 " + errorMessage);
526 resp.sendError(HttpServletResponse.SC_NOT_FOUND, "File not found on server.");
527 eelfLogger.info(EelfMsgs.EXIT);
529 } catch (IOException ioe) {
530 eelfLogger.error("NODE0117 Unable to delete files (" + pubid + ", " + pubid + FROM_DR_MESSAGE
531 + config.getMyName(), ioe);
532 eelfLogger.info(EelfMsgs.EXIT);
537 private String getFileId(HttpServletRequest req, HttpServletResponse resp) throws IOException {
539 eelfLogger.info(EelfMsgs.EXIT);
542 if (!req.isSecure()) {
544 "NODE0104 Rejecting insecure PUT or DELETE of " + req.getPathInfo() + FROM + req
546 resp.sendError(HttpServletResponse.SC_FORBIDDEN, "https required on publish requests");
547 eelfLogger.info(EelfMsgs.EXIT);
550 String fileid = req.getPathInfo();
551 if (fileid == null) {
552 eelfLogger.error("NODE0201 Rejecting bad URI for PUT or DELETE of " + req.getPathInfo() + FROM + req
554 resp.sendError(HttpServletResponse.SC_NOT_FOUND,
555 INVALID_REQUEST_URI);
556 eelfLogger.info(EelfMsgs.EXIT);
562 private boolean isAuthorizedToDelete(HttpServletResponse resp, String subscriptionId, String errorMessage)
565 boolean deletePermitted = config.isDeletePermitted(subscriptionId);
566 if (!deletePermitted) {
567 eelfLogger.error("NODE0113 " + errorMessage + " Error: Subscription "
568 + subscriptionId + " is not a privileged subscription");
569 resp.sendError(HttpServletResponse.SC_UNAUTHORIZED);
570 eelfLogger.info(EelfMsgs.EXIT);
573 } catch (NullPointerException npe) {
574 eelfLogger.error("NODE0114 " + errorMessage + " Error: Subscription " + subscriptionId
575 + " does not exist", npe);
576 resp.sendError(HttpServletResponse.SC_NOT_FOUND);
577 eelfLogger.info(EelfMsgs.EXIT);
583 private int getIdFromPath(HttpServletRequest req) {
584 String path = req.getPathInfo();
585 if (path == null || path.length() < 2) {
589 return Integer.parseInt(path.substring(1));
590 } catch (NumberFormatException e) {