[Cache API] Ensure ResourceResponse is not null when redirected/tainting/type fields...
[WebKit-https.git] / Source / WebCore / platform / network / ResourceResponseBase.h
1 /*
2  * Copyright (C) 2006, 2008, 2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "CacheValidation.h"
30 #include "CertificateInfo.h"
31 #include "HTTPHeaderMap.h"
32 #include "NetworkLoadMetrics.h"
33 #include "ParsedContentRange.h"
34 #include "URL.h"
35 #include <wtf/SHA1.h>
36
37 namespace WebCore {
38
39 class ResourceResponse;
40
41 bool isScriptAllowedByNosniff(const ResourceResponse&);
42
43 // Do not use this class directly, use the class ResponseResponse instead
44 class ResourceResponseBase {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     enum class Type { Basic, Cors, Default, Error, Opaque, Opaqueredirect };
48     enum class Tainting { Basic, Cors, Opaque, Opaqueredirect };
49
50     struct CrossThreadData {
51         CrossThreadData(const CrossThreadData&) = delete;
52         CrossThreadData& operator=(const CrossThreadData&) = delete;
53         CrossThreadData() = default;
54         CrossThreadData(CrossThreadData&&) = default;
55
56         URL url;
57         String mimeType;
58         long long expectedContentLength;
59         String textEncodingName;
60         int httpStatusCode;
61         String httpStatusText;
62         String httpVersion;
63         HTTPHeaderMap httpHeaderFields;
64         NetworkLoadMetrics networkLoadMetrics;
65         Type type;
66         Tainting tainting;
67         bool isRedirected;
68     };
69
70     CrossThreadData crossThreadData() const;
71     static ResourceResponse fromCrossThreadData(CrossThreadData&&);
72
73     bool isNull() const { return m_isNull; }
74     WEBCORE_EXPORT bool isHTTP() const;
75     bool isSuccessful() const;
76
77     WEBCORE_EXPORT const URL& url() const;
78     WEBCORE_EXPORT void setURL(const URL&);
79
80     WEBCORE_EXPORT const String& mimeType() const;
81     WEBCORE_EXPORT void setMimeType(const String& mimeType);
82
83     WEBCORE_EXPORT long long expectedContentLength() const;
84     WEBCORE_EXPORT void setExpectedContentLength(long long expectedContentLength);
85
86     WEBCORE_EXPORT const String& textEncodingName() const;
87     WEBCORE_EXPORT void setTextEncodingName(const String& name);
88
89     WEBCORE_EXPORT int httpStatusCode() const;
90     WEBCORE_EXPORT void setHTTPStatusCode(int);
91
92     WEBCORE_EXPORT const String& httpStatusText() const;
93     WEBCORE_EXPORT void setHTTPStatusText(const String&);
94
95     WEBCORE_EXPORT const String& httpVersion() const;
96     WEBCORE_EXPORT void setHTTPVersion(const String&);
97     WEBCORE_EXPORT bool isHTTP09() const;
98
99     WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
100
101     String httpHeaderField(const String& name) const;
102     WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
103     WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
104     WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
105
106     void addHTTPHeaderField(HTTPHeaderName, const String& value);
107     void addHTTPHeaderField(const String& name, const String& value);
108
109     // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
110     template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
111     template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
112     template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
113
114     bool isMultipart() const { return mimeType() == "multipart/x-mixed-replace"; }
115
116     WEBCORE_EXPORT bool isAttachment() const;
117     WEBCORE_EXPORT bool isAttachmentWithFilename() const;
118     WEBCORE_EXPORT String suggestedFilename() const;
119     WEBCORE_EXPORT static String sanitizeSuggestedFilename(const String&);
120
121     WEBCORE_EXPORT void includeCertificateInfo() const;
122     const std::optional<CertificateInfo>& certificateInfo() const { return m_certificateInfo; };
123     
124     // These functions return parsed values of the corresponding response headers.
125     WEBCORE_EXPORT bool cacheControlContainsNoCache() const;
126     WEBCORE_EXPORT bool cacheControlContainsNoStore() const;
127     WEBCORE_EXPORT bool cacheControlContainsMustRevalidate() const;
128     WEBCORE_EXPORT bool cacheControlContainsImmutable() const;
129     WEBCORE_EXPORT bool hasCacheValidatorFields() const;
130     WEBCORE_EXPORT std::optional<std::chrono::microseconds> cacheControlMaxAge() const;
131     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> date() const;
132     WEBCORE_EXPORT std::optional<std::chrono::microseconds> age() const;
133     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> expires() const;
134     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> lastModified() const;
135     ParsedContentRange& contentRange() const;
136
137     enum class Source { Unknown, Network, DiskCache, DiskCacheAfterValidation, MemoryCache, MemoryCacheAfterValidation };
138     WEBCORE_EXPORT Source source() const;
139     void setSource(Source source) { m_source = source; }
140
141     const std::optional<SHA1::Digest>& cacheBodyKey() const { return m_cacheBodyKey; }
142     void setCacheBodyKey(const SHA1::Digest& key) { m_cacheBodyKey = key; }
143
144     // FIXME: This should be eliminated from ResourceResponse.
145     // Network loading metrics should be delivered via didFinishLoad
146     // and should not be part of the ResourceResponse.
147     NetworkLoadMetrics& deprecatedNetworkLoadMetrics() const { return m_networkLoadMetrics; }
148
149     // The ResourceResponse subclass may "shadow" this method to provide platform-specific memory usage information
150     unsigned memoryUsage() const
151     {
152         // average size, mostly due to URL and Header Map strings
153         return 1280;
154     }
155
156     void setType(Type);
157     Type type() const { return m_type; }
158
159     void setRedirected(bool isRedirected) { m_isRedirected = isRedirected; }
160     bool isRedirected() const { return m_isRedirected; }
161
162     void setTainting(Tainting tainting) { m_tainting = tainting; }
163     Tainting tainting() const { return m_tainting; }
164
165     static ResourceResponse filter(const ResourceResponse&);
166
167     static bool compare(const ResourceResponse&, const ResourceResponse&);
168
169     template<class Encoder> void encode(Encoder&) const;
170     template<class Decoder> static bool decode(Decoder&, ResourceResponseBase&);
171
172 protected:
173     enum InitLevel {
174         Uninitialized,
175         CommonFieldsOnly,
176         AllFields
177     };
178
179     WEBCORE_EXPORT ResourceResponseBase();
180     WEBCORE_EXPORT ResourceResponseBase(const URL&, const String& mimeType, long long expectedLength, const String& textEncodingName);
181
182     WEBCORE_EXPORT void lazyInit(InitLevel) const;
183
184     // The ResourceResponse subclass should shadow these functions to lazily initialize platform specific fields
185     void platformLazyInit(InitLevel) { }
186     CertificateInfo platformCertificateInfo() const { return CertificateInfo(); };
187     String platformSuggestedFileName() const { return String(); }
188
189     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
190
191 private:
192     void parseCacheControlDirectives() const;
193     void updateHeaderParsedState(HTTPHeaderName);
194
195 protected:
196     bool m_isNull;
197     URL m_url;
198     AtomicString m_mimeType;
199     long long m_expectedContentLength;
200     AtomicString m_textEncodingName;
201     AtomicString m_httpStatusText;
202     AtomicString m_httpVersion;
203     HTTPHeaderMap m_httpHeaderFields;
204     mutable NetworkLoadMetrics m_networkLoadMetrics;
205
206     mutable std::optional<CertificateInfo> m_certificateInfo;
207
208     int m_httpStatusCode;
209
210 private:
211     mutable std::optional<std::chrono::microseconds> m_age;
212     mutable std::optional<std::chrono::system_clock::time_point> m_date;
213     mutable std::optional<std::chrono::system_clock::time_point> m_expires;
214     mutable std::optional<std::chrono::system_clock::time_point> m_lastModified;
215     mutable ParsedContentRange m_contentRange;
216     mutable CacheControlDirectives m_cacheControlDirectives;
217
218     mutable bool m_haveParsedCacheControlHeader { false };
219     mutable bool m_haveParsedAgeHeader { false };
220     mutable bool m_haveParsedDateHeader { false };
221     mutable bool m_haveParsedExpiresHeader { false };
222     mutable bool m_haveParsedLastModifiedHeader { false };
223     mutable bool m_haveParsedContentRangeHeader { false };
224
225     Source m_source { Source::Unknown };
226
227     std::optional<SHA1::Digest> m_cacheBodyKey;
228
229     Type m_type { Type::Default };
230     bool m_isRedirected { false };
231     Tainting m_tainting { Tainting::Basic };
232 };
233
234 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
235 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
236
237 template<class Encoder>
238 void ResourceResponseBase::encode(Encoder& encoder) const
239 {
240     encoder << m_isNull;
241     if (m_isNull)
242         return;
243     lazyInit(AllFields);
244
245     encoder << m_url;
246     encoder << m_mimeType;
247     encoder << static_cast<int64_t>(m_expectedContentLength);
248     encoder << m_textEncodingName;
249     encoder << m_httpStatusText;
250     encoder << m_httpVersion;
251     encoder << m_httpHeaderFields;
252
253     // We don't want to put the networkLoadMetrics info
254     // into the disk cache, because we will never use the old info.
255     if (Encoder::isIPCEncoder)
256         encoder << m_networkLoadMetrics;
257
258     encoder << m_httpStatusCode;
259     encoder << m_certificateInfo;
260     encoder.encodeEnum(m_source);
261     encoder << m_cacheBodyKey;
262     encoder.encodeEnum(m_type);
263     encoder.encodeEnum(m_tainting);
264     encoder << m_isRedirected;
265 }
266
267 template<class Decoder>
268 bool ResourceResponseBase::decode(Decoder& decoder, ResourceResponseBase& response)
269 {
270     ASSERT(response.m_isNull);
271     bool responseIsNull;
272     if (!decoder.decode(responseIsNull))
273         return false;
274     if (responseIsNull)
275         return true;
276
277     if (!decoder.decode(response.m_url))
278         return false;
279     if (!decoder.decode(response.m_mimeType))
280         return false;
281     int64_t expectedContentLength;
282     if (!decoder.decode(expectedContentLength))
283         return false;
284     response.m_expectedContentLength = expectedContentLength;
285     if (!decoder.decode(response.m_textEncodingName))
286         return false;
287     if (!decoder.decode(response.m_httpStatusText))
288         return false;
289     if (!decoder.decode(response.m_httpVersion))
290         return false;
291     if (!decoder.decode(response.m_httpHeaderFields))
292         return false;
293     // The networkLoadMetrics info is only send over IPC and not stored in disk cache.
294     if (Decoder::isIPCDecoder && !decoder.decode(response.m_networkLoadMetrics))
295         return false;
296     if (!decoder.decode(response.m_httpStatusCode))
297         return false;
298     if (!decoder.decode(response.m_certificateInfo))
299         return false;
300     if (!decoder.decodeEnum(response.m_source))
301         return false;
302     if (!decoder.decode(response.m_cacheBodyKey))
303         return false;
304     if (!decoder.decodeEnum(response.m_type))
305         return false;
306     if (!decoder.decodeEnum(response.m_tainting))
307         return false;
308     if (!decoder.decode(response.m_isRedirected))
309         return false;
310     response.m_isNull = false;
311
312     return true;
313 }
314
315 } // namespace WebCore