1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
|
/*
* Copyright (C) 2019-2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "WebCookieCache.h"
#include "WebPageProxyIdentifier.h"
#include <WebCore/CookieChangeListener.h>
#include <WebCore/CookieJar.h>
#include <optional>
#include <wtf/CompletionHandler.h>
#include <wtf/HashMap.h>
#include <wtf/WeakHashSet.h>
#include <wtf/text/WTFString.h>
#if PLATFORM(COCOA)
OBJC_CLASS NSHTTPCookieStorage;
#endif
namespace WebCore {
struct Cookie;
struct CookieStoreGetOptions;
enum class ShouldPartitionCookie : bool;
}
namespace WebKit {
class WebFrame;
class WebCookieJar final : public WebCore::CookieJar {
public:
static Ref<WebCookieJar> create() { return adoptRef(*new WebCookieJar); }
String cookies(WebCore::Document&, const URL&) const final;
void setCookies(WebCore::Document&, const URL&, const String& cookieString) final;
bool cookiesEnabled(WebCore::Document&) final;
void remoteCookiesEnabled(const WebCore::Document&, CompletionHandler<void(bool)>&&) const final;
std::pair<String, WebCore::SecureCookiesAccessed> cookieRequestHeaderFieldValue(const URL& firstParty, const WebCore::SameSiteInfo&, const URL&, std::optional<WebCore::FrameIdentifier>, std::optional<WebCore::PageIdentifier>, WebCore::IncludeSecureCookies) const final;
bool getRawCookies(WebCore::Document&, const URL&, Vector<WebCore::Cookie>&) const final;
void setRawCookie(const WebCore::Document&, const WebCore::Cookie&, WebCore::ShouldPartitionCookie) final;
void deleteCookie(const WebCore::Document&, const URL&, const String& cookieName, CompletionHandler<void()>&&) final;
void getCookiesAsync(WebCore::Document&, const URL&, const WebCore::CookieStoreGetOptions&, CompletionHandler<void(std::optional<Vector<WebCore::Cookie>>&&)>&&) const final;
void setCookieAsync(WebCore::Document&, const URL&, const WebCore::Cookie&, CompletionHandler<void(bool)>&&) const final;
#if HAVE(COOKIE_CHANGE_LISTENER_API)
void addChangeListenerWithAccess(const URL&, const URL& firstParty, WebCore::FrameIdentifier, WebCore::PageIdentifier, WebPageProxyIdentifier, const WebCore::CookieChangeListener&);
void addChangeListener(const WebCore::Document&, const WebCore::CookieChangeListener&) final;
void removeChangeListener(const String& host, const WebCore::CookieChangeListener&) final;
#endif
void cookiesAdded(const String& host, Vector<WebCore::Cookie>&&);
void cookiesDeleted(const String& host, Vector<WebCore::Cookie>&&);
void allCookiesDeleted();
void clearCache() final;
#if HAVE(ALLOW_ONLY_PARTITIONED_COOKIES)
void setOptInCookiePartitioningEnabled(bool);
#endif
private:
WebCookieJar();
bool remoteCookiesEnabledSync(WebCore::Document&) const;
void clearCacheForHost(const String&) final;
bool isEligibleForCache(WebFrame&, const URL& firstPartyForCookies, const URL& resourceURL) const;
String cookiesInPartitionedCookieStorage(const WebCore::Document&, const URL&, const WebCore::SameSiteInfo&) const;
void setCookiesInPartitionedCookieStorage(const WebCore::Document&, const URL&, const WebCore::SameSiteInfo&, const String& cookieString);
#if PLATFORM(COCOA)
NSHTTPCookieStorage* ensurePartitionedCookieStorage();
#endif
mutable WebCookieCache m_cache;
HashMap<String, WeakHashSet<WebCore::CookieChangeListener>> m_changeListeners;
#if PLATFORM(COCOA)
RetainPtr<NSHTTPCookieStorage> m_partitionedStorageForDOMCookies;
#endif
};
} // namespace WebKit
|