third_party/WebKit/public/platform/WebSecurityOrigin.h

/*
 * Copyright (C) 2010 Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * OWNER OR 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 WebSecurityOrigin_h
#define WebSecurityOrigin_h

#include "public/platform/WebCommon.h"
#include "public/platform/WebString.h"

#if INSIDE_BLINK
#include "wtf/PassRefPtr.h"
#else
#include "url/origin.h"
#endif

namespace blink {

class SecurityOrigin;
class WebSecurityOriginPrivate;
class WebURL;

class WebSecurityOrigin {
 public:
  ~WebSecurityOrigin() { reset(); }

  WebSecurityOrigin() : m_private(0) {}
  WebSecurityOrigin(const WebSecurityOrigin& s) : m_private(0) { assign(s); }
  WebSecurityOrigin& operator=(const WebSecurityOrigin& s) {
    assign(s);
    return *this;
  }

  BLINK_PLATFORM_EXPORT static WebSecurityOrigin createFromString(
      const WebString&);
  BLINK_PLATFORM_EXPORT static WebSecurityOrigin create(const WebURL&);
  BLINK_PLATFORM_EXPORT static WebSecurityOrigin createUnique();

  BLINK_PLATFORM_EXPORT void reset();
  BLINK_PLATFORM_EXPORT void assign(const WebSecurityOrigin&);

  bool isNull() const { return !m_private; }

  BLINK_PLATFORM_EXPORT WebString protocol() const;
  BLINK_PLATFORM_EXPORT WebString host() const;
  BLINK_PLATFORM_EXPORT unsigned short port() const;

  // |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).
  BLINK_PLATFORM_EXPORT unsigned short effectivePort() const;

  BLINK_PLATFORM_EXPORT WebString suborigin() const;

  // A unique WebSecurityOrigin is the least privileged WebSecurityOrigin.
  BLINK_PLATFORM_EXPORT bool isUnique() const;

  // Returns true if this WebSecurityOrigin 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.
  BLINK_PLATFORM_EXPORT bool canAccess(const WebSecurityOrigin&) const;

  // Returns true if this WebSecurityOrigin can read content retrieved from
  // the given URL. For example, call this function before allowing script
  // from a given security origin to receive contents from a given URL.
  BLINK_PLATFORM_EXPORT bool canRequest(const WebURL&) 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.
  BLINK_PLATFORM_EXPORT bool isPotentiallyTrustworthy() const;

  // Returns a string representation of the WebSecurityOrigin.  The empty
  // WebSecurityOrigin is represented by "null".  The representation of a
  // non-empty WebSecurityOrigin resembles a standard URL.
  BLINK_PLATFORM_EXPORT WebString toString() const;

  // Returns true if this WebSecurityOrigin can access usernames and
  // passwords stored in password manager.
  BLINK_PLATFORM_EXPORT bool canAccessPasswordManager() const;

  // Allows this WebSecurityOrigin access to local resources.
  BLINK_PLATFORM_EXPORT void grantLoadLocalResources() const;

#if INSIDE_BLINK
  BLINK_PLATFORM_EXPORT WebSecurityOrigin(WTF::PassRefPtr<SecurityOrigin>);
  BLINK_PLATFORM_EXPORT WebSecurityOrigin& operator=(
      WTF::PassRefPtr<SecurityOrigin>);
  BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<SecurityOrigin>() const;
  BLINK_PLATFORM_EXPORT SecurityOrigin* get() const;
#else
  // TODO(mkwst): A number of properties don't survive a round-trip
  // ('document.domain', for instance).  We'll need to fix that for OOPI-enabled
  // embedders, https://crbug.com/490074.
  operator url::Origin() const {
    return isUnique() ? url::Origin()
                      : url::Origin::CreateFromNormalizedTupleWithSuborigin(
                            protocol().ascii(), host().ascii(), effectivePort(),
                            suborigin().ascii());
  }

  WebSecurityOrigin(const url::Origin& origin) : m_private(0) {
    if (origin.unique()) {
      assign(WebSecurityOrigin::createUnique());
      return;
    }

    // TODO(mkwst): This might open up issues by double-canonicalizing the host.
    assign(WebSecurityOrigin::createFromTupleWithSuborigin(
        WebString::fromUTF8(origin.scheme()),
        WebString::fromUTF8(origin.host()), origin.port(),
        WebString::fromUTF8(origin.suborigin())));
  }
#endif

 private:
  // Present only to facilitate conversion from 'url::Origin'; this constructor
  // shouldn't be used anywhere else.
  BLINK_PLATFORM_EXPORT static WebSecurityOrigin createFromTupleWithSuborigin(
      const WebString& protocol,
      const WebString& host,
      int port,
      const WebString& suborigin);

  void assign(WebSecurityOriginPrivate*);
  WebSecurityOriginPrivate* m_private;
};

}  // namespace blink

#endif