OLD | NEW |
| (Empty) |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef NET_SPDY_HPACK_HPACK_DECODER2_H_ | |
6 #define NET_SPDY_HPACK_HPACK_DECODER2_H_ | |
7 | |
8 // HpackDecoder2 | |
9 | |
10 // An HpackDecoder decodes header sets as outlined in | |
11 // http://tools.ietf.org/html/rfc7541. This implementation uses the | |
12 // new HpackBlockDecoder in //net/http2/hpack/ | |
13 | |
14 #include <stddef.h> | |
15 | |
16 #include <memory> | |
17 #include <string> | |
18 | |
19 #include "base/macros.h" | |
20 #include "base/strings/string_piece.h" | |
21 #include "net/base/net_export.h" | |
22 #include "net/http2/hpack/decoder/hpack_block_decoder.h" | |
23 #include "net/http2/hpack/decoder/hpack_decoder_string_buffer.h" | |
24 #include "net/http2/hpack/decoder/hpack_entry_decoder_listener.h" | |
25 #include "net/http2/hpack/http2_hpack_constants.h" | |
26 #include "net/http2/hpack/huffman/http2_hpack_huffman_decoder.h" | |
27 #include "net/spdy/hpack/hpack_constants.h" | |
28 #include "net/spdy/hpack/hpack_decoder_interface.h" | |
29 #include "net/spdy/hpack/hpack_header_table.h" | |
30 #include "net/spdy/spdy_header_block.h" | |
31 #include "net/spdy/spdy_headers_handler_interface.h" | |
32 | |
33 namespace net { | |
34 namespace test { | |
35 class HpackDecoder2Peer; | |
36 } // namespace test | |
37 | |
38 class NET_EXPORT_PRIVATE HpackDecoder2 : public HpackDecoderInterface, | |
39 HpackEntryDecoderListener { | |
40 public: | |
41 friend test::HpackDecoder2Peer; | |
42 HpackDecoder2(); | |
43 ~HpackDecoder2() override; | |
44 | |
45 // Override the interface methods: | |
46 | |
47 void ApplyHeaderTableSizeSetting(size_t size_setting) override; | |
48 void HandleControlFrameHeadersStart( | |
49 SpdyHeadersHandlerInterface* handler) override; | |
50 bool HandleControlFrameHeadersData(const char* headers_data, | |
51 size_t headers_data_length) override; | |
52 bool HandleControlFrameHeadersComplete(size_t* compressed_len) override; | |
53 const SpdyHeaderBlock& decoded_block() const override; | |
54 void SetHeaderTableDebugVisitor( | |
55 std::unique_ptr<HpackHeaderTable::DebugVisitorInterface> visitor) | |
56 override; | |
57 void set_max_decode_buffer_size_bytes( | |
58 size_t max_decode_buffer_size_bytes) override; | |
59 size_t EstimateMemoryUsage() const override; | |
60 | |
61 protected: | |
62 // Override the HpackEntryDecoderListener methods: | |
63 | |
64 void OnIndexedHeader(size_t index) override; | |
65 void OnStartLiteralHeader(HpackEntryType entry_type, | |
66 size_t maybe_name_index) override; | |
67 void OnNameStart(bool huffman_encoded, size_t len) override; | |
68 void OnNameData(const char* data, size_t len) override; | |
69 void OnNameEnd() override; | |
70 void OnValueStart(bool huffman_encoded, size_t len) override; | |
71 void OnValueData(const char* data, size_t len) override; | |
72 void OnValueEnd() override; | |
73 void OnDynamicTableSizeUpdate(size_t size) override; | |
74 | |
75 private: | |
76 // Called when a complete header entry has been decoded, with the name and | |
77 // value of the entry. If check_header_order_ is true, confirms that | |
78 // pseudo-headers don't appear after normal headers, else it treats the | |
79 // headers as malformed, as per sections 8.1.2.3. of the HTTP2 specification. | |
80 // Calls handler_->OnHeader() if there is a handler, else adds the header | |
81 // to decoded_block_. | |
82 void HandleHeaderRepresentation(base::StringPiece name, | |
83 base::StringPiece value); | |
84 | |
85 // Reset state in preparation for decoding a new HPACK block. Does not reset | |
86 // the dynamic table. | |
87 void Reset(); | |
88 | |
89 // Called when an error is detected while decoding. Replaces the listener | |
90 // in the HpackBlockDecoder with the no-op listener. | |
91 void SetErrorDetected(); | |
92 | |
93 // Enforce the limit on the maximum size of strings that can be buffered. | |
94 // It happens that this test is made after the strings have been buffered, | |
95 // but that isn't a problem because we don't pass enormous buffers into | |
96 // HandleControlFrameHeadersData. | |
97 bool EnforceMaxDecodeBufferSize(); | |
98 | |
99 HpackHeaderTable header_table_; | |
100 SpdyHeaderBlock decoded_block_; | |
101 | |
102 // Scratch space for storing decoded literals. | |
103 HpackDecoderStringBuffer name_, value_; | |
104 | |
105 // If non-NULL, handles decoded headers. | |
106 SpdyHeadersHandlerInterface* handler_; | |
107 | |
108 HpackEntryDecoderNoOpListener no_op_listener_; | |
109 | |
110 // Total bytes that have been received as input (i.e. HPACK encoded). | |
111 size_t total_hpack_bytes_; | |
112 | |
113 // Total bytes of the name and value strings in the current HPACK block. | |
114 size_t total_header_bytes_; | |
115 | |
116 // How much encoded data this decoder is willing to buffer. | |
117 size_t max_decode_buffer_size_bytes_ = 32 * 1024; // 32 KB | |
118 | |
119 HpackBlockDecoder hpack_block_decoder_; | |
120 | |
121 // Count of Dynamic Table Size Updates seen in the current HPACK block. | |
122 uint32_t size_update_count_; | |
123 | |
124 // The type of the current header entry (with literals) that is being decoded. | |
125 HpackEntryType entry_type_; | |
126 | |
127 // Has a header been seen in the current HPACK block? | |
128 bool header_seen_; | |
129 | |
130 // Did the HpackBlockDecoder stop in the middle of an entry? | |
131 bool in_progress_; | |
132 | |
133 // Has an error been detected while decoding the HPACK block? | |
134 bool error_detected_; | |
135 | |
136 // Flag to keep track of having seen the header block start. Needed at the | |
137 // moment because HandleControlFrameHeadersStart won't be called if a handler | |
138 // is not being provided by the caller. | |
139 // TODO(jamessynge): Consider collapsing several of these bools into a single | |
140 // enum representing the state of the decoding process. | |
141 bool header_block_started_; | |
142 | |
143 DISALLOW_COPY_AND_ASSIGN(HpackDecoder2); | |
144 }; | |
145 | |
146 } // namespace net | |
147 #endif // NET_SPDY_HPACK_HPACK_DECODER2_H_ | |
OLD | NEW |