7875a1ebd0f46709369bb015ac1bc3d4f611f89e
[WebKit-https.git] / Source / WebCore / page / SecurityOrigin.h
1 /*
2  * Copyright (C) 2007, 2008 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> createFromDatabaseIdentifier(const String&);
56     // Alternate form of createFromDatabaseIdentifier that returns a nullptr on failure, instead of an empty origin.
57     // FIXME: Many users of createFromDatabaseIdentifier seem to expect maybeCreateFromDatabaseIdentifier behavior,
58     // but they aren't getting it so they might be buggy.
59     WEBCORE_EXPORT static RefPtr<SecurityOrigin> maybeCreateFromDatabaseIdentifier(const String&);
60
61     WEBCORE_EXPORT static Ref<SecurityOrigin> createFromString(const String&);
62     WEBCORE_EXPORT static Ref<SecurityOrigin> create(const String& protocol, const String& host, Optional<uint16_t> port);
63
64     // Some URL schemes use nested URLs for their security context. For example,
65     // filesystem URLs look like the following:
66     //
67     //   filesystem:http://example.com/temporary/path/to/file.png
68     //
69     // We're supposed to use "http://example.com" as the origin.
70     //
71     // Generally, we add URL schemes to this list when WebKit support them. For
72     // example, we don't include the "jar" scheme, even though Firefox
73     // understands that "jar" uses an inner URL for it's security origin.
74     static bool shouldUseInnerURL(const URL&);
75     static URL extractInnerURL(const URL&);
76
77     // Create a deep copy of this SecurityOrigin. This method is useful
78     // when marshalling a SecurityOrigin to another thread.
79     WEBCORE_EXPORT Ref<SecurityOrigin> isolatedCopy() const;
80
81     // Set the domain property of this security origin to newDomain. This
82     // function does not check whether newDomain is a suffix of the current
83     // domain. The caller is responsible for validating newDomain.
84     void setDomainFromDOM(const String& newDomain);
85     bool domainWasSetInDOM() const { return m_domainWasSetInDOM; }
86
87     const String& protocol() const { return m_protocol; }
88     const String& host() const { return m_host; }
89     const String& domain() const { return m_domain; }
90     Optional<uint16_t> port() const { return m_port; }
91
92     // Returns true if a given URL is secure, based either directly on its
93     // own protocol, or, when relevant, on the protocol of its "inner URL"
94     // Protocols like blob: and filesystem: fall into this latter category.
95     static bool isSecure(const URL&);
96
97     // Returns true if this SecurityOrigin can script objects in the given
98     // SecurityOrigin. For example, call this function before allowing
99     // script from one security origin to read or write objects from
100     // another SecurityOrigin.
101     WEBCORE_EXPORT bool canAccess(const SecurityOrigin*) const;
102
103     // Returns true if this SecurityOrigin can read content retrieved from
104     // the given URL. For example, call this function before issuing
105     // XMLHttpRequests.
106     bool canRequest(const URL&) const;
107
108     // Returns true if this SecurityOrigin can receive drag content from the
109     // initiator. For example, call this function before allowing content to be
110     // dropped onto a target.
111     bool canReceiveDragData(const SecurityOrigin* dragInitiator) const;    
112
113     // Returns true if |document| can display content from the given URL (e.g.,
114     // in an iframe or as an image). For example, web sites generally cannot
115     // display content from the user's files system.
116     WEBCORE_EXPORT bool canDisplay(const URL&) const;
117
118     // Returns true if this SecurityOrigin can load local resources, such
119     // as images, iframes, and style sheets, and can link to local URLs.
120     // For example, call this function before creating an iframe to a
121     // file:// URL.
122     //
123     // Note: A SecurityOrigin might be allowed to load local resources
124     //       without being able to issue an XMLHttpRequest for a local URL.
125     //       To determine whether the SecurityOrigin can issue an
126     //       XMLHttpRequest for a URL, call canRequest(url).
127     bool canLoadLocalResources() const { return m_canLoadLocalResources; }
128
129     // Explicitly grant the ability to load local resources to this
130     // SecurityOrigin.
131     //
132     // Note: This method exists only to support backwards compatibility
133     //       with older versions of WebKit.
134     void grantLoadLocalResources();
135
136     // Explicitly grant the ability to access very other SecurityOrigin.
137     //
138     // WARNING: This is an extremely powerful ability. Use with caution!
139     void grantUniversalAccess();
140     bool hasUniversalAccess() const { return m_universalAccess; }
141
142     void setStorageBlockingPolicy(StorageBlockingPolicy policy) { m_storageBlockingPolicy = policy; }
143
144 #if ENABLE(CACHE_PARTITIONING)
145     WEBCORE_EXPORT String domainForCachePartition() const;
146 #endif
147
148     bool canAccessDatabase(const SecurityOrigin* topOrigin = nullptr) const { return canAccessStorage(topOrigin); };
149     bool canAccessSessionStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin, AlwaysAllowFromThirdParty); }
150     bool canAccessLocalStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); };
151     bool canAccessPluginStorage(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); }
152     bool canAccessApplicationCache(const SecurityOrigin* topOrigin) const { return canAccessStorage(topOrigin); }
153     bool canAccessCookies() const { return !isUnique(); }
154     bool canRequestGeolocation() const { return !isUnique(); }
155     Policy canShowNotifications() const;
156
157     // The local SecurityOrigin is the most privileged SecurityOrigin.
158     // The local SecurityOrigin can script any document, navigate to local
159     // resources, and can set arbitrary headers on XMLHttpRequests.
160     WEBCORE_EXPORT bool isLocal() const;
161
162     // The origin is a globally unique identifier assigned when the Document is
163     // created. http://www.whatwg.org/specs/web-apps/current-work/#sandboxOrigin
164     //
165     // There's a subtle difference between a unique origin and an origin that
166     // has the SandboxOrigin flag set. The latter implies the former, and, in
167     // addition, the SandboxOrigin flag is inherited by iframes.
168     bool isUnique() const { return m_isUnique; }
169
170     // Marks a file:// origin as being in a domain defined by its path.
171     // FIXME 81578: The naming of this is confusing. Files with restricted access to other local files
172     // still can have other privileges that can be remembered, thereby not making them unique.
173     void enforceFilePathSeparation();
174
175     // Convert this SecurityOrigin into a string. The string
176     // representation of a SecurityOrigin is similar to a URL, except it
177     // lacks a path component. The string representation does not encode
178     // the value of the SecurityOrigin's domain property.
179     //
180     // When using the string value, it's important to remember that it might be
181     // "null". This happens when this SecurityOrigin is unique. For example,
182     // this SecurityOrigin might have come from a sandboxed iframe, the
183     // SecurityOrigin might be empty, or we might have explicitly decided that
184     // we shouldTreatURLSchemeAsNoAccess.
185     WEBCORE_EXPORT String toString() const;
186
187     // Similar to toString(), but does not take into account any factors that
188     // could make the string return "null".
189     WEBCORE_EXPORT String toRawString() const;
190
191     // Serialize the security origin to a string that could be used as part of
192     // file names. This format should be used in storage APIs only.
193     WEBCORE_EXPORT String databaseIdentifier() const;
194
195     // This method checks for equality between SecurityOrigins, not whether
196     // one origin can access another. It is used for hash table keys.
197     // For access checks, use canAccess().
198     // FIXME: If this method is really only useful for hash table keys, it
199     // should be refactored into SecurityOriginHash.
200     WEBCORE_EXPORT bool equal(const SecurityOrigin*) const;
201
202     // This method checks for equality, ignoring the value of document.domain
203     // (and whether it was set) but considering the host. It is used for postMessage.
204     WEBCORE_EXPORT bool isSameSchemeHostPort(const SecurityOrigin*) const;
205
206     static URL urlWithUniqueSecurityOrigin();
207
208 private:
209     SecurityOrigin();
210     explicit SecurityOrigin(const URL&);
211     explicit SecurityOrigin(const SecurityOrigin*);
212
213     // FIXME: Rename this function to something more semantic.
214     bool passesFileCheck(const SecurityOrigin*) const;
215     bool isThirdParty(const SecurityOrigin*) const;
216
217     // This method checks that the scheme for this origin is an HTTP-family
218     // scheme, e.g. HTTP and HTTPS.
219     bool isHTTPFamily() const { return m_protocol == "http" || m_protocol == "https"; }
220     
221     enum ShouldAllowFromThirdParty { AlwaysAllowFromThirdParty, MaybeAllowFromThirdParty };
222     WEBCORE_EXPORT bool canAccessStorage(const SecurityOrigin*, ShouldAllowFromThirdParty = MaybeAllowFromThirdParty) const;
223
224     String m_protocol;
225     String m_host;
226     String m_domain;
227     String m_filePath;
228     Optional<uint16_t> m_port;
229     bool m_isUnique;
230     bool m_universalAccess;
231     bool m_domainWasSetInDOM;
232     bool m_canLoadLocalResources;
233     StorageBlockingPolicy m_storageBlockingPolicy;
234     bool m_enforceFilePathSeparation;
235     bool m_needsDatabaseIdentifierQuirkForFiles;
236 };
237
238 // Returns true if the Origin header values serialized from these two origins would be the same.
239 bool originsMatch(const SecurityOrigin&, const SecurityOrigin&);
240 bool originsMatch(const SecurityOrigin*, const SecurityOrigin*);
241
242 } // namespace WebCore