1/*
2 * Copyright (C) 2003-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. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include <wtf/Forward.h>
29#include <wtf/text/WTFString.h>
30
31namespace PAL {
32class SessionID;
33}
34
35namespace WebCore {
36
37enum class IncludeSecureCookies : bool { No, Yes };
38enum class IncludeHttpOnlyCookies : bool { No, Yes };
39enum class SecureCookiesAccessed : bool { No, Yes };
40
41class Document;
42struct Cookie;
43struct CookieRequestHeaderFieldProxy;
44class NetworkStorageSession;
45class StorageSessionProvider;
46struct SameSiteInfo;
47
48class WEBCORE_EXPORT CookieJar : public RefCounted<CookieJar> {
49public:
50 static Ref<CookieJar> create(Ref<StorageSessionProvider>&&);
51
52 static CookieRequestHeaderFieldProxy cookieRequestHeaderFieldProxy(const Document&, const URL&);
53
54 String cookieRequestHeaderFieldValue(Document&, const URL&) const;
55
56 // These two functions implement document.cookie API, with special rules for HttpOnly cookies.
57 virtual String cookies(Document&, const URL&) const;
58 virtual void setCookies(Document&, const URL&, const String& cookieString);
59
60 virtual bool cookiesEnabled(const Document&) const;
61 virtual std::pair<String, SecureCookiesAccessed> cookieRequestHeaderFieldValue(const PAL::SessionID&, const URL& firstParty, const SameSiteInfo&, const URL&, Optional<uint64_t> frameID, Optional<uint64_t> pageID, IncludeSecureCookies) const;
62 virtual bool getRawCookies(const Document&, const URL&, Vector<Cookie>&) const;
63 virtual void deleteCookie(const Document&, const URL&, const String& cookieName);
64
65 virtual ~CookieJar();
66protected:
67 static SameSiteInfo sameSiteInfo(const Document&);
68 static IncludeSecureCookies shouldIncludeSecureCookies(const Document&, const URL&);
69 CookieJar(Ref<StorageSessionProvider>&&);
70
71private:
72 Ref<StorageSessionProvider> m_storageSessionProvider;
73};
74
75} // namespace WebCore
76