Document no longer needs to store a SessionID
[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 "Document.h"
31 #include "DocumentLoader.h"
32 #include "Frame.h"
33 #include "FrameLoader.h"
34 #include "FrameLoaderClient.h"
35 #include "NetworkStorageSession.h"
36 #include "NetworkingContext.h"
37 #include "PlatformStrategies.h"
38 #include "SameSiteInfo.h"
39 #include "StorageSessionProvider.h"
40 #include <wtf/SystemTracing.h>
41
42 namespace WebCore {
43
44 Ref<CookieJar> CookieJar::create(Ref<StorageSessionProvider>&& storageSessionProvider)
45 {
46     return adoptRef(*new CookieJar(WTFMove(storageSessionProvider)));
47 }
48
49 IncludeSecureCookies CookieJar::shouldIncludeSecureCookies(const Document& document, const URL& url)
50 {
51     return (url.protocolIs("https") && !document.foundMixedContent().contains(SecurityContext::MixedContentType::Active)) ? IncludeSecureCookies::Yes : IncludeSecureCookies::No;
52 }
53
54 SameSiteInfo CookieJar::sameSiteInfo(const Document& document)
55 {
56     if (auto* loader = document.loader())
57         return SameSiteInfo::create(loader->request());
58     return { };
59 }
60
61 CookieJar::CookieJar(Ref<StorageSessionProvider>&& storageSessionProvider)
62     : m_storageSessionProvider(WTFMove(storageSessionProvider))
63 {
64 }
65
66 CookieJar::~CookieJar() = default;
67
68 String CookieJar::cookies(Document& document, const URL& url) const
69 {
70     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
71
72     auto includeSecureCookies = shouldIncludeSecureCookies(document, url);
73
74     Optional<FrameIdentifier> frameID;
75     Optional<PageIdentifier> pageID;
76     if (auto* frame = document.frame()) {
77         frameID = frame->loader().client().frameID();
78         pageID = frame->loader().client().pageID();
79     }
80
81     std::pair<String, bool> result;
82     if (auto* session = m_storageSessionProvider->storageSession())
83         result = session->cookiesForDOM(document.firstPartyForCookies(), sameSiteInfo(document), url, frameID, pageID, includeSecureCookies);
84     else
85         ASSERT_NOT_REACHED();
86
87     if (result.second)
88         document.setSecureCookiesAccessed();
89
90     return result.first;
91 }
92
93 CookieRequestHeaderFieldProxy CookieJar::cookieRequestHeaderFieldProxy(PAL::SessionID sessionID, const Document& document, const URL& url)
94 {
95     TraceScope scope(FetchCookiesStart, FetchCookiesEnd);
96
97     Optional<FrameIdentifier> frameID;
98     Optional<PageIdentifier> pageID;
99     if (auto* frame = document.frame()) {
100         frameID = frame->loader().client().frameID();
101         pageID = frame->loader().client().pageID();
102     }
103
104     return { sessionID, document.firstPartyForCookies(), sameSiteInfo(document), url, frameID, pageID, shouldIncludeSecureCookies(document, url) };
105 }
106
107 void CookieJar::setCookies(Document& document, const URL& url, const String& cookieString)
108 {
109     Optional<FrameIdentifier> frameID;
110     Optional<PageIdentifier> pageID;
111     if (auto* frame = document.frame()) {
112         frameID = frame->loader().client().frameID();
113         pageID = frame->loader().client().pageID();
114     }
115
116     if (auto* session = m_storageSessionProvider->storageSession())
117         session->setCookiesFromDOM(document.firstPartyForCookies(), sameSiteInfo(document), url, frameID, pageID, cookieString);
118     else
119         ASSERT_NOT_REACHED();
120 }
121
122 bool CookieJar::cookiesEnabled(const Document&) const
123 {
124     if (auto* session = m_storageSessionProvider->storageSession())
125         return session->cookiesEnabled();
126
127     ASSERT_NOT_REACHED();
128     return false;
129 }
130
131 std::pair<String, SecureCookiesAccessed> CookieJar::cookieRequestHeaderFieldValue(const URL& firstParty, const SameSiteInfo& sameSiteInfo, const URL& url, Optional<FrameIdentifier> frameID, Optional<PageIdentifier> pageID, IncludeSecureCookies includeSecureCookies) const
132 {
133     if (auto* session = m_storageSessionProvider->storageSession()) {
134         std::pair<String, bool> result = session->cookieRequestHeaderFieldValue(firstParty, sameSiteInfo, url, frameID, pageID, includeSecureCookies);
135         return { result.first, result.second ? SecureCookiesAccessed::Yes : SecureCookiesAccessed::No };
136     }
137
138     ASSERT_NOT_REACHED();
139     return { };
140 }
141
142 String CookieJar::cookieRequestHeaderFieldValue(Document& document, const URL& url) const
143 {
144     Optional<FrameIdentifier> frameID;
145     Optional<PageIdentifier> pageID;
146     if (auto* frame = document.frame()) {
147         frameID = frame->loader().client().frameID();
148         pageID = frame->loader().client().pageID();
149     }
150
151     auto result = cookieRequestHeaderFieldValue(document.firstPartyForCookies(), sameSiteInfo(document), url, frameID, pageID, shouldIncludeSecureCookies(document, url));
152     if (result.second == SecureCookiesAccessed::Yes)
153         document.setSecureCookiesAccessed();
154     return result.first;
155 }
156
157 bool CookieJar::getRawCookies(const Document& document, const URL& url, Vector<Cookie>& cookies) const
158 {
159     Optional<FrameIdentifier> frameID;
160     Optional<PageIdentifier> pageID;
161     if (auto* frame = document.frame()) {
162         frameID = frame->loader().client().frameID();
163         pageID = frame->loader().client().pageID();
164     }
165
166     if (auto* session = m_storageSessionProvider->storageSession())
167         return session->getRawCookies(document.firstPartyForCookies(), sameSiteInfo(document), url, frameID, pageID, cookies);
168
169     ASSERT_NOT_REACHED();
170     return false;
171 }
172
173 void CookieJar::deleteCookie(const Document&, const URL& url, const String& cookieName)
174 {
175     if (auto* session = m_storageSessionProvider->storageSession())
176         session->deleteCookie(url, cookieName);
177     else
178         ASSERT_NOT_REACHED();
179 }
180
181 }