Teach ScriptExecutionContexts about their SessionID.
[WebKit-https.git] / Source / WebCore / page / SessionID.h
1 /*
2  * Copyright (C) 2014-2017 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 #pragma once
27
28 #include <wtf/HashFunctions.h>
29 #include <wtf/HashTraits.h>
30
31 namespace WebCore {
32
33 class SessionID {
34 public:
35     SessionID()
36         : SessionID(emptySessionID())
37     {
38     }
39
40     enum SessionConstants : uint64_t {
41         EphemeralSessionMask    = 0x8000000000000000,
42         DefaultSessionID        = 1,
43         LegacyPrivateSessionID  = DefaultSessionID | EphemeralSessionMask,
44         HashTableEmptyValueID   = 0,
45         HashTableDeletedValueID = std::numeric_limits<uint64_t>::max(),
46     };
47
48     static SessionID emptySessionID() { return SessionID(HashTableEmptyValueID); }
49     static SessionID hashTableDeletedValue() { return SessionID(HashTableDeletedValueID); }
50     static SessionID defaultSessionID() { return SessionID(DefaultSessionID); }
51     static SessionID legacyPrivateSessionID() { return SessionID(LegacyPrivateSessionID); }
52
53     bool isValid() const { return m_sessionID != HashTableEmptyValueID && m_sessionID != HashTableDeletedValueID; }
54     bool isEphemeral() const { return m_sessionID & EphemeralSessionMask && m_sessionID != HashTableDeletedValueID; }
55
56     WEBCORE_EXPORT static SessionID generateEphemeralSessionID();
57     WEBCORE_EXPORT static SessionID generatePersistentSessionID();
58     WEBCORE_EXPORT static void enableGenerationProtection();
59
60     uint64_t sessionID() const { return m_sessionID; }
61     bool operator==(SessionID sessionID) const { return m_sessionID == sessionID.m_sessionID; }
62     bool operator!=(SessionID sessionID) const { return m_sessionID != sessionID.m_sessionID; }
63     bool isAlwaysOnLoggingAllowed() const { return !isEphemeral(); }
64
65     template<class Encoder> void encode(Encoder&) const;
66     template<class Decoder> static bool decode(Decoder&, SessionID&);
67
68     SessionID isolatedCopy() const;
69
70 private:
71     explicit SessionID(uint64_t sessionID)
72         : m_sessionID(sessionID)
73     {
74     }
75
76     uint64_t m_sessionID;
77 };
78
79 template<class Encoder>
80 void SessionID::encode(Encoder& encoder) const
81 {
82     // FIXME: Eliminate places that encode invalid SessionIDs, then ASSERT here that the sessionID is valid.
83     encoder << m_sessionID;
84 }
85
86 template<class Decoder>
87 bool SessionID::decode(Decoder& decoder, SessionID& sessionID)
88 {
89     if (!decoder.decode(sessionID.m_sessionID))
90         return false;
91
92     // FIXME: Eliminate places that encode invalid SessionIDs, then fail to decode an invalid sessionID.
93     return true;
94 }
95
96 } // namespace WebCore
97
98 namespace WTF {
99
100 struct SessionIDHash {
101     static unsigned hash(const WebCore::SessionID& p) { return intHash(p.sessionID()); }
102     static bool equal(const WebCore::SessionID& a, const WebCore::SessionID& b) { return a == b; }
103     static const bool safeToCompareToEmptyOrDeleted = true;
104 };
105 template<> struct HashTraits<WebCore::SessionID> : GenericHashTraits<WebCore::SessionID> {
106     static WebCore::SessionID emptyValue() { return WebCore::SessionID::emptySessionID(); }
107
108     static void constructDeletedValue(WebCore::SessionID& slot) { slot = WebCore::SessionID::hashTableDeletedValue(); }
109     static bool isDeletedValue(const WebCore::SessionID& slot) { return slot == WebCore::SessionID::hashTableDeletedValue(); }
110 };
111 template<> struct DefaultHash<WebCore::SessionID> {
112     typedef SessionIDHash Hash;
113 };
114
115 } // namespace WTF