csp_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8495dd0155b2432348fbdcfc120b023c6f2da4bc
+  data.tar.gz: 380b90a23551c232282fcfaa6981fcabab582990
+SHA512:
+  metadata.gz: 2d63e8e4175bd1d244eab1c29827ee23436717ac3a55d6e04c3b0d19bdcbb664a9b8a55f7e935762fc656c41fb9b42bfd1b501d69157c108395e1bf0571a38a6
+  data.tar.gz: 629d5859c8a214378fa7e4c41c3d9ddd468ad6bdda93e1fc7008cc3973ebf01964ebf8884c8d22cdafe4ad1983f770a2be1e09b2acea6cbdb97cadea310bea17

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+install: bundle install --jobs=3 --retry=3
+rvm:
+  - "2.3.3"
+  - "2.4.0"
+script:
+  - bundle exec rake test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mikeycgto@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-minitest'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Coyne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# CspBuilder
+
+[![Travis Build Status](https://travis-ci.org/Sigient/csp_builder.svg)](https://travis-ci.org/Sigient/csp_builder)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+Content Security Policy string builder. Create rich Content Security
+Policies headers using this easy to use builder class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csp_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csp_builder
+
+## Usage
+
+Here is a quick example. Please see the
+[docs](http://www.rubydoc.info/github/Sigient/csp_builder) for more
+details!
+
+
+```ruby
+csp = CspBuilder.new.
+  script_src("https://*.cloudfront.net", :self).
+  style_src("https://*.cloudfront.net").
+  img_src('*').
+  frame_ancestors(:self).
+  upgrade_insecure_requests
+
+# Get the compiled CSP string:
+# "script-src https://*.cloudfront.net 'self'; style-src https://*.cloudfront.net; img-src *; frame-ancestors 'self'; upgrade-insecure-requests"
+csp.compile!
+```
+
+More examples using middleware and controllers coming soon!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Sigient/csp_builder. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csp_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csp_builder.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csp_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'csp_builder'
+  spec.version       = CspBuilder::VERSION
+  spec.authors       = ['Michael Coyne', 'Sigient']
+  spec.email         = ['mikeycgto@gmail.com']
+
+  spec.summary       = 'Content Security Policy string builder'
+  spec.description   = 'Create rich Content Security Policies using this easy to use builder class'
+  spec.homepage      = 'https://github.com/Sigient/csp_builder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/csp_builder/constants.rb

@@ -0,0 +1,23 @@
+class CspBuilder
+  # Fetch directive define the locations where various
+  # resource types can be loaded from. These directive
+  # all end in with "-src"
+  FETCH_DIRECTIVES = %i[
+    child connect default font frame img
+    manifest media object script style worker
+  ].freeze
+
+  # Value directives are either document, navigation,
+  # reporting or other type of directives that require
+  # a value
+  VALUE_DIRECTIVES = %i[
+    base-uri form-action frame-ancestors
+    plugin-types report-uri require-sri-for
+  ].freeze
+
+  # Meta directives do not require a value and can be
+  # used in a <meta> tag in the document's <head>
+  META_DIRECTIVES = %i[
+    block-all-mixed-content upgrade-insecure-requests
+  ].freeze
+end

data/lib/csp_builder/version.rb

@@ -0,0 +1,3 @@
+class CspBuilder
+  VERSION = '0.1.0'.freeze
+end

data/lib/csp_builder.rb

@@ -0,0 +1,142 @@
+require 'csp_builder/version'
+require 'csp_builder/constants'
+
+# Content Security Policy builder class. This class provides a lot
+# of methods for making it easier to compose Content Security Policies
+# for your web applications.
+#
+# @example Creating a CSP string
+#   csp = CspBuilder.new.
+#     script_src("https://*.cloudfront.net", :self).
+#     style_src("https://*.cloudfront.net").
+#     img_src('*').
+#     frame_ancestors(:self).
+#     upgrade_insecure_requests
+#
+#   # Get the compiled CSP string:
+#   # "script-src https://*.cloudfront.net 'self'; style-src https://*.cloudfront.net; img-src *; frame-ancestors 'self'; upgrade-insecure-requests"
+#   csp.compile!
+class CspBuilder
+  # Final result string. This is set by +compile!+
+  attr_reader :result
+
+  # Returns a new instance of +CspBuilder+
+  def initialize
+    @directives = {}
+    @result     = nil
+  end
+
+  # Returns whether the result has been compiled or not
+  # @return [Boolean]
+  def compiled?
+    !@result.nil?
+  end
+
+  # Compile Content Security Policy with all of the defined directives
+  # @return [String] compiled CSP string
+  def compile!
+    @directives.freeze unless @directives.frozen?
+
+    @result ||= compile.freeze
+  end
+
+  # @!macro [new] method_doc
+  #   Generated method
+  #   @param values [Array<String, Symbol>] one or more value; Symbols are wrapped in single quotes
+  #   @return [CspBuilder] self
+
+  # @!method child_src(*values)
+  #   @macro method_doc
+  # @!method connect_src(*values)
+  #   @macro method_doc
+  # @!method default_src(*values)
+  #   @macro method_doc
+  # @!method font_src(*values)
+  #   @macro method_doc
+  # @!method frame_src(*values)
+  #   @macro method_doc
+  # @!method img_src(*values)
+  #   @macro method_doc
+  # @!method manifest_src(*values)
+  #   @macro method_doc
+  # @!method media_src(*values)
+  #   @macro method_doc
+  # @!method object_src(*values)
+  #   @macro method_doc
+  # @!method script_src(*values)
+  #   @macro method_doc
+  # @!method style_src(*values)
+  #   @macro method_doc
+  # @!method worker_src(*values)
+  #   @macro method_doc
+  FETCH_DIRECTIVES.each do |type|
+    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+      def #{type}_src(*values)
+        values.each { |value| set_directive! :'#{type}-src', value }
+
+        self
+      end
+    RUBY_EVAL
+  end
+
+  # @!method base_uri(*values)
+  #   @macro method_doc
+  # @!method form_action(*values)
+  #   @macro method_doc
+  # @!method frame_ancestors(*values)
+  #   @macro method_doc
+  # @!method plugin_types(*values)
+  #   @macro method_doc
+  # @!method report_uri(*values)
+  #   @macro method_doc
+  # @!method require_sri_for(*values)
+  #   @macro method_doc
+  VALUE_DIRECTIVES.each do |type|
+    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+      def #{type.to_s.gsub('-', '_')}(*values)
+        values.each { |value| set_directive! :'#{type}', value }
+
+        self
+      end
+    RUBY_EVAL
+  end
+
+  # @!method block_all_mixed_content(*values)
+  #   @macro method_doc
+  # @!method upgrade_insecure_requests(*values)
+  #   @macro method_doc
+  META_DIRECTIVES.each do |type|
+    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+      def #{type.to_s.gsub('-', '_')}
+        @directives[:'#{type}'] = true
+
+        self
+      end
+    RUBY_EVAL
+  end
+
+  private
+
+  # @private
+  def compile
+    @directives.map { |key, val|
+      META_DIRECTIVES.include?(key) ? key.to_s : "#{key} #{val}"
+    }.join('; ')
+  end
+
+  # @private
+  def set_directive!(key, value)
+    if Symbol === value
+      value = "'#{value}'"
+    else
+      value = value.dup
+    end
+
+    if @directives.has_key? key
+      @directives[key] << " "
+      @directives[key] << value
+    else
+      @directives[key] = value
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: csp_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Coyne
+- Sigient
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create rich Content Security Policies using this easy to use builder
+  class
+email:
+- mikeycgto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csp_builder.gemspec
+- lib/csp_builder.rb
+- lib/csp_builder/constants.rb
+- lib/csp_builder/version.rb
+homepage: https://github.com/Sigient/csp_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Content Security Policy string builder
+test_files: []