jekyll-wkd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a06312e387e2b7da2c7bc5071f2b614a435436c47b883da84430b1d1bbbaeb3f
+  data.tar.gz: 60196f579ce1740cab8ae47d787e18f7a0c6badeaf1c679b05926feda5f76446
+SHA512:
+  metadata.gz: 9879f889d072ba3d0291105c901aa50b18fca5fa9fb2464af07f8a552bc6d393f818e62f1b6d1eafc5572f5c83656b3da1a579a9851ed8d4b2333ea97fafc913
+  data.tar.gz: bac3744510b72721c0c89e34c811af06287151185aaf60f02b92ed9a018e72b81d3227faf7f57e4b342830794a0a0e4d77c4b6b4fae48b864c990f8a68feba54

data/lib/jekyll-wkd/generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "gpgme"
+require "set"
+require "tmpdir"
+
+module JekyllWKD
+  class Generator < ::Jekyll::Generator
+    safe true
+    priority :normal
+
+    CONF_KEY = "wkd"
+    CONF_DEFAULT = {
+      "path" => "keys",
+      "exts" => %w[.asc .pub]
+    }
+
+    def generate site
+      @site = site
+
+      pgp_home = Dir.mktmpdir "jekyll-wkd-"
+      GPGME::Engine.home_dir = pgp_home
+      Jekyll::Hooks.register :site, :post_write do
+        FileUtils.remove_dir pgp_home
+      end
+
+      domains = Set.new
+
+      key_files.each do |file|
+        File.open(file.path) do |data|
+          GPGME::Key.import(data).imports.each do |key|
+            kf = KeyFile.new(
+              @site,
+              @site.source,
+              File.dirname(file.relative_path),
+              File.basename(file.relative_path),
+              key.fingerprint
+            )
+            domains << kf.domain
+            @site.static_files << kf
+          end
+        end
+      end
+
+      domains.each do |domain|
+        @site.pages << make_policy(domain)
+      end
+    end
+
+    private
+
+    def config
+      @config ||= CONF_DEFAULT.merge @site.config.fetch(CONF_KEY, {})
+    end
+
+    def in_path? file
+      File.exist? @site.in_source_dir(config["path"], file.name)
+    end
+
+    def key_files
+      @key_files ||= @site.static_files.select do |file|
+        in_path?(file) && file.relative_path.end_with?(*config["exts"])
+      end
+    end
+
+    def make_policy domain
+      path = File.join(PGP_PATH, domain, "policy")
+      PolicyFile.new(@site, __dir__, "", path).tap do |page|
+        page.content = "# Policy flags for domain `#{domain}`\n"
+        page.data.merge!(
+          "layout" => nil,
+          "sitemap" => false
+        )
+      end
+    end
+  end
+end

data/lib/jekyll-wkd/hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module JekyllWKD
+  module ZBase32
+    CHAR = "ybndrfg8ejkmcpqxot1uwisza345h769"
+    SIZE = 5
+    MASK = (1 << SIZE) - 1
+
+    def self.encode str
+      blocks(str, SIZE).map(&:encode).join
+    end
+
+    def self.blocks str, size
+      str.bytes.reverse.each_slice(size).map { |b| Block.new b }.reverse
+    end
+
+    class Block
+      def initialize bytes
+        @bytes = bytes
+      end
+
+      def encode
+        n = -(@bytes.length * -8 / SIZE)
+        c = @bytes.reverse.reduce(0) { |a, b| (a << 8) + b }
+        (n - 1).downto(0).map { |i| CHAR[(c >> i * SIZE) & MASK] }
+      end
+    end
+  end
+end

data/lib/jekyll-wkd/keyfile.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "digest"
+
+module JekyllWKD
+  class KeyFile < ::Jekyll::StaticFile
+    def initialize site, base, dir, name, fpr
+      @fpr = fpr
+      super site, base, dir, name
+    end
+
+    def destination dest
+      @destination ||= {}
+      @destination[dest] ||= @site.in_dest_dir(
+        dest, PGP_PATH, domain, "hu", hash
+      )
+    end
+
+    def write dest
+      dest_path = destination dest
+      return false if File.exist?(dest_path) && !modified?
+
+      self.class.mtimes[path] = mtime
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.rm(dest_path) if File.exist?(dest_path)
+
+      File.open(dest_path, "w") { |f| pgpkey.export output: f }
+      true
+    end
+
+    def domain
+      @domain ||= pgpkey.email.split("@").last
+    end
+
+    def username
+      @username || pgpkey.email.split("@").first
+    end
+
+    def hash
+      @hash ||= ZBase32.encode Digest::SHA1.digest username
+    end
+
+    private
+
+    def pgpkey
+      @pgpkey ||= GPGME::Key.get(@fpr)
+    end
+  end
+end

data/lib/jekyll-wkd/policyfile.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JekyllWKD
+  class PolicyFile < ::Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll-wkd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllWKD
+  VERSION = "1.0.0"
+end

data/lib/jekyll-wkd.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-wkd/generator"
+
+module JekyllWKD
+  PGP_PATH = ".well-known/openpgpkey"
+
+  autoload :VERSION, "jekyll-wkd/version"
+  autoload :ZBase32, "jekyll-wkd/hash"
+  autoload :KeyFile, "jekyll-wkd/keyfile"
+  autoload :PolicyFile, "jekyll-wkd/policyfile"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-wkd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fern Zapata
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-wkd.rb
+- lib/jekyll-wkd/generator.rb
+- lib/jekyll-wkd/hash.rb
+- lib/jekyll-wkd/keyfile.rb
+- lib/jekyll-wkd/policyfile.rb
+- lib/jekyll-wkd/version.rb
+homepage: https://github.com/fernzi/jekyll-wkd
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/fernzi/jekyll-wkd
+  source_code_uri: https://github.com/fernzi/jekyll-wkd
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: Jekyll plugin to generate an OpenPGP Web Key Directory (WKD)
+test_files: []