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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4c60e7eb8da0e545f4b95bdebd2868b4d8f9bfa9f07352ae549349eb389dcfb
-  data.tar.gz: e8322faa009accd48954b155182d06101900ca709985deb5b6c68ff711b5af7a
+  metadata.gz: 51ac58de24c4823f70c76389c591fa79c380808a053d4cf27550c5f2b4a6c171
+  data.tar.gz: 16c7ae6382f5161e93f3c31ef95d9da7d317a24aa614d92f4d7649489623dcbe
 SHA512:
-  metadata.gz: a77bae14674eb6cf7d3aba4c5f5e20673d47de36347eab7723d1502320dca614da472cf2d4ad64345e4d7c218427de46a27b088b02e120aa09024a50f36ee8a0
-  data.tar.gz: f502a9cf7ec9b92fca5de81dcd4c493c2e837cad2a58d749a889007879e17a6578e713dfcb57a1e121103a519d52d1b0506549a399de791bd92cb1633f1134a9
+  metadata.gz: bf7182c08e98b06678d3900fc4990d49e7c552c7644f077fa3c770642732d7b1303239d486053ed71cad85ee72cc00c83210b30e6cf31642d56871ec5c2fefec
+  data.tar.gz: db7b299bae6fe8b6d838600b612cdb89904cb7fe837358d8da56ed28f0d40c1ad180cc132592c3bdf8febfbdd05058a7ca48d42db080d83ddcc37d9af2d9a40a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/README.md

@@ -20,6 +20,14 @@ To speed up development of Jekyll based sites whilst also helping to generate se
 * Creates or reuses an HTTP meta tag for the content security policy.
 * Finds all images, styles, scripts and frames with external URLs and builds CSP.
 * Converts style attributes into ```<style>``` elements.
+* If a page already has a content-security-policy tag, (such as your index.html file), the script will reuse it.
+* Image URLs such as https://strongscot.com/images/logo.svg will have a rule such as https://strongscot.com/images/
+
+## Upcoming Features
+
+* Ability to specify how lax the domain rules can be. For example, ```https://strongscot.com/images/logo.svg``` would be converted to
+```https://strongscot.com/images/``` under strict and ```https://strongscot.com``` under relaxed.
+* Ability in site.yaml file to specify what files it should parse, at the moment its only ```.html```.
 
 ## Installation
 

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

@@ -43,7 +43,6 @@ module Jekyll
         end
 
         if @csp_image_src.length > 0
-          Jekyll.logger.warn @csp_image_src
           meta_content += "img-src " + @csp_image_src.join(' ') + '; '
         end
 
@@ -64,10 +63,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."
@@ -95,7 +94,7 @@ module Jekyll
                 @csp_script_src.concat(policy_parts.drop(1))
               elsif policy_parts[0] == 'style-src'
                 @csp_style_src.concat(policy_parts.drop(1))
-              elsif policy_parts[0] == 'image-src'
+              elsif policy_parts[0] == 'img-src'
                 @csp_image_src.concat(policy_parts.drop(1))
               elsif policy_parts[0] == 'frame-src'
                 @csp_frame_src.concat(policy_parts.drop(1))
@@ -107,6 +106,10 @@ module Jekyll
               Jekyll.logger.warn "Incorrect existing content security policy meta tag found, skipping."
             end
           end
+
+          @nokogiri.search('meta[http-equiv="Content-Security-Policy"]').each do |el|
+            el.remove
+          end
         end
       end
 
@@ -120,7 +123,8 @@ module Jekyll
             if find.attr('id')
               element_id = find.attr('id')
             else
-              element_id = Digest::MD5.hexdigest find_src + "#{Random.rand(11)}"
+              hash = Digest::MD5.hexdigest find_src + "#{Random.rand(11)}"
+              element_id = "csp-gen-" + hash
               find["id"] = element_id
             end
 
@@ -129,11 +133,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
@@ -148,7 +152,7 @@ module Jekyll
         @nokogiri.css('img').each do |find|
           find_src = find.attr('src')
 
-          if find_src.start_with?('http', 'https')
+          if find_src and find_src.start_with?('http', 'https')
             @csp_image_src.push find_src.match(/(.*\/)+(.*$)/)[1]
           end
         end
@@ -174,7 +178,7 @@ module Jekyll
           if find.attr('src')
             find_src = find.attr('src')
 
-            if find_src.start_with?('http', 'https')
+            if find_src and find_src.start_with?('http', 'https')
               @csp_script_src.push find_src.match(/(.*\/)+(.*$)/)[1]
             end
 
@@ -191,7 +195,7 @@ module Jekyll
           if find.attr('src')
             find_src = find.attr('src')
 
-            if find_src.start_with?('http', 'https')
+            if find_src and find_src.start_with?('http', 'https')
               @csp_style_src.push find_src.match(/(.*\/)+(.*$)/)[1]
             end
 
@@ -207,7 +211,7 @@ module Jekyll
         @nokogiri.css('iframe').each do |find|
           find_src = find.attr('src')
 
-          if find_src.start_with?('http', 'https')
+          if find_src and find_src.start_with?('http', 'https')
             @csp_frame_src.push find_src.match(/(.*\/)+(.*$)/)[1]
           end
         end
@@ -257,12 +261,14 @@ module Jekyll
     # Write document contents
     def write(dest)
       dest_path = destination(dest)
+
       if File.extname(dest_path) == ".html"
         content_security_policy_generator = ContentSecurityPolicyGenerator.new output
-        output = content_security_policy_generator.run
+        self.write_file_contents(dest_path, content_security_policy_generator.run)
+      else
+        self.write_file_contents(dest_path, output)
       end
 
-      write_file_contents(dest_path, output)
     end
 
   end
@@ -285,6 +291,7 @@ module Jekyll
     # Write page contents
     def write(dest)
       super dest
+
       Jekyll::Hooks.trigger hook_owner, :post_write, self
     end
   end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-content-security-policy-generator
 version: !ruby/object:Gem::Version
-  version: 1.6.10
+  version: 1.6.15
 platform: ruby
 authors:
 - strongscot
@@ -105,6 +105,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Cover.png
 - LICENSE
 - Makefile