npapi_plugin/origin.h

   1 /*
   2  * Copyright 2008, Google Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32
  33 #ifndef NATIVE_CLIENT_NPAPI_PLUGIN_ORIGIN_H_
  34 #define NATIVE_CLIENT_NPAPI_PLUGIN_ORIGIN_H_
  35
  36 #include <string>
  37
  38 namespace nacl {
  39
  40 /*
  41  * Given an URL, chop off the pathspec part, returning a canonicalized
  42  * representation of the protospec, host, and optional
  43  * username/password parts of the URL.  If there are any errors, an
  44  * empty string is returned.
  45  *
  46  * For example, this function would perform the following mapping
  47  *
  48  * "HTTP://WWW.Google.Com/foo/bar" -> "http://www.google.com"
  49  * "hTtP://News.gOoGle.cOm/news/section?pz=1&ned=us&topic=t"
  50  *      -> "http://news.google.com"
  51  * "file:///path/to/file" -> "file://localhost"
  52  */
  53 std::string UrlToOrigin(std::string url);
  54
  55 /*
  56  * Given an origin string as returned above, return if it is in our
  57  * internal whitelist.  The current implementation just uses a
  58  * statically compiled-in array of allowed origin strings; future
  59  * implementations may use a file or browser config: data and provide
  60  * a GUI to manage it.
  61  */
  62 bool OriginIsInWhitelist(std::string origin);
  63
  64 }
  65
  66 #endif  // NATIVE_CLIENT_NPAPI_PLUGIN_ORIGIN_H_