Implement Same-Site cookies
[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 "PlatformCookieJar.h"
39 #include "PlatformStrategies.h"
40 #include "SameSiteInfo.h"
41 #include <wtf/SystemTracing.h>
42
43 namespace WebCore {
44
45 static NetworkingContext* networkingContext(const Document& document)
46 {
47     // FIXME: Returning 0 means falling back to default context. That's not a choice that is appropriate to do at runtime
48     Frame* frame = document.frame();
49     if (!frame)
50         return nullptr;
51
52     return frame->loader().networkingContext();
53 }
54
55 inline NetworkStorageSession& storageSession(const Document& document)
56 {
57     NetworkingContext* context = networkingContext(document);
58     return context ? context->storageSession() : NetworkStorageSession::defaultStorageSession();
59 }
60
61 static IncludeSecureCookies shouldIncludeSecureCookies(const Document& document, const URL& url)
62 {
63     return (url.protocolIs("https") && !document.foundMixedContent().contains(SecurityContext::MixedContentType::Active)) ? IncludeSecureCookies::Yes : IncludeSecureCookies::No;
64 }
65
66 static inline SameSiteInfo sameSiteInfo(const Document& document)
67 {
68     if (auto* loader = document.loader())
69         return SameSiteInfo::create(loader->request());
70     return { };
71 }
72
73 String cookies(Document& document, const URL& url)
74 {
75     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
76
77     auto includeSecureCookies = shouldIncludeSecureCookies(document, url);
78
79     std::pair<String, bool> result;
80     auto frame = document.frame();
81     if (frame)
82         result = platformStrategies()->cookiesStrategy()->cookiesForDOM(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), includeSecureCookies);
83     else
84         result = platformStrategies()->cookiesStrategy()->cookiesForDOM(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, std::nullopt, std::nullopt, includeSecureCookies);
85
86     if (result.second)
87         document.setSecureCookiesAccessed();
88
89     return result.first;
90 }
91
92 CookieRequestHeaderFieldProxy cookieRequestHeaderFieldProxy(const Document& document, const URL& url)
93 {
94     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
95
96     CookieRequestHeaderFieldProxy proxy;
97     proxy.sessionID = storageSession(document).sessionID();
98     proxy.firstParty = document.firstPartyForCookies();
99     proxy.sameSiteInfo = sameSiteInfo(document);
100     proxy.url = url;
101     proxy.includeSecureCookies = shouldIncludeSecureCookies(document, url);
102     if (auto* frame = document.frame()) {
103         proxy.frameID = frame->loader().client().frameID();
104         proxy.pageID = frame->loader().client().pageID();
105     }
106     return proxy;
107 }
108
109 void setCookies(Document& document, const URL& url, const String& cookieString)
110 {
111     auto frame = document.frame();
112     if (frame)
113         platformStrategies()->cookiesStrategy()->setCookiesFromDOM(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), cookieString);
114     else
115         platformStrategies()->cookiesStrategy()->setCookiesFromDOM(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, std::nullopt, std::nullopt, cookieString);
116 }
117
118 bool cookiesEnabled(const Document& document)
119 {
120     return platformStrategies()->cookiesStrategy()->cookiesEnabled(storageSession(document));
121 }
122
123 String cookieRequestHeaderFieldValue(Document& document, const URL& url)
124 {
125     auto includeSecureCookies = shouldIncludeSecureCookies(document, url);
126
127     std::pair<String, bool> result;
128     auto frame = document.frame();
129     if (frame)
130         result = platformStrategies()->cookiesStrategy()->cookieRequestHeaderFieldValue(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), includeSecureCookies);
131     else
132         result = platformStrategies()->cookiesStrategy()->cookieRequestHeaderFieldValue(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, std::nullopt, std::nullopt, includeSecureCookies);
133
134     if (result.second)
135         document.setSecureCookiesAccessed();
136
137     return result.first;
138 }
139
140 bool getRawCookies(const Document& document, const URL& url, Vector<Cookie>& cookies)
141 {
142     auto frame = document.frame();
143     if (frame)
144         return platformStrategies()->cookiesStrategy()->getRawCookies(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, frame->loader().client().frameID(), frame->loader().client().pageID(), cookies);
145
146     return platformStrategies()->cookiesStrategy()->getRawCookies(storageSession(document), document.firstPartyForCookies(), sameSiteInfo(document), url, std::nullopt, std::nullopt, cookies);
147 }
148
149 void deleteCookie(const Document& document, const URL& url, const String& cookieName)
150 {
151     platformStrategies()->cookiesStrategy()->deleteCookie(storageSession(document), url, cookieName);
152 }
153
154 }