This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The HTTP Feature-Policy
header geolocation
directive controls whether the current document is allowed to use the Geolocation
Interface. When this policy is enabled, calls to getCurrentPosition()
and watchPosition()
will cause those functions' callbacks to be invoked with a PositionError
code of PERMISSION_DENIED
.
By default, the Geolocation API can be used within top-level documents and their same-origin child frames. This directive allows or prevents cross-origin frames from accessing geolocation. This includes same-origin frames.
Syntax
Feature-Policy: geolocation <allowlist>;
- <allowlist>
An allowlist is a list of origins that takes one or more of the following values, separated by spaces:
*
: The feature will be allowed in this document, and all nested browsing contexts (iframes) regardless of their origin.'self'
: The feature will be allowed in this document, and in all nested browsing contexts (iframes) in the same origin.'src'
: (In an iframe allow attribute only) The feature will be allowed in this iframe, as long as the document loaded into it comes from the same origin as the URL in the iframe's src attribute.'none'
: The feature is disabled in top-level and nested browsing contexts.- <origin(s)>: The feature is allowed for specific origins (for example, https://example.com). Origins should be separated by a space.
The values
*
(enable for all origins) or'none'
(disable for all origins) may only be used alone, while'self'
and'src'
may be used with one or more origins.Features are each defined to have a default allowlist, which is one of:
*
: The feature is allowed by default in top-level browsing contexts and all nested browsing contexts (iframes).'self'
: The feature is allowed by default in top-level browsing contexts and in nested browsing contexts (iframes) in the same origin. The feature is not allowed in cross-origin documents in nested browsing contexts.'none'
: The feature is disabled in top-level and nested browsing contexts.
'self'
.
Examples
General example
SecureCorp Inc. wants to disable the Geolocation API within all browsing contexts except for its own origin and those whose origin is https://example.com
. It can do so by delivering the following HTTP response header to define a feature policy:
Feature-Policy: geolocation 'self' https://example.com
With an <iframe> element
FastCorp Inc. wants to disable geolocation
for all cross-origin child frames, except for a specific <iframe>. It can do so by delivering the following HTTP response header to define a feature policy:
Feature-Policy: geolocation 'self'
Then include an allow attribute on the <iframe>
element:
<iframe src="https://other.com/map" allow="geolocation"></iframe>
iframe attributes can selectively enable features in certain frames, and not in others, even if those frames contain documents from the same origin.
Specifications
Specification | Status | Comment |
---|---|---|
Feature Policy | Editor's Draft | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
geolocation | Chrome Full support 60 | Edge Full support 79 | Firefox
Full support
74
| IE No support No | Opera Full support 47 | Safari No support No | WebView Android Full support 60 | Chrome Android Full support 60 | Firefox Android
Full support
65
| Opera Android Full support 44 | Safari iOS No support No | Samsung Internet Android Full support 8.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- User must explicitly enable this feature.
- User must explicitly enable this feature.