NetworkStorageSession.h [plain text]
#pragma once
#include "CredentialStorage.h"
#include <pal/SessionID.h>
#include <wtf/Function.h>
#include <wtf/HashMap.h>
#include <wtf/HashSet.h>
#include <wtf/text/WTFString.h>
#if PLATFORM(COCOA) || USE(CFURLCONNECTION)
#include <pal/spi/cf/CFNetworkSPI.h>
#include <wtf/RetainPtr.h>
#endif
#if USE(SOUP)
#include <wtf/Function.h>
#include <wtf/glib/GRefPtr.h>
typedef struct _SoupCookieJar SoupCookieJar;
#endif
#if USE(CURL)
#include "CookieJarCurl.h"
#include "CookieJarDB.h"
#include <wtf/UniqueRef.h>
#endif
#ifdef __OBJC__
#include <objc/objc.h>
#endif
#if PLATFORM(COCOA)
#include "CookieStorageObserver.h"
#endif
namespace WebCore {
class NetworkingContext;
class ResourceRequest;
class SoupNetworkSession;
struct Cookie;
class NetworkStorageSession {
WTF_MAKE_NONCOPYABLE(NetworkStorageSession); WTF_MAKE_FAST_ALLOCATED;
public:
WEBCORE_EXPORT static NetworkStorageSession& defaultStorageSession();
WEBCORE_EXPORT static NetworkStorageSession* storageSession(PAL::SessionID);
WEBCORE_EXPORT static void ensureSession(PAL::SessionID, const String& identifierBase = String());
WEBCORE_EXPORT static void destroySession(PAL::SessionID);
WEBCORE_EXPORT static void forEach(const WTF::Function<void(const WebCore::NetworkStorageSession&)>&);
WEBCORE_EXPORT static void permitProcessToUseCookieAPI(bool);
WEBCORE_EXPORT static bool processMayUseCookieAPI();
WEBCORE_EXPORT static void switchToNewTestingSession();
PAL::SessionID sessionID() const { return m_sessionID; }
CredentialStorage& credentialStorage() { return m_credentialStorage; }
#ifdef __OBJC__
WEBCORE_EXPORT NSHTTPCookieStorage *nsCookieStorage() const;
#endif
#if PLATFORM(COCOA) || USE(CFURLCONNECTION)
WEBCORE_EXPORT static void ensureSession(PAL::SessionID, const String& identifierBase, RetainPtr<CFHTTPCookieStorageRef>&&);
NetworkStorageSession(PAL::SessionID, RetainPtr<CFURLStorageSessionRef>&&, RetainPtr<CFHTTPCookieStorageRef>&&);
explicit NetworkStorageSession(PAL::SessionID);
CFURLStorageSessionRef platformSession() { return m_platformSession.get(); }
WEBCORE_EXPORT RetainPtr<CFHTTPCookieStorageRef> cookieStorage() const;
WEBCORE_EXPORT static void setCookieStoragePartitioningEnabled(bool);
WEBCORE_EXPORT static void setStorageAccessAPIEnabled(bool);
#if HAVE(CFNETWORK_STORAGE_PARTITIONING)
WEBCORE_EXPORT String cookieStoragePartition(const ResourceRequest&, std::optional<uint64_t> frameID, std::optional<uint64_t> pageID) const;
WEBCORE_EXPORT bool shouldBlockCookies(const ResourceRequest&) const;
WEBCORE_EXPORT bool shouldBlockCookies(const URL& firstPartyForCookies, const URL& resource) const;
WEBCORE_EXPORT String cookieStoragePartition(const URL& firstPartyForCookies, const URL& resource, std::optional<uint64_t> frameID, std::optional<uint64_t> pageID) const;
WEBCORE_EXPORT void setPrevalentDomainsToPartitionOrBlockCookies(const Vector<String>& domainsToPartition, const Vector<String>& domainsToBlock, const Vector<String>& domainsToNeitherPartitionNorBlock, bool clearFirst);
WEBCORE_EXPORT void setAgeCapForClientSideCookies(std::optional<Seconds>);
WEBCORE_EXPORT std::optional<Seconds> ageCapForClientSideCookies() const;
WEBCORE_EXPORT void removePrevalentDomains(const Vector<String>& domains);
WEBCORE_EXPORT bool hasStorageAccess(const String& resourceDomain, const String& firstPartyDomain, std::optional<uint64_t> frameID, uint64_t pageID) const;
WEBCORE_EXPORT Vector<String> getAllStorageAccessEntries() const;
WEBCORE_EXPORT void grantStorageAccess(const String& resourceDomain, const String& firstPartyDomain, std::optional<uint64_t> frameID, uint64_t pageID);
WEBCORE_EXPORT void removeStorageAccessForFrame(uint64_t frameID, uint64_t pageID);
WEBCORE_EXPORT void removeStorageAccessForAllFramesOnPage(uint64_t pageID);
WEBCORE_EXPORT void removeAllStorageAccess();
#endif
#elif USE(SOUP)
NetworkStorageSession(PAL::SessionID, std::unique_ptr<SoupNetworkSession>&&);
~NetworkStorageSession();
SoupNetworkSession* soupNetworkSession() const { return m_session.get(); };
SoupNetworkSession& getOrCreateSoupNetworkSession() const;
void clearSoupNetworkSessionAndCookieStorage();
SoupCookieJar* cookieStorage() const;
void setCookieStorage(SoupCookieJar*);
void setCookieObserverHandler(Function<void ()>&&);
void getCredentialFromPersistentStorage(const ProtectionSpace&, GCancellable*, Function<void (Credential&&)>&& completionHandler);
void saveCredentialToPersistentStorage(const ProtectionSpace&, const Credential&);
#elif USE(CURL)
NetworkStorageSession(PAL::SessionID, NetworkingContext*);
~NetworkStorageSession();
const CookieJarCurl& cookieStorage() const { return m_cookieStorage; };
CookieJarDB& cookieDatabase() const;
WEBCORE_EXPORT void setCookieDatabase(UniqueRef<CookieJarDB>&&) const;
NetworkingContext* context() const;
#else
NetworkStorageSession(PAL::SessionID, NetworkingContext*);
~NetworkStorageSession();
NetworkingContext* context() const;
#endif
WEBCORE_EXPORT void setCookie(const Cookie&);
WEBCORE_EXPORT void setCookies(const Vector<Cookie>&, const URL&, const URL& mainDocumentURL);
WEBCORE_EXPORT void deleteCookie(const Cookie&);
WEBCORE_EXPORT Vector<Cookie> getAllCookies();
WEBCORE_EXPORT Vector<Cookie> getCookies(const URL&);
WEBCORE_EXPORT void flushCookieStore();
private:
static HashMap<PAL::SessionID, std::unique_ptr<NetworkStorageSession>>& globalSessionMap();
PAL::SessionID m_sessionID;
#if PLATFORM(COCOA) || USE(CFURLCONNECTION)
RetainPtr<CFURLStorageSessionRef> m_platformSession;
RetainPtr<CFHTTPCookieStorageRef> m_platformCookieStorage;
#elif USE(SOUP)
static void cookiesDidChange(NetworkStorageSession*);
mutable std::unique_ptr<SoupNetworkSession> m_session;
GRefPtr<SoupCookieJar> m_cookieStorage;
Function<void ()> m_cookieObserverHandler;
#elif USE(CURL)
RefPtr<NetworkingContext> m_context;
UniqueRef<CookieJarCurl> m_cookieStorage;
mutable UniqueRef<CookieJarDB> m_cookieDatabase;
#else
RefPtr<NetworkingContext> m_context;
#endif
CredentialStorage m_credentialStorage;
#if HAVE(CFNETWORK_STORAGE_PARTITIONING)
bool shouldPartitionCookies(const String& topPrivatelyControlledDomain) const;
bool shouldBlockThirdPartyCookies(const String& topPrivatelyControlledDomain) const;
HashSet<String> m_topPrivatelyControlledDomainsToPartition;
HashSet<String> m_topPrivatelyControlledDomainsToBlock;
HashMap<uint64_t, HashMap<uint64_t, String, DefaultHash<uint64_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>>, DefaultHash<uint64_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> m_framesGrantedStorageAccess;
HashMap<uint64_t, HashMap<String, String>, DefaultHash<uint64_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> m_pagesGrantedStorageAccess;
std::optional<Seconds> m_ageCapForClientSideCookies { };
#endif
#if PLATFORM(COCOA)
public:
CookieStorageObserver& cookieStorageObserver() const;
private:
mutable RefPtr<CookieStorageObserver> m_cookieStorageObserver;
#endif
static bool m_processMayUseCookieAPI;
};
#if PLATFORM(COCOA)
WEBCORE_EXPORT CFURLStorageSessionRef createPrivateStorageSession(CFStringRef identifier);
#endif
}