Document::securityOrigin() should return a reference.
[WebKit-https.git] / Source / WebCore / page / SecurityOrigin.h
1 /*
2  * Copyright (C) 2007-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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include <wtf/ThreadSafeRefCounted.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class URL;
37
38 class SecurityOrigin : public ThreadSafeRefCounted<SecurityOrigin> {
39 public:
40     enum Policy {
41         AlwaysDeny = 0,
42         AlwaysAllow,
43         Ask
44     };
45
46     enum StorageBlockingPolicy {
47         AllowAllStorage = 0,
48         BlockThirdPartyStorage,
49         BlockAllStorage
50     };
51
52     WEBCORE_EXPORT static Ref<SecurityOrigin> create(const URL&);
53     static Ref<SecurityOrigin> createUnique();
54
55     WEBCORE_EXPORT static Ref<SecurityOrigin> createFromString(const String&);
56     WEBCORE_EXPORT static Ref<SecurityOrigin> create(const String& protocol, const String& host, std::optional<uint16_t> port);
57
58     // Some URL schemes use nested URLs for their security context. For example,
59     // filesystem URLs look like the following:
60     //
61     //   filesystem:http://example.com/temporary/path/to/file.png
62     //
63     // We're supposed to use "http://example.com" as the origin.
64     //
65     // Generally, we add URL schemes to this list when WebKit support them. For
66     // example, we don't include the "jar" scheme, even though Firefox
67     // understands that "jar" uses an inner URL for it's security origin.
68     static bool shouldUseInnerURL(const URL&);
69     static URL extractInnerURL(const URL&);
70
71     // Create a deep copy of this SecurityOrigin. This method is useful
72     // when marshalling a SecurityOrigin to another thread.
73     WEBCORE_EXPORT Ref<SecurityOrigin> isolatedCopy() const;
74
75     // Set the domain property of this security origin to newDomain. This
76     // function does not check whether newDomain is a suffix of the current
77     // domain. The caller is responsible for validating newDomain.
78     void setDomainFromDOM(const String& newDomain);
79     bool domainWasSetInDOM() const { return m_domainWasSetInDOM; }
80
81     const String& protocol() const { return m_protocol; }
82     const String& host() const { return m_host; }
83     const String& domain() const { return m_domain; }
84     std::optional<uint16_t> port() const { return m_port; }
85
86     // Returns true if a given URL is secure, based either directly on its
87     // own protocol, or, when relevant, on the protocol of its "inner URL"
88     // Protocols like blob: and filesystem: fall into this latter category.
89     static bool isSecure(const URL&);
90
91     // Returns true if this SecurityOrigin can script objects in the given
92     // SecurityOrigin. For example, call this function before allowing
93     // script from one security origin to read or write objects from
94     // another SecurityOrigin.
95     WEBCORE_EXPORT bool canAccess(const SecurityOrigin&) const;
96
97     // Returns true if this SecurityOrigin can read content retrieved from
98     // the given URL. For example, call this function before issuing
99     // XMLHttpRequests.
100     bool canRequest(const URL&) const;
101
102     // Returns true if this SecurityOrigin can receive drag content from the
103     // initiator. For example, call this function before allowing content to be
104     // dropped onto a target.
105     bool canReceiveDragData(const SecurityOrigin& dragInitiator) const;
106
107     // Returns true if |document| can display content from the given URL (e.g.,
108     // in an iframe or as an image). For example, web sites generally cannot
109     // display content from the user's files system.
110     WEBCORE_EXPORT bool canDisplay(const URL&) const;
111
112     // Returns true if this SecurityOrigin can load local resources, such
113     // as images, iframes, and style sheets, and can link to local URLs.
114     // For example, call this function before creating an iframe to a
115     // file:// URL.
116     //
117     // Note: A SecurityOrigin might be allowed to load local resources
118     //       without being able to issue an XMLHttpRequest for a local URL.
119     //       To determine whether the SecurityOrigin can issue an
120     //       XMLHttpRequest for a URL, call canRequest(url).
121     bool canLoadLocalResources() const { return m_canLoadLocalResources; }
122
123     // Explicitly grant the ability to load local resources to this
124     // SecurityOrigin.
125     //
126     // Note: This method exists only to support backwards compatibility
127     //       with older versions of WebKit.
128     void grantLoadLocalResources();
129
130     // Explicitly grant the ability to access very other SecurityOrigin.
131     //
132     // WARNING: This is an extremely powerful ability. Use with caution!
133     void grantUniversalAccess();
134     bool hasUniversalAccess() const { return m_universalAccess; }
135
136     void setStorageBlockingPolicy(StorageBlockingPolicy policy) { m_storageBlockingPolicy = policy; }
137
138     void grantStorageAccessFromFileURLsQuirk();
139     bool needsStorageAccessFromFileURLsQuirk() const { return m_needsStorageAccessFromFileURLsQuirk; }
140
141 #if ENABLE(CACHE_PARTITIONING)
142     WEBCORE_EXPORT String domainForCachePartition() const;
143 #endif
144
145     bool canAccessDatabase(const SecurityOrigin* topOrigin = nullptr) const { return canAccessStorage(topOrigin); };
146     bool canAccessSessionStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin, AlwaysAllowFromThirdParty); }
147     bool canAccessLocalStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); };
148     bool canAccessPluginStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); }
149     bool canAccessApplicationCache(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); }
150     bool canAccessCookies() const { return !isUnique(); }
151     bool canRequestGeolocation() const { return !isUnique(); }
152     Policy canShowNotifications() const;
153
154     // The local SecurityOrigin is the most privileged SecurityOrigin.
155     // The local SecurityOrigin can script any document, navigate to local
156     // resources, and can set arbitrary headers on XMLHttpRequests.
157     WEBCORE_EXPORT bool isLocal() const;
158
159     // The origin is a globally unique identifier assigned when the Document is
160     // created. http://www.whatwg.org/specs/web-apps/current-work/#sandboxOrigin
161     //
162     // There's a subtle difference between a unique origin and an origin that
163     // has the SandboxOrigin flag set. The latter implies the former, and, in
164     // addition, the SandboxOrigin flag is inherited by iframes.
165     bool isUnique() const { return m_isUnique; }
166
167     // Marks a file:// origin as being in a domain defined by its path.
168     // FIXME 81578: The naming of this is confusing. Files with restricted access to other local files
169     // still can have other privileges that can be remembered, thereby not making them unique.
170     void enforceFilePathSeparation();
171
172     // Convert this SecurityOrigin into a string. The string
173     // representation of a SecurityOrigin is similar to a URL, except it
174     // lacks a path component. The string representation does not encode
175     // the value of the SecurityOrigin's domain property.
176     //
177     // When using the string value, it's important to remember that it might be
178     // "null". This happens when this SecurityOrigin is unique. For example,
179     // this SecurityOrigin might have come from a sandboxed iframe, the
180     // SecurityOrigin might be empty, or we might have explicitly decided that
181     // we shouldTreatURLSchemeAsNoAccess.
182     WEBCORE_EXPORT String toString() const;
183
184     // Similar to toString(), but does not take into account any factors that
185     // could make the string return "null".
186     WEBCORE_EXPORT String toRawString() const;
187
188     // This method checks for equality between SecurityOrigins, not whether
189     // one origin can access another. It is used for hash table keys.
190     // For access checks, use canAccess().
191     // FIXME: If this method is really only useful for hash table keys, it
192     // should be refactored into SecurityOriginHash.
193     WEBCORE_EXPORT bool equal(const SecurityOrigin*) const;
194
195     // This method checks for equality, ignoring the value of document.domain
196     // (and whether it was set) but considering the host. It is used for postMessage.
197     WEBCORE_EXPORT bool isSameSchemeHostPort(const SecurityOrigin&) const;
198
199     // This method implements the "same origin" algorithm from the HTML Standard:
200     // https://html.spec.whatwg.org/multipage/browsers.html#same-origin
201     WEBCORE_EXPORT bool isSameOriginAs(const SecurityOrigin&) const;
202
203     static URL urlWithUniqueSecurityOrigin();
204
205 private:
206     SecurityOrigin();
207     explicit SecurityOrigin(const URL&);
208     explicit SecurityOrigin(const SecurityOrigin*);
209
210     // FIXME: Rename this function to something more semantic.
211     bool passesFileCheck(const SecurityOrigin&) const;
212
213     // This method checks that the scheme for this origin is an HTTP-family
214     // scheme, e.g. HTTP and HTTPS.
215     bool isHTTPFamily() const { return m_protocol == "http" || m_protocol == "https"; }
216     
217     enum ShouldAllowFromThirdParty { AlwaysAllowFromThirdParty, MaybeAllowFromThirdParty };
218     WEBCORE_EXPORT bool canAccessStorage(const SecurityOrigin*, ShouldAllowFromThirdParty = MaybeAllowFromThirdParty) const;
219
220     String m_protocol;
221     String m_host;
222     String m_domain;
223     String m_filePath;
224     std::optional<uint16_t> m_port;
225     bool m_isUnique { false };
226     bool m_universalAccess { false };
227     bool m_domainWasSetInDOM { false };
228     bool m_canLoadLocalResources { false };
229     StorageBlockingPolicy m_storageBlockingPolicy { AllowAllStorage };
230     bool m_enforceFilePathSeparation { false };
231     bool m_needsStorageAccessFromFileURLsQuirk { false };
232 };
233
234 // Returns true if the Origin header values serialized from these two origins would be the same.
235 bool originsMatch(const SecurityOrigin&, const SecurityOrigin&);
236 bool originsMatch(const SecurityOrigin*, const SecurityOrigin*);
237
238 } // namespace WebCore