[Cache API] Optimize whitespace trimming in Vary header values
[WebKit-https.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 #ifndef HTTPParsers_h
32 #define HTTPParsers_h
33
34 #include <wtf/Forward.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/Optional.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/StringHash.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace WebCore {
42
43 typedef HashSet<String, ASCIICaseInsensitiveHash> HTTPHeaderSet;
44
45 enum class HTTPHeaderName;
46
47 enum class XSSProtectionDisposition {
48     Invalid,
49     Disabled,
50     Enabled,
51     BlockEnabled,
52 };
53
54 enum ContentTypeOptionsDisposition {
55     ContentTypeOptionsNone,
56     ContentTypeOptionsNosniff
57 };
58
59 enum XFrameOptionsDisposition {
60     XFrameOptionsNone,
61     XFrameOptionsDeny,
62     XFrameOptionsSameOrigin,
63     XFrameOptionsAllowAll,
64     XFrameOptionsInvalid,
65     XFrameOptionsConflict
66 };
67
68 bool isValidReasonPhrase(const String&);
69 bool isValidHTTPHeaderValue(const String&);
70 bool isValidAcceptHeaderValue(const String&);
71 bool isValidLanguageHeaderValue(const String&);
72 bool isValidHTTPToken(const String&);
73 bool parseHTTPRefresh(const String& refresh, double& delay, String& url);
74 std::optional<std::chrono::system_clock::time_point> parseHTTPDate(const String&);
75 String filenameFromHTTPContentDisposition(const String&);
76 String extractMIMETypeFromMediaType(const String&);
77 String extractCharsetFromMediaType(const String&);
78 void findCharsetInMediaType(const String& mediaType, unsigned int& charsetPos, unsigned int& charsetLen, unsigned int start = 0);
79 XSSProtectionDisposition parseXSSProtectionHeader(const String& header, String& failureReason, unsigned& failurePosition, String& reportURL);
80 AtomicString extractReasonPhraseFromHTTPStatusLine(const String&);
81 XFrameOptionsDisposition parseXFrameOptionsHeader(const String&);
82
83 // -1 could be set to one of the return parameters to indicate the value is not specified.
84 WEBCORE_EXPORT bool parseRange(const String&, long long& rangeOffset, long long& rangeEnd, long long& rangeSuffixLength);
85
86 ContentTypeOptionsDisposition parseContentTypeOptionsHeader(const String& header);
87
88 // Parsing Complete HTTP Messages.
89 enum HTTPVersion { Unknown, HTTP_1_0, HTTP_1_1 };
90 size_t parseHTTPRequestLine(const char* data, size_t length, String& failureReason, String& method, String& url, HTTPVersion&);
91 size_t parseHTTPHeader(const char* data, size_t length, String& failureReason, StringView& nameStr, String& valueStr, bool strict = true);
92 size_t parseHTTPRequestBody(const char* data, size_t length, Vector<unsigned char>& body);
93
94 void parseAccessControlExposeHeadersAllowList(const String& headerValue, HTTPHeaderSet&);
95
96 // HTTP Header routine as per https://fetch.spec.whatwg.org/#terminology-headers
97 bool isForbiddenHeaderName(const String&);
98 bool isForbiddenResponseHeaderName(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 inline bool isHTTPSpace(UChar character)
105 {
106     return character <= ' ' && (character == ' ' || character == '\n' || character == '\t' || character == '\r');
107 }
108
109 // Strip leading and trailing whitespace as defined in https://fetch.spec.whatwg.org/#concept-header-value-normalize.
110 inline String stripLeadingAndTrailingHTTPSpaces(const String& string)
111 {
112     return string.stripWhiteSpace(isHTTPSpace);
113 }
114
115 inline StringView stripLeadingAndTrailingHTTPSpaces(StringView string)
116 {
117     return string.stripLeadingAndTrailingMatchedCharacters(isHTTPSpace);
118 }
119
120 }
121
122 #endif