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 #include "quiche/http2/decoder/payload_decoders/settings_payload_decoder.h"
6
7 #include <stddef.h>
8
9 #include <vector>
10
11 #include "quiche/http2/decoder/http2_frame_decoder_listener.h"
12 #include "quiche/http2/http2_constants.h"
13 #include "quiche/http2/test_tools/frame_parts.h"
14 #include "quiche/http2/test_tools/frame_parts_collector.h"
15 #include "quiche/http2/test_tools/http2_constants_test_util.h"
16 #include "quiche/http2/test_tools/http2_frame_builder.h"
17 #include "quiche/http2/test_tools/http2_random.h"
18 #include "quiche/http2/test_tools/http2_structures_test_util.h"
19 #include "quiche/http2/test_tools/payload_decoder_base_test_util.h"
20 #include "quiche/http2/test_tools/random_decoder_test_base.h"
21 #include "quiche/common/platform/api/quiche_logging.h"
22 #include "quiche/common/platform/api/quiche_test.h"
23
24 namespace http2 {
25 namespace test {
26
27 class SettingsPayloadDecoderPeer {
28 public:
FrameType()29 static constexpr Http2FrameType FrameType() {
30 return Http2FrameType::SETTINGS;
31 }
32
33 // Returns the mask of flags that affect the decoding of the payload (i.e.
34 // flags that that indicate the presence of certain fields or padding).
FlagsAffectingPayloadDecoding()35 static constexpr uint8_t FlagsAffectingPayloadDecoding() {
36 return Http2FrameFlag::ACK;
37 }
38 };
39
40 namespace {
41
42 struct Listener : public FramePartsCollector {
OnSettingsStarthttp2::test::__anon9777f3cc0111::Listener43 void OnSettingsStart(const Http2FrameHeader& header) override {
44 QUICHE_VLOG(1) << "OnSettingsStart: " << header;
45 EXPECT_EQ(Http2FrameType::SETTINGS, header.type) << header;
46 EXPECT_EQ(Http2FrameFlag(), header.flags) << header;
47 StartFrame(header)->OnSettingsStart(header);
48 }
49
OnSettinghttp2::test::__anon9777f3cc0111::Listener50 void OnSetting(const Http2SettingFields& setting_fields) override {
51 QUICHE_VLOG(1) << "Http2SettingFields: setting_fields=" << setting_fields;
52 CurrentFrame()->OnSetting(setting_fields);
53 }
54
OnSettingsEndhttp2::test::__anon9777f3cc0111::Listener55 void OnSettingsEnd() override {
56 QUICHE_VLOG(1) << "OnSettingsEnd";
57 EndFrame()->OnSettingsEnd();
58 }
59
OnSettingsAckhttp2::test::__anon9777f3cc0111::Listener60 void OnSettingsAck(const Http2FrameHeader& header) override {
61 QUICHE_VLOG(1) << "OnSettingsAck: " << header;
62 StartAndEndFrame(header)->OnSettingsAck(header);
63 }
64
OnFrameSizeErrorhttp2::test::__anon9777f3cc0111::Listener65 void OnFrameSizeError(const Http2FrameHeader& header) override {
66 QUICHE_VLOG(1) << "OnFrameSizeError: " << header;
67 FrameError(header)->OnFrameSizeError(header);
68 }
69 };
70
71 class SettingsPayloadDecoderTest
72 : public AbstractPayloadDecoderTest<SettingsPayloadDecoder,
73 SettingsPayloadDecoderPeer, Listener> {
74 protected:
RandSettingsFields()75 Http2SettingFields RandSettingsFields() {
76 Http2SettingFields fields;
77 test::Randomize(&fields, RandomPtr());
78 return fields;
79 }
80 };
81
82 // Confirm we get an error if the SETTINGS payload is not the correct size
83 // to hold exactly zero or more whole Http2SettingFields.
TEST_F(SettingsPayloadDecoderTest,SettingsWrongSize)84 TEST_F(SettingsPayloadDecoderTest, SettingsWrongSize) {
85 auto approve_size = [](size_t size) {
86 // Should get an error if size is not an integral multiple of the size
87 // of one setting.
88 return 0 != (size % Http2SettingFields::EncodedSize());
89 };
90 Http2FrameBuilder fb;
91 fb.Append(RandSettingsFields());
92 fb.Append(RandSettingsFields());
93 fb.Append(RandSettingsFields());
94 EXPECT_TRUE(VerifyDetectsFrameSizeError(0, fb.buffer(), approve_size));
95 }
96
97 // Confirm we get an error if the SETTINGS ACK payload is not empty.
TEST_F(SettingsPayloadDecoderTest,SettingsAkcWrongSize)98 TEST_F(SettingsPayloadDecoderTest, SettingsAkcWrongSize) {
99 auto approve_size = [](size_t size) { return size != 0; };
100 Http2FrameBuilder fb;
101 fb.Append(RandSettingsFields());
102 fb.Append(RandSettingsFields());
103 fb.Append(RandSettingsFields());
104 EXPECT_TRUE(VerifyDetectsFrameSizeError(Http2FrameFlag::ACK, fb.buffer(),
105 approve_size));
106 }
107
108 // SETTINGS must have stream_id==0, but the payload decoder doesn't check that.
TEST_F(SettingsPayloadDecoderTest,SettingsAck)109 TEST_F(SettingsPayloadDecoderTest, SettingsAck) {
110 for (int stream_id = 0; stream_id < 3; ++stream_id) {
111 Http2FrameHeader header(0, Http2FrameType::SETTINGS,
112 RandFlags() | Http2FrameFlag::ACK, stream_id);
113 set_frame_header(header);
114 FrameParts expected(header);
115 EXPECT_TRUE(DecodePayloadAndValidateSeveralWays("", expected));
116 }
117 }
118
119 // Try several values of each known SETTINGS parameter.
TEST_F(SettingsPayloadDecoderTest,OneRealSetting)120 TEST_F(SettingsPayloadDecoderTest, OneRealSetting) {
121 std::vector<uint32_t> values = {0, 1, 0xffffffff, Random().Rand32()};
122 for (auto param : AllHttp2SettingsParameters()) {
123 for (uint32_t value : values) {
124 Http2SettingFields fields(param, value);
125 Http2FrameBuilder fb;
126 fb.Append(fields);
127 Http2FrameHeader header(fb.size(), Http2FrameType::SETTINGS, RandFlags(),
128 RandStreamId());
129 set_frame_header(header);
130 FrameParts expected(header);
131 expected.AppendSetting(fields);
132 EXPECT_TRUE(DecodePayloadAndValidateSeveralWays(fb.buffer(), expected));
133 }
134 }
135 }
136
137 // Decode a SETTINGS frame with lots of fields.
TEST_F(SettingsPayloadDecoderTest,ManySettings)138 TEST_F(SettingsPayloadDecoderTest, ManySettings) {
139 const size_t num_settings = 100;
140 const size_t size = Http2SettingFields::EncodedSize() * num_settings;
141 Http2FrameHeader header(size, Http2FrameType::SETTINGS,
142 RandFlags(), // & ~Http2FrameFlag::ACK,
143 RandStreamId());
144 set_frame_header(header);
145 FrameParts expected(header);
146 Http2FrameBuilder fb;
147 for (size_t n = 0; n < num_settings; ++n) {
148 Http2SettingFields fields(static_cast<Http2SettingsParameter>(n),
149 Random().Rand32());
150 fb.Append(fields);
151 expected.AppendSetting(fields);
152 }
153 ASSERT_EQ(size, fb.size());
154 EXPECT_TRUE(DecodePayloadAndValidateSeveralWays(fb.buffer(), expected));
155 }
156
157 } // namespace
158 } // namespace test
159 } // namespace http2
160