Replace assertions with explicit runtime checks.

Numerous 'assert' statements were replaced with explicit runtime
checks where warranted. Also, mass replace tabs with 4 spaces.

Author: kwwall

src/main/java/org/owasp/esapi/crypto/CipherTextSerializer.java

@@ -29,18 +29,18 @@
  * serialization technique so they could exchange encrypted data.)
  * 
  * @author [email protected]
+ * @since 2.0
  *
  */
 public class CipherTextSerializer {
     // This should be *same* version as in CipherText & KeyDerivationFunction as
-	// these versions all need to work together.  Therefore, when one changes one
-	// one these versions, the other should be reviewed and changed as well to
-	// accommodate any differences.
-	//		Previous versions:	20110203 - Original version (ESAPI releases 2.0 & 2.0.1)
-	//						    20130830 - Fix to issue #306 (release 2.1.0)
-	// We check that in an static initialization block (when assertions are enabled)
-	// below.
-	public  static final  int cipherTextSerializerVersion = 20130830; // Current version. Format: YYYYMMDD, max is 99991231.
+    // these versions all need to work together.  Therefore, when one changes one
+    // one these versions, the other should be reviewed and changed as well to
+    // accommodate any differences.
+    //        Previous versions:    20110203 - Original version (ESAPI releases 2.0 & 2.0.1)
+    //                            20130830 - Fix to issue #306 (release 2.1.0)
+    // We check that in an static initialization block below.
+    public  static final  int cipherTextSerializerVersion = 20130830; // Current version. Format: YYYYMMDD, max is 99991231.
     private static final long serialVersionUID = cipherTextSerializerVersion;
 
     private static final Logger logger = ESAPI.getLogger("CipherTextSerializer");
@@ -50,18 +50,20 @@ public class CipherTextSerializer {
     // Check if versions of KeyDerivationFunction, CipherText, and
     // CipherTextSerializer are all the same.
     {
-    	// Ignore error about comparing identical versions and dead code.
-    	// We expect them to be, but the point is to catch us if they aren't.
-    	assert CipherTextSerializer.cipherTextSerializerVersion == CipherText.cipherTextVersion :
-            "Versions of CipherTextSerializer and CipherText are not compatible.";
-    	assert CipherTextSerializer.cipherTextSerializerVersion == KeyDerivationFunction.kdfVersion :
-    		"Versions of CipherTextSerializer and KeyDerivationFunction are not compatible.";
+        // Ignore error about comparing identical versions and dead code.
+        // We expect them to be, but the point is to catch us if they aren't.
+        if ( CipherTextSerializer.cipherTextSerializerVersion != CipherText.cipherTextVersion ) {
+            throw new ExceptionInInitializerError("Versions of CipherTextSerializer and CipherText are not compatible.");
+        }
+        if ( CipherTextSerializer.cipherTextSerializerVersion != KeyDerivationFunction.kdfVersion ) {
+            throw new ExceptionInInitializerError("Versions of CipherTextSerializer and KeyDerivationFunction are not compatible.");
+        }
     }
 
     public CipherTextSerializer(CipherText cipherTextObj) {
-    	if ( cipherTextObj == null ) {
-    		throw new IllegalArgumentException("CipherText object must not be null.");
-    	}
+        if ( cipherTextObj == null ) {
+            throw new IllegalArgumentException("CipherText object must not be null.");
+        }
         cipherText_ = cipherTextObj;
     }
 
@@ -90,28 +92,28 @@ public byte[] asSerializedByteArray() {
         long timestamp = cipherText_.getEncryptionTimestamp();
         String cipherXform = cipherText_.getCipherTransformation();
         if ( cipherText_.getKeySize() >= Short.MAX_VALUE ) {
-        	throw new IllegalArgumentException("Key size is too large. Max is " + Short.MAX_VALUE);
+            throw new IllegalArgumentException("Key size is too large. Max is " + Short.MAX_VALUE);
         }
         short keySize = (short) cipherText_.getKeySize();
         if ( cipherText_.getBlockSize() >= Short.MAX_VALUE ) {
-        	throw new IllegalArgumentException("Block size is too large. Max is " + Short.MAX_VALUE);
+            throw new IllegalArgumentException("Block size is too large. Max is " + Short.MAX_VALUE);
         }
         short blockSize = (short) cipherText_.getBlockSize();
         byte[] iv = cipherText_.getIV();
         if ( iv.length >= Short.MAX_VALUE ) {
-        	throw new IllegalArgumentException("IV size too large. Max is " + Short.MAX_VALUE + " bytes");
+            throw new IllegalArgumentException("IV size too large. Max is " + Short.MAX_VALUE + " bytes");
         }
         short ivLen = (short) iv.length;
         byte[] rawCiphertext = cipherText_.getRawCipherText();
         int ciphertextLen = rawCiphertext.length;
         // Coverity issue 1352406, GitHub issue # 364 - possible NPE later if assertion disabled.
         // Replaced assertion with explicit check.
         if ( ciphertextLen < 1 ) {
-        	throw new IllegalArgumentException("Raw ciphertext length must be >= 1 byte.");
+            throw new IllegalArgumentException("Raw ciphertext length must be >= 1 byte.");
         }
         byte[] mac = cipherText_.getSeparateMAC();
         if ( mac.length >= Short.MAX_VALUE ) {
-        	throw new IllegalArgumentException("MAC length too large. Max is " + Short.MAX_VALUE + " bytes");
+            throw new IllegalArgumentException("MAC length too large. Max is " + Short.MAX_VALUE + " bytes");
         }
         short macLen = (short) mac.length;
 
@@ -136,36 +138,36 @@ public byte[] asSerializedByteArray() {
      * @return The {@code CipherText} object that we are serializing.
      */
     public CipherText asCipherText() {
-    	if ( cipherText_ == null ) {
-    		throw new IllegalArgumentException("Program error? CipherText object, cipherText_, must not be null.");
-    	}
+        if ( cipherText_ == null ) {
+            throw new IllegalArgumentException("Program error? CipherText object, cipherText_, must not be null.");
+        }
         return cipherText_;
     }
 
     /**
      * Take all the individual elements that make of the serialized ciphertext
      * format and put them in order and return them as a byte array.
-     * @param kdfInfo	Info about the KDF... which PRF and the KDF version {@link #asCipherText()}.
-     * @param timestamp	Timestamp when the data was encrypted. Intended to help
-     * 					facilitate key change operations and nothing more. If it is meaningless,
-     * 					then the expectations are just that the recipient should ignore it. Mostly
-     * 					intended when encrypted data is kept long term over a period of many
-     * 					key change operations.
-     * @param cipherXform	Details of how the ciphertext was encrypted. The format used
-     * 						is the same as used by {@code javax.crypto.Cipher}, namely,
-     * 						"cipherAlg/cipherMode/paddingScheme".
-     * @param keySize	The key size used for encrypting. Intended for cipher algorithms
-     * 					supporting multiple key sizes such as triple DES (DESede) or
-     * 					Blowfish.
-     * @param blockSize	The cipher block size. Intended to support cipher algorithms
-     * 					that support variable block sizes, such as Rijndael.
-     * @param ivLen		The length of the IV.
-     * @param iv		The actual IV (initialization vector) bytes.
-     * @param ciphertextLen	The length of the raw ciphertext.
-     * @param rawCiphertext	The actual raw ciphertext itself
-     * @param macLen	The length of the MAC (message authentication code).
-     * @param mac		The MAC itself.
-     * @return	A byte array representing the serialized ciphertext.
+     * @param kdfInfo    Info about the KDF... which PRF and the KDF version {@link #asCipherText()}.
+     * @param timestamp    Timestamp when the data was encrypted. Intended to help
+     *                     facilitate key change operations and nothing more. If it is meaningless,
+     *                     then the expectations are just that the recipient should ignore it. Mostly
+     *                     intended when encrypted data is kept long term over a period of many
+     *                     key change operations.
+     * @param cipherXform    Details of how the ciphertext was encrypted. The format used
+     *                         is the same as used by {@code javax.crypto.Cipher}, namely,
+     *                         "cipherAlg/cipherMode/paddingScheme".
+     * @param keySize    The key size used for encrypting. Intended for cipher algorithms
+     *                     supporting multiple key sizes such as triple DES (DESede) or
+     *                     Blowfish.
+     * @param blockSize    The cipher block size. Intended to support cipher algorithms
+     *                     that support variable block sizes, such as Rijndael.
+     * @param ivLen        The length of the IV.
+     * @param iv        The actual IV (initialization vector) bytes.
+     * @param ciphertextLen    The length of the raw ciphertext.
+     * @param rawCiphertext    The actual raw ciphertext itself
+     * @param macLen    The length of the MAC (message authentication code).
+     * @param mac        The MAC itself.
+     * @return    A byte array representing the serialized ciphertext.
      */
     private byte[] computeSerialization(int kdfInfo, long timestamp,
                                         String cipherXform, short keySize,
@@ -297,10 +299,10 @@ private long readLong(ByteArrayInputStream bais)
 
     /** Convert the serialized ciphertext byte array to a {@code CipherText}
      * object.
-     * @param cipherTextSerializedBytes	The serialized ciphertext as a byte array.
+     * @param cipherTextSerializedBytes    The serialized ciphertext as a byte array.
      * @return The corresponding {@code CipherText} object.
-     * @throws EncryptionException	Thrown if the byte array data is corrupt or
-     * 				there are version mismatches, etc.
+     * @throws EncryptionException    Thrown if the byte array data is corrupt or
+     *                 there are version mismatches, etc.
      */
     private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
         throws EncryptionException
@@ -309,7 +311,7 @@ private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
             if ( cipherTextSerializedBytes == null ) {
                 throw new IllegalArgumentException("cipherTextSerializedBytes cannot be null.");
             }
-        	if ( cipherTextSerializedBytes.length == 0 ) {
+            if ( cipherTextSerializedBytes.length == 0 ) {
                 throw new IllegalArgumentException("cipherTextSerializedBytes must be > 0 in length.");
             }
             ByteArrayInputStream bais = new ByteArrayInputStream(cipherTextSerializedBytes);
@@ -325,22 +327,22 @@ private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
 
             // First do a quick sanity check on the argument. Previously this was an assertion.
             if ( ! CryptoHelper.isValidKDFVersion(kdfVers, false, false) ) {
-            	// TODO: Clean up. Use StringBuilder. Good enough for now.
-            	String logMsg = "KDF version read from serialized ciphertext (" + kdfVers + ") is out of range. " +
-            				    "Valid range for KDF version is [" + KeyDerivationFunction.originalVersion + ", " +
-            				    "99991231].";
-            	// This should never happen under actual circumstances (barring programming errors; but we've
-            	// tested the code, right?), so it is likely an attempted attack. Thus don't get the originator
-            	// of the suspect ciphertext too much info. They ought to know what they sent anyhow.
-            	throw new EncryptionException("Version info from serialized ciphertext not in valid range.",
-            				 "Likely tampering with KDF version on serialized ciphertext." + logMsg);
+                // TODO: Clean up. Use StringBuilder. Good enough for now.
+                String logMsg = "KDF version read from serialized ciphertext (" + kdfVers + ") is out of range. " +
+                                "Valid range for KDF version is [" + KeyDerivationFunction.originalVersion + ", " +
+                                "99991231].";
+                // This should never happen under actual circumstances (barring programming errors; but we've
+                // tested the code, right?), so it is likely an attempted attack. Thus don't get the originator
+                // of the suspect ciphertext too much info. They ought to know what they sent anyhow.
+                throw new EncryptionException("Version info from serialized ciphertext not in valid range.",
+                             "Likely tampering with KDF version on serialized ciphertext." + logMsg);
             }
 
             debug("convertToCipherText: kdfPrf = " + kdfPrf + ", kdfVers = " + kdfVers);
             if ( ! versionIsCompatible( kdfVers) ) {
-            	throw new EncryptionException("This version of ESAPI is not compatible with the version of ESAPI that encrypted your data.",
-            			"KDF version " + kdfVers + " from serialized ciphertext not compatibile with current KDF version of " + 
-            			KeyDerivationFunction.kdfVersion);
+                throw new EncryptionException("This version of ESAPI is not compatible with the version of ESAPI that encrypted your data.",
+                        "KDF version " + kdfVers + " from serialized ciphertext not compatibile with current KDF version of " + 
+                        KeyDerivationFunction.kdfVersion);
             }
             long timestamp = readLong(bais);
             debug("convertToCipherText: timestamp = " + new Date(timestamp));
@@ -391,7 +393,7 @@ private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
             CipherText ct = new CipherText(cipherSpec);
             if ( ! (ivLen > 0 && ct.requiresIV()) ) {
                     throw new EncryptionException("convertToCipherText: Mismatch between IV length and cipher mode.",
-                    						      "Possible tampering of serialized ciphertext?");
+                                                  "Possible tampering of serialized ciphertext?");
             }
             ct.setCiphertext(rawCiphertext);
               // Set this *AFTER* setting raw ciphertext because setCiphertext()
@@ -400,11 +402,11 @@ private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
             if ( macLen > 0 ) {
                 ct.storeSeparateMAC(mac);
             }
-            	// Fixed in ESAPI crypto version 20130839. Previously is didn't really matter
-            	// because there was only one version (20110203) and it defaulted to that
-            	// version, which was the current version. But we don't want that as now there
-            	// are two versions and we could be decrypting data encrypted using the previous
-            	// version.
+                // Fixed in ESAPI crypto version 20130839. Previously is didn't really matter
+                // because there was only one version (20110203) and it defaulted to that
+                // version, which was the current version. But we don't want that as now there
+                // are two versions and we could be decrypting data encrypted using the previous
+                // version.
             ct.setKDF_PRF(kdfPrf);
             ct.setKDFVersion(kdfVers);
             return ct;
@@ -428,28 +430,28 @@ private CipherText convertToCipherText(byte[] cipherTextSerializedBytes)
      *  both versions work the same. This checking may get more complicated in
      *  the future.
      *  
-     *  @param readKdfVers	The version information extracted from the serialized
-     *  					ciphertext.
+     *  @param readKdfVers    The version information extracted from the serialized
+     *                      ciphertext.
      */
     private static boolean versionIsCompatible(int readKdfVers) {
         if ( readKdfVers <= 0 ) {
             throw new IllegalArgumentException("Extracted KDF version is <= 0. Must be integer >= 1.");
         }
-    	
-		switch ( readKdfVers ) {
-		case KeyDerivationFunction.originalVersion:		// First version
-			return true;
-		// Add new versions here; hard coding is OK...
-		// case YYYYMMDD:
-		//	return true;
-		case KeyDerivationFunction.kdfVersion:			// Current version
-			return true;
-		default:
-			return false;
-		}
-	}
+        
+        switch ( readKdfVers ) {
+        case KeyDerivationFunction.originalVersion:        // First version
+            return true;
+        // Add new versions here; hard coding is OK...
+        // case YYYYMMDD:
+        //    return true;
+        case KeyDerivationFunction.kdfVersion:            // Current version
+            return true;
+        default:
+            return false;
+        }
+    }
 
-	private void debug(String msg) {
+    private void debug(String msg) {
         if ( logger.isDebugEnabled() ) {
             logger.debug(Logger.EVENT_SUCCESS, msg);
         }