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