netwerk/dns/nsIEffectiveTLDService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIURI;
   9
  10 [scriptable, uuid(68067eb5-ad8d-43cb-a043-1cc85ebe06e7)]
  11 interface nsIEffectiveTLDService : nsISupports
  12 {
  13     /**
  14      * Returns the public suffix of a URI. A public suffix is the highest-level domain
  15      * under which individual domains may be registered; it may therefore contain one
  16      * or more dots. For example, the public suffix for "www.bbc.co.uk" is "co.uk",
  17      * because the .uk TLD does not allow the registration of domains at the
  18      * second level ("bbc.uk" is forbidden).
  19      *
  20      * The public suffix will be returned encoded in ASCII/ACE and will be normalized
  21      * according to RFC 3454, i.e. the same encoding returned by nsIURI::GetAsciiHost().
  22      * If consumers wish to compare the result of this method against the host from
  23      * another nsIURI, the host should be obtained using nsIURI::GetAsciiHost().
  24      * In the case of nested URIs, the innermost URI will be used.
  25      *
  26      * @param   aURI   The URI to be analyzed
  27      *
  28      * @returns the public suffix
  29      *
  30      * @throws NS_ERROR_UNEXPECTED
  31      *         or other error returned by nsIIDNService::normalize when
  32      *         the hostname contains characters disallowed in URIs
  33      * @throws NS_ERROR_HOST_IS_IP_ADDRESS
  34      *         if the host is a numeric IPv4 or IPv6 address (as determined by
  35      *         the success of a call to PR_StringToNetAddr()).
  36      */
  37     ACString getPublicSuffix(in nsIURI aURI);
  38
  39     /**
  40      * Similar to getPublicSuffix, but the suffix is validated against
  41      * the Public Suffix List. If the suffix is unknown this will return
  42      * an empty string.
  43      *
  44      * @param   aURI   The URI to be analyzed
  45      * @returns the public suffix if known, an empty string otherwise
  46      * @see     getPublicSuffixFromHost()
  47      */
  48     ACString getKnownPublicSuffix(in nsIURI aURI);
  49
  50     /**
  51      * Returns the base domain of a URI; that is, the public suffix with a given
  52      * number of additional domain name parts. For example, the result of this method
  53      * for "www.bbc.co.uk", depending on the value of aAdditionalParts parameter, will
  54      * be:
  55      *
  56      *    0 (default) -> bbc.co.uk
  57      *    1           -> www.bbc.co.uk
  58      *
  59      * Similarly, the public suffix for "www.developer.mozilla.org" is "org", and the base
  60      * domain will be:
  61      *
  62      *    0 (default) -> mozilla.org
  63      *    1           -> developer.mozilla.org
  64      *    2           -> www.developer.mozilla.org
  65      *
  66      * The base domain will be returned encoded in ASCII/ACE and will be normalized
  67      * according to RFC 3454, i.e. the same encoding returned by nsIURI::GetAsciiHost().
  68      * If consumers wish to compare the result of this method against the host from
  69      * another nsIURI, the host should be obtained using nsIURI::GetAsciiHost().
  70      * In the case of nested URIs, the innermost URI will be used.
  71      *
  72      * @param   aURI               The URI to be analyzed
  73      * @param   aAdditionalParts   Number of domain name parts to be
  74      *                             returned in addition to the public suffix
  75      *
  76      * @returns the base domain (public suffix plus the requested number of additional parts)
  77      *
  78      * @throws NS_ERROR_UNEXPECTED
  79      *         or other error returned by nsIIDNService::normalize when
  80      *         the hostname contains characters disallowed in URIs
  81      * @throws NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS
  82      *         when there are insufficient subdomain levels in the hostname to satisfy the
  83      *         requested aAdditionalParts value.
  84      * @throws NS_ERROR_HOST_IS_IP_ADDRESS
  85      *         if aHost is a numeric IPv4 or IPv6 address (as determined by
  86      *         the success of a call to PR_StringToNetAddr()).
  87      *
  88      * @see    getPublicSuffix()
  89      */
  90     ACString getBaseDomain(in nsIURI aURI, [optional] in uint32_t aAdditionalParts);
  91
  92     /**
  93      * NOTE: It is strongly recommended to use getPublicSuffix() above if a suitable
  94      * nsIURI is available. Only use this method if this is not the case.
  95      *
  96      * Returns the public suffix of a host string. Otherwise identical to getPublicSuffix().
  97      *
  98      * @param   aHost   The host to be analyzed. Any additional parts (e.g. scheme,
  99      *                  port, or path) will cause this method to throw. ASCII/ACE and
 100      *                  UTF8 encodings are acceptable as input; normalization will
 101      *                  be performed as specified in getBaseDomain().
 102      *
 103      * @see     getPublicSuffix()
 104      */
 105     ACString getPublicSuffixFromHost(in AUTF8String aHost);
 106
 107     /**
 108      * Similar to getPublicSuffixFromHost, but the suffix is validated against
 109      * the Public Suffix List. If the suffix is unknown this will return
 110      * an empty string.
 111      *
 112      * @param   aHost   The host to be analyzed.
 113      * @returns the public suffix if known, an empty string otherwise
 114      * @see     getPublicSuffixFromHost()
 115      */
 116     ACString getKnownPublicSuffixFromHost(in AUTF8String aHost);
 117
 118     /**
 119      * NOTE: It is strongly recommended to use getBaseDomain() above if a suitable
 120      * nsIURI is available. Only use this method if this is not the case.
 121      *
 122      * Returns the base domain of a host string. Otherwise identical to getBaseDomain().
 123      *
 124      * @param   aHost   The host to be analyzed. Any additional parts (e.g. scheme,
 125      *                  port, or path) will cause this method to throw. ASCII/ACE and
 126      *                  UTF8 encodings are acceptable as input; normalization will
 127      *                  be performed as specified in getBaseDomain().
 128      *
 129      * @see     getBaseDomain()
 130      */
 131     ACString getBaseDomainFromHost(in AUTF8String aHost, [optional] in uint32_t aAdditionalParts);
 132
 133     /**
 134      * Returns the parent sub-domain of a host string. If the host is a base
 135      * domain, it will throw NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS.
 136      *
 137      * For example: "player.bbc.co.uk" would return "bbc.co.uk" and
 138      *              "bbc.co.uk" would throw NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS.
 139      *
 140      * @param   aHost   The host to be analyzed. Any additional parts (e.g. scheme,
 141      *                  port, or path) will cause this method to throw. ASCII/ACE and
 142      *                  UTF8 encodings are acceptable as input; normalization will
 143      *                  be performed as specified in getBaseDomain().
 144      */
 145     ACString getNextSubDomain(in AUTF8String aHost);
 146
 147     /**
 148      * Returns true if the |aInput| in is part of the root domain of |aHost|.
 149      * For example, if |aInput| is "www.mozilla.org", and we pass in
 150      * "mozilla.org" as |aHost|, this will return true.  It would return false
 151      * the other way around.
 152      *
 153      * @param aInput The host to be analyzed.
 154      * @param aHost  The host to compare to.
 155      */
 156     bool hasRootDomain(in AUTF8String aInput, in AUTF8String aHost);
 157 };
 158