third_party/WebKit/Source/platform/weborigin/SecurityOrigin.h

/*
 * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SecurityOrigin_h
#define SecurityOrigin_h

#include <memory>
#include "base/gtest_prod_util.h"
#include "platform/PlatformExport.h"
#include "platform/weborigin/Suborigin.h"
#include "platform/wtf/Noncopyable.h"
#include "platform/wtf/ThreadSafeRefCounted.h"
#include "platform/wtf/text/WTFString.h"
#include "url/origin.h"

namespace blink {

class KURL;
class URLSecurityOriginMap;

class PLATFORM_EXPORT SecurityOrigin : public RefCounted<SecurityOrigin> {
  WTF_MAKE_NONCOPYABLE(SecurityOrigin);

 public:
  static scoped_refptr<SecurityOrigin> Create(const KURL&);
  static scoped_refptr<SecurityOrigin> CreateUnique();

  static scoped_refptr<SecurityOrigin> CreateFromString(const String&);
  static scoped_refptr<SecurityOrigin> Create(const String& protocol,
                                              const String& host,
                                              int port);
  static scoped_refptr<SecurityOrigin> Create(const String& protocol,
                                              const String& host,
                                              int port,
                                              const String& suborigin);
  static scoped_refptr<SecurityOrigin> CreateFromUrlOrigin(const url::Origin&);
  url::Origin ToUrlOrigin() const;

  static void SetMap(URLSecurityOriginMap*);

  // Some URL schemes use nested URLs for their security context. For example,
  // filesystem URLs look like the following:
  //
  //   filesystem:http://example.com/temporary/path/to/file.png
  //
  // We're supposed to use "http://example.com" as the origin.
  //
  // Generally, we add URL schemes to this list when WebKit support them. For
  // example, we don't include the "jar" scheme, even though Firefox
  // understands that "jar" uses an inner URL for it's security origin.
  static bool ShouldUseInnerURL(const KURL&);
  static KURL ExtractInnerURL(const KURL&);

  // Create a deep copy of this SecurityOrigin. This method is useful
  // when marshalling a SecurityOrigin to another thread.
  scoped_refptr<SecurityOrigin> IsolatedCopy() const;

  // Set the domain property of this security origin to newDomain. This
  // function does not check whether newDomain is a suffix of the current
  // domain. The caller is responsible for validating newDomain.
  void SetDomainFromDOM(const String& new_domain);
  bool DomainWasSetInDOM() const { return domain_was_set_in_dom_; }

  String Protocol() const { return protocol_; }
  String Host() const { return host_; }
  String Domain() const { return domain_; }
  unsigned short Port() const { return port_; }

  // |port()| will return 0 if the port is the default for an origin. This
  // method instead returns the effective port, even if it is the default port
  // (e.g. "http" => 80).
  unsigned short EffectivePort() const { return effective_port_; }

  // Returns true if a given URL is secure, based either directly on its
  // own protocol, or, when relevant, on the protocol of its "inner URL"
  // Protocols like blob: and filesystem: fall into this latter category.
  static bool IsSecure(const KURL&);

  // Returns true if this SecurityOrigin can script objects in the given
  // SecurityOrigin. For example, call this function before allowing
  // script from one security origin to read or write objects from
  // another SecurityOrigin.
  //
  // This takes suborigins into account.
  bool CanAccess(const SecurityOrigin*) const;

  // Returns true if this SecurityOrigin can read content retrieved from
  // the given URL. For example, call this function before issuing
  // XMLHttpRequests.
  bool CanRequest(const KURL&) const;

  // Same as canRequest, except that it adds an additional check to make sure
  // that the SecurityOrigin does not have a suborigin name. If you're not
  // familiar with Suborigins, you probably want canRequest() for now.
  // Suborigins is a spec in progress, and where it should be enforced is still
  // in flux. See https://crbug.com/336894 for more details.
  //
  // TODO(jww): Once the Suborigin spec has become more settled, and we are
  // confident in the correctness of our implementation, canRequest should be
  // made to check the suborigin and this should be turned into
  // canRequestBypassSuborigin check, which should be the exceptional case.
  bool CanRequestNoSuborigin(const KURL&) const;

  // Returns true if drawing an image from this URL taints a canvas from
  // this security origin. For example, call this function before
  // drawing an image onto an HTML canvas element with the drawImage API.
  bool TaintsCanvas(const KURL&) const;

  // Returns true if |document| can display content from the given URL (e.g.,
  // in an iframe or as an image). For example, web sites generally cannot
  // display content from the user's files system.
  bool CanDisplay(const KURL&) const;

  // Returns true if the origin loads resources either from the local
  // machine or over the network from a
  // cryptographically-authenticated origin, as described in
  // https://w3c.github.io/webappsec/specs/powerfulfeatures/#is-origin-trustworthy.
  bool IsPotentiallyTrustworthy() const;

  // Returns a human-readable error message describing that a non-secure
  // origin's access to a feature is denied.
  static String IsPotentiallyTrustworthyErrorMessage();

  // Returns true if this SecurityOrigin can load local resources, such
  // as images, iframes, and style sheets, and can link to local URLs.
  // For example, call this function before creating an iframe to a
  // file:// URL.
  //
  // Note: A SecurityOrigin might be allowed to load local resources
  //       without being able to issue an XMLHttpRequest for a local URL.
  //       To determine whether the SecurityOrigin can issue an
  //       XMLHttpRequest for a URL, call canRequest(url).
  bool CanLoadLocalResources() const { return can_load_local_resources_; }

  // Explicitly grant the ability to load local resources to this
  // SecurityOrigin.
  //
  // Note: This method exists only to support backwards compatibility
  //       with older versions of WebKit.
  void GrantLoadLocalResources();

  // Explicitly grant the ability to access every other SecurityOrigin.
  //
  // WARNING: This is an extremely powerful ability. Use with caution!
  void GrantUniversalAccess();
  bool IsGrantedUniversalAccess() const { return universal_access_; }

  bool CanAccessDatabase() const { return !IsUnique(); }
  bool CanAccessLocalStorage() const { return !IsUnique(); }
  bool CanAccessSharedWorkers() const { return !IsUnique(); }
  bool CanAccessServiceWorkers() const {
    return !IsUnique() && !HasSuborigin();
  }
  bool CanAccessCookies() const { return !IsUnique(); }
  bool CanAccessPasswordManager() const { return !IsUnique(); }
  bool CanAccessFileSystem() const { return !IsUnique(); }
  bool CanAccessCacheStorage() const { return !IsUnique(); }

  // Technically, we should always allow access to sessionStorage, but we
  // currently don't handle creating a sessionStorage area for unique
  // origins.
  bool CanAccessSessionStorage() const { return !IsUnique(); }

  // The local SecurityOrigin is the most privileged SecurityOrigin.
  // The local SecurityOrigin can script any document, navigate to local
  // resources, and can set arbitrary headers on XMLHttpRequests.
  bool IsLocal() const;

  // Returns true if the host is one of 127.0.0.1/8, ::1/128, or "localhost".
  bool IsLocalhost() const;

  // The origin is a globally unique identifier assigned when the Document is
  // created. http://www.whatwg.org/specs/web-apps/current-work/#sandboxOrigin
  //
  // There's a subtle difference between a unique origin and an origin that
  // has the SandboxOrigin flag set. The latter implies the former, and, in
  // addition, the SandboxOrigin flag is inherited by iframes.
  bool IsUnique() const { return is_unique_; }

  // Assigns a suborigin namespace to the SecurityOrigin. addSuborigin() must
  // only ever be called once per SecurityOrigin(). If it is called on a
  // SecurityOrigin that has already had a suborigin assigned, it will hit a
  // CHECK().
  bool HasSuborigin() const { return !suborigin_.GetName().IsNull(); }
  const Suborigin* GetSuborigin() const { return &suborigin_; }
  void AddSuborigin(const Suborigin&);

  // Returns true when this SecurityOrigin has a suborigin, its policy
  // allows sending credentials to the same physical origin, and the specified
  // origin is the same physical origin.
  bool HasSuboriginAndShouldAllowCredentialsFor(const KURL&) const;

  // By default 'file:' URLs may access other 'file:' URLs. This method
  // denies access. If either SecurityOrigin sets this flag, the access
  // check will fail.
  void BlockLocalAccessFromLocalOrigin();

  // Convert this SecurityOrigin into a string. The string
  // representation of a SecurityOrigin is similar to a URL, except it
  // lacks a path component. The string representation does not encode
  // the value of the SecurityOrigin's domain property.
  //
  // When using the string value, it's important to remember that it might be
  // "null". This happens when this SecurityOrigin is unique. For example,
  // this SecurityOrigin might have come from a sandboxed iframe, the
  // SecurityOrigin might be empty, or we might have explicitly decided that
  // we shouldTreatURLSchemeAsNoAccess.
  String ToString() const;
  AtomicString ToAtomicString() const;
  // Same as toString above, but ignores Suborigin, if present. This is
  // generally not what you want.
  String ToPhysicalOriginString() const;

  // Similar to toString(), but does not take into account any factors that
  // could make the string return "null".
  String ToRawString() const;
  AtomicString ToRawAtomicString() const;

  // This method checks for equality, ignoring the value of document.domain
  // (and whether it was set) but considering the host. It is used for
  // postMessage.
  bool IsSameSchemeHostPort(const SecurityOrigin*) const;
  bool IsSameSchemeHostPortAndSuborigin(const SecurityOrigin*) const;

  static bool AreSameSchemeHostPort(const KURL& a, const KURL& b);

  static const KURL& UrlWithUniqueSecurityOrigin();

  // Transfer origin privileges from another security origin.
  // The following privileges are currently copied over:
  //
  //   - Grant universal access.
  //   - Grant loading of local resources.
  //   - Use path-based file:// origins.
  struct PrivilegeData {
    bool universal_access_;
    bool can_load_local_resources_;
    bool block_local_access_from_local_origin_;
  };
  std::unique_ptr<PrivilegeData> CreatePrivilegeData() const;
  void TransferPrivilegesFrom(std::unique_ptr<PrivilegeData>);

  void SetUniqueOriginIsPotentiallyTrustworthy(
      bool is_unique_origin_potentially_trustworthy);

  // Only used for document.domain setting. The method should probably be moved
  // if we need it for something more general.
  static String CanonicalizeHost(const String& host, bool* success);

 private:
  friend class SecurityOriginTest;
  FRIEND_TEST_ALL_PREFIXES(SecurityOriginTest, Suborigins);
  FRIEND_TEST_ALL_PREFIXES(SecurityOriginTest, SuboriginsParsing);
  FRIEND_TEST_ALL_PREFIXES(SecurityOriginTest,
                           SuboriginsIsSameSchemeHostPortAndSuborigin);

  SecurityOrigin();
  explicit SecurityOrigin(const KURL&);
  explicit SecurityOrigin(const SecurityOrigin*);

  // FIXME: Rename this function to something more semantic.
  bool PassesFileCheck(const SecurityOrigin*) const;
  void BuildRawString(StringBuilder&, bool include_suborigin) const;

  String ToRawStringIgnoreSuborigin() const;
  static bool DeserializeSuboriginAndProtocolAndHost(const String&,
                                                     const String&,
                                                     String&,
                                                     String&,
                                                     String&);

  bool HasSameSuboriginAs(const SecurityOrigin* other) const;

  String protocol_;
  String host_;
  String domain_;
  Suborigin suborigin_;
  unsigned short port_;
  unsigned short effective_port_;
  bool is_unique_;
  bool universal_access_;
  bool domain_was_set_in_dom_;
  bool can_load_local_resources_;
  bool block_local_access_from_local_origin_;
  bool is_unique_origin_potentially_trustworthy_;
};

}  // namespace blink

#endif  // SecurityOrigin_h