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

/*
 * Copyright (C) 2009 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 OriginAccessEntry_h
#define OriginAccessEntry_h

#include "platform/PlatformExport.h"
#include "wtf/Allocator.h"
#include "wtf/text/WTFString.h"

namespace blink {

class SecurityOrigin;

class PLATFORM_EXPORT OriginAccessEntry {
  USING_FAST_MALLOC(OriginAccessEntry);

 public:
  enum SubdomainSetting {
    // 'www.example.com' matches an OriginAccessEntry for 'example.com'
    AllowSubdomains,

    // 'www.example.com' matches an OriginAccessEntry for 'not-www.example.com'
    AllowRegisterableDomains,

    // 'www.example.com' does not match an OriginAccessEntry for 'example.com'
    DisallowSubdomains
  };

  enum MatchResult {
    MatchesOrigin,
    MatchesOriginButIsPublicSuffix,
    DoesNotMatchOrigin
  };

  // If host is empty string and SubdomainSetting is not DisallowSubdomains, the
  // entry will match all domains in the specified protocol.
  // IPv6 addresses must include brackets (e.g.
  // '[2001:db8:85a3::8a2e:370:7334]', not '2001:db8:85a3::8a2e:370:7334').
  OriginAccessEntry(const String& protocol,
                    const String& host,
                    SubdomainSetting);

  // 'matchesOrigin' requires a protocol match (e.g. 'http' != 'https').
  // 'matchesDomain' relaxes this constraint.
  MatchResult matchesOrigin(const SecurityOrigin&) const;
  MatchResult matchesDomain(const SecurityOrigin&) const;

  const String& protocol() const { return m_protocol; }
  const String& host() const { return m_host; }
  SubdomainSetting subdomainSettings() const { return m_subdomainSettings; }
  bool hostIsIPAddress() const { return m_hostIsIPAddress; }
  const String& registerable() const { return m_registerableDomain; }

 private:
  String m_protocol;
  String m_host;
  String m_registerableDomain;
  SubdomainSetting m_subdomainSettings;
  bool m_hostIsIPAddress;
  bool m_hostIsPublicSuffix;
};

PLATFORM_EXPORT inline bool operator==(const OriginAccessEntry& a,
                                       const OriginAccessEntry& b) {
  return equalIgnoringASCIICase(a.protocol(), b.protocol()) &&
         equalIgnoringASCIICase(a.host(), b.host()) &&
         a.subdomainSettings() == b.subdomainSettings();
}

PLATFORM_EXPORT inline bool operator!=(const OriginAccessEntry& a,
                                       const OriginAccessEntry& b) {
  return !(a == b);
}

}  // namespace blink

#endif  // OriginAccessEntry_h