Whitelist

Whitelist Guide

Domain whitelisting is a security model that controls access to external domains over which your application has no control. Cordova provides a configurable security policy to define which external sites may be accessed. By default, new apps are configured to allow access to any site. Before moving your application to production, you should formulate a whitelist and allow access to specific network domains and subdomains.

For Android (as of its 4.0 release), Cordova's security policy is extensible via a plugin interface. Your app should use the cordova-plugin-whitelist, as it provides better security and configurability than earlier versions of Cordova. While it is possible to implement your own whitelist plugin, it is not recommended unless your app has very specific security policy needs. See the cordova-plugin-whitelist for details on usage and configuration.

For other platforms, Cordova adheres to the W3C Widget Access specification, which relies on the <access> element within the app's config.xml file to enable network access to specific domains. For projects that rely on the CLI workflow described in The Command-Line Interface, this file is located in the project's top-level directory. Otherwise for platform-specific development paths, locations are listed in the sections below.

The following examples demonstrate <access> whitelist syntax:

• Access to google.com:

  <access origin="http://google.com" />
  

• Access to the secure google.com (https://):

  <access origin="https://google.com" />
  

• Access to the subdomain maps.google.com:

  <access origin="http://maps.google.com" />
  

• Access to all the subdomains on google.com, for example mail.google.com and docs.google.com:

  <access origin="http://*.google.com" />
  

• Access to all domains, for example, google.com and developer.mozilla.org:

  <access origin="*" />
  

This is the default value for newly created CLI projects.

Be aware that some websites may automatically redirect from their home page to a different url, such as using https protocol or to a country-specific domain. For example http://www.google.com will redirect to use SSL/TLS at https://www.google.com, and then may further redirect to a geography such as https://www.google.co.uk. Such scenarios may require modified or additional whitelist entries beyond your initial requirement. Please consider this as you are building your whitelist.

Note that the whitelist applies only to the main Cordova webview, and does not apply to an InAppBrowser webview or opening links in the system web browser.

Android Whitelisting

As above, see cordova-plugin-whitelist for details. For cordova-android prior to 4.0.0, see older versions of this documentation.

iOS Whitelisting

Cordova-ios version 4.0 and greater does not require the cordova-plugin-whitelist plugin to be installed, however it's configuration details apply to iOS too. The <allow-intent> and <allow-navigation> tags are new for cordova-ios 4.x and greater, see the cordova-plugin-whitelist documentation for details on the usage of these tags.

For cordova-ios versions prior to 4.0.0, see the older versions of this documentation.

Application Transport Security (ATS) is new in iOS 9 (Xcode 7). This new feature acts as a whitelist for your app. The cordova cli will automatically convert <access> and <allow-navigation> tags to the appropriate ATS directives.

The <access> and <allow-navigation> tags support these three attributes below, which have their equivalents in ATS:

1. minimum-tls-version (String, defaults to 'TLSv1.2')
2. requires-forward-secrecy (Boolean, defaults to 'true')
3. requires-certificate-transparency (Boolean, defaults to 'false', new in iOS 10)

• example:

  <access origin='https://cordova.apache.org' minimum-tls-version='TLSv1.1' requires-forward-secrecy='false' requires-certificate-transparency='true' />
  

In iOS 10 and above, the <access> tag supports these three attributes below, when paired with the origin wildcard *. These attributes also have their equivalents in ATS:

1. allows-arbitrary-loads-in-media (Boolean, defaults to 'false', new in iOS 10)
2. allows-arbitrary-loads-in-web-content (Boolean, defaults to 'false', new in iOS 10)
3. allows-local-networking (Boolean, defaults to 'false', new in iOS 10)

• example:

  <access origin='*' allows-arbitrary-loads-in-media='true' allows-arbitrary-loads-in-web-content='true' allows-local-networking='true' />
  

See the ATS Technote for more details.

BlackBerry 10 Whitelisting

The whitelisting rules are found in www/config.xml.

BlackBerry 10's use of wildcards differs from other platforms in two ways:

• Any content accessed by XMLHttpRequest must be declared explicitly. Setting origin="*" does not work in this case. Alternatively, all web security may be disabled using the WebSecurity preference described in BlackBerry Configuration:

  <preference name="websecurity" value="disable" />
  

• As an alternative to setting *.domain, set an additional subdomains attribute to true. It should be set to false by default.

  <!-- Narrows access to google.com -->
  <access origin="http://google.com" subdomains="false" />
  
  <!-- Allows access to maps.google.com and docs.google.com -->
  <access origin="http://google.com" subdomains="true" />
  
  <!-- Allows access to all domains, including the local `file://` protocol -->
  <access origin="*" subdomains="true" />
  

For more information on support, see BlackBerry's documentation on the access element.

Windows Phone Whitelisting

The whitelisting rules for Windows Phone 8 are found in the app's config.xml file.