jekyll-hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57db1ecd180fa5dea5af353997ea7e6bbdff4995d8fb2a218bcb12d301ee858d
+  data.tar.gz: 5b6854b88e11c3a6843667754a7d0f668e45cee0b73d9688481593e23ced4af6
+SHA512:
+  metadata.gz: 1d2d699fd047aff3d2ae8f796e496bf2a0714a12eeacfcfb16a09182e49b2878fd4ad69f89442489a4817cc00dd14e28c00f2488558d0e0b6e4495cf4b267862
+  data.tar.gz: e402f7b51694afecdbf9d48cfeff29a8c77e12cfee6198cddd41f6e5e0c16b36a77d3c5799b51660ec043961e0389965fbbe7222ea3535a7d0453c029ce3b718

data/README.md

@@ -0,0 +1,43 @@
+# Jekyll Hash Filter
+
+Adds a variety of filters to enable string hashing in Jekyll.
+
+Currently the filter supports the following hash functions:
+
+- SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256
+- SHA3-224, SHA3-256, SHA3-384, SHA3-512
+
+This plugin uses the OpenSSL implementations of the above hash functions.
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```
+gem 'jekyll-hash`
+```
+
+Then make the following entry under `_config.yml`:
+
+```
+plugins:
+    - jekyll-hash
+```
+
+## Usage
+
+The filters can be used as follows:
+
+```
+{{ 'text to be hashed' | sha_256 }}
+{{ 'text to be hashed' | sha_512_224 }}
+{{ 'text to be hashed' | sha3_512 }}
+```
+
+## Testing
+
+Run the command:
+
+```
+bundle exec rspec
+```

data/lib/jekyll-hash/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+    module HashFilter
+        VERSION = '0.0.1'
+    end
+end

data/lib/jekyll-hash.rb

@@ -0,0 +1,49 @@
+require "openssl"
+
+module Jekyll
+    module HashFilter
+        # SHA
+        def sha_224(input)
+            OpenSSL::Digest.new('SHA224').hexdigest(input)
+        end
+
+        def sha_256(input)
+            OpenSSL::Digest.new('SHA256').hexdigest(input)
+        end
+
+        def sha_384(input)
+            OpenSSL::Digest.new('SHA384').hexdigest(input)
+        end
+
+        def sha_512(input)
+            OpenSSL::Digest.new('SHA512').hexdigest(input)
+        end
+
+        def sha_512_224(input)
+            OpenSSL::Digest.new('SHA512-224').hexdigest(input)
+        end
+
+        def sha_512_256(input)
+            OpenSSL::Digest.new('SHA512-256').hexdigest(input)
+        end
+
+        # SHA3
+        def sha3_224(input)
+            OpenSSL::Digest.new('SHA3-224').hexdigest(input)
+        end
+
+        def sha3_256(input)
+            OpenSSL::Digest.new('SHA3-256').hexdigest(input)
+        end
+
+        def sha3_384(input)
+            OpenSSL::Digest.new('SHA3-384').hexdigest(input)
+        end
+
+        def sha3_512(input)
+            OpenSSL::Digest.new('SHA3-512').hexdigest(input)
+        end
+    end
+end
+
+Liquid::Template.register_filter(Jekyll::HashFilter)

data/spec/jekyll-hash_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe(Jekyll::HashFilter) do
+  let(:output) do
+    render_liquid(content, {'str' => str})
+  end
+
+  # SHA
+  context "SHA-224" do
+    let(:str) { "SHA-224 test string" }
+    let(:content)  { "{{ '#{str}' | sha_224 }}" }
+
+    it "produces the correct SHA-224 hash" do
+      expect(output).to eq("b61c3d89346ccb3f54018d43a88942b2284292ea99a953674b1d2d98")
+    end
+  end
+
+  context "SHA-256" do
+    let(:str) { "SHA-256 test string" }
+    let(:content)  { "{{ '#{str}' | sha_256 }}" }
+
+    it "produces the correct SHA-256 hash" do
+      expect(output).to eq("7b5f93b25e76daa39830a7591d40750f656fafdde5efb9bb4b7a4fa00cc37227")
+    end
+  end
+
+  context "SHA-384" do
+    let(:str) { "SHA-384 test string" }
+    let(:content)  { "{{ '#{str}' | sha_384 }}" }
+
+    it "produces the correct SHA-384 hash" do
+      expect(output).to eq("ea0378d51cc1679f525194895515930af035f1e7677ad558f6823927a64bb0e33dd60cf14eca0d5504edacae1b780529")
+    end
+  end
+
+  context "SHA-512" do
+    let(:str) { "SHA-512 test string" }
+    let(:content)  { "{{ '#{str}' | sha_512 }}" }
+
+    it "produces the correct SHA-512 hash" do
+      expect(output).to eq("9faedb0bbb45bc01cc37b5c645c3136c949d482c0e6d9aeba0f63630570f0c5d4866e441b462eda8fbba21f41d47be69deb2a467111a989771820def5dcbd1df")
+    end
+  end
+
+  context "SHA-512/224" do
+    let(:str) { "SHA-512/224 test string" }
+    let(:content)  { "{{ '#{str}' | sha_512_224 }}" }
+
+    it "produces the correct SHA-512/224 hash" do
+      expect(output).to eq("503941a788a47dedbec6e857f917ce28d1fdbd8b59c8bba24fe78634")
+    end
+  end
+
+  context "SHA-512/256" do
+    let(:str) { "SHA-512/256 test string" }
+    let(:content)  { "{{ '#{str}' | sha_512_256 }}" }
+
+    it "produces the correct SHA-512/256 hash" do
+      expect(output).to eq("26756c84af30abf395e4973b4c6f3c1e2499fbb77df7e08d6659737fd30158ed")
+    end
+  end
+
+  # SHA3
+  context "SHA3-224" do
+    let(:str) { "SHA3-224 test string" }
+    let(:content)  { "{{ '#{str}' | sha3_224 }}" }
+
+    it "produces the correct SHA3-224 hash" do
+      expect(output).to eq("f560c1381a3a81fb674f26cee8f2030570032ce6094dac84a0478afb")
+    end
+  end
+
+  context "SHA3-256" do
+    let(:str) { "SHA3-256 test string" }
+    let(:content)  { "{{ '#{str}' | sha3_256 }}" }
+
+    it "produces the correct SHA3-256 hash" do
+      expect(output).to eq("c6d803ea0394cae943e1d70660d34511870a2b6395cf6222857c197e51db6103")
+    end
+  end
+
+  context "SHA3-384" do
+    let(:str) { "SHA3-384 test string" }
+    let(:content)  { "{{ '#{str}' | sha3_384 }}" }
+
+    it "produces the correct SHA3-384 hash" do
+      expect(output).to eq("75684296cbbc768de02c251814f41288b47e902e1466efebe90352e436a77b2af7710fafef3bc3ebfc15ad4e4c1b408f")
+    end
+  end
+
+  context "SHA3-512" do
+    let(:str) { "SHA3-512 test string" }
+    let(:content)  { "{{ '#{str}' | sha3_512 }}" }
+
+    it "produces the correct SHA3-512 hash" do
+      expect(output).to eq("d326751d4c34d9805e65ec39202dc5c7fdbc98d73923510fa13ceef8942986b701089eaacd5bb3d61d0517afd4ef724a64e5b2341a36c78582845155b58c0bb7")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+TEST_DIR = File.dirname(__FILE__)
+
+require 'liquid'
+require File.expand_path("../lib/jekyll-hash.rb", TEST_DIR)
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  def render_liquid(content, variables)
+    template = Liquid::Template.parse(content)
+    template.render(variables)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harrison McCarty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.26
+description: Message digest filter for Jekyll
+email:
+- mccarth@purdue.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jekyll-hash.rb
+- lib/jekyll-hash/version.rb
+- spec/jekyll-hash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hmccarty/jekyll-hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: This plugin provides a simple liquid filter which converts strings to crptographically
+  secure hashes.
+test_files:
+- spec/spec_helper.rb
+- spec/jekyll-hash_spec.rb