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 com.att.eelf.configuration.EELFLogger;
28 import com.att.eelf.configuration.EELFManager;
31 import java.io.FileInputStream;
32 import java.io.IOException;
33 import java.net.InetAddress;
34 import java.security.KeyStore;
35 import java.security.MessageDigest;
36 import java.security.cert.X509Certificate;
37 import java.text.SimpleDateFormat;
38 import java.util.Date;
39 import java.util.Enumeration;
40 import java.util.TimeZone;
41 import java.util.UUID;
42 import java.util.zip.GZIPInputStream;
43 import javax.servlet.http.HttpServletRequest;
44 import javax.servlet.http.HttpServletResponse;
45 import org.apache.commons.codec.binary.Base64;
46 import org.apache.commons.lang3.StringUtils;
47 import org.apache.log4j.Logger;
48 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
51 import static com.att.eelf.configuration.Configuration.*;
54 * Utility functions for the data router node
56 public class NodeUtils {
58 private static EELFLogger eelfLogger = EELFManager.getInstance()
59 .getLogger(NodeUtils.class);
60 private static Logger nodeUtilsLogger = Logger.getLogger("org.onap.dmaap.datarouter.node.NodeUtils");
66 * Base64 encode a byte array
68 * @param raw The bytes to be encoded
69 * @return The encoded string
71 public static String base64Encode(byte[] raw) {
72 return (Base64.encodeBase64String(raw));
76 * Given a user and password, generate the credentials
78 * @param user User name
79 * @param password User password
80 * @return Authorization header value
82 public static String getAuthHdr(String user, String password) {
83 if (user == null || password == null) {
86 return ("Basic " + base64Encode((user + ":" + password).getBytes()));
90 * Given a node name, generate the credentials
92 * @param node Node name
94 public static String getNodeAuthHdr(String node, String key) {
96 MessageDigest md = MessageDigest.getInstance("SHA");
97 md.update(key.getBytes());
98 md.update(node.getBytes());
99 md.update(key.getBytes());
100 return (getAuthHdr(node, base64Encode(md.digest())));
101 } catch (Exception exception) {
103 .error("Exception in generating Credentials for given node name:= " + exception.toString(),
110 * Given a keystore file and its password, return the value of the CN of the first private key entry with a
113 * @param kstype The type of keystore
114 * @param ksfile The file name of the keystore
115 * @param kspass The password of the keystore
116 * @return CN of the certificate subject or null
118 public static String getCanonicalName(String kstype, String ksfile, String kspass) {
121 ks = KeyStore.getInstance(kstype);
122 try (FileInputStream fileInputStream = new FileInputStream(ksfile)) {
123 ks.load(fileInputStream, kspass.toCharArray());
124 } catch (IOException ioException) {
125 nodeUtilsLogger.error("IOException occurred while opening FileInputStream: " + ioException.getMessage(),
129 } catch (Exception e) {
130 setIpAndFqdnForEelf("getCanonicalName");
131 eelfLogger.error(EelfMsgs.MESSAGE_KEYSTORE_LOAD_ERROR, ksfile, e.toString());
132 nodeUtilsLogger.error("NODE0401 Error loading my keystore file + " + ksfile + " " + e.toString(), e);
135 return (getCanonicalName(ks));
139 * Given a keystore, return the value of the CN of the first private key entry with a certificate.
141 * @param ks The KeyStore
142 * @return CN of the certificate subject or null
144 public static String getCanonicalName(KeyStore ks) {
146 Enumeration<String> aliases = ks.aliases();
147 while (aliases.hasMoreElements()) {
148 String s = aliases.nextElement();
149 if (ks.entryInstanceOf(s, KeyStore.PrivateKeyEntry.class)) {
150 X509Certificate c = (X509Certificate) ks.getCertificate(s);
152 String subject = c.getSubjectX500Principal().getName();
153 String[] parts = subject.split(",");
154 if (parts.length < 1) {
157 subject = parts[5].trim();
158 if (!subject.startsWith("CN=")) {
162 return (subject.substring(3));
166 } catch (Exception e) {
167 nodeUtilsLogger.error("NODE0402 Error extracting my name from my keystore file " + e.toString(), e);
173 * Given a string representation of an IP address, get the corresponding byte array
175 * @param ip The IP address as a string
176 * @return The IP address as a byte array or null if the address is invalid
178 public static byte[] getInetAddress(String ip) {
180 return (InetAddress.getByName(ip).getAddress());
181 } catch (Exception exception) {
183 .error("Exception in generating byte array for given IP address := " + exception.toString(),
190 * Given a uri with parameters, split out the feed ID and file ID
192 public static String[] getFeedAndFileID(String uriandparams) {
193 int end = uriandparams.length();
194 int i = uriandparams.indexOf('#');
195 if (i != -1 && i < end) {
198 i = uriandparams.indexOf('?');
199 if (i != -1 && i < end) {
202 end = uriandparams.lastIndexOf('/', end);
206 i = uriandparams.lastIndexOf('/', end - 1);
210 return (new String[]{uriandparams.substring(i + 1, end), uriandparams.substring(end + 1)});
214 * Escape fields that might contain vertical bar, backslash, or newline by replacing them with backslash p,
215 * backslash e and backslash n.
217 public static String loge(String s) {
221 return (s.replaceAll("\\\\", "\\\\e").replaceAll("\\|", "\\\\p").replaceAll("\n", "\\\\n"));
225 * Undo what loge does.
227 public static String unloge(String s) {
231 return (s.replaceAll("\\\\p", "\\|").replaceAll("\\\\n", "\n").replaceAll("\\\\e", "\\\\"));
235 * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
237 public static String logts(long when) {
238 return (logts(new Date(when)));
242 * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
244 public static synchronized String logts(Date when) {
245 SimpleDateFormat logDate = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
246 logDate.setTimeZone(TimeZone.getTimeZone("GMT"));
247 return (logDate.format(when));
250 /* Method prints method name, server FQDN and IP Address of the machine in EELF logs
251 * @Method - setIpAndFqdnForEelf - Rally:US664892
252 * @Params - method, prints method name in EELF log.
254 public static void setIpAndFqdnForEelf(String method) {
256 MDC.put(MDC_SERVICE_NAME, method);
258 MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getHostName());
259 MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
260 } catch (Exception exception) {
262 .error("Exception in generating byte array for given IP address := " + exception.toString(),
268 /* Method sets RequestIs and InvocationId for se in EELF logs
269 * @Method - setIpAndFqdnForEelf
270 * @Params - Req, Request used to get RequestId and InvocationId
272 public static void setRequestIdAndInvocationId(HttpServletRequest req) {
273 String reqId = req.getHeader("X-ONAP-RequestID");
274 if (StringUtils.isBlank(reqId)) {
275 reqId = UUID.randomUUID().toString();
277 MDC.put(MDC_KEY_REQUEST_ID, reqId);
278 String invId = req.getHeader("X-InvocationID");
279 if (StringUtils.isBlank(invId)) {
280 invId = UUID.randomUUID().toString();
282 MDC.put("InvocationId", invId);
285 public static void sendResponseError(HttpServletResponse response, int errorCode, Logger intlogger) {
287 response.sendError(errorCode);
288 } catch (IOException ioe) {
289 intlogger.error("IOException" + ioe.getMessage());
294 * Method to check to see if file is of type gzip
296 * @param file The name of the file to be checked
297 * @return True if the file is of type gzip
299 public static boolean isFiletypeGzip(File file){
300 try(FileInputStream fileInputStream = new FileInputStream(file);
301 GZIPInputStream gzip = new GZIPInputStream(fileInputStream)) {
304 }catch (IOException e){
305 nodeUtilsLogger.error("NODE0403 " + file.toString() + " Not in gzip(gz) format: " + e.toString() + e);