merchant key validity check and optional caching implementation while executing loadMerchantP12File method.

Author: ammajumd

README.md

@@ -1,6 +1,6 @@
 # CyberSource Simple Order API for Java
 
-[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-java.png?branch=future)](https://travis-ci.org/CyberSource/cybersource-sdk-java)
+[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-java.png?branch=master)](https://travis-ci.org/CyberSource/cybersource-sdk-java)
 
 ## Package Managers
 
@@ -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.5</version>
+  <version>6.2.6</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.5'
+  compile 'com.cybersource:cybersource-sdk-java:6.2.6'
 }
 ```
 ## Requirements
@@ -61,6 +61,7 @@ You do not need to download and build the source to use the SDK but if you want
     - if `enablejdkcert` parameter is set to true, certificates will be read from the JKS file specified at keysDirectory location. The JKS file should be of the same name as specified in keyFilename.
       - To know how to convert p12 to JKS refer the JKS creation section of this document.
     - `enableCacerts` property is considered only if `enablejdkcert` is set to true. If `enableCacerts` is set to true, certificates will be read from the cacerts folder under the JDK.
+    - if `certificateCacheEnabled` parameter is set to false (default is true), the p12 certificate of a merchant will be reloaded from filesystem every time a transaction is made 
     - `allowRetry` config parameter will only work for HttpClient. Set `allowRetry` config parameter to "true" to enable retry mechanism and set merchant specific values for the retry.
     - Set integer values for config parameter `numberOfRetries` *and* `retryInterval`. Retry Interval is time delay for next retry in seconds.
       - Number of retry parameter should be set between 1 to 5. Any other value will throw an Error Message.
@@ -181,12 +182,12 @@ Retry Pattern allows to retry sending a failed request and it will only work wit
 
 ## Changes
 
-Version Cybersource-sdk-java 6.2.5 (OCT,2017)
+Version Cybersource-sdk-java 6.2.6 (OCT,2017)
 _______________________________
   1) Merchant cert to be read from JAVA key store. Flag is added to enable reading cert from Java keystore.
   2) Added Custom HttpClient feature. Merchants can use there own http client instead of defaults which comes with SDK.
   3) Http Client connection reuse issue.
-  4) Changed clientLibrary version to 6.2.5; in 6.2.4 release it was missed. So, in 6.2.4 release, clientLibrary version was      pointing to 6.2.3.
+  4) Changed clientLibrary version to 6.2.6; in 6.2.4 release it was missed. So, in 6.2.4 release, clientLibrary version was      pointing to 6.2.3.
 _______________________________  
 Version Cybersource-sdk-java 6.2.4 (Dec 15, 2016)
 _______________________________

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

@@ -41,7 +41,7 @@ public class Identity {
 
     private static final String SERVER_ALIAS = "CyberSource_SJC_US";
 
-    Logger logger = new LoggerImpl(merchantConfig);
+    private Logger logger = null;
 
 
 
@@ -55,9 +55,12 @@ public class Identity {
      * @param x509Certificate
      * @throws SignException
      */
-    public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate) throws SignException {
+    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()){
             setupJdkServerCerts();
         }
@@ -98,26 +101,38 @@ else if (subjectDNrray.length == 2 && subjectDNrray[1].contains(SERVER_ALIAS)) {
      * @param privateKey
      * @throws SignException
      */
-    public Identity(MerchantConfig merchantConfig,X509Certificate x509Certificate, PrivateKey privateKey) 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());
-         throw new SignException(e.getMessage());
+         throw new SignException("Exception While initializing the merchant identity constructor with keyfile last modified date"+e.getMessage());
 		}
         setUpMerchant();
     }
 
     public boolean isValid(File keyFile)
     {
 
-       return this.lastModifiedDate == keyFile.lastModified();
+    	if(this.lastModifiedDate == keyFile.lastModified()){
+    		
+    	     logger.log(Logger.LT_INFO, "key files not yet changed");
+    	}
+    	//boolean b=this.lastModifiedDate == keyFile.lastModified();
+    	//String p=String.valueOf(b);
+    	//logger.log(Logger.LT_INFO,"Check the merchant certificate is new " +p);
+       //return b;
+    	//logger.log(Logger.LT_INFO, "Could not load the custom HTTP class ");
+    	return this.lastModifiedDate == keyFile.lastModified();
     }
 
     private void setUpMerchant() throws SignException {

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

@@ -66,6 +66,7 @@ public class MerchantConfig {
     private String cacertPassword;
     private String customHttpClass;
     private boolean customHttpClassEnabled;
+    private boolean certificateCacheEnabled; 
 
     public String getcustomHttpClass() {
 		return customHttpClass;
@@ -83,6 +84,8 @@ public boolean isCustomHttpClassEnabled() {
     private int numberOfRetries = 0;
     private long retryInterval  = 0;
     private boolean allowRetry=true;
+
+	
 
 
     // getter methods
@@ -183,6 +186,10 @@ public String getProxyPassword() {
         return proxyPassword != null ? proxyPassword : "";
     }
 
+    public boolean isCertificateCacheEnabled() {  
+        return certificateCacheEnabled;  
+    }  
+    
     /**
      * Returns the effective server URL to which the request will be sent.
      * If a serverURL is specified, then that is what is returned.
@@ -271,6 +278,7 @@ public MerchantConfig(Properties _props, String _merchantID)
         enableCacert=getBooleanProperty(merchantID, "enableCacert", false);
         cacertPassword=getProperty(merchantID,"cacertPassword","changeit");
         customHttpClassEnabled=getBooleanProperty(merchantID,"customHttpClassEnabled",false);
+        certificateCacheEnabled=getBooleanProperty(merchantID,"certificateCacheEnabled",true); 
         // compute and store effective namespace URI
 
         if (namespaceURI == null && targetAPIVersion == null) {
@@ -495,6 +503,7 @@ public String getLogString() {
             }
         }
         appendPair(sb, "useSignAndEncrypted", useSignAndEncrypted);
+        appendPair(sb, "certificateCacheEnabled", certificateCacheEnabled);
         return (sb.toString());
     }
 
@@ -580,4 +589,5 @@ public boolean isJdkCertEnabled() {
     public String getCacertPassword(){
         return cacertPassword;
     }
+	
 }

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

@@ -23,7 +23,6 @@
 import java.security.UnrecoverableKeyException;
 import java.security.cert.CertificateException;
 import java.security.cert.X509Certificate;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.concurrent.ConcurrentHashMap;
@@ -81,13 +80,13 @@ private static void initKeystore() throws KeyStoreException, CredentialException
      */
     public static void loadMerchantP12File(MerchantConfig merchantConfig, Logger logger) throws SignException, SignEncryptException, ConfigException {
 
-        // Load the KeyStore and get the signing key and certificate do this once only
+        // Load the KeyStore and get the signing key and certificate
         // This change is made based on the assumptions that at point of time , a merchant will have only one P12 Key
 
 
 
         Identity identity=identities.get(merchantConfig.getMerchantID());
-        if(identity == null || !(identity.isValid(merchantConfig.getKeyFile()))){
+        if(!merchantConfig.isCertificateCacheEnabled() || identity == null || !(identity.isValid(merchantConfig.getKeyFile()))){
             try {
                 if (localKeyStoreHandler == null)
                     initKeystore();
@@ -164,12 +163,12 @@ private static void readAndStoreCertificateAndPrivateKey(MerchantConfig merchant
                         throw new SignException(e);
                     }
 
-                    Identity identity = new Identity(merchantConfig,(X509Certificate) keyEntry.getCertificate(),keyEntry.getPrivateKey());
+                    Identity identity = new Identity(merchantConfig,(X509Certificate) keyEntry.getCertificate(),keyEntry.getPrivateKey(),logger);
                     localKeyStoreHandler.addIdentityToKeyStore(identity, logger);
                     identities.put(identity.getName(), identity);
                     continue;
                 }
-                Identity identity = new Identity(merchantConfig, (X509Certificate) merchantKeyStore.getCertificate(merchantKeyAlias));
+                Identity identity = new Identity(merchantConfig, (X509Certificate) merchantKeyStore.getCertificate(merchantKeyAlias),logger);
                 localKeyStoreHandler.addIdentityToKeyStore(identity, logger);
                 identities.put(identity.getName(), identity);
             }
@@ -312,12 +311,12 @@ public static void readJdkCert(MerchantConfig merchantConfig, Logger logger) thr
                             throw new SignException(e);
                         }
 
-                        Identity identity = new Identity(merchantConfig,(X509Certificate) keyEntry.getCertificate(),keyEntry.getPrivateKey());
+                        Identity identity = new Identity(merchantConfig,(X509Certificate) keyEntry.getCertificate(),keyEntry.getPrivateKey(),logger);
                         localKeyStoreHandler.addIdentityToKeyStore(identity, logger);
                         identities.put(identity.getName(), identity);
                         continue;
                     }
-                    Identity identity = new Identity(merchantConfig, (X509Certificate) keystore.getCertificate(merchantKeyAlias));
+                    Identity identity = new Identity(merchantConfig, (X509Certificate) keystore.getCertificate(merchantKeyAlias),logger);
                     localKeyStoreHandler.addIdentityToKeyStore(identity, logger);
                     identities.put(identity.getName(), identity);
                 }
@@ -358,13 +357,13 @@ private static void loadJavaKeystore(String keystore_location, MerchantConfig me
                 if (merchantConfig.getKeyAlias().equals(
                                                         keystore.getCertificateAlias(cert[i]))) {
                     identity = new Identity(merchantConfig,
-                                            (X509Certificate) cert[i], key);
+                                            (X509Certificate) cert[i], key,logger);
                     localKeyStoreHandler
                     .addIdentityToKeyStore(identity, logger);
                     identities.put(identity.getName(), identity);
                 } else {
                     identity = new Identity(merchantConfig,
-                                            (X509Certificate) cert[i]);
+                                            (X509Certificate) cert[i],logger);
                     localKeyStoreHandler
                     .addIdentityToKeyStore(identity, logger);
                     identities.put(identity.getName(), identity);
@@ -375,7 +374,7 @@ private static void loadJavaKeystore(String keystore_location, MerchantConfig me
                 	throw new SignException("Missing Server Certificate ");
                 }
             identity = new Identity(merchantConfig,
-                                    (X509Certificate) serverCert);
+                                    (X509Certificate) serverCert,logger);
             localKeyStoreHandler
             .addIdentityToKeyStore(identity, logger);
             identities.put(identity.getName(), identity);

java/src/main/resources/cybs.properties

@@ -54,6 +54,11 @@ enableLog=true
 logDirectory=../../logs
 logMaximumSize=10
 
+# If this property is set to false then the p12 certificate of a merchant will be reloaded  
+# every time a transaction is made  
+
+certificateCacheEnabled=true
+
 # Optional proxy server settings
 #proxyHost=<-- Set the Proxy Host-->
 #proxyPort=< -- Set the Proxy port-->

java/src/test/java/com/cybersource/ws/client/IdentityTest.java

@@ -34,9 +34,10 @@ public void testSetUpMerchant() throws InstantiationException, IllegalAccessExce
     	X509Certificate x509Cert = Mockito.mock(X509Certificate.class);
     	Principal principal =  Mockito.mock(Principal.class);
     	PrivateKey pkey = Mockito.mock(PrivateKey.class);
+    	Logger logger = Mockito.mock(Logger.class);
     	Mockito.when(x509Cert.getSubjectDN()).thenReturn(principal);
     	Mockito.when(principal.getName()).thenReturn(keyAlias);
-    	Identity identity = new Identity(config,x509Cert,pkey);
+    	Identity identity = new Identity(config,x509Cert,pkey,logger);
     	assertEquals(identity.getName(), config.getMerchantID());
     	assertEquals(identity.getSerialNumber(), "400000009910179089277");
     	assertNotNull(identity.getPrivateKey());
@@ -47,9 +48,10 @@ public void testsetUpServer() throws InstantiationException, IllegalAccessExcept
     	String keyAlias = "CN=CyberSource_SJC_US,SERIALNUMBER=400000009910179089277";
     	X509Certificate x509Cert = Mockito.mock(X509Certificate.class);
     	Principal principal =  Mockito.mock(Principal.class);
+    	Logger logger = Mockito.mock(Logger.class);
     	Mockito.when(x509Cert.getSubjectDN()).thenReturn(principal);
     	Mockito.when(principal.getName()).thenReturn(keyAlias);
-    	Identity identity = new Identity(config,x509Cert);
+    	Identity identity = new Identity(config,x509Cert,logger);
     	assertEquals(identity.getName(), "CyberSource_SJC_US");
     	assertEquals(identity.getSerialNumber(), "400000009910179089277");
     	assertNull(identity.getPrivateKey());