Author: markt Date: Wed Oct 19 19:13:32 2016 New Revision: 1765700 URL: http://svn.apache.org/viewvc?rev=1765700&view=rev Log: Enable configuration of allowed trailer headers
Modified: tomcat/tc8.5.x/trunk/ (props changed) tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2Protocol.java tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2UpgradeHandler.java tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Stream.java tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/Http2TestBase.java tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/TestHttp2Section_8_1.java tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml tomcat/tc8.5.x/trunk/webapps/docs/config/http2.xml Propchange: tomcat/tc8.5.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Wed Oct 19 19:13:32 2016 @@ -1 +1 @@ -/tomcat/trunk:1734785,1734799,1734845,1734928,1735041,1735044,1735480,1735577,1735597,1735599-1735600,1735615,1736145,1736162,1736209,1736280,1736297,1736299,1736489,1736646,1736703,1736836,1736849,1737104-1737105,1737112,1737117,1737119-1737120,1737155,1737157,1737192,1737280,1737339,1737632,1737664,1737715,1737748,1737785,1737834,1737860,1737903,1737959,1738005,1738007,1738014-1738015,1738018,1738022,1738039,1738043,1738059-1738060,1738147,1738149,1738174-1738175,1738261,1738589,1738623-1738625,1738643,1738816,1738850,1738855,1738946-1738948,1738953-1738954,1738979,1738982,1739079-1739081,1739087,1739113,1739153,1739172,1739176,1739191,1739474,1739726,1739762,1739775,1739814,1739817-1739818,1739975,1740131,1740324,1740465,1740495,1740508-1740509,1740520,1740535,1740707,1740803,1740810,1740969,1740980,1740991,1740997,1741015,1741033,1741036,1741058,1741060,1741080,1741147,1741159,1741164,1741173,1741181,1741190,1741197,1741202,1741208,1741213,1741221,1741225,1741232,1741409,1741501 ,1741677,1741892,1741896,1741984,1742023,1742042,1742071,1742090,1742093,1742101,1742105,1742111,1742139,1742146,1742148,1742166,1742181,1742184,1742187,1742246,1742248-1742251,1742263-1742264,1742268,1742276,1742369,1742387,1742448,1742509-1742512,1742917,1742919,1742933,1742975-1742976,1742984,1742986,1743019,1743115,1743117,1743124-1743125,1743134,1743425,1743554,1743679,1743696-1743698,1743700-1743701,1744058,1744064-1744065,1744125,1744194,1744229,1744270,1744323,1744432,1744684,1744697,1744705,1744713,1744760,1744786,1745083,1745142-1745143,1745145,1745177,1745179-1745180,1745227,1745248,1745254,1745337,1745467,1745473,1745576,1745735,1745744,1746304,1746306-1746307,1746319,1746327,1746338,1746340-1746341,1746344,1746427,1746441,1746473,1746490,1746492,1746495-1746496,1746499-1746501,1746503-1746507,1746509,1746549,1746551,1746554,1746556,1746558,1746584,1746620,1746649,1746724,1746939,1746989,1747014,1747028,1747035,1747210,1747225,1747234,1747253,1747404,1747506,1747536,1747 924,1747980,1747993,1748001,1748253,1748452,1748547,1748629,1748676,1748715,1749287,1749296,1749328,1749373,1749465,1749506,1749508,1749665-1749666,1749763,1749865-1749866,1749898,1749978,1749980,1750011,1750015,1750056,1750480,1750617,1750634,1750692,1750697,1750700,1750703,1750707,1750714,1750718,1750723,1750774,1750899,1750975,1750995,1751061,1751097,1751173,1751438,1751447,1751463,1751702,1752212,1752737,1752745,1753078,1753080,1753358,1753363,1754111,1754140-1754141,1754281,1754310,1754445,1754467,1754494,1754496,1754528,1754532-1754533,1754613,1754714,1754874,1754941,1754944,1754950-1754951,1755005,1755007,1755009,1755132,1755180-1755181,1755185,1755190,1755204-1755206,1755208,1755214,1755224,1755227,1755230,1755629,1755646-1755647,1755650,1755653,1755675,1755680,1755683,1755693,1755717,1755731-1755737,1755812,1755828,1755884,1755890,1755918-1755919,1755942,1755958,1755960,1755970,1755993,1756013,1756019,1756039,1756056,1756083-1756114,1756175,1756288-1756289,1756408-1756410,1 756778,1756798,1756878,1756898,1756939,1757123-1757124,1757126,1757128,1757132-1757133,1757136,1757145,1757167-1757168,1757175,1757180,1757182,1757195,1757271,1757278,1757347,1757353-1757354,1757363,1757374,1757399,1757406,1757408,1757485,1757495,1757499,1757527,1757578,1757684,1757722,1757727,1757853,1757903,1757997,1758072-1758075,1758078-1758079,1758292,1758369,1758423,1758425-1758427,1758430,1758459,1758483,1758486-1758487,1758499,1758525,1758556,1758582,1758584,1758588,1758842,1759019,1759212,1759224,1759227,1759252,1759274,1759513-1759516,1759611,1760005,1760022,1760300,1760397,1760446,1760454,1760640,1760648,1761057,1761422,1761491,1761498,1761500-1761501,1761550,1761553,1761572,1761574,1761625-1761626,1761628,1761682,1761740,1761752,1762123,1762168,1762172,1762182,1762202,1762288,1762296,1762348,1762353,1762374,1762503,1762505,1762541,1762608,1762710,1762753,1762766,1762769,1762944,1762947,1762953,1763167,1763179,1763232,1763259,1763271-1763272,1763276-1763277,1763319-176332 0,1763370,1763372,1763375,1763377,1763393,1763412,1763430,1763450,1763512,1763516,1763518,1763520,1763529,1763574,1763634-1763635,1763718,1763786,1763798-1763799,1764083,1764425,1764646,1764648-1764649,1764663,1764682,1764862,1764866-1764867,1764870,1764897,1765133,1765299,1765358,1765447,1765495,1765502,1765569-1765571,1765579,1765582,1765589 +/tomcat/trunk:1734785,1734799,1734845,1734928,1735041,1735044,1735480,1735577,1735597,1735599-1735600,1735615,1736145,1736162,1736209,1736280,1736297,1736299,1736489,1736646,1736703,1736836,1736849,1737104-1737105,1737112,1737117,1737119-1737120,1737155,1737157,1737192,1737280,1737339,1737632,1737664,1737715,1737748,1737785,1737834,1737860,1737903,1737959,1738005,1738007,1738014-1738015,1738018,1738022,1738039,1738043,1738059-1738060,1738147,1738149,1738174-1738175,1738261,1738589,1738623-1738625,1738643,1738816,1738850,1738855,1738946-1738948,1738953-1738954,1738979,1738982,1739079-1739081,1739087,1739113,1739153,1739172,1739176,1739191,1739474,1739726,1739762,1739775,1739814,1739817-1739818,1739975,1740131,1740324,1740465,1740495,1740508-1740509,1740520,1740535,1740707,1740803,1740810,1740969,1740980,1740991,1740997,1741015,1741033,1741036,1741058,1741060,1741080,1741147,1741159,1741164,1741173,1741181,1741190,1741197,1741202,1741208,1741213,1741221,1741225,1741232,1741409,1741501 ,1741677,1741892,1741896,1741984,1742023,1742042,1742071,1742090,1742093,1742101,1742105,1742111,1742139,1742146,1742148,1742166,1742181,1742184,1742187,1742246,1742248-1742251,1742263-1742264,1742268,1742276,1742369,1742387,1742448,1742509-1742512,1742917,1742919,1742933,1742975-1742976,1742984,1742986,1743019,1743115,1743117,1743124-1743125,1743134,1743425,1743554,1743679,1743696-1743698,1743700-1743701,1744058,1744064-1744065,1744125,1744194,1744229,1744270,1744323,1744432,1744684,1744697,1744705,1744713,1744760,1744786,1745083,1745142-1745143,1745145,1745177,1745179-1745180,1745227,1745248,1745254,1745337,1745467,1745473,1745576,1745735,1745744,1746304,1746306-1746307,1746319,1746327,1746338,1746340-1746341,1746344,1746427,1746441,1746473,1746490,1746492,1746495-1746496,1746499-1746501,1746503-1746507,1746509,1746549,1746551,1746554,1746556,1746558,1746584,1746620,1746649,1746724,1746939,1746989,1747014,1747028,1747035,1747210,1747225,1747234,1747253,1747404,1747506,1747536,1747 924,1747980,1747993,1748001,1748253,1748452,1748547,1748629,1748676,1748715,1749287,1749296,1749328,1749373,1749465,1749506,1749508,1749665-1749666,1749763,1749865-1749866,1749898,1749978,1749980,1750011,1750015,1750056,1750480,1750617,1750634,1750692,1750697,1750700,1750703,1750707,1750714,1750718,1750723,1750774,1750899,1750975,1750995,1751061,1751097,1751173,1751438,1751447,1751463,1751702,1752212,1752737,1752745,1753078,1753080,1753358,1753363,1754111,1754140-1754141,1754281,1754310,1754445,1754467,1754494,1754496,1754528,1754532-1754533,1754613,1754714,1754874,1754941,1754944,1754950-1754951,1755005,1755007,1755009,1755132,1755180-1755181,1755185,1755190,1755204-1755206,1755208,1755214,1755224,1755227,1755230,1755629,1755646-1755647,1755650,1755653,1755675,1755680,1755683,1755693,1755717,1755731-1755737,1755812,1755828,1755884,1755890,1755918-1755919,1755942,1755958,1755960,1755970,1755993,1756013,1756019,1756039,1756056,1756083-1756114,1756175,1756288-1756289,1756408-1756410,1 756778,1756798,1756878,1756898,1756939,1757123-1757124,1757126,1757128,1757132-1757133,1757136,1757145,1757167-1757168,1757175,1757180,1757182,1757195,1757271,1757278,1757347,1757353-1757354,1757363,1757374,1757399,1757406,1757408,1757485,1757495,1757499,1757527,1757578,1757684,1757722,1757727,1757853,1757903,1757997,1758072-1758075,1758078-1758079,1758292,1758369,1758423,1758425-1758427,1758430,1758459,1758483,1758486-1758487,1758499,1758525,1758556,1758582,1758584,1758588,1758842,1759019,1759212,1759224,1759227,1759252,1759274,1759513-1759516,1759611,1760005,1760022,1760300,1760397,1760446,1760454,1760640,1760648,1761057,1761422,1761491,1761498,1761500-1761501,1761550,1761553,1761572,1761574,1761625-1761626,1761628,1761682,1761740,1761752,1762123,1762168,1762172,1762182,1762202,1762288,1762296,1762348,1762353,1762374,1762503,1762505,1762541,1762608,1762710,1762753,1762766,1762769,1762944,1762947,1762953,1763167,1763179,1763232,1763259,1763271-1763272,1763276-1763277,1763319-176332 0,1763370,1763372,1763375,1763377,1763393,1763412,1763430,1763450,1763512,1763516,1763518,1763520,1763529,1763574,1763634-1763635,1763718,1763786,1763798-1763799,1764083,1764425,1764646,1764648-1764649,1764663,1764682,1764862,1764866-1764867,1764870,1764897,1765133,1765299,1765358,1765447,1765495,1765502,1765569-1765571,1765579,1765582,1765589-1765590 Modified: tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2Protocol.java URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2Protocol.java?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2Protocol.java (original) +++ tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2Protocol.java Wed Oct 19 19:13:32 2016 @@ -17,7 +17,14 @@ package org.apache.coyote.http2; import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; import java.util.Enumeration; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; import org.apache.coyote.Adapter; import org.apache.coyote.Processor; @@ -54,6 +61,9 @@ public class Http2Protocol implements Up // If a lower initial value is required, set it here but DO NOT change the // default defined above. private int initialWindowSize = DEFAULT_INITIAL_WINDOW_SIZE; + private Set<String> allowedTrailerHeaders = + Collections.newSetFromMap(new ConcurrentHashMap<String, Boolean>()); + @Override public String getHttpUpgradeName(boolean isSSLEnabled) { @@ -93,7 +103,7 @@ public class Http2Protocol implements Up result.setMaxConcurrentStreams(getMaxConcurrentStreams()); result.setMaxConcurrentStreamExecution(getMaxConcurrentStreamExecution()); result.setInitialWindowSize(getInitialWindowSize()); - + result.setAllowedTrailerHeaders(allowedTrailerHeaders); return result; } @@ -178,4 +188,43 @@ public class Http2Protocol implements Up public void setInitialWindowSize(int initialWindowSize) { this.initialWindowSize = initialWindowSize; } + + + public void setAllowedTrailerHeaders(String commaSeparatedHeaders) { + // Jump through some hoops so we don't end up with an empty set while + // doing updates. + Set<String> toRemove = new HashSet<>(); + toRemove.addAll(allowedTrailerHeaders); + if (commaSeparatedHeaders != null) { + String[] headers = commaSeparatedHeaders.split(","); + for (String header : headers) { + String trimmedHeader = header.trim().toLowerCase(Locale.ENGLISH); + if (toRemove.contains(trimmedHeader)) { + toRemove.remove(trimmedHeader); + } else { + allowedTrailerHeaders.add(trimmedHeader); + } + } + allowedTrailerHeaders.removeAll(toRemove); + } + } + + + public String getAllowedTrailerHeaders() { + // Chances of a size change between these lines are small enough that a + // sync is unnecessary. + List<String> copy = new ArrayList<>(allowedTrailerHeaders.size()); + copy.addAll(allowedTrailerHeaders); + StringBuilder result = new StringBuilder(); + boolean first = true; + for (String header : copy) { + if (first) { + first = false; + } else { + result.append(','); + } + result.append(header); + } + return result.toString(); + } } Modified: tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2UpgradeHandler.java URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2UpgradeHandler.java?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2UpgradeHandler.java (original) +++ tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Http2UpgradeHandler.java Wed Oct 19 19:13:32 2016 @@ -20,6 +20,7 @@ import java.io.EOFException; import java.io.IOException; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; +import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; @@ -145,6 +146,10 @@ public class Http2UpgradeHandler extends private AtomicInteger streamConcurrency = null; private Queue<StreamProcessor> queuedProcessors = null; + // Limits + private Set<String> allowedTrailerHeaders = Collections.emptySet(); + + public Http2UpgradeHandler(Adapter adapter, Request coyoteRequest) { super (STREAM_ID_ZERO); this.adapter = adapter; @@ -1056,6 +1061,11 @@ public class Http2UpgradeHandler extends } + boolean isTrailerHeaderAllowed(String headerName) { + return allowedTrailerHeaders.contains(headerName); + } + + // ------------------------------------------- Configuration getters/setters public long getReadTimeout() { @@ -1103,6 +1113,11 @@ public class Http2UpgradeHandler extends } + public void setAllowedTrailerHeaders(Set<String> allowedTrailerHeaders) { + this.allowedTrailerHeaders = allowedTrailerHeaders; + } + + // ----------------------------------------------- Http2Parser.Input methods @Override Modified: tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Stream.java URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Stream.java?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Stream.java (original) +++ tomcat/tc8.5.x/trunk/java/org/apache/coyote/http2/Stream.java Wed Oct 19 19:13:32 2016 @@ -280,6 +280,9 @@ public class Stream extends AbstractStre break; } default: { + if (headerState == HEADER_STATE_TRAILER && !handler.isTrailerHeaderAllowed(name)) { + break; + } if ("expect".equals(name) && "100-continue".equals(value)) { coyoteRequest.setExpectation(true); } Modified: tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/Http2TestBase.java URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/Http2TestBase.java?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/Http2TestBase.java (original) +++ tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/Http2TestBase.java Wed Oct 19 19:13:32 2016 @@ -69,7 +69,8 @@ public abstract class Http2TestBase exte EMPTY_HTTP2_SETTINGS_HEADER = "HTTP2-Settings: " + Base64.encodeBase64String(empty) + "\r\n"; } - private static final String TRAILER_HEADER_NAME = "X-TrailerTest"; + protected static final String TRAILER_HEADER_NAME = "X-TrailerTest"; + protected static final String TRAILER_HEADER_VALUE = "test"; private Socket s; protected HpackEncoder hpackEncoder; @@ -354,7 +355,7 @@ public abstract class Http2TestBase exte // Trailers if (trailersPayload != null) { MimeHeaders trailerHeaders = new MimeHeaders(); - trailerHeaders.addValue(TRAILER_HEADER_NAME).setString("xxxx"); + trailerHeaders.addValue(TRAILER_HEADER_NAME).setString(TRAILER_HEADER_VALUE); hpackEncoder.encode(trailerHeaders, trailersPayload); trailersPayload.flip(); Modified: tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/TestHttp2Section_8_1.java URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/TestHttp2Section_8_1.java?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/TestHttp2Section_8_1.java (original) +++ tomcat/tc8.5.x/trunk/test/org/apache/coyote/http2/TestHttp2Section_8_1.java Wed Oct 19 19:13:32 2016 @@ -34,7 +34,23 @@ public class TestHttp2Section_8_1 extend @Test public void testPostWithTrailerHeaders() throws Exception { + doTestPostWithTrailerHeaders(true); + } + + + @Test + public void testPostWithTrailerHeadersBlocked() throws Exception { + doTestPostWithTrailerHeaders(false); + } + + + private void doTestPostWithTrailerHeaders(boolean allowTrailerHeader) throws Exception{ http2Connect(); + if (allowTrailerHeader) { + Http2Protocol http2Protocol = + (Http2Protocol) getTomcatInstance().getConnector().findUpgradeProtocols()[0]; + http2Protocol.setAllowedTrailerHeaders(TRAILER_HEADER_NAME); + } byte[] headersFrameHeader = new byte[9]; ByteBuffer headersPayload = ByteBuffer.allocate(128); @@ -58,13 +74,22 @@ public class TestHttp2Section_8_1 extend parser.readFrame(true); parser.readFrame(true); + String len; + if (allowTrailerHeader) { + len = Integer.toString(256 + TRAILER_HEADER_VALUE.length()); + } else { + len = "256"; + } + Assert.assertEquals("0-WindowSize-[256]\n" + "3-WindowSize-[256]\n" + "3-HeadersStart\n" + "3-Header-[:status]-[200]\n" + "3-Header-[date]-["+ DEFAULT_DATE + "]\n" + "3-HeadersEnd\n" + - "3-Body-260\n" + + "3-Body-" + + len + + "\n" + "3-EndOfStream\n", output.getTrace()); } Modified: tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml Wed Oct 19 19:13:32 2016 @@ -101,6 +101,9 @@ <add> Add checks around the handling of HTTP/2 pseudo headers. (markt) </add> + <add> + Add support for trailer headers to the HTTP/2 implementation. (markt) + </add> </changelog> </subsection> <subsection name="Jasper"> Modified: tomcat/tc8.5.x/trunk/webapps/docs/config/http2.xml URL: http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/webapps/docs/config/http2.xml?rev=1765700&r1=1765699&r2=1765700&view=diff ============================================================================== --- tomcat/tc8.5.x/trunk/webapps/docs/config/http2.xml (original) +++ tomcat/tc8.5.x/trunk/webapps/docs/config/http2.xml Wed Oct 19 19:13:32 2016 @@ -71,6 +71,12 @@ <attributes> + <attribute name="allowedTrailerHeaders" required="false"> + <p>By default Tomcat will ignore all trailer headers when processing + HTTP/2 connections. For a header to be processed, it must be added to this + comma-separated list of header names.</p> + </attribute> + <attribute name="initialWindowSize" required="false"> <p>Controls the initial size of the flow control window for streams that Tomcat advertises to clients. If not specified, the default value of --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org