aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/metal/feature_policy.rb
blob: eecca20dda8a5f310c0d781ef3328d19a9069664 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# frozen_string_literal: true

module ActionController #:nodoc:
  # HTTP Feature Policy is a web standard for defining a mechanism to
  # allow and deny the use of browser features in its own context, and
  # in content within any <iframe> elements in the document.
  #
  # Full details of HTTP Feature Policy specification and guidelines can
  # be found at MDN:
  #
  # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy
  #
  # Examples of usage:
  #
  #   # Global policy
  #   Rails.application.config.feature_policy do |f|
  #     f.camera      :none
  #     f.gyroscope   :none
  #     f.microphone  :none
  #     f.usb         :none
  #     f.fullscreen  :self
  #     f.payment     :self, "https://secure-example.com"
  #   end
  #
  #   # Controller level policy
  #   class PagesController < ApplicationController
  #     feature_policy do |p|
  #       p.geolocation "https://example.com"
  #     end
  #   end
  module FeaturePolicy
    extend ActiveSupport::Concern

    module ClassMethods
      def feature_policy(**options, &block)
        before_action(options) do
          if block_given?
            policy = request.feature_policy.clone
            yield policy
            request.feature_policy = policy
          end
        end
      end
    end
  end
end