hocho-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5016c6937fbb5f6380d20ac14aa17818aba2331737a314202cc18d85de983e4b
+  data.tar.gz: a6e44884f54eb2592c89ea66755629de34272a3adee65bb49a9ba3011547492f
+SHA512:
+  metadata.gz: 87335b218e85acf9679aa9812e342c90a053773a53154f4514dc8124cdc1a4b87eb8a63299931764e2a4f19f14d8b566b3fa744aab393e41a88a8ddc149cfcc5
+  data.tar.gz: 984a4fe10b5bba4baca30e3d75c9e91bd3459f52a2d9e009ab66ecc5e39468d7266397d991d7d1ff268ef8f26fa18f91e70c8b1b415f728d98d10d50688cb5f7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hocho-jwt.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    hocho-jwt (0.1.0)
+      hocho
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    diff-lcs (1.3)
+    hashie (4.1.0)
+    hocho (0.3.4)
+      hashie
+      itamae
+      net-ssh (>= 4.1.0)
+      thor
+    itamae (1.10.7)
+      ansi
+      hashie
+      schash (~> 0.1.0)
+      specinfra (>= 2.64.0, < 3.0.0)
+      thor
+    jwt (2.2.1)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.0.2)
+    net-telnet (0.1.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    schash (0.1.2)
+    sfl (2.3)
+    specinfra (2.82.16)
+      net-scp
+      net-ssh (>= 2.7)
+      net-telnet (= 0.1.1)
+      sfl
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hocho-jwt!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sorah Fukumori
+
+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,100 @@
+# hocho-jwt: Pass JWT to servers on `hocho apply`
+
+[hocho](https://github.com/sorah/hocho) plugin to issue and sign JWT (JSON Web Token) and pass it to a host as a node attribute on `hocho apply`.
+
+## Use cases
+
+- Use with step-ca ([smallstep/certificates](https://github.com/smallstep/certificates)): allow servers to get certificates from step-ca during initial provision with hocho
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'hocho-jwt'
+```
+
+## Usage
+
+```yaml
+# hocho.yml
+property_providers:
+  - add_default:
+      properties:
+        hocho_jwt:
+          ## JWT will be issued when host.properties.jwt.issue is present
+          issue: false
+
+          ## Lifetime in seconds
+          duration: 120
+
+          ## Claims
+          claims:
+            iss: hocho
+          
+          ## Set false to skip when issue=true but no signing key is present.
+          fail_when_no_signing_key: true
+  - jwt:
+      algorithm: ES256
+
+      ## Signing Private Key
+      # EC256: openssl ecparam -name prime256v1 -genkey -noout -out key.pem
+      # RS256: openssl genrsa -noout -out key.pem 2048
+      signing_key:
+        ## Key ID
+        # kid_string: key-id
+        # kid_file: path/to/kid
+        # kid_env: HOCHO_JWT_KID
+        ## String to PEM or Base64 encoded DER
+        # pem_string: "..."
+        # pem_file: /path/to/jwk
+        # pem_env: HOCHO_JWT_KEY
+
+      ## Templates are rendered using ERB, and `host` (Hocho::Host) is given. 
+      ## Invalid DNS names will be removed.
+      sub_template: "<%= host.name %>"
+```
+
+```yaml
+# hocho host.yml
+myhost.example.org:
+  properties:
+    hocho_jwt:
+      issue: true
+      claims:
+        # this overrides sub_template
+        # sub: "static-subject.example.org"
+        aud: 'audience'
+        customclaim: test
+        customclaimarray: ['test']
+        
+```
+
+```ruby
+# itamae recipe
+
+file "/etc/jwt.txt" do
+  content "#{node[:hocho_jwt][:token]}\n"
+  owner 'root'
+  group 'root'
+  mode  '0640'
+end
+
+execute "do-something-with-token"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/hocho-jwt.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hocho/jwt"
+
+# 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(__FILE__)

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/hocho-jwt.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/hocho/jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hocho-jwt"
+  spec.version       = Hocho::Jwt::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["her@sorah.jp"]
+
+  spec.summary       = %q{Pass JWT to servers using hocho}
+  spec.homepage      = "https://github.com/sorah/hocho-jwt"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'jwt'
+  spec.add_dependency 'hocho'
+end

data/lib/hocho/jwt.rb

@@ -0,0 +1,3 @@
+require 'hocho/jwt/version'
+require 'hocho/property_providers/jwt'
+

data/lib/hocho/jwt/version.rb

@@ -0,0 +1,5 @@
+module Hocho
+  module Jwt
+    VERSION = "0.1.0"
+  end
+end

data/lib/hocho/property_providers/jwt.rb

@@ -0,0 +1,133 @@
+require 'erb'
+require 'jwt'
+require 'openssl'
+
+require 'hocho/property_providers/base'
+
+module Hocho
+  module PropertyProviders
+    class Jwt < Base
+      Token = Struct.new(:payload, :headers, :signing_key, :algorithm) do
+        def to_s
+          JWT.encode(
+            payload,
+            signing_key,
+            algorithm,
+            headers,
+          )
+        end
+      end
+
+      def initialize(algorithm:, signing_key:, sub_template:, target: :hocho_jwt)
+        @algorithm = algorithm
+        @signing_key, @kid = load_key(**(signing_key || {}))
+        @sub_template = Class.new(Template).tap { |t| t.erb = ERB.new(sub_template) }
+        @target = target
+      end
+
+      def determine(host)
+        request = Request.new(**{
+          issue: false,
+          claims: {},
+          fail_when_no_signing_key: true,
+        }.merge(host.properties[@target] || {}))
+
+        return unless host.properties.dig(@target, :issue)
+
+        unless @signing_key
+          if request.fail_when_no_signing_key
+            raise ArgumentError, "cannot issue JWT key, no signing key is present"
+          else
+            return
+          end
+        end
+
+        headers = {}
+        headers[:kid] = @kid if @kid
+
+        payload = generate_payload(request, host)
+        host.attributes[@target] = {
+          payload: payload,
+          token: Token.new(
+            payload,
+            headers,
+            @signing_key,
+            @algorithm,
+          ),
+        }
+
+        nil
+      end
+
+      private
+
+      class Template
+        def self.erb; @erb; end
+        def self.erb=(x); @erb = x; end
+
+        def initialize(host)
+          @host = host
+        end
+
+        attr_reader :host
+
+        def result()
+          self.class.erb.result(binding)
+        end
+      end
+
+      Request = Struct.new(:issue, :duration, :claims, :fail_when_no_signing_key, keyword_init: true)
+
+      def generate_payload(request, host)
+        now = Time.now
+        data = {
+          sub: @sub_template.new(host).result(),
+        }
+        data[:iat] = now.to_i
+        if request.duration
+          data[:nbf] = now.to_i
+          data[:exp] = (now + request.duration).to_i
+        end
+        data.merge(request.claims)
+      end
+
+      def load_key(pem_string: nil, pem_file: nil, pem_env: nil, kid_string: nil, kid_file: nil, kid_env: nil)
+        pem = case
+        when pem_string
+          pem_string.to_s
+        when pem_file
+          File.read(pem_string) rescue nil
+        when pem_env
+          ENV[pem_env].yield_self do |e|
+            if e.start_with?('-----')
+              e
+            else
+              e.unpack1('m*')
+            end
+          end
+        end
+        return nil unless pem
+
+        kid = case
+        when kid_string
+          kid_string.to_s
+        when kid_file
+          File.read(kid_string).chomp
+        when kid_env
+          ENV.fetch(kid_env)
+        end
+
+        key = case @algorithm
+        when /^ES/
+          OpenSSL::PKey::EC.new(pem, '')
+        when /^RS/
+          OpenSSL::PKey::RSA.new(pem, '')
+        else
+          raise ArgumentError, "unsupported cipher algorithm"
+        end
+
+        [key, kid]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: hocho-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hocho
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- her@sorah.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hocho-jwt.gemspec
+- lib/hocho/jwt.rb
+- lib/hocho/jwt/version.rb
+- lib/hocho/property_providers/jwt.rb
+homepage: https://github.com/sorah/hocho-jwt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sorah/hocho-jwt
+  source_code_uri: https://github.com/sorah/hocho-jwt
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Pass JWT to servers using hocho
+test_files: []