Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/main/java/org/apache/commons/text/StrBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -1819,6 +1819,15 @@ public String get() {
return toString();
}

/**
* Gets the internal buffer for testing.
*
* @return the internal buffer.
*/
char[] getBuffer() {
return buffer;
}

/**
* Copies the character array into the specified array.
*
Expand Down Expand Up @@ -2608,6 +2617,9 @@ private void replaceImpl(final int startIndex, final int endIndex, final int rem
if (insertLen != removeLen) {
ensureCapacity(newSize);
System.arraycopy(buffer, endIndex, buffer, startIndex + insertLen, size - endIndex);
if (size > newSize) {
Arrays.fill(buffer, newSize, size, CharUtils.NUL);
}
size = newSize;
}
if (insertLen > 0) {
Expand Down Expand Up @@ -2720,12 +2732,12 @@ public StrBuilder setLength(final int length) {
throw new StringIndexOutOfBoundsException(length);
}
if (length < size) {
size = length;
Arrays.fill(buffer, length, size, CharUtils.NUL);
} else if (length > size) {
ensureCapacity(length);
Arrays.fill(buffer, size, length, CharUtils.NUL);
size = length;
}
size = length;
return this;
}

Expand Down
45 changes: 45 additions & 0 deletions src/test/java/org/apache/commons/text/StrBuilderClearTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,17 @@

package org.apache.commons.text;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Reader;
import java.nio.charset.StandardCharsets;

import org.apache.commons.lang3.CharUtils;
import org.apache.commons.lang3.SerializationUtils;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -138,6 +141,48 @@ public void testReadFromReaderDoesNotExposeStaleInternalBuffer() throws IOExcept
}
}

@Test
void testReplaceImplLeavesResidue() throws Exception {
final String string = "SECRET_PASSWORD_DATA";
final StrBuilder sb = new StrBuilder(string);
assertEquals(20, sb.length());
// Shrink: replace [0,20) with "X" => removeLen=20, insertLen=1, newSize=1.
sb.replace(0, 20, "X");
assertEquals(1, sb.length());
assertEquals("X", sb.toString());
final char[] buf = sb.getBuffer();
assertTrue(buf.length >= 20);
// Tail [1..20) should be cleared but isn't on baseline => residue persists.
// Probe offset 5: original was '_' (underscore from "SECRET_..."). After
// arraycopy(buf, endIndex=20, buf, startIndex+insertLen=1, size-endIndex=0)
// the shift is a no-op, so buf[5] retains the original 'T' from "SECRET_".
// Either way it is non-NUL.
assertEquals(CharUtils.NUL, buf[5]);
// Dump the visible residue at the logical-unused tail.
for (int i = 1; i < 20; i++) {
assertEquals(CharUtils.NUL, buf[i]);
}
}

@Test
void testSetLengthShrinkLeavesResidue() throws Exception {
final String string = "CONFIDENTIAL_TOKEN_VALUE";
final int len = string.length();
final StrBuilder sb = new StrBuilder(string);
assertEquals(len, sb.length());
// setLength(5) shrinks: size = 5, but [5..24) is NOT cleared.
sb.setLength(5);
assertEquals(5, sb.length());
assertEquals("CONFI", sb.toString());
final char[] buf = sb.getBuffer();
assertTrue(buf.length >= len);
// Probe offset 10: original was 'L' (CONFIDENTIA*L*_TOKEN_VALUE).
assertEquals(CharUtils.NUL, buf[10]);
for (int i = 5; i < len; i++) {
assertEquals(CharUtils.NUL, buf[i]);
}
}

@Test
public void testStaleCharsNotLeakedAfterClear() throws Exception {
final StrBuilder sb = new StrBuilder("secret_password_xyzzy_leak");
Expand Down
Loading