jwt-aws-kms 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 914aa0d86548b288e664ca6ec1fc307d9ed6314906d88a53724ea8f66a50de3f
+  data.tar.gz: 3194829083c71babcf27d4a7a9faa8c7461af0e8e4eec75a49450051c934b0fe
+SHA512:
+  metadata.gz: 3a883fdf468c545b4d40ff7df480ec31dd18bb13b418a241d31cd85614fc73330a6f9d27c28d4335d4448eb1b8ef12e3c68e4b007f90c6fdadf721e5b6fc7d17
+  data.tar.gz: ca891f35bf16367d8aec94e021db54c684aeea578eebe31458feb81a90831caad1f11efb4077889fc4ce4c8f228b55c8b0b4808b8fc5a83992f32e1ccf09e70f

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.6.0"
+}

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Exclude:
+    - lib/jwt-aws-kms.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+    - '*.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.2.0](https://github.com/anakinj/jwt-kms/compare/v0.1.0...v0.2.0) (2024-09-20)
+
+
+### Features
+
+* Support all HMAC algos ([eb09bd3](https://github.com/anakinj/jwt-kms/commit/eb09bd3a7ba6cc932ce8c96dffa696d04d36e59a))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,55 @@
+# JWT::KMS
+
+AWS KMS algorithm extensions for ruby-jwt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jwt-aws-kms'
+```
+
+And require the gem in your code.
+
+```ruby
+require `jwt-aws-kms`
+```
+
+## Usage
+
+```ruby
+
+# Create a key, for example with the ruby AWS SDK
+key = Aws::KMS::Client.new.create_key(key_spec: "HMAC_512", key_usage: "GENERATE_VERIFY_MAC")
+
+algo = ::JWT::Aws::KMS.for(algorithm: "HS512")
+
+token = JWT.encode(payload, key.key_metadata.key_id, algo)
+decoded_token = JWT.decode(token, key.key_metadata.key_id, true, algorithm: algo)
+```
+
+## Development
+
+[Localstack](https://www.localstack.cloud/) can be used to simulate the AWS KMS environment.
+
+```
+docker run \
+  --rm -it \
+  -p 127.0.0.1:4566:4566 \
+  -p 127.0.0.1:4510-4559:4510-4559 \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  localstack/localstack
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anakinj/jwt-aws-kms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/anakinj/jwt-aws-kms/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jwt::Kms project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anakinj/jwt-aws-kms/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/jwt/aws/kms/hmac_key.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module JWT
+  module Aws
+    module KMS
+      # Represent a AWS HMAC key
+      # https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+      class HmacKey
+        include JWT::JWA::SigningAlgorithm
+
+        MAPPINGS = {
+          "HS256" => "HMAC_SHA_256",
+          "HS384" => "HMAC_SHA_384",
+          "HS512" => "HMAC_SHA_512"
+        }.freeze
+
+        def initialize(algorithm:)
+          @alg = algorithm
+        end
+
+        def sign(data:, signing_key:, **)
+          KMS.client.generate_mac(key_id: signing_key, mac_algorithm: mac_algorithm, message: data).mac
+        end
+
+        def verify(data:, verification_key:, signature:, **)
+          KMS.client.verify_mac(key_id: verification_key, mac_algorithm: mac_algorithm, message: data,
+                                mac: signature).mac_valid
+        end
+
+        private
+
+        attr_reader :key_id
+
+        def mac_algorithm
+          MAPPINGS.fetch(alg, nil)
+        end
+      end
+    end
+  end
+end

data/lib/jwt/aws/kms/sign_verify_key.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module JWT
+  module Aws
+    module KMS
+      # Represent a AWS asymmetric key
+      # https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+      class SignVerifyKey
+        include JWT::JWA::SigningAlgorithm
+
+        MAPPINGS = {
+          "RS256" => "RSASSA_PKCS1_V1_5_SHA_256",
+          "RS384" => "RSASSA_PKCS1_V1_5_SHA_384",
+          "RS512" => "RSASSA_PKCS1_V1_5_SHA_512",
+          "PS256" => "RSASSA_PSS_SHA_256",
+          "PS384" => "RSASSA_PSS_SHA_384",
+          "PS512" => "RSASSA_PSS_SHA_512",
+          "ES256" => "ECDSA_SHA_256",
+          "ES384" => "ECDSA_SHA_384",
+          "ES512" => "ECDSA_SHA_512"
+        }.freeze
+
+        def initialize(algorithm:)
+          @alg = algorithm
+        end
+
+        def sign(data:, signing_key:, **)
+          KMS.client.sign(key_id: signing_key, signing_algorithm: signing_algorithm,
+                          message: data).signature
+        end
+
+        def verify(data:, verification_key:, signature:, **)
+          KMS.client.verify(key_id: verification_key, signing_algorithm: signing_algorithm,
+                            message: data, signature: signature).signature_valid
+        end
+
+        private
+
+        attr_reader :key_id
+
+        def signing_algorithm
+          MAPPINGS.fetch(alg, nil)
+        end
+      end
+    end
+  end
+end

data/lib/jwt/aws/kms/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JWT
+  module Aws
+    module KMS
+      VERSION = "0.6.0"
+    end
+  end
+end

data/lib/jwt/aws/kms.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "aws-sdk-kms"
+require "jwt"
+
+require_relative "kms/version"
+require_relative "kms/hmac_key"
+require_relative "kms/sign_verify_key"
+
+module JWT
+  # :nodoc:
+  module Aws
+    # :nodoc:
+    module KMS
+      def self.client
+        @client ||= ::Aws::KMS::Client.new
+      end
+
+      def self.for(algorithm:)
+        if HmacKey::MAPPINGS.key?(algorithm)
+          HmacKey
+        elsif SignVerifyKey::MAPPINGS.key?(algorithm)
+          SignVerifyKey
+        else
+          raise ArgumentError, "Algorithm #{algorithm} not supported"
+        end.new(algorithm: algorithm)
+      end
+    end
+  end
+end

data/lib/jwt-aws-kms.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "jwt/aws/kms"

data/release-please-config.json

@@ -0,0 +1,9 @@
+{
+  "release-type": "ruby",
+  "include-v-in-tag": true,
+  "packages": {
+    ".": {
+      "version-file": "lib/jwt/aws/kms/version.rb"
+    }
+  }
+}

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jwt-aws-kms
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Joakim Antman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-kms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Utilize AWS KMS to handle the signing and verification of JWT tokens
+email:
+- antman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".release-please-manifest.json"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jwt-aws-kms.rb
+- lib/jwt/aws/kms.rb
+- lib/jwt/aws/kms/hmac_key.rb
+- lib/jwt/aws/kms/sign_verify_key.rb
+- lib/jwt/aws/kms/version.rb
+- release-please-config.json
+homepage: https://github.com/anakinj/jwt-aws-kms
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/anakinj/jwt-aws-kms
+  source_code_uri: https://github.com/anakinj/jwt-aws-kms
+  changelog_uri: https://github.com/anakinj/jwt-aws-kms/blob/v0.6.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: AWS KMS algorithm extension for ruby-jwt
+test_files: []