9066888635a415d5cfe878776a518b02e17207fa
[WebKit.git] / Source / WebCore / loader / CrossOriginPreflightResultCache.cpp
1 /*
2  * Copyright (C) 2008, 2009 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  *
25  */
26
27 #include "config.h"
28 #include "CrossOriginPreflightResultCache.h"
29
30 #include "CrossOriginAccessControl.h"
31 #include "HTTPHeaderNames.h"
32 #include "HTTPParsers.h"
33 #include "ResourceResponse.h"
34 #include <wtf/MainThread.h>
35 #include <wtf/NeverDestroyed.h>
36
37 namespace WebCore {
38
39 using namespace std::literals::chrono_literals;
40
41 // These values are at the discretion of the user agent.
42 static const auto defaultPreflightCacheTimeout = 5s;
43 static const auto maxPreflightCacheTimeout = 600s; // Should be short enough to minimize the risk of using a poisoned cache after switching to a secure network.
44
45 CrossOriginPreflightResultCache::CrossOriginPreflightResultCache()
46 {
47 }
48
49 static bool parseAccessControlMaxAge(const String& string, std::chrono::seconds& expiryDelta)
50 {
51     // FIXME: this will not do the correct thing for a number starting with a '+'
52     bool ok = false;
53     expiryDelta = std::chrono::seconds(string.toUIntStrict(&ok));
54     return ok;
55 }
56
57 template<class HashType>
58 static void addToAccessControlAllowList(const String& string, unsigned start, unsigned end, HashSet<String, HashType>& set)
59 {
60     StringImpl* stringImpl = string.impl();
61     if (!stringImpl)
62         return;
63
64     // Skip white space from start.
65     while (start <= end && isSpaceOrNewline((*stringImpl)[start]))
66         ++start;
67
68     // only white space
69     if (start > end) 
70         return;
71
72     // Skip white space from end.
73     while (end && isSpaceOrNewline((*stringImpl)[end]))
74         --end;
75
76     set.add(string.substring(start, end - start + 1));
77 }
78
79 template<class HashType>
80 static bool parseAccessControlAllowList(const String& string, HashSet<String, HashType>& set)
81 {
82     unsigned start = 0;
83     size_t end;
84     while ((end = string.find(',', start)) != notFound) {
85         if (start != end)
86             addToAccessControlAllowList(string, start, end - 1, set);
87         start = end + 1;
88     }
89     if (start != string.length())
90         addToAccessControlAllowList(string, start, string.length() - 1, set);
91
92     return true;
93 }
94
95 bool CrossOriginPreflightResultCacheItem::parse(const ResourceResponse& response, String& errorDescription)
96 {
97     m_methods.clear();
98     if (!parseAccessControlAllowList(response.httpHeaderField(HTTPHeaderName::AccessControlAllowMethods), m_methods)) {
99         errorDescription = "Cannot parse Access-Control-Allow-Methods response header field.";
100         return false;
101     }
102
103     m_headers.clear();
104     if (!parseAccessControlAllowList(response.httpHeaderField(HTTPHeaderName::AccessControlAllowHeaders), m_headers)) {
105         errorDescription = "Cannot parse Access-Control-Allow-Headers response header field.";
106         return false;
107     }
108
109     std::chrono::seconds expiryDelta;
110     if (parseAccessControlMaxAge(response.httpHeaderField(HTTPHeaderName::AccessControlMaxAge), expiryDelta)) {
111         if (expiryDelta > maxPreflightCacheTimeout)
112             expiryDelta = maxPreflightCacheTimeout;
113     } else
114         expiryDelta = defaultPreflightCacheTimeout;
115
116     m_absoluteExpiryTime = std::chrono::steady_clock::now() + expiryDelta;
117     return true;
118 }
119
120 bool CrossOriginPreflightResultCacheItem::allowsCrossOriginMethod(const String& method, String& errorDescription) const
121 {
122     if (m_methods.contains(method) || isOnAccessControlSimpleRequestMethodWhitelist(method))
123         return true;
124
125     errorDescription = "Method " + method + " is not allowed by Access-Control-Allow-Methods.";
126     return false;
127 }
128
129 bool CrossOriginPreflightResultCacheItem::allowsCrossOriginHeaders(const HTTPHeaderMap& requestHeaders, String& errorDescription) const
130 {
131     for (const auto& header : requestHeaders) {
132         if (header.keyAsHTTPHeaderName && isCrossOriginSafeRequestHeader(header.keyAsHTTPHeaderName.value(), header.value))
133             continue;
134         if (!m_headers.contains(header.key)) {
135             errorDescription = "Request header field " + header.key + " is not allowed by Access-Control-Allow-Headers.";
136             return false;
137         }
138     }
139     return true;
140 }
141
142 bool CrossOriginPreflightResultCacheItem::allowsRequest(StoredCredentialsPolicy storedCredentialsPolicy, const String& method, const HTTPHeaderMap& requestHeaders) const
143 {
144     String ignoredExplanation;
145     if (m_absoluteExpiryTime < std::chrono::steady_clock::now())
146         return false;
147     if (storedCredentialsPolicy == StoredCredentialsPolicy::Use && m_storedCredentialsPolicy == StoredCredentialsPolicy::DoNotUse)
148         return false;
149     if (!allowsCrossOriginMethod(method, ignoredExplanation))
150         return false;
151     if (!allowsCrossOriginHeaders(requestHeaders, ignoredExplanation))
152         return false;
153     return true;
154 }
155
156 CrossOriginPreflightResultCache& CrossOriginPreflightResultCache::singleton()
157 {
158     ASSERT(isMainThread());
159
160     static NeverDestroyed<CrossOriginPreflightResultCache> cache;
161     return cache;
162 }
163
164 void CrossOriginPreflightResultCache::appendEntry(const String& origin, const URL& url, std::unique_ptr<CrossOriginPreflightResultCacheItem> preflightResult)
165 {
166     ASSERT(isMainThread());
167     m_preflightHashMap.set(std::make_pair(origin, url), WTFMove(preflightResult));
168 }
169
170 bool CrossOriginPreflightResultCache::canSkipPreflight(const String& origin, const URL& url, StoredCredentialsPolicy storedCredentialsPolicy, const String& method, const HTTPHeaderMap& requestHeaders)
171 {
172     ASSERT(isMainThread());
173     auto it = m_preflightHashMap.find(std::make_pair(origin, url));
174     if (it == m_preflightHashMap.end())
175         return false;
176
177     if (it->value->allowsRequest(storedCredentialsPolicy, method, requestHeaders))
178         return true;
179
180     m_preflightHashMap.remove(it);
181     return false;
182 }
183
184 void CrossOriginPreflightResultCache::empty()
185 {
186     ASSERT(isMainThread());
187     m_preflightHashMap.clear();
188 }
189
190 } // namespace WebCore