90bcd18a0ee092cdf6cfe8a22b9b89d5b02713ec
[WebKit.git] / Source / WebCore / platform / network / HTTPParsers.h
1 /*
2  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  * Copyright (C) 2011 Apple Inc. All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include <wtf/Forward.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/Optional.h>
36 #include <wtf/WallTime.h>
37 #include <wtf/text/StringHash.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 typedef HashSet<String, ASCIICaseInsensitiveHash> HTTPHeaderSet;
43
44 enum class HTTPHeaderName;
45
46 enum class XSSProtectionDisposition {
47     Invalid,
48     Disabled,
49     Enabled,
50     BlockEnabled,
51 };
52
53 enum ContentTypeOptionsDisposition {
54     ContentTypeOptionsNone,
55     ContentTypeOptionsNosniff
56 };
57
58 enum XFrameOptionsDisposition {
59     XFrameOptionsNone,
60     XFrameOptionsDeny,
61     XFrameOptionsSameOrigin,
62     XFrameOptionsAllowAll,
63     XFrameOptionsInvalid,
64     XFrameOptionsConflict
65 };
66
67 enum class FromOriginDisposition {
68     None,
69     Same,
70     SameSite,
71     Invalid
72 };
73
74 bool isValidReasonPhrase(const String&);
75 bool isValidHTTPHeaderValue(const String&);
76 bool isValidAcceptHeaderValue(const String&);
77 bool isValidLanguageHeaderValue(const String&);
78 bool isValidHTTPToken(const String&);
79 bool parseHTTPRefresh(const String& refresh, double& delay, String& url);
80 std::optional<WallTime> parseHTTPDate(const String&);
81 String filenameFromHTTPContentDisposition(const String&);
82 String extractMIMETypeFromMediaType(const String&);
83 String extractCharsetFromMediaType(const String&);
84 void findCharsetInMediaType(const String& mediaType, unsigned int& charsetPos, unsigned int& charsetLen, unsigned int start = 0);
85 XSSProtectionDisposition parseXSSProtectionHeader(const String& header, String& failureReason, unsigned& failurePosition, String& reportURL);
86 AtomicString extractReasonPhraseFromHTTPStatusLine(const String&);
87 XFrameOptionsDisposition parseXFrameOptionsHeader(const String&);
88
89 // -1 could be set to one of the return parameters to indicate the value is not specified.
90 WEBCORE_EXPORT bool parseRange(const String&, long long& rangeOffset, long long& rangeEnd, long long& rangeSuffixLength);
91
92 ContentTypeOptionsDisposition parseContentTypeOptionsHeader(const String& header);
93
94 // Parsing Complete HTTP Messages.
95 enum HTTPVersion { Unknown, HTTP_1_0, HTTP_1_1 };
96 size_t parseHTTPRequestLine(const char* data, size_t length, String& failureReason, String& method, String& url, HTTPVersion&);
97 size_t parseHTTPHeader(const char* data, size_t length, String& failureReason, StringView& nameStr, String& valueStr, bool strict = true);
98 size_t parseHTTPRequestBody(const char* data, size_t length, Vector<unsigned char>& body);
99
100 void parseAccessControlExposeHeadersAllowList(const String& headerValue, HTTPHeaderSet&);
101
102 // HTTP Header routine as per https://fetch.spec.whatwg.org/#terminology-headers
103 bool isForbiddenHeaderName(const String&);
104 bool isForbiddenResponseHeaderName(const String&);
105 bool isForbiddenMethod(const String&);
106 bool isSimpleHeader(const String& name, const String& value);
107 bool isCrossOriginSafeHeader(HTTPHeaderName, const HTTPHeaderSet&);
108 bool isCrossOriginSafeHeader(const String&, const HTTPHeaderSet&);
109 bool isCrossOriginSafeRequestHeader(HTTPHeaderName, const String&);
110
111 String normalizeHTTPMethod(const String&);
112
113 WEBCORE_EXPORT FromOriginDisposition parseFromOriginHeader(const String&);
114
115 inline bool isHTTPSpace(UChar character)
116 {
117     return character <= ' ' && (character == ' ' || character == '\n' || character == '\t' || character == '\r');
118 }
119
120 // Strip leading and trailing whitespace as defined in https://fetch.spec.whatwg.org/#concept-header-value-normalize.
121 inline String stripLeadingAndTrailingHTTPSpaces(const String& string)
122 {
123     return string.stripLeadingAndTrailingCharacters(isHTTPSpace);
124 }
125
126 inline StringView stripLeadingAndTrailingHTTPSpaces(StringView string)
127 {
128     return string.stripLeadingAndTrailingMatchedCharacters(isHTTPSpace);
129 }
130
131 template<class HashType>
132 void addToAccessControlAllowList(const String& string, unsigned start, unsigned end, HashSet<String, HashType>& set)
133 {
134     StringImpl* stringImpl = string.impl();
135     if (!stringImpl)
136         return;
137
138     // Skip white space from start.
139     while (start <= end && isSpaceOrNewline((*stringImpl)[start]))
140         ++start;
141
142     // only white space
143     if (start > end)
144         return;
145
146     // Skip white space from end.
147     while (end && isSpaceOrNewline((*stringImpl)[end]))
148         --end;
149
150     set.add(string.substring(start, end - start + 1));
151 }
152
153 template<class HashType = DefaultHash<String>::Hash>
154 std::optional<HashSet<String, HashType>> parseAccessControlAllowList(const String& string)
155 {
156     HashSet<String, HashType> set;
157     unsigned start = 0;
158     size_t end;
159     while ((end = string.find(',', start)) != notFound) {
160         if (start != end)
161             addToAccessControlAllowList(string, start, end - 1, set);
162         start = end + 1;
163     }
164     if (start != string.length())
165         addToAccessControlAllowList(string, start, string.length() - 1, set);
166
167     return set;
168 }
169
170 }