]>
Commit | Line | Data |
---|---|---|
9b769c67 | 1 | /* |
b8ae064d | 2 | * Copyright (C) 1996-2023 The Squid Software Foundation and contributors |
9b769c67 | 3 | * |
bbc27441 AJ |
4 | * Squid software is distributed under GPLv2+ license and includes |
5 | * contributions from numerous individuals and organizations. | |
6 | * Please see the COPYING and CONTRIBUTORS files for details. | |
9b769c67 AJ |
7 | */ |
8 | ||
bbc27441 AJ |
9 | /* DEBUG: section 57 HTTP Status-line */ |
10 | ||
9b769c67 | 11 | #include "squid.h" |
0a647ffb | 12 | #include "base/Packable.h" |
675b8408 | 13 | #include "debug/Stream.h" |
38da9c24 | 14 | #include "http/one/ResponseParser.h" |
9b769c67 | 15 | #include "http/StatusLine.h" |
38da9c24 EB |
16 | #include "parser/forward.h" |
17 | #include "parser/Tokenizer.h" | |
18 | ||
19 | #include <algorithm> | |
9b769c67 AJ |
20 | |
21 | void | |
22 | Http::StatusLine::init() | |
23 | { | |
aee3523a | 24 | set(Http::ProtocolVersion(), Http::scNone, nullptr); |
9b769c67 AJ |
25 | } |
26 | ||
27 | void | |
28 | Http::StatusLine::clean() | |
29 | { | |
aee3523a | 30 | set(Http::ProtocolVersion(), Http::scInternalServerError, nullptr); |
9b769c67 AJ |
31 | } |
32 | ||
33 | /* set values */ | |
34 | void | |
2592bc70 | 35 | Http::StatusLine::set(const AnyP::ProtocolVersion &newVersion, const Http::StatusCode newStatus, const char *newReason) |
9b769c67 | 36 | { |
9b769c67 AJ |
37 | version = newVersion; |
38 | status_ = newStatus; | |
39 | /* Note: no xstrdup for 'reason', assumes constant 'reasons' */ | |
40 | reason_ = newReason; | |
41 | } | |
42 | ||
43 | const char * | |
44 | Http::StatusLine::reason() const | |
45 | { | |
46 | return reason_ ? reason_ : Http::StatusCodeString(status()); | |
47 | } | |
48 | ||
55e1c6e8 EB |
49 | size_t |
50 | Http::StatusLine::packedLength() const | |
51 | { | |
52 | // Keep in sync with packInto(). TODO: Refactor to avoid code duplication. | |
53 | ||
54 | auto packedStatus = status(); | |
55 | auto packedReason = reason(); | |
56 | ||
57 | if (packedStatus == scNone) { | |
58 | packedStatus = scInternalServerError; | |
59 | packedReason = StatusCodeString(packedStatus); | |
60 | } | |
61 | ||
62 | // "ICY %3d %s\r\n" | |
63 | if (version.protocol == AnyP::PROTO_ICY) { | |
64 | return | |
65 | + 3 // ICY | |
66 | + 1 // SP | |
67 | + 3 // %3d (packedStatus) | |
68 | + 1 // SP | |
69 | + strlen(packedReason) // %s | |
70 | + 2; // CRLF | |
71 | } | |
72 | ||
73 | // "HTTP/%d.%d %3d %s\r\n" | |
74 | return | |
75 | + 4 // HTTP | |
76 | + 1 // "/" | |
77 | + 3 // %d.%d (version.major and version.minor) | |
78 | + 1 // SP | |
79 | + 3 // %3d (packedStatus) | |
80 | + 1 // SP | |
81 | + strlen(packedReason) // %s | |
82 | + 2; // CRLF | |
83 | } | |
84 | ||
9b769c67 | 85 | void |
17802cf1 | 86 | Http::StatusLine::packInto(Packable * p) const |
9b769c67 | 87 | { |
55e1c6e8 EB |
88 | // Keep in sync with packedLength(). |
89 | ||
9b769c67 AJ |
90 | assert(p); |
91 | ||
7f98aad5 CT |
92 | auto packedStatus = status(); |
93 | auto packedReason = reason(); | |
94 | ||
95 | if (packedStatus == Http::scNone) { | |
96 | static unsigned int reports = 0; | |
97 | if (++reports <= 100) | |
d816f28d | 98 | debugs(57, DBG_IMPORTANT, "ERROR: Squid BUG: the internalized response lacks status-code"); |
7f98aad5 CT |
99 | packedStatus = Http::scInternalServerError; |
100 | packedReason = Http::StatusCodeString(packedStatus); // ignore custom reason_ (if any) | |
101 | } | |
102 | ||
9b769c67 AJ |
103 | /* local constants */ |
104 | /* AYJ: see bug 2469 - RFC2616 confirms stating 'SP characters' plural! */ | |
105 | static const char *Http1StatusLineFormat = "HTTP/%d.%d %3d %s\r\n"; | |
106 | static const char *IcyStatusLineFormat = "ICY %3d %s\r\n"; | |
107 | ||
108 | /* handle ICY protocol status line specially. Pass on the bad format. */ | |
8774ca07 | 109 | if (version.protocol == AnyP::PROTO_ICY) { |
9b769c67 AJ |
110 | debugs(57, 9, "packing sline " << this << " using " << p << ":"); |
111 | debugs(57, 9, "FORMAT=" << IcyStatusLineFormat ); | |
7f98aad5 CT |
112 | debugs(57, 9, "ICY " << packedStatus << " " << packedReason); |
113 | p->appendf(IcyStatusLineFormat, packedStatus, packedReason); | |
9b769c67 AJ |
114 | return; |
115 | } | |
116 | ||
117 | debugs(57, 9, "packing sline " << this << " using " << p << ":"); | |
118 | debugs(57, 9, "FORMAT=" << Http1StatusLineFormat ); | |
7f98aad5 CT |
119 | debugs(57, 9, "HTTP/" << version.major << "." << version.minor << " " << packedStatus << " " << packedReason); |
120 | p->appendf(Http1StatusLineFormat, version.major, version.minor, packedStatus, packedReason); | |
9b769c67 AJ |
121 | } |
122 | ||
9b769c67 | 123 | bool |
38da9c24 | 124 | Http::StatusLine::parse(const String &protoPrefix, const char *start, const char *end) |
9b769c67 | 125 | { |
f53969cc | 126 | status_ = Http::scInvalidHeader; /* Squid header parsing error */ |
9b769c67 | 127 | |
63df1d28 | 128 | // XXX: Http::Message::parse() has a similar check but is using |
9b769c67 AJ |
129 | // casesensitive comparison (which is required by HTTP errata?) |
130 | ||
131 | if (protoPrefix.cmp("ICY", 3) == 0) { | |
61beade2 | 132 | debugs(57, 3, "Invalid HTTP identifier. Detected ICY protocol instead."); |
8774ca07 | 133 | version = AnyP::ProtocolVersion(AnyP::PROTO_ICY, 1, 0); |
9b769c67 AJ |
134 | start += protoPrefix.size(); |
135 | } else if (protoPrefix.caseCmp(start, protoPrefix.size()) == 0) { | |
136 | ||
137 | start += protoPrefix.size(); | |
138 | ||
139 | if (!xisdigit(*start)) | |
140 | return false; | |
141 | ||
142 | // XXX: HTTPbis have defined this to be single-digit version numbers. no need to sscanf() | |
143 | // XXX: furthermore, only HTTP/1 will be using ASCII format digits | |
144 | ||
145 | if (sscanf(start, "%d.%d", &version.major, &version.minor) != 2) { | |
146 | debugs(57, 7, "Invalid HTTP identifier."); | |
147 | return false; | |
148 | } | |
149 | } else | |
150 | return false; | |
151 | ||
152 | if (!(start = strchr(start, ' '))) | |
153 | return false; | |
154 | ||
38da9c24 EB |
155 | ++start; // skip SP between HTTP-version and status-code |
156 | ||
157 | assert(start <= end); | |
158 | const auto stdStatusAreaLength = 4; // status-code length plus SP | |
159 | const auto unparsedLength = end - start; | |
160 | const auto statusAreaLength = std::min<size_t>(stdStatusAreaLength, unparsedLength); | |
161 | ||
162 | static SBuf statusBuf; | |
163 | statusBuf.assign(start, statusAreaLength); | |
164 | Parser::Tokenizer tok(statusBuf); | |
165 | try { | |
166 | One::ResponseParser::ParseResponseStatus(tok, status_); | |
167 | } catch (const Parser::InsufficientInput &) { | |
168 | debugs(57, 7, "need more; have " << unparsedLength); | |
169 | return false; | |
170 | } catch (...) { | |
171 | debugs(57, 3, "cannot parse status-code area: " << CurrentException); | |
172 | return false; | |
173 | } | |
9b769c67 AJ |
174 | |
175 | // XXX check if the given 'reason' is the default status string, if not save to reason_ | |
176 | ||
177 | /* we ignore 'reason-phrase' */ | |
178 | /* Should assert start < end ? */ | |
f53969cc | 179 | return true; /* success */ |
9b769c67 | 180 | } |
f53969cc | 181 |