- Adding private constructors

- Minor cleanup of code

Author: danny-gallagher

src/main/java/com/mastercard/developer/encryption/EncryptionConfig.java

@@ -21,24 +21,24 @@ public enum Scheme {
     /**
      * The encryption scheme to be used
      */
-    protected Scheme scheme = Scheme.LEGACY;
+    Scheme scheme = Scheme.LEGACY;
 
     /**
      * The SHA-256 hex-encoded digest of the key used for encryption (optional, the digest will be
      * automatically computed if this field is null or empty).
      * Example: "c3f8ef7053c4fb306f7476e7d1956f0aa992ff9dfdd5244b912a1d377ff3a84f"
      */
-    protected String encryptionKeyFingerprint;
+    String encryptionKeyFingerprint;
 
     /**
      * A certificate object whose public key will be used for encryption.
      */
-    protected Certificate encryptionCertificate;
+    Certificate encryptionCertificate;
 
     /**
      * A private key object to be used for decryption.
      */
-    protected PrivateKey decryptionKey;
+    PrivateKey decryptionKey;
 
     /**
      * A list of JSON paths to encrypt in request payloads.
@@ -51,7 +51,7 @@ public enum Scheme {
      * }
      * </pre>
      */
-    protected Map<String, String> encryptionPaths = Collections.emptyMap();
+    Map<String, String> encryptionPaths = Collections.emptyMap();
 
     /**
      * A list of JSON paths to decrypt in response payloads.
@@ -64,12 +64,12 @@ public enum Scheme {
      * }
      * </pre>
      */
-    protected Map<String, String> decryptionPaths = Collections.emptyMap();
+    Map<String, String> decryptionPaths = Collections.emptyMap();
 
     /**
      * The name of the payload field where to write/read the encrypted data value.
      */
-    protected String encryptedValueFieldName = null;
+    String encryptedValueFieldName = null;
 
     public String getEncryptionKeyFingerprint() { return encryptionKeyFingerprint; }
 
@@ -83,15 +83,15 @@ public PrivateKey getDecryptionKey() {
 
     public Scheme getScheme() { return scheme; }
 
-    public Map<String, String> getEncryptionPaths() {
+    Map<String, String> getEncryptionPaths() {
         return encryptionPaths;
     }
 
-    public Map<String, String> getDecryptionPaths() {
+    Map<String, String> getDecryptionPaths() {
         return decryptionPaths;
     }
 
-    public String getEncryptedValueFieldName() {
+    String getEncryptedValueFieldName() {
         return encryptedValueFieldName;
     }
 }

src/main/java/com/mastercard/developer/encryption/FieldLevelEncryption.java

@@ -23,6 +23,10 @@
  */
 public class FieldLevelEncryption {
 
+    private FieldLevelEncryption() {
+        // Nothing to do here
+    }
+
     public static String encryptPayload(String payload, FieldLevelEncryptionConfig config) throws EncryptionException {
         return encryptPayload(payload, config, null);
     }

src/main/java/com/mastercard/developer/encryption/FieldLevelEncryptionConfig.java

@@ -18,73 +18,73 @@ public enum FieldValueEncoding {
      * automatically computed if this field is null or empty).
      * Example: "4d9d7540be320429ffc8e6506f054525816e2d0e95a85247d5b58be713f28be0"
      */
-    protected String encryptionCertificateFingerprint;
+    String encryptionCertificateFingerprint;
 
     /**
      * The digest algorithm to be used for the RSA OAEP padding. Example: "SHA-512".
      */
-    protected String oaepPaddingDigestAlgorithm = null;
+    String oaepPaddingDigestAlgorithm = null;
 
     /**
      * The name of the payload field where to write/read the digest algorithm used for
      * the RSA OAEP padding (optional, the field won't be set if the name is null or empty).
      */
-    protected String oaepPaddingDigestAlgorithmFieldName = null;
+    String oaepPaddingDigestAlgorithmFieldName = null;
 
     /**
      * The name of the HTTP header where to write/read the digest algorithm used for
      * the RSA OAEP padding (optional, the header won't be set if the name is null or empty).
      */
-    protected String oaepPaddingDigestAlgorithmHeaderName = null;
+    String oaepPaddingDigestAlgorithmHeaderName = null;
 
     /**
      * The name of the payload field where to write/read the initialization vector value.
      */
-    protected String ivFieldName = null;
+    String ivFieldName = null;
 
     /**
      * The name of the header where to write/read the initialization vector value.
      */
-    protected String ivHeaderName = null;
+    String ivHeaderName = null;
 
     /**
      * The name of the payload field where to write/read the one-time usage encrypted symmetric key.
      */
-    protected String encryptedKeyFieldName = null;
+    String encryptedKeyFieldName = null;
 
     /**
      * The name of the header where to write/read the one-time usage encrypted symmetric key.
      */
-    protected String encryptedKeyHeaderName = null;
+    String encryptedKeyHeaderName = null;
 
     /**
      * The name of the payload field where to write/read the digest of the encryption
      * certificate (optional, the field won't be set if the name is null or empty).
      */
-    protected String encryptionCertificateFingerprintFieldName = null;
+    String encryptionCertificateFingerprintFieldName = null;
 
     /**
      * The name of the header where to write/read the digest of the encryption
      * certificate (optional, the header won't be set if the name is null or empty).
      */
-    protected String encryptionCertificateFingerprintHeaderName = null;
+    String encryptionCertificateFingerprintHeaderName = null;
 
     /**
      * The name of the payload field where to write/read the digest of the encryption
      * key (optional, the field won't be set if the name is null or empty).
      */
-    protected String encryptionKeyFingerprintFieldName = null;
+    String encryptionKeyFingerprintFieldName = null;
 
     /**
      * The name of the header where to write/read the digest of the encryption
      * key (optional, the header won't be set if the name is null or empty).
      */
-    protected String encryptionKeyFingerprintHeaderName = null;
+    String encryptionKeyFingerprintHeaderName = null;
 
     /**
      * How the field/header values have to be encoded.
      */
-    protected FieldLevelEncryptionConfig.FieldValueEncoding fieldValueEncoding;
+    FieldLevelEncryptionConfig.FieldValueEncoding fieldValueEncoding;
 
     /**
      * If the encryption parameters must be written to/read from HTTP headers.
@@ -96,7 +96,7 @@ public boolean useHttpHeaders() {
     /**
      * If the encryption parameters must be written to/read from HTTP payloads.
      */
-    public boolean useHttpPayloads() {
+    boolean useHttpPayloads() {
         return encryptedKeyFieldName != null && ivFieldName != null;
     }
 

src/main/java/com/mastercard/developer/encryption/JsonParser.java

@@ -12,6 +12,10 @@
 
 final class JsonParser {
 
+    private JsonParser() {
+        // Nothing to do here
+    }
+
     static JsonEngine jsonEngine;
     static Configuration jsonPathConfig = withJsonEngine(JsonEngine.getDefault());
 

src/main/java/com/mastercard/developer/encryption/JweEncryption.java

@@ -2,8 +2,8 @@
 
 import com.jayway.jsonpath.DocumentContext;
 import com.jayway.jsonpath.JsonPath;
-import com.mastercard.developer.encryption.jwe.JWEHeader;
-import com.mastercard.developer.encryption.jwe.JWEObject;
+import com.mastercard.developer.encryption.jwe.JweHeader;
+import com.mastercard.developer.encryption.jwe.JweObject;
 
 import java.security.GeneralSecurityException;
 import java.util.ArrayList;
@@ -15,6 +15,10 @@
 
 public class JweEncryption {
 
+    private JweEncryption() {
+        // Nothing to do here
+    }
+
     private static final String ALGORITHM = "RSA-OAEP-256";
     private static final String ENCRYPTION = "A256GCM";
     private static final String CONTENT_TYPE = "application/json";
@@ -65,8 +69,8 @@ private static void encryptPayloadPath(DocumentContext payloadContext, String js
         }
 
         String inJsonString = sanitizeJson(jsonEngine.toJsonString(inJsonElement));
-        JWEHeader myHeader = new JWEHeader(ALGORITHM, ENCRYPTION, config.encryptionKeyFingerprint, CONTENT_TYPE);
-        String payload = JWEObject.encrypt(config, inJsonString, myHeader);
+        JweHeader myHeader = new JweHeader(ALGORITHM, ENCRYPTION, config.encryptionKeyFingerprint, CONTENT_TYPE);
+        String payload = JweObject.encrypt(config, inJsonString, myHeader);
 
         // Delete data in clear
         if (!"$".equals(jsonPathIn)) {
@@ -100,7 +104,7 @@ private static void decryptPayloadPath(DocumentContext payloadContext, String js
         }
 
         String encryptedValue = jsonEngine.toJsonString(encryptedValueJsonElement).replace("\"", "");
-        JWEObject jweObject = JWEObject.parse(encryptedValue, jsonEngine);
+        JweObject jweObject = JweObject.parse(encryptedValue, jsonEngine);
         String payload = jweObject.decrypt(config);
 
         // Add decrypted data at the given JSON path

src/main/java/com/mastercard/developer/encryption/aes/AESCBC.java

@@ -1,6 +1,6 @@
 package com.mastercard.developer.encryption.aes;
 
-import com.mastercard.developer.encryption.jwe.JWEObject;
+import com.mastercard.developer.encryption.jwe.JweObject;
 import com.mastercard.developer.utils.EncodingUtils;
 
 import javax.crypto.Cipher;
@@ -17,7 +17,7 @@ private AESCBC() {
 
     private static final String CYPHER = "AES/CBC/PKCS5Padding";
 
-    public static byte[] decrypt(Key secretKey, JWEObject object) throws GeneralSecurityException {
+    public static byte[] decrypt(Key secretKey, JweObject object) throws GeneralSecurityException {
         SecretKeySpec aesKey = new SecretKeySpec(secretKey.getEncoded(), 16, 16, "AES");
 
         byte[] cipherText = EncodingUtils.base64Decode(object.getCipherText());

src/main/java/com/mastercard/developer/encryption/aes/AESEncryption.java

@@ -10,6 +10,10 @@
 
 public class AESEncryption {
 
+    private AESEncryption() {
+        // Nothing to do here
+    }
+
     public static IvParameterSpec generateIv() throws EncryptionException {
         try {
             SecureRandom secureRandom = SecureRandom.getInstance("SHA1PRNG");

src/main/java/com/mastercard/developer/encryption/aes/AESGCM.java

@@ -1,6 +1,6 @@
 package com.mastercard.developer.encryption.aes;
 
-import com.mastercard.developer.encryption.jwe.JWEObject;
+import com.mastercard.developer.encryption.jwe.JweObject;
 import com.mastercard.developer.utils.ByteUtils;
 import com.mastercard.developer.utils.EncodingUtils;
 
@@ -15,11 +15,12 @@
 public class AESGCM {
 
     private AESGCM() {
+        // Nothing to do here
     }
 
     private static final String CYPHER = "AES/GCM/NoPadding";
 
-    public static byte[] decrypt(Key cek, JWEObject object) throws GeneralSecurityException {
+    public static byte[] decrypt(Key cek, JweObject object) throws GeneralSecurityException {
         byte[] aad = object.getRawHeader().getBytes(StandardCharsets.US_ASCII);
         SecretKey aesKey = new SecretKeySpec(cek.getEncoded(), "AES");
         GCMParameterSpec gcmSpec = new GCMParameterSpec(128, EncodingUtils.base64Decode(object.getIv()));

…/developer/encryption/jwe/JWEHeader.java …/developer/encryption/jwe/JweHeader.javasrc/main/java/com/mastercard/developer/encryption/jwe/JWEHeader.java renamed to src/main/java/com/mastercard/developer/encryption/jwe/JweHeader.java src/main/java/com/mastercard/developer/encryption/jwe/JWEHeader.java renamed to src/main/java/com/mastercard/developer/encryption/jwe/JweHeader.java

@@ -4,13 +4,13 @@
 import com.mastercard.developer.json.JsonEngine;
 import com.mastercard.developer.utils.EncodingUtils;
 
-public final class JWEHeader {
+public final class JweHeader {
     private final String enc;
     private final String kid;
     private final String alg;
     private final String cty;
 
-    public JWEHeader(String alg, String enc, String kid, String cty) {
+    public JweHeader(String alg, String enc, String kid, String cty) {
         this.alg = alg;
         this.enc = enc;
         this.kid = kid;
@@ -36,14 +36,14 @@ String toJson() {
         return engine.toJsonString(obj);
     }
 
-    static JWEHeader parseJweHeader(String encodedHeader, JsonEngine jsonEngine) {
+    static JweHeader parseJweHeader(String encodedHeader, JsonEngine jsonEngine) {
         Object headerObj = jsonEngine.parse(new String(EncodingUtils.base64Decode(encodedHeader)));
         JsonProvider jsonProvider = jsonEngine.getJsonProvider();
         String alg = jsonProvider.getMapValue(headerObj, "alg").toString();
         String enc = jsonProvider.getMapValue(headerObj, "enc").toString();
         String kid = jsonProvider.getMapValue(headerObj, "kid").toString();
         Object cty = jsonProvider.getMapValue(headerObj, "cty");
-        return new JWEHeader(alg, enc, kid, cty != null ? cty.toString() : null);
+        return new JweHeader(alg, enc, kid, cty != null ? cty.toString() : null);
     }
 
     String getEnc() { return enc; }

…/developer/encryption/jwe/JWEObject.java …/developer/encryption/jwe/JweObject.javasrc/main/java/com/mastercard/developer/encryption/jwe/JWEObject.java renamed to src/main/java/com/mastercard/developer/encryption/jwe/JweObject.java src/main/java/com/mastercard/developer/encryption/jwe/JWEObject.java renamed to src/main/java/com/mastercard/developer/encryption/jwe/JweObject.java

@@ -19,8 +19,8 @@
 import java.security.Key;
 import java.util.Base64;
 
-public class JWEObject {
-    private final JWEHeader header;
+public class JweObject {
+    private final JweHeader header;
     private final String rawHeader;
     private final String encryptedKey;
     private final String iv;
@@ -30,7 +30,7 @@ public class JWEObject {
     private static final String A128CBC_HS256 = "A128CBC-HS256";
     private static final String A256GCM = "A256GCM";
 
-    private JWEObject(JWEHeader header, String rawHeader, String encryptedKey, String iv, String cipherText, String authTag) {
+    private JweObject(JweHeader header, String rawHeader, String encryptedKey, String iv, String cipherText, String authTag) {
         this.header = header;
         this.rawHeader = rawHeader;
         this.encryptedKey = encryptedKey;
@@ -56,7 +56,7 @@ public String decrypt(JweConfig config) throws EncryptionException, GeneralSecur
         return new String(plainText);
     }
 
-    public static String encrypt(JweConfig config, String payload, JWEHeader header) throws EncryptionException, GeneralSecurityException {
+    public static String encrypt(JweConfig config, String payload, JweHeader header) throws EncryptionException, GeneralSecurityException {
         SecretKeySpec cek = AESEncryption.generateCek(256);
         byte[] encryptedSecretKeyBytes = RSA.wrapSecretKey(config.getEncryptionCertificate().getPublicKey(), cek, "SHA-256");
         String encryptedKey = base64Encode(encryptedSecretKeyBytes);
@@ -82,34 +82,32 @@ public static String encrypt(JweConfig config, String payload, JWEHeader header)
     }
 
     private static String serialize(String header, String encryptedKey, String iv, String cipherText, String authTag) {
-        StringBuilder sb = new StringBuilder(header);
-        sb.append('.');
-        sb.append(encryptedKey);
-        sb.append('.');
-        sb.append(iv);
-        sb.append('.');
-        sb.append(cipherText);
-        sb.append('.');
-        sb.append(authTag);
-        return sb.toString();
+        return header + '.' +
+                encryptedKey +
+                '.' +
+                iv +
+                '.' +
+                cipherText +
+                '.' +
+                authTag;
     }
 
     private static String base64Encode(byte[] bytes) {
         return EncodingUtils.encodeBytes(bytes, FieldLevelEncryptionConfig.FieldValueEncoding.BASE64);
     }
 
-    public static JWEObject parse(String encryptedPayload, JsonEngine jsonEngine) {
+    public static JweObject parse(String encryptedPayload, JsonEngine jsonEngine) {
         String t = encryptedPayload.trim();
         int dot1 = t.indexOf('.');
         int dot2 = t.indexOf('.', dot1 + 1);
         int dot3 = t.indexOf('.', dot2 + 1);
         int dot4 = t.indexOf('.', dot3 + 1);
-        JWEHeader header = JWEHeader.parseJweHeader(t.substring(0, dot1), jsonEngine);
+        JweHeader header = JweHeader.parseJweHeader(t.substring(0, dot1), jsonEngine);
 
-        return new JWEObject(header, t.substring(0, dot1), t.substring(dot1 + 1, dot2), t.substring(dot2 + 1, dot3), t.substring(dot3 + 1, dot4), t.substring(dot4 + 1));
+        return new JweObject(header, t.substring(0, dot1), t.substring(dot1 + 1, dot2), t.substring(dot2 + 1, dot3), t.substring(dot3 + 1, dot4), t.substring(dot4 + 1));
     }
 
-    public JWEHeader getHeader() {
+    public JweHeader getHeader() {
         return header;
     }