jekyll-content-security-policy-generator 1.6.1 → 1.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8e466efa24dc267fb4838ef7330f763d1285cb940b2e43f7b02915d1a1a864f
-  data.tar.gz: 7ad7db2677f878606cb062ed1b75f81c327027e158a9fccfba56c39cfcc7310b
+  metadata.gz: d4c60e7eb8da0e545f4b95bdebd2868b4d8f9bfa9f07352ae549349eb389dcfb
+  data.tar.gz: e8322faa009accd48954b155182d06101900ca709985deb5b6c68ff711b5af7a
 SHA512:
-  metadata.gz: 5f6fd3f8937956dd53e4a7cb3ad2f733bbb46abb8b5eb855ac6a8b3c6ef287353c7e707de4ebe6f8ee5a1830b7489b2aaecccbdad359ce5eb1485983a9a5cbf3
-  data.tar.gz: 76cc86776a4dc159939aefb2f774ffbee23d351d752f52f0a75fa3ee2350395fab98f498af5040450eb0d91bf294f1a8a05392961294fe3abf408f6bcc40f645
+  metadata.gz: a77bae14674eb6cf7d3aba4c5f5e20673d47de36347eab7723d1502320dca614da472cf2d4ad64345e4d7c218427de46a27b088b02e120aa09024a50f36ee8a0
+  data.tar.gz: f502a9cf7ec9b92fca5de81dcd4c493c2e837cad2a58d749a889007879e17a6578e713dfcb57a1e121103a519d52d1b0506549a399de791bd92cb1633f1134a9

data/README.md

@@ -1,5 +1,7 @@
 # jekyll-content-security-policy-generator Plugin
 
+![Jekyll Image Cover](Cover.png)
+
 This Jekyll plugin automatically builds an HTML content-security-policy for a Jekyll site. The plugin
 will scan ```.html``` files generated by Jekyll and attempt to locate images, styles, scripts, frames etc and build a
 content security policy HTML meta tag. The script will also generate SHA256 hashes for inline scripts and styles. If
@@ -21,15 +23,40 @@ To speed up development of Jekyll based sites whilst also helping to generate se
 
 ## Installation
 
-Install the gem:
+Add the plugin your Gemfile within the jekyll_plugins group:
+
+```
+group :jekyll_plugins do
+  gem 'jekyll-content-security-policy-generator'
+  ... other gem files
+end
+```
+
+Then install
+
+```
+bundle install
+```
+
+## Nokogiri Error on Mac?
+
+For some reason, Nokogiri will install with both the ARM (M1) and x86 variants which will confuse bundler. Best way I found to fix this was to open the Gemfile.lock and remove the:
+
+```
+nokogiri (1.11.3-arm64-darwin)
+  racc (~> 1.4)
+```
 
-```gem install jekyll-content-security-policy-generator```
+Or the x86 if you have an M1 mac.
 
-Then add this to your _config.yml:
+Alternatively, you can add ```nokogiri``` to your Gemfile, like so:
 
 ```
-plugins:
-  - jekyll-content-security-policy-generator
+group :jekyll_plugins do
+  gem 'nokogiri'
+  gem 'jekyll-content-security-policy-generator'
+  ... other gem files
+end
 ```
 
 ## Support

data/jekyll-content-security-policy-generator.gemspec

@@ -1,10 +1,15 @@
 lib = File.expand_path("../lib", __FILE__)
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "jekyll-content-security-policy-generator/version"
+
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-content-security-policy-generator"
   spec.summary       = "Helps generate a content security policy."
-  spec.description   = "Helps generate a content security policy. Locates inline scripts, images, frames etc."
+  spec.description   = "Will generate a content-security-policy based on images, scripts, stylesheets, frames and"\
+                       "others on each generated page. This script assumes that all your linked resources as 'safe'."\
+                       "Style attributes will also be converted into <style> elements and SHA256 hashes will be"\
+                       "generated for inline styles/scripts."
   spec.version       = JekyllContentSecurityPolicyGenerator::VERSION
   spec.authors       = ["strongscot"]
   spec.email         = ["mail@strongscot.com"]
@@ -12,11 +17,10 @@ Gem::Specification.new do |spec|
   spec.licenses      = ["MIT"]
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!)  }
   spec.require_paths = ["lib"]
-  spec.add_dependency "jekyll"
-
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "nokogiri"
-  spec.add_development_dependency "digest"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
+  spec.add_dependency 'jekyll'
+  spec.add_dependency 'digest'
+  spec.add_dependency 'nokogiri'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/jekyll-content-security-policy-generator/hook.rb

@@ -2,6 +2,7 @@ require 'jekyll'
 require 'nokogiri'
 require 'digest'
 require 'open-uri'
+require 'uri'
 
 ##
 # Provides the ability to generate a content security policy for inline scripts and styles.
@@ -30,11 +31,19 @@ module Jekyll
       def generate_convert_security_policy_meta_tag
         meta_content = ""
 
+        @csp_script_src = @csp_script_src.uniq
+        @csp_image_src = @csp_image_src.uniq
+        @csp_style_src = @csp_style_src.uniq
+        @csp_script_src = @csp_script_src.uniq
+        @csp_unknown = @csp_unknown.uniq
+
         if @csp_frame_src.length > 0
+          @csp_script_src.uniq
           meta_content += "frame-src " + @csp_frame_src.join(' ') + '; '
         end
 
         if @csp_image_src.length > 0
+          Jekyll.logger.warn @csp_image_src
           meta_content += "img-src " + @csp_image_src.join(' ') + '; '
         end
 
@@ -55,10 +64,10 @@ module Jekyll
         end
 
         if @nokogiri.at("head")
-          Jekyll.logger.info "Generated content security policy, inserted in HEAD."
+          #Jekyll.logger.info "Generated content security policy, inserted in HEAD."
           @nokogiri.at("head") << "<meta http-equiv=\"Content-Security-Policy\" content=\"" + meta_content + "\">"
         elsif @nokogiri.at("body")
-          Jekyll.logger.info "Generated content security policy, inserted in BODY."
+          #Jekyll.logger.info "Generated content security policy, inserted in BODY."
           @nokogiri.at("body") << "<meta http-equiv=\"Content-Security-Policy\" content=\"" + meta_content + "\">"
         else
           Jekyll.logger.error "Generated content security policy but found no-where to insert it."
@@ -84,16 +93,12 @@ module Jekyll
 
               if policy_parts[0] == 'script-src'
                 @csp_script_src.concat(policy_parts.drop(1))
-                @csp_script_src = @csp_script_src.uniq
               elsif policy_parts[0] == 'style-src'
                 @csp_style_src.concat(policy_parts.drop(1))
-                @csp_style_src = @csp_style_src.uniq
               elsif policy_parts[0] == 'image-src'
                 @csp_image_src.concat(policy_parts.drop(1))
-                @csp_image_src = @csp_image_src.uniq
               elsif policy_parts[0] == 'frame-src'
                 @csp_frame_src.concat(policy_parts.drop(1))
-                @csp_frame_src = @csp_frame_src.uniq
               else
                 @csp_unknown.concat([policy_parts])
               end
@@ -124,11 +129,11 @@ module Jekyll
 
             if @nokogiri.at('head')
               @nokogiri.at('head') << new_element
-              Jekyll.logger.info'Converting style attribute to inline style, inserted into HEAD.'
+              #Jekyll.logger.info'Converting style attribute to inline style, inserted into HEAD.'
             else
               if @nokogiri.at('body')
                 @nokogiri.at('body') << new_element
-                Jekyll.logger.info'Converting style attribute to inline style, inserted into BODY.'
+                #Jekyll.logger.info'Converting style attribute to inline style, inserted into BODY.'
               else
                 Jekyll.logger.warn'Unable to convert style attribute to inline style, no HEAD or BODY found.'
               end
@@ -147,6 +152,19 @@ module Jekyll
             @csp_image_src.push find_src.match(/(.*\/)+(.*$)/)[1]
           end
         end
+
+        @nokogiri.css('style').each do |find|
+          finds = find.content.scan(/url\(([^\)]+)\)/)
+
+          finds.each do |innerFind|
+            innerFind = innerFind[0]
+            innerFind = innerFind.tr('\'"', '')
+            if innerFind.start_with?('http', 'https')
+              @csp_image_src.push self.get_domain(innerFind)
+            end
+          end
+        end
+
       end
 
       ##
@@ -195,6 +213,11 @@ module Jekyll
         end
       end
 
+      def get_domain(url)
+        uri = URI.parse(url)
+        "#{uri.scheme}://#{uri.host}"
+      end
+
       ##
       # Generate a content hash
       def generate_sha256_content_hash(content)

data/lib/jekyll-content-security-policy-generator/version.rb

@@ -1,3 +1,3 @@
 module JekyllContentSecurityPolicyGenerator
-  VERSION = "1.6.1".freeze
+  VERSION = "1.6.10".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-content-security-policy-generator
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.10
 platform: ruby
 authors:
 - strongscot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-11 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: digest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: digest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,8 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Helps generate a content security policy. Locates inline scripts, images,
-  frames etc.
+description: Will generate a content-security-policy based on images, scripts, stylesheets,
+  frames andothers on each generated page. This script assumes that all your linked
+  resources as 'safe'.Style attributes will also be converted into <style> elements
+  and SHA256 hashes will begenerated for inline styles/scripts.
 email:
 - mail@strongscot.com
 executables: []
@@ -103,6 +105,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Cover.png
 - LICENSE
 - Makefile
 - README.md