Split headerValueForVary into specialized functions for NetworkProcess and WebProcess...
[WebKit-https.git] / Source / WebCore / loader / CookieJar.cpp
1 /*
2  * Copyright (C) 2012-2018 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "CookieJar.h"
28
29 #include "CookieRequestHeaderFieldProxy.h"
30 #include "CookiesStrategy.h"
31 #include "Document.h"
32 #include "DocumentLoader.h"
33 #include "Frame.h"
34 #include "FrameLoader.h"
35 #include "FrameLoaderClient.h"
36 #include "NetworkStorageSession.h"
37 #include "NetworkingContext.h"
38 #include "PlatformStrategies.h"
39 #include "SameSiteInfo.h"
40 #include <wtf/SystemTracing.h>
41
42 namespace WebCore {
43
44 static IncludeSecureCookies shouldIncludeSecureCookies(const Document& document, const URL& url)
45 {
46     return (url.protocolIs("https") && !document.foundMixedContent().contains(SecurityContext::MixedContentType::Active)) ? IncludeSecureCookies::Yes : IncludeSecureCookies::No;
47 }
48
49 static inline SameSiteInfo sameSiteInfo(const Document& document)
50 {
51     if (auto* loader = document.loader())
52         return SameSiteInfo::create(loader->request());
53     return { };
54 }
55
56 String cookies(Document& document, const URL& url)
57 {
58     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
59
60     auto includeSecureCookies = shouldIncludeSecureCookies(document, url);
61
62     std::pair<String, bool> result;
63     auto frame = document.frame();
64     if (frame)
65         result = platformStrategies()->cookiesStrategy()->cookiesForDOM(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), includeSecureCookies);
66     else
67         result = platformStrategies()->cookiesStrategy()->cookiesForDOM(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, WTF::nullopt, WTF::nullopt, includeSecureCookies);
68
69     if (result.second)
70         document.setSecureCookiesAccessed();
71
72     return result.first;
73 }
74
75 CookieRequestHeaderFieldProxy cookieRequestHeaderFieldProxy(const Document& document, const URL& url)
76 {
77     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
78
79     CookieRequestHeaderFieldProxy proxy;
80     proxy.sessionID = document.sessionID();
81     proxy.firstParty = document.firstPartyForCookies();
82     proxy.sameSiteInfo = sameSiteInfo(document);
83     proxy.url = url;
84     proxy.includeSecureCookies = shouldIncludeSecureCookies(document, url);
85     if (auto* frame = document.frame()) {
86         proxy.frameID = frame->loader().client().frameID();
87         proxy.pageID = frame->loader().client().pageID();
88     }
89     return proxy;
90 }
91
92 void setCookies(Document& document, const URL& url, const String& cookieString)
93 {
94     auto frame = document.frame();
95     if (frame)
96         platformStrategies()->cookiesStrategy()->setCookiesFromDOM(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), cookieString);
97     else
98         platformStrategies()->cookiesStrategy()->setCookiesFromDOM(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, WTF::nullopt, WTF::nullopt, cookieString);
99 }
100
101 bool cookiesEnabled(const Document& document)
102 {
103     return platformStrategies()->cookiesStrategy()->cookiesEnabled(document.sessionID());
104 }
105
106 String cookieRequestHeaderFieldValue(Document& document, const URL& url)
107 {
108     auto includeSecureCookies = shouldIncludeSecureCookies(document, url);
109
110     std::pair<String, bool> result;
111     auto frame = document.frame();
112     if (frame)
113         result = platformStrategies()->cookiesStrategy()->cookieRequestHeaderFieldValue(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), includeSecureCookies);
114     else
115         result = platformStrategies()->cookiesStrategy()->cookieRequestHeaderFieldValue(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, WTF::nullopt, WTF::nullopt, includeSecureCookies);
116
117     if (result.second)
118         document.setSecureCookiesAccessed();
119
120     return result.first;
121 }
122
123 bool getRawCookies(const Document& document, const URL& url, Vector<Cookie>& cookies)
124 {
125     auto frame = document.frame();
126     if (frame)
127         return platformStrategies()->cookiesStrategy()->getRawCookies(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), cookies);
128
129     return platformStrategies()->cookiesStrategy()->getRawCookies(document.sessionID(), document.firstPartyForCookies(), sameSiteInfo(document), url, WTF::nullopt, WTF::nullopt, cookies);
130 }
131
132 void deleteCookie(const Document& document, const URL& url, const String& cookieName)
133 {
134     platformStrategies()->cookiesStrategy()->deleteCookie(document.sessionID(), url, cookieName);
135 }
136
137 }