Response headers should be filtered when sent from NetworkProcess to WebProcess
[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 bool isValidReasonPhrase(const String&);
68 bool isValidHTTPHeaderValue(const String&);
69 bool isValidAcceptHeaderValue(const String&);
70 bool isValidLanguageHeaderValue(const String&);
71 bool isValidHTTPToken(const String&);
72 bool parseHTTPRefresh(const String& refresh, double& delay, String& url);
73 std::optional<WallTime> parseHTTPDate(const String&);
74 String filenameFromHTTPContentDisposition(const String&);
75 String extractMIMETypeFromMediaType(const String&);
76 String extractCharsetFromMediaType(const String&);
77 void findCharsetInMediaType(const String& mediaType, unsigned int& charsetPos, unsigned int& charsetLen, unsigned int start = 0);
78 XSSProtectionDisposition parseXSSProtectionHeader(const String& header, String& failureReason, unsigned& failurePosition, String& reportURL);
79 AtomicString extractReasonPhraseFromHTTPStatusLine(const String&);
80 XFrameOptionsDisposition parseXFrameOptionsHeader(const String&);
81
82 // -1 could be set to one of the return parameters to indicate the value is not specified.
83 WEBCORE_EXPORT bool parseRange(const String&, long long& rangeOffset, long long& rangeEnd, long long& rangeSuffixLength);
84
85 ContentTypeOptionsDisposition parseContentTypeOptionsHeader(const String& header);
86
87 // Parsing Complete HTTP Messages.
88 enum HTTPVersion { Unknown, HTTP_1_0, HTTP_1_1 };
89 size_t parseHTTPRequestLine(const char* data, size_t length, String& failureReason, String& method, String& url, HTTPVersion&);
90 size_t parseHTTPHeader(const char* data, size_t length, String& failureReason, StringView& nameStr, String& valueStr, bool strict = true);
91 size_t parseHTTPRequestBody(const char* data, size_t length, Vector<unsigned char>& body);
92
93 void parseAccessControlExposeHeadersAllowList(const String& headerValue, HTTPHeaderSet&);
94
95 // HTTP Header routine as per https://fetch.spec.whatwg.org/#terminology-headers
96 bool isForbiddenHeaderName(const String&);
97 bool isForbiddenResponseHeaderName(const String&);
98 bool isForbiddenMethod(const String&);
99 bool isSimpleHeader(const String& name, const String& value);
100 bool isCrossOriginSafeHeader(HTTPHeaderName, const HTTPHeaderSet&);
101 bool isCrossOriginSafeHeader(const String&, const HTTPHeaderSet&);
102 bool isCrossOriginSafeRequestHeader(HTTPHeaderName, const String&);
103
104 String normalizeHTTPMethod(const String&);
105
106 inline bool isHTTPSpace(UChar character)
107 {
108     return character <= ' ' && (character == ' ' || character == '\n' || character == '\t' || character == '\r');
109 }
110
111 // Strip leading and trailing whitespace as defined in https://fetch.spec.whatwg.org/#concept-header-value-normalize.
112 inline String stripLeadingAndTrailingHTTPSpaces(const String& string)
113 {
114     return string.stripLeadingAndTrailingCharacters(isHTTPSpace);
115 }
116
117 inline StringView stripLeadingAndTrailingHTTPSpaces(StringView string)
118 {
119     return string.stripLeadingAndTrailingMatchedCharacters(isHTTPSpace);
120 }
121
122 template<class HashType>
123 void addToAccessControlAllowList(const String& string, unsigned start, unsigned end, HashSet<String, HashType>& set)
124 {
125     StringImpl* stringImpl = string.impl();
126     if (!stringImpl)
127         return;
128
129     // Skip white space from start.
130     while (start <= end && isSpaceOrNewline((*stringImpl)[start]))
131         ++start;
132
133     // only white space
134     if (start > end)
135         return;
136
137     // Skip white space from end.
138     while (end && isSpaceOrNewline((*stringImpl)[end]))
139         --end;
140
141     set.add(string.substring(start, end - start + 1));
142 }
143
144 template<class HashType = DefaultHash<String>::Hash>
145 std::optional<HashSet<String, HashType>> parseAccessControlAllowList(const String& string)
146 {
147     HashSet<String, HashType> set;
148     unsigned start = 0;
149     size_t end;
150     while ((end = string.find(',', start)) != notFound) {
151         if (start != end)
152             addToAccessControlAllowList(string, start, end - 1, set);
153         start = end + 1;
154     }
155     if (start != string.length())
156         addToAccessControlAllowList(string, start, string.length() - 1, set);
157
158     return set;
159 }
160
161 }