You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cr...@apache.org on 2001/09/04 23:49:55 UTC
cvs commit: jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util Base64.java
craigmcc 01/09/04 14:49:55
Modified: catalina/src/share/org/apache/catalina/util Base64.java
Log:
Update Base64 implementation (matches the one in the commons util package)
to eliminate trailing 00 bytes on the output from decode().
PR: Bugzilla #3093
Submitted by: Kevin Brown <ke...@air2web.com>
Revision Changes Path
1.4 +133 -103 jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util/Base64.java
Index: Base64.java
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util/Base64.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Base64.java 2001/07/22 20:25:13 1.3
+++ Base64.java 2001/09/04 21:49:55 1.4
@@ -1,7 +1,7 @@
/*
- * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util/Base64.java,v 1.3 2001/07/22 20:25:13 pier Exp $
- * $Revision: 1.3 $
- * $Date: 2001/07/22 20:25:13 $
+ * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util/Base64.java,v 1.4 2001/09/04 21:49:55 craigmcc Exp $
+ * $Revision: 1.4 $
+ * $Date: 2001/09/04 21:49:55 $
*
* ====================================================================
*
@@ -61,23 +61,20 @@
*
*/
-
package org.apache.catalina.util;
-
/**
- * This class provides encode/decode for RFC 2045 Base64 as
- * defined by RFC 2045, N. Freed and N. Borenstein.
- * RFC 2045: Multipurpose Internet Mail Extensions (MIME)
- * Part One: Format of Internet Message Bodies. Reference
- * 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
- * This class is used by XML Schema binary format validation
+ * This class provides encode/decode for RFC 2045 Base64 as defined by
+ * RFC 2045, N. Freed and N. Borenstein. <a
+ * href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>:
+ * Multipurpose Internet Mail Extensions (MIME) Part One: Format of
+ * Internet Message Bodies. Reference 1996
*
* @author Jeffrey Rodriguez
- * @version $Id: Base64.java,v 1.3 2001/07/22 20:25:13 pier Exp $
+ * @version $Id: Base64.java,v 1.4 2001/09/04 21:49:55 craigmcc Exp $
*/
-
-public final class Base64 {
+public final class Base64
+{
static private final int BASELENGTH = 255;
static private final int LOOKUPLENGTH = 64;
static private final int TWENTYFOURBITGROUP = 24;
@@ -86,207 +83,240 @@
static private final int SIXBIT = 6;
static private final int FOURBYTE = 4;
static private final int SIGN = -128;
- static private final byte PAD = ( byte ) '=';
- static private final boolean fDebug = false;
+ static private final byte PAD = (byte) '=';
static private byte [] base64Alphabet = new byte[BASELENGTH];
static private byte [] lookUpBase64Alphabet = new byte[LOOKUPLENGTH];
-
-
- static {
+ //static private final Log log = LogSource.getInstance("org.apache.commons.util.Base64");
- for (int i = 0; i<BASELENGTH; i++ ) {
+ static
+ {
+ for (int i = 0; i < BASELENGTH; i++ )
+ {
base64Alphabet[i] = -1;
}
- for ( int i = 'Z'; i >= 'A'; i-- ) {
- base64Alphabet[i] = (byte) (i-'A');
+ for (int i = 'Z'; i >= 'A'; i--)
+ {
+ base64Alphabet[i] = (byte) (i - 'A');
}
- for ( int i = 'z'; i>= 'a'; i--) {
- base64Alphabet[i] = (byte) ( i-'a' + 26);
+ for (int i = 'z'; i>= 'a'; i--)
+ {
+ base64Alphabet[i] = (byte) (i - 'a' + 26);
}
-
- for ( int i = '9'; i >= '0'; i--) {
- base64Alphabet[i] = (byte) (i-'0' + 52);
+ for (int i = '9'; i >= '0'; i--)
+ {
+ base64Alphabet[i] = (byte) (i - '0' + 52);
}
base64Alphabet['+'] = 62;
base64Alphabet['/'] = 63;
+
+ for (int i = 0; i <= 25; i++ )
+ lookUpBase64Alphabet[i] = (byte) ('A' + i);
- for (int i = 0; i<=25; i++ )
- lookUpBase64Alphabet[i] = (byte) ('A'+i );
+ for (int i = 26, j = 0; i <= 51; i++, j++ )
+ lookUpBase64Alphabet[i] = (byte) ('a'+ j);
- for (int i = 26, j = 0; i<=51; i++, j++ )
- lookUpBase64Alphabet[i] = (byte) ('a'+ j );
+ for (int i = 52, j = 0; i <= 61; i++, j++ )
+ lookUpBase64Alphabet[i] = (byte) ('0' + j);
- for (int i = 52, j = 0; i<=61; i++, j++ )
- lookUpBase64Alphabet[i] = (byte) ('0' + j );
lookUpBase64Alphabet[62] = (byte) '+';
lookUpBase64Alphabet[63] = (byte) '/';
-
}
- public static boolean isBase64( String isValidString ){
- return( isArrayByteBase64( isValidString.getBytes()));
+ public static boolean isBase64( String isValidString )
+ {
+ return isArrayByteBase64(isValidString.getBytes());
}
-
- public static boolean isBase64( byte octect ) {
+ public static boolean isBase64( byte octect )
+ {
//shall we ignore white space? JEFF??
- return(octect == PAD || base64Alphabet[octect] != -1 );
+ return (octect == PAD || base64Alphabet[octect] != -1);
}
-
- public static boolean isArrayByteBase64( byte[] arrayOctect ) {
+ public static boolean isArrayByteBase64( byte[] arrayOctect )
+ {
int length = arrayOctect.length;
- if ( length == 0 )
- return false;
- for ( int i=0; i < length; i++ ) {
- if ( Base64.isBase64( arrayOctect[i] ) == false)
+ if (length == 0)
+ {
+ // shouldn't a 0 length array be valid base64 data?
+ // return false;
+ return true;
+ }
+ for (int i=0; i < length; i++)
+ {
+ if ( !Base64.isBase64(arrayOctect[i]) )
return false;
}
return true;
}
/**
- * Encodes hex octects into Base64
+ * Encodes hex octects into Base64.
*
- * @param binaryData Array containing binaryData
- * @return Encoded Base64 array
+ * @param binaryData Array containing binary data to encode.
+ * @return Base64-encoded data.
*/
- public static byte[] encode( byte[] binaryData ) {
+ public static byte[] encode( byte[] binaryData )
+ {
int lengthDataBits = binaryData.length*EIGHTBIT;
int fewerThan24bits = lengthDataBits%TWENTYFOURBITGROUP;
int numberTriplets = lengthDataBits/TWENTYFOURBITGROUP;
byte encodedData[] = null;
- if ( fewerThan24bits != 0 ) //data not divisible by 24 bit
- encodedData = new byte[ (numberTriplets + 1 )*4 ];
- else // 16 or 8 bit
- encodedData = new byte[ numberTriplets*4 ];
+ if (fewerThan24bits != 0)
+ {
+ //data not divisible by 24 bit
+ encodedData = new byte[ (numberTriplets + 1 ) * 4 ];
+ }
+ else
+ {
+ // 16 or 8 bit
+ encodedData = new byte[ numberTriplets * 4 ];
+ }
- byte k=0, l=0, b1=0,b2=0,b3=0;
+ byte k = 0, l = 0, b1 = 0, b2 = 0, b3 = 0;
int encodedIndex = 0;
int dataIndex = 0;
int i = 0;
- if (fDebug ) {
- System.out.println("number of triplets = " + numberTriplets );
- }
- for ( i = 0; i<numberTriplets; i++ ) {
-
+ //log.debug("number of triplets = " + numberTriplets);
+ for ( i = 0; i<numberTriplets; i++ )
+ {
dataIndex = i*3;
b1 = binaryData[dataIndex];
b2 = binaryData[dataIndex + 1];
b3 = binaryData[dataIndex + 2];
- if (fDebug) {
- System.out.println( "b1= " + b1 +", b2= " + b2 + ", b3= " + b3 );
- }
+ //log.debug("b1= " + b1 +", b2= " + b2 + ", b3= " + b3);
l = (byte)(b2 & 0x0f);
k = (byte)(b1 & 0x03);
- encodedIndex = i*4;
+ encodedIndex = i * 4;
byte val1 = ((b1 & SIGN)==0)?(byte)(b1>>2):(byte)((b1)>>2^0xc0);
-
byte val2 = ((b2 & SIGN)==0)?(byte)(b2>>4):(byte)((b2)>>4^0xf0);
byte val3 = ((b3 & SIGN)==0)?(byte)(b3>>6):(byte)((b3)>>6^0xfc);
encodedData[encodedIndex] = lookUpBase64Alphabet[ val1 ];
- if (fDebug) {
- System.out.println( "val2 = " + val2 );
- System.out.println( "k4 = " + (k<<4));
- System.out.println( "vak = " + (val2 | (k<<4)));
- }
-
- encodedData[encodedIndex+1] = lookUpBase64Alphabet[ val2 | ( k<<4 )];
- encodedData[encodedIndex+2] = lookUpBase64Alphabet[ (l <<2 ) | val3 ];
+ //log.debug( "val2 = " + val2 );
+ //log.debug( "k4 = " + (k<<4) );
+ //log.debug( "vak = " + (val2 | (k<<4)) );
+ encodedData[encodedIndex+1] =
+ lookUpBase64Alphabet[ val2 | ( k<<4 )];
+ encodedData[encodedIndex+2] =
+ lookUpBase64Alphabet[ (l <<2 ) | val3 ];
encodedData[encodedIndex+3] = lookUpBase64Alphabet[ b3 & 0x3f ];
}
// form integral number of 6-bit groups
dataIndex = i*3;
encodedIndex = i*4;
- if (fewerThan24bits == EIGHTBIT ) {
+ if (fewerThan24bits == EIGHTBIT )
+ {
b1 = binaryData[dataIndex];
k = (byte) ( b1 &0x03 );
- if (fDebug ) {
- System.out.println("b1=" + b1);
- System.out.println("b1<<2 = " + (b1>>2) );
- }
+ //log.debug("b1=" + b1);
+ //log.debug("b1<<2 = " + (b1>>2) );
byte val1 = ((b1 & SIGN)==0)?(byte)(b1>>2):(byte)((b1)>>2^0xc0);
encodedData[encodedIndex] = lookUpBase64Alphabet[ val1 ];
encodedData[encodedIndex + 1] = lookUpBase64Alphabet[ k<<4 ];
encodedData[encodedIndex + 2] = PAD;
encodedData[encodedIndex + 3] = PAD;
- } else if ( fewerThan24bits == SIXTEENBIT ) {
+ }
+ else if (fewerThan24bits == SIXTEENBIT)
+ {
b1 = binaryData[dataIndex];
b2 = binaryData[dataIndex +1 ];
- l = ( byte ) ( b2 &0x0f );
- k = ( byte ) ( b1 &0x03 );
+ l = (byte) (b2 & 0x0f);
+ k = (byte) (b1 & 0x03);
- byte val1 = ((b1 & SIGN)==0)?(byte)(b1>>2):(byte)((b1)>>2^0xc0);
- byte val2 = ((b2 & SIGN)==0)?(byte)(b2>>4):(byte)((b2)>>4^0xf0);
+ byte val1 = ((b1 & SIGN) == 0)?(byte)(b1>>2):(byte)((b1)>>2^0xc0);
+ byte val2 = ((b2 & SIGN) == 0)?(byte)(b2>>4):(byte)((b2)>>4^0xf0);
encodedData[encodedIndex] = lookUpBase64Alphabet[ val1 ];
- encodedData[encodedIndex + 1] = lookUpBase64Alphabet[ val2 | ( k<<4 )];
+ encodedData[encodedIndex + 1] =
+ lookUpBase64Alphabet[ val2 | ( k<<4 )];
encodedData[encodedIndex + 2] = lookUpBase64Alphabet[ l<<2 ];
encodedData[encodedIndex + 3] = PAD;
}
+
return encodedData;
}
-
/**
* Decodes Base64 data into octects
*
* @param binaryData Byte array containing Base64 data
- * @return Array containind decoded data.
+ * @return Array containing decoded data.
*/
- public static byte[] decode( byte[] base64Data ) {
+ public static byte[] decode( byte[] base64Data )
+ {
+ // handle the edge case, so we don't have to worry about it later
+ if(base64Data.length == 0) { return new byte[0]; }
+
int numberQuadruple = base64Data.length/FOURBYTE;
byte decodedData[] = null;
byte b1=0,b2=0,b3=0, b4=0, marker0=0, marker1=0;
// Throw away anything not in base64Data
- // Adjust size
int encodedIndex = 0;
int dataIndex = 0;
- decodedData = new byte[ numberQuadruple*3 + 1 ];
+ {
+ // this sizes the output array properly - rlw
+ int lastData = base64Data.length;
+ // ignore the '=' padding
+ while (base64Data[lastData-1] == PAD)
+ {
+ if (--lastData == 0)
+ {
+ return new byte[0];
+ }
+ }
+ decodedData = new byte[ lastData - numberQuadruple ];
+ }
- for (int i = 0; i<numberQuadruple; i++ ) {
- dataIndex = i*4;
- marker0 = base64Data[dataIndex +2];
- marker1 = base64Data[dataIndex +3];
+ for (int i = 0; i < numberQuadruple; i++)
+ {
+ dataIndex = i * 4;
+ marker0 = base64Data[dataIndex + 2];
+ marker1 = base64Data[dataIndex + 3];
b1 = base64Alphabet[base64Data[dataIndex]];
b2 = base64Alphabet[base64Data[dataIndex +1]];
- if ( marker0 != PAD && marker1 != PAD ) { //No PAD e.g 3cQl
+ if (marker0 != PAD && marker1 != PAD)
+ {
+ //No PAD e.g 3cQl
b3 = base64Alphabet[ marker0 ];
b4 = base64Alphabet[ marker1 ];
decodedData[encodedIndex] = (byte)( b1 <<2 | b2>>4 ) ;
- decodedData[encodedIndex+1] = (byte)(((b2 & 0xf)<<4 ) |( (b3>>2) & 0xf) );
- decodedData[encodedIndex+2] = (byte)( b3<<6 | b4 );
- } else if ( marker0 == PAD ) { //Two PAD e.g. 3c[Pad][Pad]
+ decodedData[encodedIndex + 1] =
+ (byte)(((b2 & 0xf)<<4 ) |( (b3>>2) & 0xf) );
+ decodedData[encodedIndex + 2] = (byte)( b3<<6 | b4 );
+ }
+ else if (marker0 == PAD)
+ {
+ //Two PAD e.g. 3c[Pad][Pad]
decodedData[encodedIndex] = (byte)( b1 <<2 | b2>>4 ) ;
- decodedData[encodedIndex+1] = (byte)((b2 & 0xf)<<4 );
- decodedData[encodedIndex+2] = (byte) 0;
- } else if ( marker1 == PAD ) { //One PAD e.g. 3cQ[Pad]
+ }
+ else if (marker1 == PAD)
+ {
+ //One PAD e.g. 3cQ[Pad]
b3 = base64Alphabet[ marker0 ];
decodedData[encodedIndex] = (byte)( b1 <<2 | b2>>4 );
- decodedData[encodedIndex+1] = (byte)(((b2 & 0xf)<<4 ) |( (b3>>2) & 0xf) );
- decodedData[encodedIndex+2] = (byte)( b3<<6);
+ decodedData[encodedIndex + 1] =
+ (byte)(((b2 & 0xf)<<4 ) |( (b3>>2) & 0xf) );
}
encodedIndex += 3;
}
return decodedData;
-
}
-}
+}