secure_headers 6.3.4 → 7.3.0

data/.github/ISSUE_TEMPLATE.md

@@ -1,41 +0,0 @@
-# Feature Requests
-
-## Adding a new header
-
-Generally, adding a new header is always OK. 
-
-* Is the header supported by any user agent? If so, which?
-* What does it do?
-* What are the valid values for the header?
-* Where does the specification live?
-
-## Adding a new CSP directive
-
-* Is the directive supported by any user agent? If so, which?
-* What does it do?
-* What are the valid values for the directive?
-
----
-
-# Bugs
-
-Console errors and deprecation warnings are considered bugs that should be addressed with more precise UA sniffing. Bugs caused by incorrect or invalid UA sniffing are also bugs.
-
-### Expected outcome
-
-Describe what you expected to happen 
-
-1. I configure CSP to do X
-1. When I inspect the response headers, the CSP should have included X
-
-### Actual outcome
-
-1. The generated policy did not include X
-
-### Config
-
-Please provide the configuration (`SecureHeaders::Configuration.default`) you are using including any overrides (`SecureHeaders::Configuration.override`).
-
-### Generated headers
-
-Provide a sample response containing the headers

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,20 +0,0 @@
-## All PRs:
-
-* [ ] Has tests
-* [ ] Documentation updated
-
-## Adding a new header
-
-Generally, adding a new header is always OK.
-
-* Is the header supported by any user agent? If so, which?
-* What does it do?
-* What are the valid values for the header?
-* Where does the specification live?
-
-## Adding a new CSP directive
-
-* Is the directive supported by any user agent? If so, which?
-* What does it do?
-* What are the valid values for the directive?
-

data/.github/workflows/build.yml

@@ -1,24 +0,0 @@
-name: Build + Test
-on: [pull_request]
-
-jobs:
-  build:
-    name: Build + Test
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3 --without guard
-        bundle exec rspec spec
-        bundle exec rubocop
-

data/.github/workflows/github-release.yml

@@ -1,28 +0,0 @@
-name: GitHub Release
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  Publish:
-    permissions:
-      contents: write
-    runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - name: Calculate release name
-        run: |
-          GITHUB_REF=${{ github.ref }}
-          RELEASE_NAME=${GITHUB_REF#"refs/tags/"}
-          echo "RELEASE_NAME=${RELEASE_NAME}" >> $GITHUB_ENV
-      - name: Publish release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: ${{ env.RELEASE_NAME }}
-          draft: false
-          prerelease: false

data/.gitignore

@@ -1,13 +0,0 @@
-*.gem
-*.DS_STORE
-*.rbc
-.bundle
-.config
-.yardoc
-*.log
-Gemfile.lock
-_yardoc
-coverage
-pkg
-rdoc
-spec/reports

data/.rspec

@@ -1,3 +0,0 @@
---order rand
---warnings
---format progress

data/.rubocop.yml

@@ -1,4 +0,0 @@
-inherit_gem:
-  rubocop-github:
-    - config/default.yml
-require: rubocop-performance

data/.ruby-gemset

@@ -1 +0,0 @@
-secureheaders

data/.ruby-version

@@ -1 +0,0 @@
-2.6.6

data/CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at neil.matatall@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -1,41 +0,0 @@
-## Contributing
-
-[fork]: https://github.com/twitter/secureheaders/fork
-[pr]: https://github.com/twitter/secureheaders/compare
-[style]: https://github.com/styleguide/ruby
-[code-of-conduct]: CODE_OF_CONDUCT.md
-
-Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
-
-Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
-
-## Submitting a pull request
-
-0. [Fork][fork] and clone the repository
-0. Configure and install the dependencies: `bundle install`
-0. Make sure the tests pass on your machine: `bundle exec rspec spec`
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, add tests, and make sure the tests still pass and that no warnings are raised
-0. Push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
-
-Here are a few things you can do that will increase the likelihood of your pull request being accepted:
-
-- Write tests.
-- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
-- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
-
-## Releasing
-
-0. Ensure CI is green
-0. Pull the latest code
-0. Increment the version
-0. Run `gem build secure_headers.gemspec`
-0. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem
-0. Test behavior locally, branch deploy, whatever needs to happen
-0. Run `bundle exec rake release`
-
-## Resources
-
-- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)

data/Guardfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-guard :rspec, cmd: "bundle exec rspec", all_on_start: true, all_after_pass: true do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-end

data/Rakefile

@@ -1,32 +0,0 @@
-#!/usr/bin/env rake
-# frozen_string_literal: true
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "net/http"
-require "net/https"
-
-RSpec::Core::RakeTask.new
-
-begin
-  require "rdoc/task"
-rescue LoadError
-  require "rdoc/rdoc"
-  require "rake/rdoctask"
-  RDoc::Task = Rake::RDocTask
-end
-
-begin
-  require "rubocop/rake_task"
-  RuboCop::RakeTask.new
-rescue LoadError
-  task(:rubocop) { $stderr.puts "RuboCop is disabled" }
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "SecureHeaders"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-task default: [:spec, :rubocop]

data/docs/cookies.md

@@ -1,65 +0,0 @@
-## Cookies
-
-SecureHeaders supports `Secure`, `HttpOnly` and [`SameSite`](https://tools.ietf.org/html/draft-west-first-party-cookies-07) cookies. These can be defined in the form of a boolean, or as a Hash for more refined configuration.
-
-__Note__: Regardless of the configuration specified, Secure cookies are only enabled for HTTPS requests.
-
-#### Defaults
-
-By default, all cookies will get both `Secure`, `HttpOnly`, and `SameSite=Lax`.
-
-```ruby
-config.cookies = {
-  secure: true, # defaults to true but will be a no op on non-HTTPS requests
-  httponly: true, # defaults to true
-  samesite: {  # defaults to set `SameSite=Lax`
-    lax: true
-  }
-}
-```
-
-#### Boolean-based configuration
-
-Boolean-based configuration is intended to globally enable or disable a specific cookie attribute. *Note: As of 4.0, you must use OPT_OUT rather than false to opt out of the defaults.*
-
-```ruby
-config.cookies = {
-  secure: true, # mark all cookies as Secure
-  httponly: SecureHeaders::OPT_OUT, # do not mark any cookies as HttpOnly
-}
-```
-
-#### Hash-based configuration
-
-Hash-based configuration allows for fine-grained control.
-
-```ruby
-config.cookies = {
-  secure: { except: ['_guest'] }, # mark all but the `_guest` cookie as Secure
-  httponly: { only: ['_rails_session'] }, # only mark the `_rails_session` cookie as HttpOnly
-}
-```
-
-#### SameSite cookie configuration
-
-SameSite cookies permit either `Strict` or `Lax` enforcement mode options.
-
-```ruby
-config.cookies = {
-  samesite: {
-    strict: true # mark all cookies as SameSite=Strict
-  }
-}
-```
-
-`Strict`, `Lax`, and `None` enforcement modes can also be specified using a Hash.
-
-```ruby
-config.cookies = {
-  samesite: {
-    strict: { only: ['session_id_duplicate'] },
-    lax: { only: ['_guest', '_rails_session', 'device_id'] },
-    none: { only: ['_tracking', 'saml_cookie', 'session_id'] },
-  }
-}
-```

data/docs/hashes.md

@@ -1,64 +0,0 @@
-## Hash
-
-`script`/`style-src` hashes can be used to whitelist inline content that is static. This has the benefit of allowing inline content without opening up the possibility of dynamic javascript like you would with a `nonce`.
-
-You can add hash sources directly to your policy :
-
-```ruby
-::SecureHeaders::Configuration.default do |config|
-   config.csp = {
-     default_src: %w('self')
-
-     # this is a made up value but browsers will show the expected hash in the console.
-     script_src: %w(sha256-123456)
-   }
- end
- ```
-
- You can also use the automated inline script detection/collection/computation of hash source values in your app.
-
- ```bash
- rake secure_headers:generate_hashes
- ```
-
- This will generate a file (`config/secure_headers_generated_hashes.yml` by default, you can override by setting `ENV["secure_headers_generated_hashes_file"]`) containing a mapping of file names with the array of hash values found on that page. When ActionView renders a given file, we check if there are any known hashes for that given file. If so, they are added as values to the header.
-
-```yaml
----
-scripts:
-  app/views/asdfs/index.html.erb:
-  - "'sha256-yktKiAsZWmc8WpOyhnmhQoDf9G2dAZvuBBC+V0LGQhg='"
-styles:
-  app/views/asdfs/index.html.erb:
-  - "'sha256-SLp6LO3rrKDJwsG9uJUxZapb4Wp2Zhj6Bu3l+d9rnAY='"
-  - "'sha256-HSGHqlRoKmHAGTAJ2Rq0piXX4CnEbOl1ArNd6ejp2TE='"
-```
-
-##### Helpers
-
-**This will not compute dynamic hashes** by design. The output of both helpers will be a plain `script`/`style` tag without modification and the known hashes for a given file will be added to `script-src`/`style-src` when `hashed_javascript_tag` and `hashed_style_tag` are used. You can use `raise_error_on_unrecognized_hash = true` to be extra paranoid that you have precomputed hash values for all of your inline content. By default, this will raise an error in non-production environments.
-
-```erb
-<%= hashed_style_tag do %>
-body {
-  background-color: black;
-}
-<% end %>
-
-<%= hashed_style_tag do %>
-body {
-  font-size: 30px;
-  font-color: green;
-}
-<% end %>
-
-<%= hashed_javascript_tag do %>
-console.log(1)
-<% end %>
-```
-
-```
-Content-Security-Policy: ...
- script-src 'sha256-yktKiAsZWmc8WpOyhnmhQoDf9G2dAZvuBBC+V0LGQhg=' ... ;
- style-src 'sha256-SLp6LO3rrKDJwsG9uJUxZapb4Wp2Zhj6Bu3l+d9rnAY=' 'sha256-HSGHqlRoKmHAGTAJ2Rq0piXX4CnEbOl1ArNd6ejp2TE=' ...;
-```

data/docs/named_overrides_and_appends.md

@@ -1,104 +0,0 @@
-## Named Appends
-
-Named Appends are blocks of code that can be reused and composed during requests. e.g. If a certain partial is rendered conditionally, and the csp needs to be adjusted for that partial, you can create a named append for that situation. The value returned by the block will be passed into `append_content_security_policy_directives`. The current request object is passed as an argument to the block for even more flexibility. Reusing a configuration name is not allowed and will throw an exception.
-
-```ruby
-def show
-  if include_widget?
-    @widget = widget.render
-    use_content_security_policy_named_append(:widget_partial)
-  end
-end
-
-
-SecureHeaders::Configuration.named_append(:widget_partial) do |request|
-  SecureHeaders.override_x_frame_options(request, "DENY")
-  if request.controller_instance.current_user.in_test_bucket?
-    { child_src: %w(beta.thirdpartyhost.com) }
-  else
-    { child_src: %w(thirdpartyhost.com) }
-  end
-end
-```
-
-You can use as many named appends as you would like per request, but be careful because order of inclusion matters. Consider the following:
-
-```ruby
-SecureHeader::Configuration.default do |config|
-  config.csp = { default_src: %w('self')}
-end
-
-SecureHeaders::Configuration.named_append(:A) do |request|
-  { default_src: %w(myhost.com) }
-end
-
-SecureHeaders::Configuration.named_append(:B) do |request|
-  { script_src: %w('unsafe-eval') }
-end
-```
-
-The following code will produce different policies due to the way policies are normalized (e.g. providing a previously undefined directive that inherits from `default-src`, removing host source values when `*` is provided. Removing `'none'` when additional values are present, etc.):
-
-```ruby
-def index
-  use_content_security_policy_named_append(:A)
-  use_content_security_policy_named_append(:B)
-  # produces default-src 'self' myhost.com; script-src 'self' myhost.com 'unsafe-eval';
-end
-
-def show
-  use_content_security_policy_named_append(:B)
-  use_content_security_policy_named_append(:A)
-  # produces default-src 'self' myhost.com; script-src 'self' 'unsafe-eval';
-end
-```
-
-
-## Named overrides
-
-Named overrides serve two purposes:
-
-* To be able to refer to a configuration by simple name.
-* By precomputing the headers for a named configuration, the headers generated once and reused over every request.
-
-To use a named override, drop a `SecureHeaders::Configuration.override` block **outside** of method definitions and then declare which named override you'd like to use. You can even override an override.
-
-```ruby
-class ApplicationController < ActionController::Base
-  SecureHeaders::Configuration.default do |config|
-    config.csp = {
-      default_src: %w('self'),
-      script_src: %w(example.org)
-    }
-  end
-
-  # override default configuration
-  SecureHeaders::Configuration.override(:script_from_otherdomain_com) do |config|
-    config.csp[:script_src] << "otherdomain.com"
-  end
-end
-
-class MyController < ApplicationController
-  def index
-    # Produces default-src 'self'; script-src example.org otherdomain.com
-    use_secure_headers_override(:script_from_otherdomain_com)
-  end
-
-  def show
-    # Produces default-src 'self'; script-src example.org otherdomain.org evenanotherdomain.com
-    use_secure_headers_override(:another_config)
-  end
-end
-```
-
-Reusing a configuration name is not allowed and will throw an exception.
-
-By default, a no-op configuration is provided. No headers will be set when this default override is used.
-
-```ruby
-class MyController < ApplicationController
-  def index
-    SecureHeaders.opt_out_of_all_protection(request)
-  end
-end
-```

data/docs/per_action_configuration.md

@@ -1,139 +0,0 @@
-## Per-action configuration
-
-You can override the settings for a given action by producing a temporary override. Be aware that because of the dynamic nature of the value, the header values will be computed per request.
-
-```ruby
-# Given a config of:
-::SecureHeaders::Configuration.default do |config|
-   config.csp = {
-     default_src: %w('self'),
-     script_src: %w('self')
-   }
- end
-
-class MyController < ApplicationController
-  def index
-    # Append value to the source list, override 'none' values
-    # Produces: default-src 'self'; script-src 'self' s3.amazonaws.com; object-src 'self' www.youtube.com
-    append_content_security_policy_directives(script_src: %w(s3.amazonaws.com), object_src: %w('self' www.youtube.com))
-
-    # Overrides the previously set source list, override 'none' values
-    # Produces: default-src 'self'; script-src s3.amazonaws.com; object-src 'self'
-    override_content_security_policy_directives(script_src: %w(s3.amazonaws.com), object_src: %w('self'))
-
-    # Global settings default to "sameorigin"
-    override_x_frame_options("DENY")
-  end
-```
-
-The following methods are available as controller instance methods. They are also available as class methods, but require you to pass in the `request` object.
-* `append_content_security_policy_directives(hash)`: appends each value to the corresponding CSP app-wide configuration.
-* `override_content_security_policy_directives(hash)`: merges the hash into the app-wide configuration, overwriting any previous config
-* `override_x_frame_options(value)`: sets the `X-Frame-Options header` to `value`
-
-## Appending / overriding Content Security Policy
-
-When manipulating content security policy, there are a few things to consider. The default header value is `default-src https:` which corresponds to a default configuration of `{ default_src: %w(https:)}`.
-
-#### Append to the policy with a directive other than `default_src`
-
-The value of `default_src` is joined with the addition if the it is a [fetch directive](https://w3c.github.io/webappsec-csp/#directives-fetch). Note the `https:` is carried over from the `default-src` config. If you do not want this, use `override_content_security_policy_directives` instead. To illustrate:
-
-```ruby
-::SecureHeaders::Configuration.default do |config|
-   config.csp = {
-     default_src: %w('self')
-   }
- end
- ```
-
-Code  | Result
-------------- | -------------
-`append_content_security_policy_directives(script_src: %w(mycdn.com))` | `default-src 'self'; script-src 'self' mycdn.com`
-`override_content_security_policy_directives(script_src: %w(mycdn.com))`  | `default-src 'self'; script-src mycdn.com`
-
-#### Nonce
-
-You can use a view helper to automatically add nonces to script tags. Currently, using a nonce helper or calling `content_security_policy_nonce` will populate all configured CSP headers, including report-only and enforced policies. 
-
-```erb
-<%= nonced_javascript_tag do %>
-console.log("nonced!");
-<% end %>
-
-<%= nonced_style_tag do %>
-body {
-  background-color: black;
-}
-<% end %>
-
-<%= nonced_javascript_include_tag "include.js" %>
-
-<%= nonced_javascript_pack_tag "pack.js" %>
-
-<%= nonced_stylesheet_link_tag "link.css" %>
-
-<%= nonced_stylesheet_pack_tag "pack.css" %>
-```
-
-becomes:
-
-```html
-<script nonce="/jRAxuLJsDXAxqhNBB7gg7h55KETtDQBXe4ZL+xIXwI=">
-console.log("nonced!")
-</script>
-<style nonce="/jRAxuLJsDXAxqhNBB7gg7h55KETtDQBXe4ZL+xIXwI=">
-body {
-  background-color: black;
-}
-</style>
-```
-
-```
-
-Content-Security-Policy: ...
-  script-src 'nonce-/jRAxuLJsDXAxqhNBB7gg7h55KETtDQBXe4ZL+xIXwI=' ...;
-  style-src 'nonce-/jRAxuLJsDXAxqhNBB7gg7h55KETtDQBXe4ZL+xIXwI=' ...;
-```
-
-`script`/`style-nonce` can be used to whitelist inline content. To do this, call the `content_security_policy_script_nonce` or `content_security_policy_style_nonce` then set the nonce attributes on the various tags.
-
-```erb
-<script nonce="<%= content_security_policy_script_nonce %>">
-  console.log("whitelisted, will execute")
-</script>
-
-<script nonce="lol">
-  console.log("won't execute, not whitelisted")
-</script>
-
-<script>
-  console.log("won't execute, not whitelisted")
-</script>
-```
-
-## Clearing browser cache
-
-You can clear the browser cache after the logout request by using the following.
-
-``` ruby
-class ApplicationController < ActionController::Base
-  # Configuration override to send the Clear-Site-Data header.
-  SecureHeaders::Configuration.override(:clear_browser_cache) do |config|
-    config.clear_site_data = SecureHeaders::ClearSiteData::ALL_TYPES
-  end
-
-
-  # Clears the browser's cache for browsers supporting the Clear-Site-Data
-  # header.
-  #
-  # Returns nothing.
-  def clear_browser_cache
-    SecureHeaders.use_secure_headers_override(request, :clear_browser_cache)
-  end
-end
-
-class SessionsController < ApplicationController
-  after_action  :clear_browser_cache, only: :destroy
-end
-```

data/docs/sinatra.md

@@ -1,25 +0,0 @@
-## Sinatra
-
-Here's an example using SecureHeaders for Sinatra applications:
-
-```ruby
-require 'rubygems'
-require 'sinatra'
-require 'haml'
-require 'secure_headers'
-
-use SecureHeaders::Middleware
-
-SecureHeaders::Configuration.default do |config|
-  ...
-end
-
-class Donkey < Sinatra::Application
-  set :root, APP_ROOT
-
-  get '/' do
-    SecureHeaders.override_x_frame_options(request, SecureHeaders::OPT_OUT)
-    haml :index
-  end
-end
-```