2015-11-04 21:46:03 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2015 The Netty Project
|
|
|
|
*
|
|
|
|
* The Netty Project licenses this file to you 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright 2014 Twitter, Inc.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
2017-03-02 06:30:55 +01:00
|
|
|
package io.netty.handler.codec.http2;
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
import com.google.gson.FieldNamingPolicy;
|
|
|
|
import com.google.gson.Gson;
|
|
|
|
import com.google.gson.GsonBuilder;
|
|
|
|
import com.google.gson.JsonDeserializationContext;
|
|
|
|
import com.google.gson.JsonDeserializer;
|
|
|
|
import com.google.gson.JsonElement;
|
|
|
|
import com.google.gson.JsonObject;
|
|
|
|
import com.google.gson.JsonParseException;
|
2016-05-30 13:40:08 +02:00
|
|
|
import io.netty.buffer.ByteBuf;
|
|
|
|
import io.netty.buffer.Unpooled;
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
import java.io.IOException;
|
|
|
|
import java.io.InputStream;
|
|
|
|
import java.io.InputStreamReader;
|
|
|
|
import java.lang.reflect.Type;
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.Arrays;
|
|
|
|
import java.util.List;
|
|
|
|
import java.util.Map;
|
|
|
|
import java.util.Set;
|
|
|
|
|
2017-01-14 02:09:44 +01:00
|
|
|
import static io.netty.handler.codec.http2.Http2CodecUtil.DEFAULT_HEADER_LIST_SIZE;
|
2016-09-16 15:57:33 +02:00
|
|
|
import static io.netty.handler.codec.http2.Http2CodecUtil.MAX_HEADER_LIST_SIZE;
|
|
|
|
import static io.netty.handler.codec.http2.Http2TestUtil.newTestEncoder;
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
final class HpackTestCase {
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
private static final Gson GSON = new GsonBuilder()
|
|
|
|
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
|
2017-03-02 06:30:55 +01:00
|
|
|
.registerTypeAdapter(HpackHeaderField.class, new HeaderFieldDeserializer())
|
2015-11-04 21:46:03 +01:00
|
|
|
.create();
|
|
|
|
|
|
|
|
int maxHeaderTableSize = -1;
|
|
|
|
boolean sensitiveHeaders;
|
|
|
|
|
|
|
|
List<HeaderBlock> headerBlocks;
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private HpackTestCase() {
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
static HpackTestCase load(InputStream is) throws IOException {
|
2015-11-04 21:46:03 +01:00
|
|
|
InputStreamReader r = new InputStreamReader(is);
|
2017-03-02 06:30:55 +01:00
|
|
|
HpackTestCase hpackTestCase = GSON.fromJson(r, HpackTestCase.class);
|
|
|
|
for (HeaderBlock headerBlock : hpackTestCase.headerBlocks) {
|
|
|
|
headerBlock.encodedBytes = HpackHex.decodeHex(headerBlock.getEncodedStr().toCharArray());
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
2017-03-02 06:30:55 +01:00
|
|
|
return hpackTestCase;
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void testCompress() throws Exception {
|
2017-03-02 06:30:55 +01:00
|
|
|
HpackEncoder hpackEncoder = createEncoder();
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
for (HeaderBlock headerBlock : headerBlocks) {
|
|
|
|
|
|
|
|
byte[] actual =
|
2017-03-02 06:30:55 +01:00
|
|
|
encode(hpackEncoder, headerBlock.getHeaders(), headerBlock.getMaxHeaderTableSize(),
|
2015-11-04 21:46:03 +01:00
|
|
|
sensitiveHeaders);
|
|
|
|
|
|
|
|
if (!Arrays.equals(actual, headerBlock.encodedBytes)) {
|
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED:\n" + headerBlock.getEncodedStr() +
|
2017-03-02 06:30:55 +01:00
|
|
|
"\nACTUAL:\n" + HpackHex.encodeHexString(actual));
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> actualDynamicTable = new ArrayList<HpackHeaderField>();
|
|
|
|
for (int index = 0; index < hpackEncoder.length(); index++) {
|
|
|
|
actualDynamicTable.add(hpackEncoder.getHeaderField(index));
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> expectedDynamicTable = headerBlock.getDynamicTable();
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
if (!expectedDynamicTable.equals(actualDynamicTable)) {
|
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED DYNAMIC TABLE:\n" + expectedDynamicTable +
|
|
|
|
"\nACTUAL DYNAMIC TABLE:\n" + actualDynamicTable);
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
if (headerBlock.getTableSize() != hpackEncoder.size()) {
|
2015-11-04 21:46:03 +01:00
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED TABLE SIZE: " + headerBlock.getTableSize() +
|
2017-03-02 06:30:55 +01:00
|
|
|
"\n ACTUAL TABLE SIZE : " + hpackEncoder.size());
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void testDecompress() throws Exception {
|
2017-03-02 06:30:55 +01:00
|
|
|
HpackDecoder hpackDecoder = createDecoder();
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
for (HeaderBlock headerBlock : headerBlocks) {
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> actualHeaders = decode(hpackDecoder, headerBlock.encodedBytes);
|
2015-11-04 21:46:03 +01:00
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> expectedHeaders = new ArrayList<HpackHeaderField>();
|
|
|
|
for (HpackHeaderField h : headerBlock.getHeaders()) {
|
|
|
|
expectedHeaders.add(new HpackHeaderField(h.name, h.value));
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!expectedHeaders.equals(actualHeaders)) {
|
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED:\n" + expectedHeaders +
|
|
|
|
"\nACTUAL:\n" + actualHeaders);
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> actualDynamicTable = new ArrayList<HpackHeaderField>();
|
|
|
|
for (int index = 0; index < hpackDecoder.length(); index++) {
|
|
|
|
actualDynamicTable.add(hpackDecoder.getHeaderField(index));
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> expectedDynamicTable = headerBlock.getDynamicTable();
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
if (!expectedDynamicTable.equals(actualDynamicTable)) {
|
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED DYNAMIC TABLE:\n" + expectedDynamicTable +
|
|
|
|
"\nACTUAL DYNAMIC TABLE:\n" + actualDynamicTable);
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
if (headerBlock.getTableSize() != hpackDecoder.size()) {
|
2015-11-04 21:46:03 +01:00
|
|
|
throw new AssertionError(
|
|
|
|
"\nEXPECTED TABLE SIZE: " + headerBlock.getTableSize() +
|
2017-03-02 06:30:55 +01:00
|
|
|
"\n ACTUAL TABLE SIZE : " + hpackDecoder.size());
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private HpackEncoder createEncoder() {
|
2015-11-04 21:46:03 +01:00
|
|
|
int maxHeaderTableSize = this.maxHeaderTableSize;
|
|
|
|
if (maxHeaderTableSize == -1) {
|
|
|
|
maxHeaderTableSize = Integer.MAX_VALUE;
|
|
|
|
}
|
|
|
|
|
2016-09-16 15:57:33 +02:00
|
|
|
try {
|
|
|
|
return newTestEncoder(true, MAX_HEADER_LIST_SIZE, maxHeaderTableSize);
|
|
|
|
} catch (Http2Exception e) {
|
|
|
|
throw new Error("invalid initial values!", e);
|
|
|
|
}
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private HpackDecoder createDecoder() {
|
2015-11-04 21:46:03 +01:00
|
|
|
int maxHeaderTableSize = this.maxHeaderTableSize;
|
|
|
|
if (maxHeaderTableSize == -1) {
|
|
|
|
maxHeaderTableSize = Integer.MAX_VALUE;
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
return new HpackDecoder(DEFAULT_HEADER_LIST_SIZE, 32, maxHeaderTableSize);
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private static byte[] encode(HpackEncoder hpackEncoder, List<HpackHeaderField> headers, int maxHeaderTableSize,
|
2016-09-16 15:57:33 +02:00
|
|
|
final boolean sensitive) throws Http2Exception {
|
|
|
|
Http2Headers http2Headers = toHttp2Headers(headers);
|
|
|
|
Http2HeadersEncoder.SensitivityDetector sensitivityDetector = new Http2HeadersEncoder.SensitivityDetector() {
|
|
|
|
@Override
|
|
|
|
public boolean isSensitive(CharSequence name, CharSequence value) {
|
|
|
|
return sensitive;
|
|
|
|
}
|
|
|
|
};
|
2016-05-30 13:40:08 +02:00
|
|
|
ByteBuf buffer = Unpooled.buffer();
|
|
|
|
try {
|
|
|
|
if (maxHeaderTableSize != -1) {
|
2017-03-02 06:30:55 +01:00
|
|
|
hpackEncoder.setMaxHeaderTableSize(buffer, maxHeaderTableSize);
|
2016-05-30 13:40:08 +02:00
|
|
|
}
|
2015-11-04 21:46:03 +01:00
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
hpackEncoder.encodeHeaders(3 /* randomly chosen */, buffer, http2Headers, sensitivityDetector);
|
2016-05-30 13:40:08 +02:00
|
|
|
byte[] bytes = new byte[buffer.readableBytes()];
|
|
|
|
buffer.readBytes(bytes);
|
|
|
|
return bytes;
|
|
|
|
} finally {
|
|
|
|
buffer.release();
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private static Http2Headers toHttp2Headers(List<HpackHeaderField> inHeaders) {
|
2016-09-16 15:57:33 +02:00
|
|
|
Http2Headers headers = new DefaultHttp2Headers(false);
|
2017-03-02 06:30:55 +01:00
|
|
|
for (HpackHeaderField e : inHeaders) {
|
2016-09-16 15:57:33 +02:00
|
|
|
headers.add(e.name, e.value);
|
|
|
|
}
|
|
|
|
return headers;
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
private static List<HpackHeaderField> decode(HpackDecoder hpackDecoder, byte[] expected) throws Exception {
|
2016-05-30 13:40:08 +02:00
|
|
|
ByteBuf in = Unpooled.wrappedBuffer(expected);
|
|
|
|
try {
|
2017-03-02 06:30:55 +01:00
|
|
|
List<HpackHeaderField> headers = new ArrayList<HpackHeaderField>();
|
2016-05-30 13:40:08 +02:00
|
|
|
TestHeaderListener listener = new TestHeaderListener(headers);
|
2017-03-02 06:30:55 +01:00
|
|
|
hpackDecoder.decode(0, in, listener);
|
2016-05-30 13:40:08 +02:00
|
|
|
return headers;
|
|
|
|
} finally {
|
|
|
|
in.release();
|
|
|
|
}
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
private static String concat(List<String> l) {
|
|
|
|
StringBuilder ret = new StringBuilder();
|
|
|
|
for (String s : l) {
|
|
|
|
ret.append(s);
|
|
|
|
}
|
|
|
|
return ret.toString();
|
|
|
|
}
|
|
|
|
|
|
|
|
static class HeaderBlock {
|
|
|
|
private int maxHeaderTableSize = -1;
|
|
|
|
private byte[] encodedBytes;
|
|
|
|
private List<String> encoded;
|
2017-03-02 06:30:55 +01:00
|
|
|
private List<HpackHeaderField> headers;
|
|
|
|
private List<HpackHeaderField> dynamicTable;
|
2015-11-04 21:46:03 +01:00
|
|
|
private int tableSize;
|
|
|
|
|
|
|
|
private int getMaxHeaderTableSize() {
|
|
|
|
return maxHeaderTableSize;
|
|
|
|
}
|
|
|
|
|
|
|
|
public String getEncodedStr() {
|
|
|
|
return concat(encoded).replaceAll(" ", "");
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
public List<HpackHeaderField> getHeaders() {
|
2015-11-04 21:46:03 +01:00
|
|
|
return headers;
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
public List<HpackHeaderField> getDynamicTable() {
|
2015-11-04 21:46:03 +01:00
|
|
|
return dynamicTable;
|
|
|
|
}
|
|
|
|
|
|
|
|
public int getTableSize() {
|
|
|
|
return tableSize;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-02 06:30:55 +01:00
|
|
|
static class HeaderFieldDeserializer implements JsonDeserializer<HpackHeaderField> {
|
2015-11-04 21:46:03 +01:00
|
|
|
|
|
|
|
@Override
|
2017-03-02 06:30:55 +01:00
|
|
|
public HpackHeaderField deserialize(JsonElement json, Type typeOfT,
|
|
|
|
JsonDeserializationContext context) {
|
2015-11-04 21:46:03 +01:00
|
|
|
JsonObject jsonObject = json.getAsJsonObject();
|
|
|
|
Set<Map.Entry<String, JsonElement>> entrySet = jsonObject.entrySet();
|
|
|
|
if (entrySet.size() != 1) {
|
|
|
|
throw new JsonParseException("JSON Object has multiple entries: " + entrySet);
|
|
|
|
}
|
|
|
|
Map.Entry<String, JsonElement> entry = entrySet.iterator().next();
|
|
|
|
String name = entry.getKey();
|
|
|
|
String value = entry.getValue().getAsString();
|
2017-03-02 06:30:55 +01:00
|
|
|
return new HpackHeaderField(name, value);
|
2015-11-04 21:46:03 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|