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 com.att.eelf.configuration.Configuration.MDC_KEY_REQUEST_ID;
28 import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN;
29 import static com.att.eelf.configuration.Configuration.MDC_SERVER_IP_ADDRESS;
30 import static com.att.eelf.configuration.Configuration.MDC_SERVICE_NAME;
32 import com.att.eelf.configuration.EELFLogger;
33 import com.att.eelf.configuration.EELFManager;
35 import java.io.FileInputStream;
36 import java.io.IOException;
37 import java.net.InetAddress;
38 import java.security.KeyStore;
39 import java.security.KeyStoreException;
40 import java.security.MessageDigest;
41 import java.security.NoSuchAlgorithmException;
42 import java.security.cert.CertificateException;
43 import java.security.cert.X509Certificate;
44 import java.text.SimpleDateFormat;
45 import java.util.Date;
46 import java.util.Enumeration;
47 import java.util.TimeZone;
48 import java.util.UUID;
49 import java.util.zip.GZIPInputStream;
50 import javax.servlet.http.HttpServletRequest;
51 import javax.servlet.http.HttpServletResponse;
52 import org.apache.commons.codec.binary.Base64;
53 import org.apache.commons.lang3.StringUtils;
54 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
58 * Utility functions for the data router node.
60 public class NodeUtils {
62 private static EELFLogger eelfLogger = EELFManager.getInstance()
63 .getLogger(NodeUtils.class);
69 * Base64 encode a byte array.
71 * @param raw The bytes to be encoded
72 * @return The encoded string
74 public static String base64Encode(byte[] raw) {
75 return (Base64.encodeBase64String(raw));
79 * Given a user and password, generate the credentials.
81 * @param user User name
82 * @param password User password
83 * @return Authorization header value
85 public static String getAuthHdr(String user, String password) {
86 if (user == null || password == null) {
89 return ("Basic " + base64Encode((user + ":" + password).getBytes()));
93 * Given a node name, generate the credentials.
95 * @param node Node name
97 public static String getNodeAuthHdr(String node, String key) {
99 MessageDigest md = MessageDigest.getInstance("SHA");
100 md.update(key.getBytes());
101 md.update(node.getBytes());
102 md.update(key.getBytes());
103 return (getAuthHdr(node, base64Encode(md.digest())));
104 } catch (Exception exception) {
106 .error("Exception in generating Credentials for given node name:= " + exception.toString(),
113 * Given a keystore file and its password, return the value of the CN of the first private key entry with a
116 * @param kstype The type of keystore
117 * @param ksfile The file name of the keystore
118 * @param kspass The password of the keystore
119 * @return CN of the certificate subject or null
121 public static String getCanonicalName(String kstype, String ksfile, String kspass) {
124 ks = KeyStore.getInstance(kstype);
125 if (loadKeyStore(ksfile, kspass, ks)) {
128 } catch (Exception e) {
129 setIpAndFqdnForEelf("getCanonicalName");
130 eelfLogger.error(EelfMsgs.MESSAGE_KEYSTORE_LOAD_ERROR, e, ksfile);
133 return (getCanonicalName(ks));
137 * Given a keystore, return the value of the CN of the first private key entry with a certificate.
139 * @param ks The KeyStore
140 * @return CN of the certificate subject or null
142 public static String getCanonicalName(KeyStore ks) {
144 Enumeration<String> aliases = ks.aliases();
145 while (aliases.hasMoreElements()) {
146 String name = getNameFromSubject(ks, aliases);
151 } catch (Exception e) {
152 eelfLogger.error("NODE0402 Error extracting my name from my keystore file " + e.toString(), e);
158 * Given a string representation of an IP address, get the corresponding byte array.
160 * @param ip The IP address as a string
161 * @return The IP address as a byte array or null if the address is invalid
163 public static byte[] getInetAddress(String ip) {
165 return (InetAddress.getByName(ip).getAddress());
166 } catch (Exception exception) {
168 .error("Exception in generating byte array for given IP address := " + exception.toString(),
175 * Given a uri with parameters, split out the feed ID and file ID.
177 public static String[] getFeedAndFileID(String uriandparams) {
178 int end = uriandparams.length();
179 int index = uriandparams.indexOf('#');
180 if (index != -1 && index < end) {
183 index = uriandparams.indexOf('?');
184 if (index != -1 && index < end) {
187 end = uriandparams.lastIndexOf('/', end);
191 index = uriandparams.lastIndexOf('/', end - 1);
195 return (new String[]{uriandparams.substring(index + 1, end), uriandparams.substring(end + 1)});
199 * Escape fields that might contain vertical bar, backslash, or newline by replacing them with backslash p,
200 * backslash e and backslash n.
202 public static String loge(String string) {
203 if (string == null) {
206 return (string.replaceAll("\\\\", "\\\\e").replaceAll("\\|", "\\\\p").replaceAll("\n", "\\\\n"));
210 * Undo what loge does.
212 public static String unloge(String string) {
213 if (string == null) {
216 return (string.replaceAll("\\\\p", "\\|").replaceAll("\\\\n", "\n").replaceAll("\\\\e", "\\\\"));
220 * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
222 public static String logts(long when) {
223 return (logts(new Date(when)));
227 * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
229 public static synchronized String logts(Date when) {
230 SimpleDateFormat logDate = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
231 logDate.setTimeZone(TimeZone.getTimeZone("GMT"));
232 return (logDate.format(when));
235 /** Method prints method name, server FQDN and IP Address of the machine in EELF logs.
237 * @param method Prints method name in EELF log.
239 public static void setIpAndFqdnForEelf(String method) {
241 MDC.put(MDC_SERVICE_NAME, method);
243 MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getHostName());
244 MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
245 } catch (Exception exception) {
247 .error("Exception in generating byte array for given IP address := " + exception.toString(),
253 /** Method sets RequestIs and InvocationId for se in EELF logs.
255 * @param req Request used to get RequestId and InvocationId.
257 public static void setRequestIdAndInvocationId(HttpServletRequest req) {
258 String reqId = req.getHeader("X-ONAP-RequestID");
259 if (StringUtils.isBlank(reqId)) {
260 reqId = UUID.randomUUID().toString();
262 MDC.put(MDC_KEY_REQUEST_ID, reqId);
263 String invId = req.getHeader("X-InvocationID");
264 if (StringUtils.isBlank(invId)) {
265 invId = UUID.randomUUID().toString();
267 MDC.put("InvocationId", invId);
271 * Sends error as response with error code input.
273 public static void sendResponseError(HttpServletResponse response, int errorCode, EELFLogger intlogger) {
275 response.sendError(errorCode);
276 } catch (IOException ioe) {
277 intlogger.error("IOException", ioe);
282 * Method to check to see if file is of type gzip.
284 * @param file The name of the file to be checked
285 * @return True if the file is of type gzip
287 public static boolean isFiletypeGzip(File file) {
288 try (FileInputStream fileInputStream = new FileInputStream(file);
289 GZIPInputStream gzip = new GZIPInputStream(fileInputStream)) {
292 } catch (IOException e) {
293 eelfLogger.error("NODE0403 " + file.toString() + " Not in gzip(gz) format: " + e.toString() + e);
299 private static boolean loadKeyStore(String ksfile, String kspass, KeyStore ks)
300 throws NoSuchAlgorithmException, CertificateException {
301 try (FileInputStream fileInputStream = new FileInputStream(ksfile)) {
302 ks.load(fileInputStream, kspass.toCharArray());
303 } catch (IOException ioException) {
304 eelfLogger.error("IOException occurred while opening FileInputStream: " + ioException.getMessage(),
312 private static String getNameFromSubject(KeyStore ks, Enumeration<String> aliases) throws KeyStoreException {
313 String alias = aliases.nextElement();
314 if (ks.entryInstanceOf(alias, KeyStore.PrivateKeyEntry.class)) {
315 X509Certificate cert = (X509Certificate) ks.getCertificate(alias);
317 String subject = cert.getSubjectX500Principal().getName();
318 String[] parts = subject.split(",");
319 if (parts.length < 1) {
322 subject = parts[5].trim();
323 if (!subject.startsWith("CN=")) {
326 return subject.substring(3);