// Copyright © 2014 The CefSharp Authors. All rights reserved. // // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file. using System; using System.Collections.Generic; using System.Linq; using CefSharp.Enums; using CefSharp.Internals; namespace CefSharp { /// /// Used in conjunction with CefSettings.RegisterScheme to register a scheme. /// You can register your own custom scheme e.g. custom:// if you are using a build in scheme /// (http/https) then you should directly register your using /// Cef.GetGlobalRequestContext().RegisterSchemeHandlerFactory - make sure the Global RequestContext has /// been initialized before doing so, you can use /// for notification of RequestContext initialization (Pass an IBrowserProcessHandler instance to Cef.Initialize) /// public sealed class CefCustomScheme { private SchemeOptions schemeOptions; /// /// Schema Name e.g. custom /// public string SchemeName { get; set; } /// /// Optional Domain Name. An empty value for a standard scheme /// will cause the factory to match all domain names. The |domain_name| value /// will be ignored for non-standard schemes. /// public string DomainName { get; set; } /// /// If true the scheme will be treated as a standard scheme. /// Standard schemes are subject to URL canonicalization and parsing rules as /// defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available /// at http://www.ietf.org/rfc/rfc1738.txt /// /// In particular, the syntax for standard scheme URLs must be of the form: ///
        ///  [scheme]://[username]:[password]@[host]:[port]/[url-path]
        /// 
/// Standard scheme URLs must have a host component that is a fully qualified /// domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of /// RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the /// simplest case and "scheme://username:password@host:port/path" in the most /// explicit case. For example, "scheme:host/path" and "scheme:///host/path" /// will both be canonicalized to "scheme://host/path". The origin of a /// standard scheme URL is the combination of scheme, host and port (i.e., /// "scheme://host:port" in the most explicit case). /// /// For non-standard scheme URLs only the "scheme:" component is parsed and /// canonicalized. The remainder of the URL will be passed to the handler /// as-is. For example, "scheme:///some%20text" will remain the same. /// Non-standard scheme URLs cannot be used as a target for form submission. ///
public bool IsStandard { get { return schemeOptions.HasFlag(SchemeOptions.Standard); } set { if (value) { schemeOptions |= SchemeOptions.Standard; } else { schemeOptions &= ~SchemeOptions.Standard; } } } /// /// If true the scheme will be treated as local (i.e. with the /// same security rules as those applied to "file" URLs). Normal pages cannot /// link to or access local URLs. Also, by default, local URLs can only perform /// XMLHttpRequest calls to the same URL (origin + path) that originated the /// request. To allow XMLHttpRequest calls from a local URL to other URLs with /// the same origin set the CefSettings.file_access_from_file_urls_allowed /// value to true. To allow XMLHttpRequest calls from a local URL to all /// origins set the CefSettings.universal_access_from_file_urls_allowed value /// to true. /// public bool IsLocal { get { return schemeOptions.HasFlag(SchemeOptions.Local); } set { if (value) { schemeOptions |= SchemeOptions.Local; } else { schemeOptions &= ~SchemeOptions.Local; } } } /// /// If true the scheme will be treated as display-isolated. /// This means that pages cannot display these URLs unless they are /// from the same scheme. For example, pages in another origin cannot create /// iframes or hyperlinks to URLs with this scheme. /// public bool IsDisplayIsolated { get { return schemeOptions.HasFlag(SchemeOptions.DisplayIsolated); } set { if (value) { schemeOptions |= SchemeOptions.DisplayIsolated; } else { schemeOptions &= ~SchemeOptions.DisplayIsolated; } } } /// /// If true the scheme will be treated with the same security /// rules as those applied to "https" URLs. For example, loading this scheme /// from other secure schemes will not trigger mixed content warnings. /// public bool IsSecure { get { return schemeOptions.HasFlag(SchemeOptions.Secure); } set { if (value) { schemeOptions |= SchemeOptions.Secure; } else { schemeOptions &= ~SchemeOptions.Secure; } } } /// /// If true the scheme can be sent CORS requests. /// This value should be true in most cases where IsStandard is true. /// public bool IsCorsEnabled { get { return schemeOptions.HasFlag(SchemeOptions.CorsEnabled); } set { if (value) { schemeOptions |= SchemeOptions.CorsEnabled; } else { schemeOptions &= ~SchemeOptions.CorsEnabled; } } } /// /// If true the scheme can bypass Content-Security-Policy(CSP) checks. /// This value should be false in most cases where IsStandard is true. /// public bool IsCSPBypassing { get { return schemeOptions.HasFlag(SchemeOptions.CspBypassing); } set { if (value) { schemeOptions |= SchemeOptions.CspBypassing; } else { schemeOptions &= ~SchemeOptions.CspBypassing; } } } /// /// If true the scheme can perform Fetch API requests. /// public bool IsFetchEnabled { get { return schemeOptions.HasFlag(SchemeOptions.FetchEnabled); } set { if (value) { schemeOptions |= SchemeOptions.FetchEnabled; } else { schemeOptions &= ~SchemeOptions.FetchEnabled; } } } /// /// Factory Class that creates instances /// for handling scheme requests. Leave this null if you wish to manually register the /// scheme handler with the relevant RequestContext. /// public ISchemeHandlerFactory SchemeHandlerFactory { get; set; } /// /// Gets the underlying scheme options that represents /// public SchemeOptions Options { get { return schemeOptions; } } /// /// Creates a new CefCustomScheme. /// public CefCustomScheme() { schemeOptions = SchemeOptions.Standard | SchemeOptions.Secure | SchemeOptions.CorsEnabled; } /// /// Creates a new CefCustomScheme. /// /// scheme name /// scheme options public CefCustomScheme(string schemeName, SchemeOptions options) { SchemeName = schemeName; schemeOptions = options; } /// /// Method used internally /// /// command line arguments /// list of scheme objects public static List ParseCommandLineArguments(IEnumerable args) { var schemes = args.GetArgumentValue(CefSharpArguments.CustomSchemeArgument); var customSchemes = new List(); if (!string.IsNullOrEmpty(schemes)) { schemes.Split(';').ToList().ForEach(x => { var tokens = x.Split('|'); var schemeName = tokens[0]; var schemeOptions = SchemeOptions.None; Enum.TryParse(tokens[1], out schemeOptions); var customScheme = new CefCustomScheme(schemeName, schemeOptions); customSchemes.Add(customScheme); }); } return customSchemes; } } }