Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-9517: Don't subclass Deflater and instead create a patch for setDictionary() using a functional interface (#1850)

This commit is contained in:
Uwe Schindler 2020-09-10 11:12:59 +02:00 committed by GitHub
parent a05a055d9d
commit 8debc9d0c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
gradle/validation/forbidden-apis/defaults.all.txt
View File

@ -62,3 +62,7 @@ java.lang.Double#<init>(java.lang.String)
@defaultMessage Java deserialization is unsafe when the data is untrusted. The java developer is powerless: no checks or casts help, exploitation can happen in places such as clinit or finalize!
java.io.ObjectInputStream
java.io.ObjectOutputStream
@defaultMessage Don't set a dictionary on a Deflater using a method that takes an offset or ByteBuffer (JDK-8252739)
java.util.zip.Deflater#setDictionary(byte[],int,int)
java.util.zip.Deflater#setDictionary(java.nio.ByteBuffer)

44
lucene/core/src/java/org/apache/lucene/codecs/lucene87/BugfixDeflater_JDK8252739.java
View File

@ -21,49 +21,47 @@ import java.util.zip.DataFormatException;
import java.util.zip.Deflater;
import java.util.zip.Inflater;
import org.apache.lucene.util.SuppressForbidden;
/**
* This class is a workaround for JDK bug
* <a href="https://bugs.openjdk.java.net/browse/JDK-8252739">JDK-8252739</a>.
*/
final class BugfixDeflater_JDK8252739 extends Deflater {
@FunctionalInterface
interface BugfixDeflater_JDK8252739 {
public static final boolean IS_BUGGY_JDK = detectBuggyJDK();
/**
* Creates a {@link Deflater} instance, which works around JDK-8252739.
* Creates a bugfix for {@link Deflater} instances, which works around JDK-8252739.
* <p>
* Use this whenever you intend to call {@link #setDictionary(byte[], int, int)} or
* {@link #setDictionary(java.nio.ByteBuffer)} on a {@code Deflater}.
* Use this whenever you intend to call {@link Deflater#setDictionary(byte[], int, int)}
* on a {@code Deflater}.
* */
public static Deflater createDeflaterInstance(int level, boolean nowrap, int dictLength) {
@SuppressForbidden(reason = "Works around bug, so it must call forbidden method")
public static BugfixDeflater_JDK8252739 createBugfix(Deflater deflater, int dictLength) {
if (dictLength < 0) {
throw new IllegalArgumentException("dictLength must be >= 0");
}
if (IS_BUGGY_JDK) {
return new BugfixDeflater_JDK8252739(level, nowrap, dictLength);
} else {
return new Deflater(level, nowrap);
}
}
private final byte[] dictBytesScratch;
private BugfixDeflater_JDK8252739(int level, boolean nowrap, int dictLength) {
super(level, nowrap);
this.dictBytesScratch = new byte[dictLength];
}
@Override
public void setDictionary(byte[] dictBytes, int off, int len) {
final byte[] dictBytesScratch = new byte[dictLength];
return (dictBytes, off, len) -> {
if (off > 0) {
System.arraycopy(dictBytes, off, dictBytesScratch, 0, len);
super.setDictionary(dictBytesScratch, 0, len);
deflater.setDictionary(dictBytesScratch, 0, len);
} else {
super.setDictionary(dictBytes, off, len);
deflater.setDictionary(dictBytes, off, len);
}
};
} else {
return deflater::setDictionary;
}
}
/** Call this method as a workaround */
void setDictionary(byte[] dictBytes, int off, int len);
@SuppressForbidden(reason = "Detector for the bug, so it must call buggy method")
private static boolean detectBuggyJDK() {
final byte[] testData = new byte[] { 1, 2, 3, 4, 5, 6, 7, 8 };
final byte[] compressed = new byte[32]; // way enough space

6
lucene/core/src/java/org/apache/lucene/codecs/lucene87/DeflateWithPresetDictCompressionMode.java
View File

@ -157,11 +157,13 @@ public final class DeflateWithPresetDictCompressionMode extends CompressionMode
private final int dictLength, blockLength;
final Deflater compressor;
final BugfixDeflater_JDK8252739 deflaterBugfix;
byte[] compressed;
boolean closed;
DeflateWithPresetDictCompressor(int level, int dictLength, int blockLength) {
compressor = BugfixDeflater_JDK8252739.createDeflaterInstance(level, true, dictLength);
compressor = new Deflater(level, true);
deflaterBugfix = BugfixDeflater_JDK8252739.createBugfix(compressor, dictLength);
compressed = new byte[64];
this.dictLength = dictLength;
this.blockLength = blockLength;
@ -208,7 +210,7 @@ public final class DeflateWithPresetDictCompressionMode extends CompressionMode
// And then sub blocks
for (int start = off + dictLength; start < end; start += blockLength) {
compressor.reset();
compressor.setDictionary(bytes, off, dictLength);
deflaterBugfix.setDictionary(bytes, off, dictLength);
doCompress(bytes, start, Math.min(blockLength, off + len - start), out);
}
}