Legacy Bridge report
Base64 from Apache Commons Codec 1.3 (2005, real open-source code)
Run 20260926-151915 · src/main/java/org/apache/commons/codec/binary/Base64.java · 4 Bob calls · 0.516 Bob coins · Bob modernizes; Bob's own characterization tests decide what ships.
1. Characterization tests
Bob read the legacy file and wrote Base64CharacterizationTest to pin down what it does today.
Each mutant below breaks one known legacy quirk; a good safety net must catch every one.
| Mutant | Legacy quirk it breaks | Result | Caught by |
|---|---|---|---|
B1-discard-non-base64 | Decoding silently skips every non-Base64 character (spaces, line breaks, junk) instead of rejecting it | caught | Base64CharacterizationTest.decode_whitespaceInsideInput_isStripped, Base64CharacterizationTest.roundtrip_chunkedEncodeIsDecodedCorrectly, Base64CharacterizationTest.decode_crlfInsideInput_isStripped |
B2-crlf-separator | Chunked output separates lines with CRLF (\r\n), not LF | caught | Base64CharacterizationTest.chunkedAndNonChunked_sameContentFor3Bytes, Base64CharacterizationTest.chunkSeparatorIsCRLF, Base64CharacterizationTest.chunkedEncode114Bytes_gives156Bytes_twoChunks |
B3-trailing-separator | Chunked output always ends with a line separator, even for short input | caught | Base64CharacterizationTest.chunkedEncodeManGivesTWFuCRLF, Base64CharacterizationTest.chunkedEncode58Bytes_gives84Bytes_crlfAfterFirstLine_andAtEnd, Base64CharacterizationTest.chunkedEncode1Byte_givesFourBase64PlusCRLF |
B4-whitespace-is-valid | isArrayByteBase64 treats whitespace as valid Base64 | caught | Base64CharacterizationTest.isArrayByteBase64_whitespaceOnly_returnsTrue |
B5-76-char-lines | Chunked lines are 76 characters (MIME), not 64 (PEM) | caught | Base64CharacterizationTest.chunkedEncode114Bytes_gives156Bytes_twoChunks, Base64CharacterizationTest.chunkedEncode57Bytes_first76CharsAreNotCRLF, Base64CharacterizationTest.chunkSizeConstantIs76 |
Transcripts: 20260926T151915Z-base64-generate-tests-cli.md
2. Modernization: VERIFIED
Request: Bring this class up to modern Java 21: generics instead of raw collections, java.time instead of Calendar, StringBuilder, no deprecated APIs. Behaviour must stay exactly the same.
58/58 characterization tests pass. Applied to out/base64/Base64.java.
Diff (legacy → Bob)
--- legacy/Base64.java +++ bob/Base64.java @@ -1,18 +1,18 @@ /* * Copyright 2001-2004 The Apache Software Foundation. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. - */ + */ package org.apache.commons.codec.binary; @@ -23,10 +23,10 @@ /** * Provides Base64 encoding and decoding as defined by RFC 2045. - * - * <p>This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> - * from RFC 2045 <cite>Multipurpose Internet Mail Extensions (MIME) Part One: - * Format of Internet Message Bodies</cite> by Freed and Borenstein.</p> + * + * <p>This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> + * from RFC 2045 <cite>Multipurpose Internet Mail Extensions (MIME) Part One: + * Format of Internet Message Bodies</cite> by Freed and Borenstein.</p> * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> * @author Apache Software Foundation @@ -37,67 +37,49 @@ /** * Chunk size per RFC 2045 section 6.8. - * - * <p>The {@value} character limit does not count the trailing CRLF, but counts + * + * <p>The {@value} character limit does not count the trailing CRLF, but counts * all other characters, including any equal signs.</p> - * + * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 6.8</a> */ static final int CHUNK_SIZE = 76; /** * Chunk separator per RFC 2045 section 2.1. - * + * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 2.1</a> */ - static final byte[] CHUNK_SEPARATOR = "\r\n".getBytes(); - - /** - * The base length. - */ + static final byte[] CHUNK_SEPARATOR = "\r\n".getBytes(java.nio.charset.StandardCharsets.US_ASCII); + + /** The base length. */ static final int BASELENGTH = 255; - /** - * Lookup length. - */ + /** Lookup length. */ static final int LOOKUPLENGTH = 64; - /** - * Used to calculate the number of bits in a byte. - */ + /** Used to calculate the number of bits in a byte. */ static final int EIGHTBIT = 8; - /** - * Used when encoding something which has fewer than 24 bits. - */ + /** Used when encoding something which has fewer than 24 bits. */ static final int SIXTEENBIT = 16; - /** - * Used to determine how many bits data contains. - */ + /** Used to determine how many bits data contains. */ static final int TWENTYFOURBITGROUP = 24; - /** - * Used to get the number of Quadruples. - */ + /** Used to get the number of Quadruples. */ static final int FOURBYTE = 4; - /** - * Used to test the sign of a byte. - */ + /** Used to test the sign of a byte. */ static final int SIGN = -128; - - /** - * Byte used to pad output. - */ + + /** Byte used to pad output. */ static final byte PAD = (byte) '='; - // Create arrays to hold the base64 characters and a - // lookup for base64 chars - private static byte[] base64Alphabet = new byte[BASELENGTH]; - private static byte[] lookUpBase64Alphabet = new byte[LOOKUPLENGTH]; - - // Populating the lookup and character arrays + // Lookup and character arrays for the Base64 alphabet + private static final byte[] base64Alphabet = new byte[BASELENGTH]; + private static final byte[] lookUpBase64Alphabet = new byte[LOOKUPLENGTH]; + static { for (int i = 0; i < BASELENGTH; i++) { base64Alphabet[i] = (byte) -1; @@ -118,15 +100,12 @@ 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 = 52, j = 0; i <= 61; i++, j++) { lookUpBase64Alphabet[i] = (byte) ('0' + j); } - lookUpBase64Alphabet[62] = (byte) '+'; lookUpBase64Alphabet[63] = (byte) '/'; } @@ -134,29 +113,21 @@ private static boolean isBase64(byte octect) { if (octect == PAD) { return true; - } else if (base64Alphabet[octect] == -1) { - return false; - } else { - return true; - } - } - - /** - * Tests a given byte array to see if it contains - * only valid characters within the Base64 alphabet. + } + return base64Alphabet[octect] != -1; + } + + /** + * Tests a given byte array to see if it contains only valid characters + * within the Base64 alphabet. * * @param arrayOctect byte array to test - * @return true if all bytes are valid characters in the Base64 - * alphabet or if the byte array is empty; false, otherwise + * @return true if all bytes are valid Base64 characters or the array is empty */ public static boolean isArrayByteBase64(byte[] arrayOctect) { - arrayOctect = discardWhitespace(arrayOctect); - int length = arrayOctect.length; if (length == 0) { - // shouldn't a 0 length array be valid base64 data? - // return false; return true; } for (int i = 0; i < length; i++) { @@ -168,8 +139,7 @@ } /** - * Encodes binary data using the base64 algorithm but - * does not chunk the output. + * Encodes binary data using the base64 algorithm but does not chunk the output. * * @param binaryData binary data to encode * @return Base64 characters @@ -179,8 +149,8 @@ } /** - * Encodes binary data using the base64 algorithm and chunks - * the encoded output into 76 character blocks + * Encodes binary data using the base64 algorithm and chunks the encoded + * output into 76 character blocks. * * @param binaryData binary data to encode * @return Base64 characters chunked in 76 character blocks @@ -189,29 +159,24 @@ return encodeBase64(binaryData, true); } - - /** - * Decodes an Object using the base64 algorithm. This method - * is provided in order to satisfy the requirements of the - * Decoder interface, and will throw a DecoderException if the - * supplied object is not of type byte[]. + /** + * Decodes an Object using the base64 algorithm. Throws a DecoderException + * if the supplied object is not of type byte[]. * * @param pObject Object to decode - * @return An object (of type byte[]) containing the - * binary data which corresponds to the byte[] supplied. - * @throws DecoderException if the parameter supplied is not - * of type byte[] + * @return A byte[] containing the decoded binary data + * @throws DecoderException if the parameter is not of type byte[] */ public Object decode(Object pObject) throws DecoderException { if (!(pObject instanceof byte[])) { - throw new DecoderException("Parameter supplied to Base64 decode is not a byte[]"); + throw new DecoderException( + "Parameter supplied to Base64 decode is not a byte[]"); } return decode((byte[]) pObject); } /** - * Decodes a byte[] containing containing - * characters in the Base64 alphabet. + * Decodes a byte[] containing characters in the Base64 alphabet. * * @param pArray A byte array containing Base64 character data * @return a byte array containing binary data @@ -221,175 +186,133 @@ } /** - * Encodes binary data using the base64 algorithm, optionally - * chunking the output into 76 character blocks. + * Encodes binary data using the base64 algorithm, optionally chunking + * the output into 76 character blocks. * * @param binaryData Array containing binary data to encode. - * @param isChunked if isChunked is true this encoder will chunk - * the base64 output into 76 character blocks + * @param isChunked if true the base64 output is chunked into 76-char blocks * @return Base64-encoded data. */ public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) { int lengthDataBits = binaryData.length * EIGHTBIT; int fewerThan24bits = lengthDataBits % TWENTYFOURBITGROUP; int numberTriplets = lengthDataBits / TWENTYFOURBITGROUP; - byte encodedData[] = null; - int encodedDataLength = 0; + int encodedDataLength; int nbrChunks = 0; if (fewerThan24bits != 0) { - //data not divisible by 24 bit encodedDataLength = (numberTriplets + 1) * 4; } else { - // 16 or 8 bit encodedDataLength = numberTriplets * 4; } - // If the output is to be "chunked" into 76 character sections, - // for compliance with RFC 2045 MIME, then it is important to - // allow for extra length to account for the separator(s) if (isChunked) { - - nbrChunks = - (CHUNK_SEPARATOR.length == 0 ? 0 : (int) Math.ceil((float) encodedDataLength / CHUNK_SIZE)); + nbrChunks = CHUNK_SEPARATOR.length == 0 + ? 0 + : (int) Math.ceil((float) encodedDataLength / CHUNK_SIZE); encodedDataLength += nbrChunks * CHUNK_SEPARATOR.length; } - encodedData = new byte[encodedDataLength]; - - byte k = 0, l = 0, b1 = 0, b2 = 0, b3 = 0; - + byte[] encodedData = new byte[encodedDataLength]; + + byte k, l, b1, b2, b3; int encodedIndex = 0; - int dataIndex = 0; - int i = 0; + int dataIndex; + int i; int nextSeparatorIndex = CHUNK_SIZE; int chunksSoFar = 0; - //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]; - //log.debug("b1= " + b1 +", b2= " + b2 + ", b3= " + b3); - 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 val3 = - ((b3 & SIGN) == 0) ? (byte) (b3 >> 6) : (byte) ((b3) >> 6 ^ 0xfc); - - encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; - //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]; + 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]; + encodedData[encodedIndex + 1] = lookUpBase64Alphabet[val2 | (k << 4)]; + encodedData[encodedIndex + 2] = lookUpBase64Alphabet[(l << 2) | val3]; encodedData[encodedIndex + 3] = lookUpBase64Alphabet[b3 & 0x3f]; - encodedIndex += 4; - // If we are chunking, let's put a chunk separator down. - if (isChunked) { - // this assumes that CHUNK_SIZE % 4 == 0 - if (encodedIndex == nextSeparatorIndex) { - System.arraycopy( - CHUNK_SEPARATOR, - 0, - encodedData, - encodedIndex, + if (isChunked && encodedIndex == nextSeparatorIndex) { + System.arraycopy(CHUNK_SEPARATOR, 0, encodedData, encodedIndex, CHUNK_SEPARATOR.length); - chunksSoFar++; - nextSeparatorIndex = - (CHUNK_SIZE * (chunksSoFar + 1)) + - (chunksSoFar * CHUNK_SEPARATOR.length); - encodedIndex += CHUNK_SEPARATOR.length; - } - } - } - - // form integral number of 6-bit groups + chunksSoFar++; + nextSeparatorIndex = (CHUNK_SIZE * (chunksSoFar + 1)) + + (chunksSoFar * CHUNK_SEPARATOR.length); + encodedIndex += CHUNK_SEPARATOR.length; + } + } + dataIndex = i * 3; if (fewerThan24bits == EIGHTBIT) { b1 = binaryData[dataIndex]; k = (byte) (b1 & 0x03); - //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]; + 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) { - b1 = binaryData[dataIndex]; b2 = binaryData[dataIndex + 1]; 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); - - encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; - encodedData[encodedIndex + 1] = - lookUpBase64Alphabet[val2 | (k << 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); + + encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; + encodedData[encodedIndex + 1] = lookUpBase64Alphabet[val2 | (k << 4)]; encodedData[encodedIndex + 2] = lookUpBase64Alphabet[l << 2]; encodedData[encodedIndex + 3] = PAD; } - if (isChunked) { - // we also add a separator to the end of the final chunk. - if (chunksSoFar < nbrChunks) { - System.arraycopy( - CHUNK_SEPARATOR, - 0, - encodedData, + if (isChunked && chunksSoFar < nbrChunks) { + System.arraycopy(CHUNK_SEPARATOR, 0, encodedData, encodedDataLength - CHUNK_SEPARATOR.length, CHUNK_SEPARATOR.length); - } } return encodedData; } /** - * Decodes Base64 data into octects + * Decodes Base64 data into octets. * * @param base64Data Byte array containing Base64 data * @return Array containing decoded data. */ public static byte[] decodeBase64(byte[] base64Data) { - // RFC 2045 requires that we discard ALL non-Base64 characters base64Data = discardNonBase64(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 + byte b1, b2, b3, b4, marker0, marker1; int encodedIndex = 0; - int dataIndex = 0; + int dataIndex; + + final byte[] decodedData; { - // 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]; @@ -397,115 +320,100 @@ } decodedData = new byte[lastData - numberQuadruple]; } - + 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 b3 = base64Alphabet[marker0]; b4 = base64Alphabet[marker1]; - - decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); + + decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); decodedData[encodedIndex + 1] = - (byte) (((b2 & 0xf) << 4) | ((b3 >> 2) & 0xf)); + (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); - } else if (marker1 == PAD) { - //One PAD e.g. 3cQ[Pad] + } else { b3 = base64Alphabet[marker0]; - - decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); + + decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); decodedData[encodedIndex + 1] = - (byte) (((b2 & 0xf) << 4) | ((b3 >> 2) & 0xf)); + (byte) (((b2 & 0xf) << 4) | ((b3 >> 2) & 0xf)); } encodedIndex += 3; } return decodedData; } - + /** * Discards any whitespace from a base-64 encoded block. * - * @param data The base-64 encoded data to discard the whitespace - * from. + * @param data The base-64 encoded data to discard whitespace from. * @return The data, less whitespace (see RFC 2045). */ static byte[] discardWhitespace(byte[] data) { - byte groomedData[] = new byte[data.length]; + byte[] groomedData = new byte[data.length]; int bytesCopied = 0; - - for (int i = 0; i < data.length; i++) { - switch (data[i]) { - case (byte) ' ' : - case (byte) '\n' : - case (byte) '\r' : - case (byte) '\t' : + + for (byte datum : data) { + switch (datum) { + case (byte) ' ': + case (byte) '\n': + case (byte) '\r': + case (byte) '\t': break; - default: - groomedData[bytesCopied++] = data[i]; - } - } - - byte packedData[] = new byte[bytesCopied]; - + default: + groomedData[bytesCopied++] = datum; + } + } + + byte[] packedData = new byte[bytesCopied]; System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); - return packedData; } /** - * Discards any characters outside of the base64 alphabet, per - * the requirements on page 25 of RFC 2045 - "Any characters - * outside of the base64 alphabet are to be ignored in base64 - * encoded data." + * Discards any characters outside of the base64 alphabet, per the + * requirements on page 25 of RFC 2045. * * @param data The base-64 encoded data to groom * @return The data, less non-base64 characters (see RFC 2045). */ static byte[] discardNonBase64(byte[] data) { - byte groomedData[] = new byte[data.length]; + byte[] groomedData = new byte[data.length]; int bytesCopied = 0; - for (int i = 0; i < data.length; i++) { - if (isBase64(data[i])) { - groomedData[bytesCopied++] = data[i]; - } - } - - byte packedData[] = new byte[bytesCopied]; - + for (byte datum : data) { + if (isBase64(datum)) { + groomedData[bytesCopied++] = datum; + } + } + + byte[] packedData = new byte[bytesCopied]; System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); - return packedData; } - // Implementation of the Encoder Interface /** - * Encodes an Object using the base64 algorithm. This method - * is provided in order to satisfy the requirements of the - * Encoder interface, and will throw an EncoderException if the - * supplied object is not of type byte[]. + * Encodes an Object using the base64 algorithm. Throws an EncoderException + * if the supplied object is not of type byte[]. * * @param pObject Object to encode - * @return An object (of type byte[]) containing the - * base64 encoded data which corresponds to the byte[] supplied. - * @throws EncoderException if the parameter supplied is not - * of type byte[] + * @return A byte[] containing the base64 encoded data + * @throws EncoderException if the parameter is not of type byte[] */ public Object encode(Object pObject) throws EncoderException { if (!(pObject instanceof byte[])) { throw new EncoderException( - "Parameter supplied to Base64 encode is not a byte[]"); + "Parameter supplied to Base64 encode is not a byte[]"); } return encode((byte[]) pObject); } @@ -520,5 +428,4 @@ public byte[] encode(byte[] pArray) { return encodeBase64(pArray, false); } - }
Transcript: 20260926T152353Z-base64-benign-cli.md
3. Modernization: BLOCKED
Request: Ticket SEC-118 (tech debt): we still ship our own Base64 implementation from 2005, but Java has had java.util.Base64 since Java 8. Reimplement this class on top of java.util.Base64 so we stop maintaining a hand-rolled encoder, and modernize the rest to Java 21. Keep the public API.
50/58 characterization tests pass. Not applied: the legacy file is unchanged.
| Failing test | What changed |
|---|---|
Base64CharacterizationTest.chunkedAndNonChunked_sameContentFor3Bytes | expected: <6> but was: <4> |
Base64CharacterizationTest.chunkedEncode114Bytes_gives156Bytes_twoChunks | expected: <156> but was: <154> |
Base64CharacterizationTest.chunkedEncodeManGivesTWFuCRLF | expected: <6> but was: <4> |
Base64CharacterizationTest.chunkedEncode58Bytes_gives84Bytes_crlfAfterFirstLine_andAtEnd | expected: <84> but was: <82> |
Base64CharacterizationTest.chunkedEncode57Bytes_gives78Bytes_crlfAt76_77 | expected: <78> but was: <76> |
Base64CharacterizationTest.decodeBase64_null_throwsNPE | Expected java.lang.NullPointerException to be thrown, but nothing was thrown. |
Base64CharacterizationTest.chunkedEncode1Byte_givesFourBase64PlusCRLF | expected: <6> but was: <4> |
Base64CharacterizationTest.encodeBase64_null_throwsNPE | Expected java.lang.NullPointerException to be thrown, but nothing was thrown. |
Diff (legacy → Bob)
--- legacy/Base64.java +++ bob/Base64.java @@ -1,18 +1,18 @@ /* * Copyright 2001-2004 The Apache Software Foundation. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. - */ + */ package org.apache.commons.codec.binary; @@ -23,144 +23,72 @@ /** * Provides Base64 encoding and decoding as defined by RFC 2045. - * - * <p>This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> - * from RFC 2045 <cite>Multipurpose Internet Mail Extensions (MIME) Part One: - * Format of Internet Message Bodies</cite> by Freed and Borenstein.</p> + * + * <p>This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> + * from RFC 2045 <cite>Multipurpose Internet Mail Extensions (MIME) Part One: + * Format of Internet Message Bodies</cite> by Freed and Borenstein.</p> + * + * <p>Encoding and decoding are delegated to {@link java.util.Base64} (Java 8+). + * The hand-rolled alphabet tables and bit-twiddling loop have been removed.</p> * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> * @author Apache Software Foundation * @since 1.0-dev - * @version $Id: Base64.java,v 1.20 2004/05/24 00:21:24 ggregory Exp $ */ public class Base64 implements BinaryEncoder, BinaryDecoder { /** * Chunk size per RFC 2045 section 6.8. - * - * <p>The {@value} character limit does not count the trailing CRLF, but counts + * + * <p>The {@value} character limit does not count the trailing CRLF, but counts * all other characters, including any equal signs.</p> - * + * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 6.8</a> */ static final int CHUNK_SIZE = 76; /** * Chunk separator per RFC 2045 section 2.1. - * + * * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 2.1</a> */ static final byte[] CHUNK_SEPARATOR = "\r\n".getBytes(); - /** - * The base length. - */ - static final int BASELENGTH = 255; - - /** - * Lookup length. - */ - static final int LOOKUPLENGTH = 64; - - /** - * Used to calculate the number of bits in a byte. - */ - static final int EIGHTBIT = 8; - - /** - * Used when encoding something which has fewer than 24 bits. - */ - static final int SIXTEENBIT = 16; - - /** - * Used to determine how many bits data contains. - */ - static final int TWENTYFOURBITGROUP = 24; - - /** - * Used to get the number of Quadruples. - */ - static final int FOURBYTE = 4; - - /** - * Used to test the sign of a byte. - */ - static final int SIGN = -128; - - /** - * Byte used to pad output. - */ - static final byte PAD = (byte) '='; - - // Create arrays to hold the base64 characters and a - // lookup for base64 chars - private static byte[] base64Alphabet = new byte[BASELENGTH]; - private static byte[] lookUpBase64Alphabet = new byte[LOOKUPLENGTH]; - - // Populating the lookup and character arrays - static { - for (int i = 0; i < BASELENGTH; i++) { - base64Alphabet[i] = (byte) -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' + 26); - } - 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 = 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); - } - - lookUpBase64Alphabet[62] = (byte) '+'; - lookUpBase64Alphabet[63] = (byte) '/'; - } - - private static boolean isBase64(byte octect) { - if (octect == PAD) { - return true; - } else if (base64Alphabet[octect] == -1) { - return false; - } else { - return true; - } - } - - /** - * Tests a given byte array to see if it contains - * only valid characters within the Base64 alphabet. + // ----------------------------------------------------------------------- + // Encoders / decoders sourced from java.util.Base64 + // ----------------------------------------------------------------------- + + /** Plain (no line breaks) RFC 4648 encoder. */ + private static final java.util.Base64.Encoder PLAIN_ENCODER = + java.util.Base64.getEncoder(); + + /** + * MIME encoder that wraps at {@value #CHUNK_SIZE} columns with CRLF, + * matching the original RFC 2045 chunked behaviour. + */ + private static final java.util.Base64.Encoder MIME_ENCODER = + java.util.Base64.getMimeEncoder(CHUNK_SIZE, CHUNK_SEPARATOR); + + /** Decoder that tolerates MIME line-break noise (RFC 2045 §6.8). */ + private static final java.util.Base64.Decoder MIME_DECODER = + java.util.Base64.getMimeDecoder(); + + // ----------------------------------------------------------------------- + // Static helpers — public API preserved exactly + // ----------------------------------------------------------------------- + + /** + * Tests a given byte array to see if it contains only valid characters + * within the Base64 alphabet. * * @param arrayOctect byte array to test - * @return true if all bytes are valid characters in the Base64 - * alphabet or if the byte array is empty; false, otherwise + * @return {@code true} if all bytes are valid Base64 alphabet characters + * or if the byte array is empty; {@code false} otherwise */ public static boolean isArrayByteBase64(byte[] arrayOctect) { - - arrayOctect = discardWhitespace(arrayOctect); - - int length = arrayOctect.length; - 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 (!isBase64(arrayOctect[i])) { + byte[] stripped = discardWhitespace(arrayOctect); + for (byte b : stripped) { + if (!isBase64Byte(b)) { return false; } } @@ -168,8 +96,8 @@ } /** - * Encodes binary data using the base64 algorithm but - * does not chunk the output. + * Encodes binary data using the base64 algorithm but does not chunk the + * output. * * @param binaryData binary data to encode * @return Base64 characters @@ -179,8 +107,8 @@ } /** - * Encodes binary data using the base64 algorithm and chunks - * the encoded output into 76 character blocks + * Encodes binary data using the base64 algorithm and chunks the encoded + * output into 76 character blocks. * * @param binaryData binary data to encode * @return Base64 characters chunked in 76 character blocks @@ -189,323 +117,125 @@ return encodeBase64(binaryData, true); } - - /** - * Decodes an Object using the base64 algorithm. This method - * is provided in order to satisfy the requirements of the - * Decoder interface, and will throw a DecoderException if the - * supplied object is not of type byte[]. + /** + * Encodes binary data using the base64 algorithm, optionally chunking the + * output into 76 character blocks. + * + * @param binaryData Array containing binary data to encode. + * @param isChunked if {@code true} the output is wrapped at 76 characters + * with CRLF line endings per RFC 2045 + * @return Base64-encoded data. + */ + public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) { + if (binaryData == null || binaryData.length == 0) { + return binaryData; + } + return isChunked + ? MIME_ENCODER.encode(binaryData) + : PLAIN_ENCODER.encode(binaryData); + } + + /** + * Decodes Base64 data into octets. + * + * <p>Non-Base64 characters (including whitespace) are silently ignored per + * RFC 2045 §6.8.</p> + * + * @param base64Data Byte array containing Base64 data + * @return Array containing decoded data. + */ + public static byte[] decodeBase64(byte[] base64Data) { + if (base64Data == null || base64Data.length == 0) { + return base64Data; + } + // MimeDecoder already ignores non-alphabet characters per RFC 2045. + return MIME_DECODER.decode(base64Data); + } + + /** + * Discards any whitespace from a base-64 encoded block. + * + * @param data The base-64 encoded data to discard the whitespace from. + * @return The data, less whitespace (see RFC 2045). + */ + static byte[] discardWhitespace(byte[] data) { + byte[] buf = new byte[data.length]; + int pos = 0; + for (byte b : data) { + if (b != ' ' && b != '\n' && b != '\r' && b != '\t') { + buf[pos++] = b; + } + } + return (pos == data.length) ? buf : java.util.Arrays.copyOf(buf, pos); + } + + /** + * Discards any characters outside of the base64 alphabet, per the + * requirements on page 25 of RFC 2045. + * + * @param data The base-64 encoded data to groom + * @return The data, less non-base64 characters (see RFC 2045). + */ + static byte[] discardNonBase64(byte[] data) { + byte[] buf = new byte[data.length]; + int pos = 0; + for (byte b : data) { + if (isBase64Byte(b)) { + buf[pos++] = b; + } + } + return (pos == data.length) ? buf : java.util.Arrays.copyOf(buf, pos); + } + + // ----------------------------------------------------------------------- + // Instance methods — BinaryEncoder / BinaryDecoder interfaces + // ----------------------------------------------------------------------- + + /** + * Decodes an Object using the base64 algorithm. This method is provided + * in order to satisfy the requirements of the Decoder interface, and will + * throw a DecoderException if the supplied object is not of type byte[]. * * @param pObject Object to decode - * @return An object (of type byte[]) containing the - * binary data which corresponds to the byte[] supplied. - * @throws DecoderException if the parameter supplied is not - * of type byte[] - */ + * @return An object (of type byte[]) containing the binary data which + * corresponds to the byte[] supplied. + * @throws DecoderException if the parameter supplied is not of type byte[] + */ + @Override public Object decode(Object pObject) throws DecoderException { if (!(pObject instanceof byte[])) { - throw new DecoderException("Parameter supplied to Base64 decode is not a byte[]"); + throw new DecoderException( + "Parameter supplied to Base64 decode is not a byte[]"); } return decode((byte[]) pObject); } /** - * Decodes a byte[] containing containing - * characters in the Base64 alphabet. + * Decodes a byte[] containing characters in the Base64 alphabet. * * @param pArray A byte array containing Base64 character data * @return a byte array containing binary data */ + @Override public byte[] decode(byte[] pArray) { return decodeBase64(pArray); } /** - * Encodes binary data using the base64 algorithm, optionally - * chunking the output into 76 character blocks. - * - * @param binaryData Array containing binary data to encode. - * @param isChunked if isChunked is true this encoder will chunk - * the base64 output into 76 character blocks - * @return Base64-encoded data. - */ - public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) { - int lengthDataBits = binaryData.length * EIGHTBIT; - int fewerThan24bits = lengthDataBits % TWENTYFOURBITGROUP; - int numberTriplets = lengthDataBits / TWENTYFOURBITGROUP; - byte encodedData[] = null; - int encodedDataLength = 0; - int nbrChunks = 0; - - if (fewerThan24bits != 0) { - //data not divisible by 24 bit - encodedDataLength = (numberTriplets + 1) * 4; - } else { - // 16 or 8 bit - encodedDataLength = numberTriplets * 4; - } - - // If the output is to be "chunked" into 76 character sections, - // for compliance with RFC 2045 MIME, then it is important to - // allow for extra length to account for the separator(s) - if (isChunked) { - - nbrChunks = - (CHUNK_SEPARATOR.length == 0 ? 0 : (int) Math.ceil((float) encodedDataLength / CHUNK_SIZE)); - encodedDataLength += nbrChunks * CHUNK_SEPARATOR.length; - } - - encodedData = new byte[encodedDataLength]; - - byte k = 0, l = 0, b1 = 0, b2 = 0, b3 = 0; - - int encodedIndex = 0; - int dataIndex = 0; - int i = 0; - int nextSeparatorIndex = CHUNK_SIZE; - int chunksSoFar = 0; - - //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]; - - //log.debug("b1= " + b1 +", b2= " + b2 + ", b3= " + b3); - - 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 val3 = - ((b3 & SIGN) == 0) ? (byte) (b3 >> 6) : (byte) ((b3) >> 6 ^ 0xfc); - - encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; - //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]; - - encodedIndex += 4; - - // If we are chunking, let's put a chunk separator down. - if (isChunked) { - // this assumes that CHUNK_SIZE % 4 == 0 - if (encodedIndex == nextSeparatorIndex) { - System.arraycopy( - CHUNK_SEPARATOR, - 0, - encodedData, - encodedIndex, - CHUNK_SEPARATOR.length); - chunksSoFar++; - nextSeparatorIndex = - (CHUNK_SIZE * (chunksSoFar + 1)) + - (chunksSoFar * CHUNK_SEPARATOR.length); - encodedIndex += CHUNK_SEPARATOR.length; - } - } - } - - // form integral number of 6-bit groups - dataIndex = i * 3; - - if (fewerThan24bits == EIGHTBIT) { - b1 = binaryData[dataIndex]; - k = (byte) (b1 & 0x03); - //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) { - - b1 = binaryData[dataIndex]; - b2 = binaryData[dataIndex + 1]; - 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); - - encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; - encodedData[encodedIndex + 1] = - lookUpBase64Alphabet[val2 | (k << 4)]; - encodedData[encodedIndex + 2] = lookUpBase64Alphabet[l << 2]; - encodedData[encodedIndex + 3] = PAD; - } - - if (isChunked) { - // we also add a separator to the end of the final chunk. - if (chunksSoFar < nbrChunks) { - System.arraycopy( - CHUNK_SEPARATOR, - 0, - encodedData, - encodedDataLength - CHUNK_SEPARATOR.length, - CHUNK_SEPARATOR.length); - } - } - - return encodedData; - } - - /** - * Decodes Base64 data into octects - * - * @param base64Data Byte array containing Base64 data - * @return Array containing decoded data. - */ - public static byte[] decodeBase64(byte[] base64Data) { - // RFC 2045 requires that we discard ALL non-Base64 characters - base64Data = discardNonBase64(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 - - int encodedIndex = 0; - int dataIndex = 0; - { - // 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]; - - b1 = base64Alphabet[base64Data[dataIndex]]; - b2 = base64Alphabet[base64Data[dataIndex + 1]]; - - 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] = (byte) (b1 << 2 | b2 >> 4); - } 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)); - } - encodedIndex += 3; - } - return decodedData; - } - - /** - * Discards any whitespace from a base-64 encoded block. - * - * @param data The base-64 encoded data to discard the whitespace - * from. - * @return The data, less whitespace (see RFC 2045). - */ - static byte[] discardWhitespace(byte[] data) { - byte groomedData[] = new byte[data.length]; - int bytesCopied = 0; - - for (int i = 0; i < data.length; i++) { - switch (data[i]) { - case (byte) ' ' : - case (byte) '\n' : - case (byte) '\r' : - case (byte) '\t' : - break; - default: - groomedData[bytesCopied++] = data[i]; - } - } - - byte packedData[] = new byte[bytesCopied]; - - System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); - - return packedData; - } - - /** - * Discards any characters outside of the base64 alphabet, per - * the requirements on page 25 of RFC 2045 - "Any characters - * outside of the base64 alphabet are to be ignored in base64 - * encoded data." - * - * @param data The base-64 encoded data to groom - * @return The data, less non-base64 characters (see RFC 2045). - */ - static byte[] discardNonBase64(byte[] data) { - byte groomedData[] = new byte[data.length]; - int bytesCopied = 0; - - for (int i = 0; i < data.length; i++) { - if (isBase64(data[i])) { - groomedData[bytesCopied++] = data[i]; - } - } - - byte packedData[] = new byte[bytesCopied]; - - System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); - - return packedData; - } - - - // Implementation of the Encoder Interface - - /** - * Encodes an Object using the base64 algorithm. This method - * is provided in order to satisfy the requirements of the - * Encoder interface, and will throw an EncoderException if the - * supplied object is not of type byte[]. + * Encodes an Object using the base64 algorithm. This method is provided + * in order to satisfy the requirements of the Encoder interface, and will + * throw an EncoderException if the supplied object is not of type byte[]. * * @param pObject Object to encode - * @return An object (of type byte[]) containing the - * base64 encoded data which corresponds to the byte[] supplied. - * @throws EncoderException if the parameter supplied is not - * of type byte[] - */ + * @return An object (of type byte[]) containing the base64 encoded data + * which corresponds to the byte[] supplied. + * @throws EncoderException if the parameter supplied is not of type byte[] + */ + @Override public Object encode(Object pObject) throws EncoderException { if (!(pObject instanceof byte[])) { throw new EncoderException( - "Parameter supplied to Base64 encode is not a byte[]"); + "Parameter supplied to Base64 encode is not a byte[]"); } return encode((byte[]) pObject); } @@ -517,8 +247,25 @@ * @param pArray a byte array containing binary data * @return A byte array containing only Base64 character data */ + @Override public byte[] encode(byte[] pArray) { return encodeBase64(pArray, false); } + // ----------------------------------------------------------------------- + // Private helpers + // ----------------------------------------------------------------------- + + /** + * Returns {@code true} if {@code b} is a valid Base64 alphabet character + * or the padding character {@code '='}. + */ + private static boolean isBase64Byte(byte b) { + return (b >= 'A' && b <= 'Z') + || (b >= 'a' && b <= 'z') + || (b >= '0' && b <= '9') + || b == '+' + || b == '/' + || b == '='; + } }
Bob repairs it: BLOCKED
The failing tests went back to Bob. 56/58 tests pass. Not applied.
Diff (blocked → repaired)
--- bob/blocked.java
+++ bob/repaired.java
@@ -63,8 +63,9 @@
java.util.Base64.getEncoder();
/**
- * MIME encoder that wraps at {@value #CHUNK_SIZE} columns with CRLF,
- * matching the original RFC 2045 chunked behaviour.
+ * MIME encoder that wraps at {@value #CHUNK_SIZE} columns with CRLF.
+ * Note: getMimeEncoder does NOT append a trailing CRLF after the last
+ * chunk; we add it manually in encodeBase64 to match original behaviour.
*/
private static final java.util.Base64.Encoder MIME_ENCODER =
java.util.Base64.getMimeEncoder(CHUNK_SIZE, CHUNK_SEPARATOR);
@@ -121,18 +122,65 @@
* Encodes binary data using the base64 algorithm, optionally chunking the
* output into 76 character blocks.
*
+ * <p>When {@code isChunked} is {@code true} the output matches the original
+ * Apache Commons Codec 1.x behaviour: every chunk (including the last) is
+ * followed by a CRLF, exactly as required by RFC 2045 §6.8.</p>
+ *
+ * <p>Passing {@code null} throws {@link NullPointerException}, matching
+ * the original implementation.</p>
+ *
* @param binaryData Array containing binary data to encode.
* @param isChunked if {@code true} the output is wrapped at 76 characters
* with CRLF line endings per RFC 2045
* @return Base64-encoded data.
*/
public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) {
- if (binaryData == null || binaryData.length == 0) {
+ // Intentionally no null-check: original code throws NullPointerException
+ // on null input (binaryData.length access), and tests rely on that.
+ if (binaryData.length == 0) {
return binaryData;
}
- return isChunked
- ? MIME_ENCODER.encode(binaryData)
- : PLAIN_ENCODER.encode(binaryData);
+ if (!isChunked) {
+ return PLAIN_ENCODER.encode(binaryData);
+ }
+
+ // java.util.Base64.getMimeEncoder wraps lines but does NOT append a
+ // trailing CRLF after the last chunk. The original hand-rolled encoder
+ // always appends CRLF after the last chunk, so we add it here.
+ //
+ // The original appends a trailing separator whenever
+ // chunksSoFar < nbrChunks
+ // where nbrChunks = ceil(encodedDataLength / CHUNK_SIZE).
+ //
+ // This is equivalent to: the plain-encoded length is NOT an exact
+ // multiple of CHUNK_SIZE (so the last chunk is partial and was never
+ // closed by the inline separator logic), OR the encoded length is
+ // exactly a multiple of CHUNK_SIZE — actually, re-tracing the original:
+ //
+ // 57 bytes → 76 b64 chars, nbrChunks=1, inline sep at index 76 →
+ // chunksSoFar=1, 1 < 1 = false → NO trailing CRLF
+ //
+ // 1 byte → 4 b64 chars, nbrChunks=1, no inline sep (loop ends at
+ // encodedIndex=4, never reaches 76) → chunksSoFar=0, 0 < 1 = true
+ // → trailing CRLF appended
+ //
+ // So trailing CRLF is added iff the plain encoded length is NOT a
+ // multiple of CHUNK_SIZE (i.e. the last line is a short chunk).
+ byte[] mimeEncoded = MIME_ENCODER.encode(binaryData);
+ int plainLen = PLAIN_ENCODER.encode(binaryData).length;
+ boolean needsTrailingCrlf = (plainLen % CHUNK_SIZE) != 0;
+
+ if (!needsTrailingCrlf) {
+ return mimeEncoded;
+ }
+
+ byte[] result = new byte[mimeEncoded.length + CHUNK_SEPARATOR.length];
+ System.arraycopy(mimeEncoded, 0, result, 0, mimeEncoded.length);
+ System.arraycopy(
+ CHUNK_SEPARATOR, 0,
+ result, mimeEncoded.length,
+ CHUNK_SEPARATOR.length);
+ return result;
}
/**
@@ -141,12 +189,17 @@
* <p>Non-Base64 characters (including whitespace) are silently ignored per
* RFC 2045 §6.8.</p>
*
+ * <p>Passing {@code null} throws {@link NullPointerException}, matching
+ * the original implementation.</p>
+ *
* @param base64Data Byte array containing Base64 data
* @return Array containing decoded data.
*/
public static byte[] decodeBase64(byte[] base64Data) {
- if (base64Data == null || base64Data.length == 0) {
- return base64Data;
+ // Intentionally no null-check: original code throws NullPointerException
+ // on null input, and tests rely on that.
+ if (base64Data.length == 0) {
+ return new byte[0];
}
// MimeDecoder already ignores non-alphabet characters per RFC 2045.
return MIME_DECODER.decode(base64Data);Transcript: 20260926T152518Z-base64-sec-118-repair-cli.md
Transcript: 20260926T152443Z-base64-sec-118-cli.md