5f55f942b81fcfe00bfd43bc10996f3cdc24715d
[WebKit-https.git] / Source / WebCore / page / SecurityOriginData.h
1  /*
2  * Copyright (C) 2011, 2015 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/text/WTFString.h>
29
30 namespace WebCore {
31
32 class Frame;
33 class SecurityOrigin;
34
35 struct SecurityOriginData {
36     SecurityOriginData() = default;
37     SecurityOriginData(const String& protocol, const String& host, std::optional<uint16_t> port)
38         : protocol(protocol)
39         , host(host)
40         , port(port)
41     {
42     }
43     SecurityOriginData(WTF::HashTableDeletedValueType)
44         : protocol(WTF::HashTableDeletedValue)
45     {
46     }
47     
48     WEBCORE_EXPORT static SecurityOriginData fromSecurityOrigin(const SecurityOrigin&);
49     WEBCORE_EXPORT static SecurityOriginData fromFrame(Frame*);
50
51     WEBCORE_EXPORT Ref<SecurityOrigin> securityOrigin() const;
52
53     // FIXME <rdar://9018386>: We should be sending more state across the wire than just the protocol,
54     // host, and port.
55
56     String protocol;
57     String host;
58     std::optional<uint16_t> port;
59
60     WEBCORE_EXPORT SecurityOriginData isolatedCopy() const;
61
62     // Serialize the security origin to a string that could be used as part of
63     // file names. This format should be used in storage APIs only.
64     WEBCORE_EXPORT String databaseIdentifier() const;
65     WEBCORE_EXPORT static std::optional<SecurityOriginData> fromDatabaseIdentifier(const String&);
66     
67     template<class Encoder> void encode(Encoder&) const;
68     template<class Decoder> static std::optional<SecurityOriginData> decode(Decoder&);
69
70     bool isEmpty() const
71     {
72         return protocol.isNull() && host.isNull() && port == std::nullopt;
73     }
74     
75     bool isHashTableDeletedValue() const
76     {
77         return protocol.isHashTableDeletedValue();
78     }
79     
80     WEBCORE_EXPORT String toString() const;
81
82 #if !LOG_DISABLED
83     String debugString() const { return toString(); }
84 #endif
85 };
86
87 WEBCORE_EXPORT bool operator==(const SecurityOriginData&, const SecurityOriginData&);
88 inline bool operator!=(const SecurityOriginData& first, const SecurityOriginData& second) { return !(first == second); }
89
90 template<class Encoder>
91 void SecurityOriginData::encode(Encoder& encoder) const
92 {
93     encoder << protocol;
94     encoder << host;
95     encoder << port;
96 }
97
98 template<class Decoder>
99 std::optional<SecurityOriginData> SecurityOriginData::decode(Decoder& decoder)
100 {
101     std::optional<String> protocol;
102     decoder >> protocol;
103     if (!protocol)
104         return std::nullopt;
105     
106     std::optional<String> host;
107     decoder >> host;
108     if (!host)
109         return std::nullopt;
110     
111     std::optional<uint16_t> port;
112     if (!decoder.decode(port))
113         return std::nullopt;
114     
115     return {{ WTFMove(*protocol), WTFMove(*host), WTFMove(port) }};
116 }
117
118 struct SecurityOriginDataHashTraits : WTF::SimpleClassHashTraits<SecurityOriginData> {
119     static const bool hasIsEmptyValueFunction = true;
120     static const bool emptyValueIsZero = false;
121     static bool isEmptyValue(const SecurityOriginData& data) { return data.isEmpty(); }
122 };
123
124 struct SecurityOriginDataHash {
125     static unsigned hash(const SecurityOriginData& data)
126     {
127         unsigned hashCodes[3] = {
128             data.protocol.impl() ? data.protocol.impl()->hash() : 0,
129             data.host.impl() ? data.host.impl()->hash() : 0,
130             data.port.value_or(0)
131         };
132         return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
133     }
134     static bool equal(const SecurityOriginData& a, const SecurityOriginData& b) { return a == b; }
135     static const bool safeToCompareToEmptyOrDeleted = false;
136 };
137
138 } // namespace WebCore
139
140 namespace WTF {
141
142 template<> struct HashTraits<WebCore::SecurityOriginData> : WebCore::SecurityOriginDataHashTraits { };
143 template<> struct DefaultHash<WebCore::SecurityOriginData> {
144     typedef WebCore::SecurityOriginDataHash Hash;
145 };
146
147 } // namespace WTF