datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/NodeUtils.java

   1 /*******************************************************************************
   2  * ============LICENSE_START==================================================
   3  * * org.onap.dmaap
   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
  10  * *
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0
  12  * *
  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====================================================
  19  * *
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  * *
  22  ******************************************************************************/
  23
  24
  25 package org.onap.dmaap.datarouter.node;
  26
  27 import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN;
  28 import static com.att.eelf.configuration.Configuration.MDC_SERVER_IP_ADDRESS;
  29 import static com.att.eelf.configuration.Configuration.MDC_SERVICE_NAME;
  30
  31 import com.att.eelf.configuration.EELFLogger;
  32 import com.att.eelf.configuration.EELFManager;
  33 import java.io.FileInputStream;
  34 import java.io.IOException;
  35 import java.net.InetAddress;
  36 import java.security.KeyStore;
  37 import java.security.MessageDigest;
  38 import java.security.cert.X509Certificate;
  39 import java.text.SimpleDateFormat;
  40 import java.util.Date;
  41 import java.util.Enumeration;
  42 import java.util.TimeZone;
  43 import org.apache.commons.codec.binary.Base64;
  44 import org.apache.log4j.Logger;
  45 import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
  46 import org.slf4j.MDC;
  47
  48 /**
  49  * Utility functions for the data router node
  50  */
  51 public class NodeUtils {
  52
  53     private static EELFLogger eelfLogger = EELFManager.getInstance()
  54         .getLogger("org.onap.dmaap.datarouter.node.NodeUtils");
  55     private static Logger nodeUtilsLogger = Logger.getLogger("org.onap.dmaap.datarouter.node.NodeUtils");
  56     private static SimpleDateFormat logDate;
  57
  58     static {
  59         logDate = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
  60         logDate.setTimeZone(TimeZone.getTimeZone("GMT"));
  61     }
  62
  63     private NodeUtils() {
  64     }
  65
  66     /**
  67      * Base64 encode a byte array
  68      *
  69      * @param raw The bytes to be encoded
  70      * @return The encoded string
  71      */
  72     public static String base64Encode(byte[] raw) {
  73         return (Base64.encodeBase64String(raw));
  74     }
  75
  76     /**
  77      * Given a user and password, generate the credentials
  78      *
  79      * @param user User name
  80      * @param password User password
  81      * @return Authorization header value
  82      */
  83     public static String getAuthHdr(String user, String password) {
  84         if (user == null || password == null) {
  85             return (null);
  86         }
  87         return ("Basic " + base64Encode((user + ":" + password).getBytes()));
  88     }
  89
  90     /**
  91      * Given a node name, generate the credentials
  92      *
  93      * @param node Node name
  94      */
  95     public static String getNodeAuthHdr(String node, String key) {
  96         try {
  97             MessageDigest md = MessageDigest.getInstance("SHA");
  98             md.update(key.getBytes());
  99             md.update(node.getBytes());
 100             md.update(key.getBytes());
 101             return (getAuthHdr(node, base64Encode(md.digest())));
 102         } catch (Exception exception) {
 103             nodeUtilsLogger
 104                 .error("Exception in generating Credentials for given node name:= " + exception.toString(), exception);
 105             return (null);
 106         }
 107     }
 108
 109     /**
 110      * Given a keystore file and its password, return the value of the CN of the first private key entry with a
 111      * certificate.
 112      *
 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
 117      */
 118     public static String getCanonicalName(String kstype, String ksfile, String kspass) {
 119         KeyStore ks;
 120         try {
 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(),
 126                     ioException);
 127                 return (null);
 128             }
 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);
 133             return (null);
 134         }
 135         return (getCanonicalName(ks));
 136     }
 137
 138     /**
 139      * Given a keystore, return the value of the CN of the first private key entry with a certificate.
 140      *
 141      * @param ks The KeyStore
 142      * @return CN of the certificate subject or null
 143      */
 144     public static String getCanonicalName(KeyStore ks) {
 145         try {
 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);
 151                     if (c != null) {
 152                         String subject = c.getSubjectX500Principal().getName();
 153                         String[] parts = subject.split(",");
 154                         if (parts.length < 1) {
 155                             return (null);
 156                         }
 157                         subject = parts[5].trim();
 158                         if (!subject.startsWith("CN=")) {
 159                             return (null);
 160
 161                         }
 162                         return (subject.substring(3));
 163                     }
 164                 }
 165             }
 166         } catch (Exception e) {
 167             nodeUtilsLogger.error("NODE0402 Error extracting my name from my keystore file " + e.toString(), e);
 168         }
 169         return (null);
 170     }
 171
 172     /**
 173      * Given a string representation of an IP address, get the corresponding byte array
 174      *
 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
 177      */
 178     public static byte[] getInetAddress(String ip) {
 179         try {
 180             return (InetAddress.getByName(ip).getAddress());
 181         } catch (Exception exception) {
 182             nodeUtilsLogger
 183                 .error("Exception in generating byte array for given IP address := " + exception.toString(), exception);
 184         }
 185         return (null);
 186     }
 187
 188     /**
 189      * Given a uri with parameters, split out the feed ID and file ID
 190      */
 191     public static String[] getFeedAndFileID(String uriandparams) {
 192         int end = uriandparams.length();
 193         int i = uriandparams.indexOf('#');
 194         if (i != -1 && i < end) {
 195             end = i;
 196         }
 197         i = uriandparams.indexOf('?');
 198         if (i != -1 && i < end) {
 199             end = i;
 200         }
 201         end = uriandparams.lastIndexOf('/', end);
 202         if (end < 2) {
 203             return (null);
 204         }
 205         i = uriandparams.lastIndexOf('/', end - 1);
 206         if (i == -1) {
 207             return (null);
 208         }
 209         return (new String[]{uriandparams.substring(i + 1, end), uriandparams.substring(end + 1)});
 210     }
 211
 212     /**
 213      * Escape fields that might contain vertical bar, backslash, or newline by replacing them with backslash p,
 214      * backslash e and backslash n.
 215      */
 216     public static String loge(String s) {
 217         if (s == null) {
 218             return (s);
 219         }
 220         return (s.replaceAll("\\\\", "\\\\e").replaceAll("\\|", "\\\\p").replaceAll("\n", "\\\\n"));
 221     }
 222
 223     /**
 224      * Undo what loge does.
 225      */
 226     public static String unloge(String s) {
 227         if (s == null) {
 228             return (s);
 229         }
 230         return (s.replaceAll("\\\\p", "\\|").replaceAll("\\\\n", "\n").replaceAll("\\\\e", "\\\\"));
 231     }
 232
 233     /**
 234      * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
 235      */
 236     public static String logts(long when) {
 237         return (logts(new Date(when)));
 238     }
 239
 240     /**
 241      * Format a logging timestamp as yyyy-mm-ddThh:mm:ss.mmmZ
 242      */
 243     public static synchronized String logts(Date when) {
 244         return (logDate.format(when));
 245     }
 246
 247     /* Method prints method name, server FQDN and IP Address of the machine in EELF logs
 248      * @Method - setIpAndFqdnForEelf - Rally:US664892
 249      * @Params - method, prints method name in EELF log.
 250      */
 251     public static void setIpAndFqdnForEelf(String method) {
 252         MDC.clear();
 253         MDC.put(MDC_SERVICE_NAME, method);
 254         try {
 255             MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getHostName());
 256             MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
 257         } catch (Exception exception) {
 258             nodeUtilsLogger
 259                 .error("Exception in generating byte array for given IP address := " + exception.toString(), exception);
 260         }
 261
 262     }
 263
 264
 265 }