6a82ad27a596a80c14154cf140968e1ebc918745
[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 #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/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<std::chrono::system_clock::time_point> 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 isSimpleHeader(const String& name, const String& value);
99 bool isCrossOriginSafeHeader(HTTPHeaderName, const HTTPHeaderSet&);
100 bool isCrossOriginSafeHeader(const String&, const HTTPHeaderSet&);
101 bool isCrossOriginSafeRequestHeader(HTTPHeaderName, const String&);
102
103 inline bool isHTTPSpace(UChar character)
104 {
105     return character <= ' ' && (character == ' ' || character == '\n' || character == '\t' || character == '\r');
106 }
107
108 // Strip leading and trailing whitespace as defined in https://fetch.spec.whatwg.org/#concept-header-value-normalize.
109 inline String stripLeadingAndTrailingHTTPSpaces(const String& string)
110 {
111     return string.stripWhiteSpace(isHTTPSpace);
112 }
113
114 inline StringView stripLeadingAndTrailingHTTPSpaces(StringView string)
115 {
116     return string.stripLeadingAndTrailingMatchedCharacters(isHTTPSpace);
117 }
118
119 }
120
121 #endif