Merge pull request #134 from CyberSource/future

6.2.8 release changes

Author: mahendya1002

README.md

@@ -10,7 +10,7 @@ To install the `cybersource-sdk-java` from central repository, add dependency to
 <dependency>
   <groupId>com.cybersource</groupId>
   <artifactId>cybersource-sdk-java</artifactId>
-  <version>6.2.7</version>
+  <version>6.2.8</version>
 </dependency> 
 ```
 Run `mvn install` to install dependency
@@ -19,7 +19,7 @@ Run `mvn install` to install dependency
 Add the dependency to your build.gradle
 ```java
 dependencies {
-  compile 'com.cybersource:cybersource-sdk-java:6.2.6'
+  compile 'com.cybersource:cybersource-sdk-java:6.2.8'
 }
 ```
 ## Requirements
@@ -124,7 +124,7 @@ openssl pkcs12 -export -certfile CyberSourceCertAuth.crt -in <Merchant_ID>.crt -
 
 - Create JKS from p12 using keytool
 ```
-keytool -importkeystore -destkeystore <Your_keystore_name> -deststorepass <your_password> -srckeystore identity.p12 -srcstoretype PKCS12 -srcstorepass <Merchant_ID>
+keytool -importkeystore -destkeystore <Your_keystore_name>.jks -deststorepass <your_password> -srckeystore identity.p12 -srcstoretype PKCS12 -srcstorepass <Merchant_ID>
 ```
 - Now import the CyberSource_SJC_US.crt to your keystore
 ```
@@ -183,6 +183,13 @@ Retry Pattern allows to retry sending a failed request and it will only work wit
 
 ## Changes
 
+Version Cybersource-sdk-java 6.2.8 (OCT,2019)
+_______________________________
+
+  1)Added request header and logged request and response headers
+  
+  2)Caching of certificate is done using keyAlias earlier it was done using merchant_id
+
 Version Cybersource-sdk-java 6.2.7 (MAR,2019)
 _______________________________
   1) Fixed security vulnerabilities found in the jar dependencies.

java/src/main/java/com/cybersource/ws/client/Client.java

@@ -19,28 +19,19 @@
 package com.cybersource.ws.client;
 
 
-import org.apache.ws.security.util.XMLUtils;
 import org.w3c.dom.Document;
 import org.w3c.dom.Node;
 import org.w3c.dom.Text;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
-import javax.security.cert.X509Certificate;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.ParserConfigurationException;
-
-import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.StringReader;
 import java.lang.reflect.InvocationTargetException;
-import java.security.KeyStore;
-import java.security.cert.PKIXParameters;
-import java.security.cert.TrustAnchor;
 import java.text.MessageFormat;
 import java.util.HashMap;
-import java.util.Iterator;
 import java.util.Map;
 import java.util.Properties;
 
@@ -49,8 +40,6 @@
  * form of a Map object.
  */
 public class Client {
-    private static final String HEADER_FORMAT = "{0}={1}";
-
     private static final String SOAP_ENVELOPE1 = "<soap:Envelope xmlns:soap=\"" +
             "http://schemas.xmlsoap.org/soap/envelope/\">\n<soap:Body id=\"body1\">\n" +
             "<nvpRequest xmlns=\"{0}\">\n{1}</nvpRequest>" +
@@ -99,8 +88,6 @@ public static Map runTransaction(
         MerchantConfig mc;
         LoggerWrapper logger = null;
         Connection con = null;
-
-
         try {
             setVersionInformation(request);
 
@@ -229,16 +216,16 @@ private static Document soapWrapAndSign(
             		+ mapToString(request, true, PCI.REQUEST));
         }
 
-        Document wrappedDoc = soapWrap(request, mc, builder,logger);
+        Document wrappedDoc = soapWrap(request, mc, builder);
         logger.log(Logger.LT_INFO, "Client, End of soapWrap   ",true); 
 
-        Document resultDocument = null;
+        Document resultDocument;
 
         SecurityUtil.loadMerchantP12File(mc,logger);
         logger.log(Logger.LT_INFO, "Client, End of loading Merchant Certificates ", true);       
 
         // sign Document object
-        resultDocument = SecurityUtil.createSignedDoc(wrappedDoc, mc.getMerchantID(), mc.getKeyPassword(), logger);
+        resultDocument = SecurityUtil.createSignedDoc(wrappedDoc, mc.getKeyAlias(), mc.getKeyPassword(), logger);
         logger.log(Logger.LT_INFO, "Client, End of createSignedDoc   ", true);
 
         if ( mc.getUseSignAndEncrypted() ) {
@@ -254,7 +241,7 @@ private static Document soapWrapAndSign(
         return resultDocument ;
     }
 
-    private static Document soapWrap(Map request, MerchantConfig mc, DocumentBuilder builder, LoggerWrapper logger) throws SAXException, IOException{
+    private static Document soapWrap(Map request, MerchantConfig mc, DocumentBuilder builder) throws SAXException, IOException{
     	// wrap in SOAP envelope
         Object[] arguments
                 = {mc.getEffectiveNamespaceURI(),

java/src/main/java/com/cybersource/ws/client/Connection.java

@@ -35,6 +35,7 @@
 import java.net.HttpURLConnection;
 import java.net.MalformedURLException;
 import java.net.ProtocolException;
+import java.util.concurrent.TimeUnit;
 
 
 /**
@@ -123,10 +124,9 @@ public Document post(Document request)
     private void checkForFault()
             throws FaultException, ClientException {
         try {
-            logger.log(Logger.LT_INFO, "Reading response...");
-
+            logger.log(Logger.LT_INFO, "waiting for response...");
             int responseCode = getHttpResponseCode();
-
+            logResponseHeaders();
             // if successful, there's nothing left to do here.
             // we'll process the response in a later method.
             if (responseCode == HttpURLConnection.HTTP_OK) return;
@@ -193,7 +193,10 @@ private void checkForFault()
     private Document parseReceivedDocument()
             throws IOException, SAXException {
         logger.log(Logger.LT_INFO, "Parsing response...");
-        return builder.parse(getResponseStream());
+        //long startTime = System.nanoTime();
+        Document document = builder.parse(getResponseStream());
+        //System.out.println("Connection.parseReceivedDocument time taken to parse the response is " + TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime) + " ms");
+        return document;
     }
 
     /**
@@ -214,7 +217,15 @@ static ByteArrayOutputStream makeStream(Document doc)
 
         return baos;
     }
+    /*
+     * Log Request and Response Headers
+     * 
+     */
+
+    	abstract public void logRequestHeaders();
+    	abstract public void logResponseHeaders();
 }
 
+
 /* Copyright 2006 CyberSource Corporation */
 

java/src/main/java/com/cybersource/ws/client/HttpClientConnection.java

@@ -33,11 +33,9 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.net.MalformedURLException;
-import java.net.ProtocolException;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
-
 /**
  * Class helps in posting the Request document for the Transaction using HttpClient.
  * Converts the document to String format and also helps in setting up the Proxy connections.
@@ -57,9 +55,7 @@ class HttpClientConnection extends Connection {
      * @see com.cybersource.ws.client.Connection#postDocument(org.w3c.dom.Document)
      */
     void postDocument(Document request)
-            throws IOException, TransformerConfigurationException,
-            TransformerException, MalformedURLException,
-            ProtocolException {
+            throws IOException, TransformerException {
 
     	/*
     	 * SimpleHttpConnectionManager(boolean alwaysClose) : 
@@ -81,7 +77,8 @@ void postDocument(Document request)
 
         postMethod.setRequestEntity(
                 new StringRequestEntity(requestString, null, "UTF-8"));
-
+        postMethod.setRequestHeader(Utility.ORIGIN_TIMESTAMP, String.valueOf(System.currentTimeMillis()));
+		logRequestHeaders();
         httpClient.executeMethod(postMethod);
     }
 
@@ -105,8 +102,7 @@ public void release() {
     /* (non-Javadoc)
      * @see com.cybersource.ws.client.Connection#getHttpResponseCode()
      */
-    int getHttpResponseCode()
-            throws IOException {
+    int getHttpResponseCode(){
         return postMethod != null ? postMethod.getStatusCode() : -1;
     }
 
@@ -222,7 +218,6 @@ public boolean retryMethod(
          	        Thread.sleep(retryWaitInterval);
          	        logger.log( Logger.LT_INFO+" Retrying Request -- ",mc.getUniqueKey().toString()+ " Retry Count -- "+executionCount);
                  } catch (InterruptedException e) {
-         	        // TODO Auto-generated catch block
          	        e.printStackTrace();
                  }
                 return true;
@@ -231,6 +226,19 @@ public boolean retryMethod(
             return false;
         }
     }
+    
+    @Override
+	public void logRequestHeaders() {		
+		List<Header> reqheaders=Arrays.asList(postMethod.getRequestHeaders());
+        logger.log(Logger.LT_INFO, "Request Headers: " +reqheaders);
+	}
+	
+	@Override
+	public void logResponseHeaders() {
+		List<Header> respheaders=Arrays.asList(postMethod.getResponseHeaders());
+		 logger.log(Logger.LT_INFO, "Response Headers"+ respheaders);
+	}
+	
 }
 
 /* Copyright 2006 CyberSource Corporation */

java/src/main/java/com/cybersource/ws/client/Identity.java

@@ -43,8 +43,6 @@ public class Identity {
 
     private char[] pswd;
 
-    private Logger logger = null;
-    
     /**
      * Creates an Identity instance.this type of the instance can
      * only be used to store server certificate identity.
@@ -56,18 +54,15 @@ public class Identity {
     public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate,Logger logger) throws SignException {
         this.merchantConfig = merchantConfig;
         this.x509Cert=x509Certificate;
-        if(this.logger == null){
-        	this.logger=logger;
-        }
         if(merchantConfig.isJdkCertEnabled() || merchantConfig.isCacertEnabled()){
             setupJdkServerCerts();
         }
         else{
           setUpServer();
         }
     }
+
     private void setupJdkServerCerts() throws SignException {
-        
         if (x509Cert != null) {
             String subjectDN = x509Cert.getSubjectDN().getName();
             if (subjectDN != null) {
@@ -82,7 +77,6 @@ else if (subjectDNrray.length == 2 && subjectDNrray[1].contains(SERVER_ALIAS)) {
                 }else{
                     throw new SignException("Exception while obtaining private key from KeyStore with alias, '" + merchantConfig.getKeyAlias() + "'");
                 }
-                
             } else {
                 throw new SignException("Exception while obtaining private key from KeyStore with alias, '" + merchantConfig.getKeyAlias() + "'");
             }
@@ -99,17 +93,13 @@ else if (subjectDNrray.length == 2 && subjectDNrray[1].contains(SERVER_ALIAS)) {
      * @param privateKey
      * @throws SignException
      */
-    public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate, PrivateKey privateKey,Logger logger) throws SignException {
+    public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate, PrivateKey privateKey, Logger logger) throws SignException {
         this.merchantConfig = merchantConfig;
         this.x509Cert = x509Certificate;
         this.privateKey = privateKey;
-        if(this.logger == null){
-        	this.logger=logger;
-        }
         try {
 			this.lastModifiedDate=merchantConfig.getKeyFile().lastModified();
 		} catch (ConfigException e) {
-			
 			logger.log(Logger.LT_EXCEPTION,
                     "Identity object ,cannot instantiate with key file lastModifiedDate. "
                     + e.getMessage());
@@ -123,7 +113,7 @@ public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate, P
      * else isValid method will return true and certificate reload will not occur.
     */
 
-	public boolean isValid(File keyFile) {
+	public boolean isValid(File keyFile, Logger logger) {
 		boolean changeKeyFileStatus=(this.lastModifiedDate == keyFile.lastModified());
 		if (!changeKeyFileStatus) {
 			logger.log(Logger.LT_INFO, "Key file changed");
@@ -136,14 +126,14 @@ private void setUpMerchant() throws SignException {
         if (serialNumber == null && x509Cert != null) {
             String subjectDN = x509Cert.getSubjectDN().getName();
             if (subjectDN != null) {
-                String subjectDNrray[] = subjectDN.split("SERIALNUMBER=");
+                String[] subjectDNrray = subjectDN.split("SERIALNUMBER=");
                 if (subjectDNrray.length != 2) {
                     throw new SignException("Exception while obtaining private key from KeyStore with alias, '" + merchantConfig.getKeyAlias() + "'");
                 }
                 name = merchantConfig.getMerchantID();
                 pswd = merchantConfig.getKeyPassword().toCharArray();
                 serialNumber = subjectDNrray[1];
-                keyAlias = "serialNumber=" + serialNumber + ",CN=" + name;
+                keyAlias = merchantConfig.getKeyAlias();
             } else {
                 throw new SignException("Exception while obtaining private key from KeyStore with alias, '" + merchantConfig.getKeyAlias() + "'");
             }
@@ -155,7 +145,7 @@ private void setUpServer() throws SignException {
         if (serialNumber == null && x509Cert != null) {
             String subjectDN = x509Cert.getSubjectDN().getName();
             if (subjectDN != null) {
-                String subjectDNrray[] = subjectDN.split("SERIALNUMBER=");
+                String[] subjectDNrray = subjectDN.split("SERIALNUMBER=");
                 if (subjectDNrray.length == 1 && subjectDNrray[0].contains("CyberSourceCertAuth")){
                     name = keyAlias = "CyberSourceCertAuth";
                 }