jwt-eddsa 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cba8697910cd64e5b5072557775a09baec30d058de58b688a8c607a8e8579e
-  data.tar.gz: 3b455727ff1ad75b55ebcc47fb3c3207840744a7d0a334e0c886bcfe24b87b68
+  metadata.gz: 3ae49f7f6ef6a2bb537a159116337a058c5c1f0c4624989391a9ead28792881b
+  data.tar.gz: 3205f4a5bb26b79e47e4cef4c37ee8615dfde8668276c865151a0efd308b1011
 SHA512:
-  metadata.gz: 585f29fe08a00df55178bf929f2a7cddf9ba0e82f1e5389e3bb3cb76a3d2ec6bbbb2754b6dc35bda6280dab8c5f3eb3c1cbf8ae15d68671482bd92e8f7642647
-  data.tar.gz: 4cacbba5d3c1d2e92996a1736ba6ab23308d76c5fce1379c146d1aa60d39c9e63596c562d9b7a7597b39aea51f956ffc46bd915152747665b6e14c41e2bea0a7
+  metadata.gz: 4603a113307396cb3cde7c2cfb27abf349efe594b9445a446bb367d972a5fddf3d3f3c60d64082eb2ad4d8c7b17d1921a93853fe6a09f1570b9893adf52f885c
+  data.tar.gz: 79827ac9ab51c432b08ac6b605f72ef8e834f4b8fa1f432d1ce3248b2e8e455a7d824ec5a83182a2b014daa6d98734670830c655567c117c53715fd9aa54e743

data/.release-please-manifest.json

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

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.7.0](https://github.com/anakinj/jwt-eddsa/compare/v0.6.0...v0.7.0) (2024-08-04)
+
+
+### Features
+
+* Always set `alg` header to `EdDSA` ([#13](https://github.com/anakinj/jwt-eddsa/issues/13)) ([daaa740](https://github.com/anakinj/jwt-eddsa/commit/daaa740e653c9786c7ac9c5d086ad5ef9c432df7))
+* Replace rbnacl with ed25519 ([#9](https://github.com/anakinj/jwt-eddsa/issues/9)) ([a0f8200](https://github.com/anakinj/jwt-eddsa/commit/a0f8200d1d81ce5807539a54e6fac29c4065ac97))
+* Support the `ED25519` reference when pointing to the algorithm ([#12](https://github.com/anakinj/jwt-eddsa/issues/12)) ([982ecf3](https://github.com/anakinj/jwt-eddsa/commit/982ecf31b68bde8d06bb791de0717b51fb5084e8))
+
 ## [0.6.0](https://github.com/anakinj/jwt-eddsa/compare/v0.5.0...v0.6.0) (2024-08-02)
 
 

data/README.md

@@ -1,7 +1,7 @@
 # jwt-eddsa
 
 [![Gem Version](https://badge.fury.io/rb/jwt-eddsa.svg)](https://badge.fury.io/rb/jwt-eddsa)
-[![Build Status](https://github.com/anakinj/jwt-eddsa/workflows/test/badge.svg?branch=main)](https://github.com/jwt/ruby-jwt/actions)
+[![Build Status](https://github.com/anakinj/jwt-eddsa/workflows/test/badge.svg?branch=main)](https://github.com/anakinj/jwt-eddsa/actions?query=branch%3Amain+workflow%3Atest)
 
 A library extending the ruby-jwt gem with EdDSA algorithms. Based on [RFC 8037](https://datatracker.ietf.org/doc/html/rfc8037).
 
@@ -40,7 +40,9 @@ bundle exec rake
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anakinj/jwt-eddsa. 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-eddsa/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/anakinj/jwt-eddsa. 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-eddsa/blob/main/CODE_OF_CONDUCT.md).
+
+In this repository, pull request titles must follow the [Conventional Commit](https://www.conventionalcommits.org/) specification to ensure clear and consistent communication of changes.
 
 ## License
 
@@ -48,4 +50,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the jwt-eddsa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jwt-eddsa/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the jwt-eddsa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anakinj/jwt-eddsa/blob/main/CODE_OF_CONDUCT.md).

data/lib/jwt/eddsa/algo.rb

@@ -4,30 +4,33 @@ module JWT
   module EdDSA
     # EdDSA algorithm implementation
     module Algo
-      include JWT::JWA::Algorithm
+      include JWT::JWA::SignatureAlgorithm
 
       register_algorithm("EdDSA")
+      register_algorithm("ED25519")
 
       class << self
-        def sign(_algorithm, msg, key)
-          unless key.is_a?(RbNaCl::Signatures::Ed25519::SigningKey)
-            raise_sign_error!("Key given is a #{key.class} but needs to be a " \
-                              "RbNaCl::Signatures::Ed25519::SigningKey")
+        def sign(_alg, msg, key)
+          unless key.is_a?(Ed25519::SigningKey)
+            raise_sign_error!("Key given is a #{key.class} but needs to be a Ed25519::SigningKey")
           end
 
           key.sign(msg)
         end
 
-        def verify(_algorithm, public_key, signing_input, signature)
-          unless public_key.is_a?(RbNaCl::Signatures::Ed25519::VerifyKey)
-            raise_verify_error!("Key given is a #{public_key.class} but needs to be a " \
-                                "RbNaCl::Signatures::Ed25519::VerifyKey")
+        def verify(_alg, public_key, signing_input, signature)
+          unless public_key.is_a?(Ed25519::VerifyKey)
+            raise_verify_error!("Key given is a #{public_key.class} but needs to be a Ed25519::VerifyKey")
           end
 
           public_key.verify(signature, signing_input)
-        rescue RbNaCl::CryptoError
+        rescue Ed25519::VerifyError
           false
         end
+
+        def header(*)
+          { "alg" => "EdDSA" }
+        end
       end
     end
   end

data/lib/jwt/eddsa/jwk/okp.rb

@@ -6,8 +6,7 @@ module JWT
       # https://datatracker.ietf.org/doc/html/rfc8037
       class OKP < ::JWT::JWK::KeyBase
         KTY  = "OKP"
-        KTYS = [KTY, JWT::EdDSA::JWK::OKP, RbNaCl::Signatures::Ed25519::SigningKey,
-                RbNaCl::Signatures::Ed25519::VerifyKey].freeze
+        KTYS = [KTY, JWT::EdDSA::JWK::OKP, Ed25519::SigningKey, Ed25519::VerifyKey].freeze
         OKP_PUBLIC_KEY_ELEMENTS = %i[kty n x].freeze
         OKP_PRIVATE_KEY_ELEMENTS = %i[d].freeze
 
@@ -63,11 +62,11 @@ module JWT
           case key
           when JWT::JWK::KeyBase
             key.export(include_private: true)
-          when RbNaCl::Signatures::Ed25519::SigningKey
+          when Ed25519::SigningKey
             @signing_key = key
             @verify_key = key.verify_key
             parse_okp_key_params(@verify_key, @signing_key)
-          when RbNaCl::Signatures::Ed25519::VerifyKey
+          when Ed25519::VerifyKey
             @signing_key = nil
             @verify_key = key
             parse_okp_key_params(@verify_key)
@@ -75,8 +74,8 @@ module JWT
             key.transform_keys(&:to_sym)
           else
             raise ArgumentError,
-                  "key must be of type RbNaCl::Signatures::Ed25519::SigningKey, " \
-                  "RbNaCl::Signatures::Ed25519::VerifyKey " \
+                  "key must be of type Ed25519::SigningKey, " \
+                  "Ed25519::VerifyKey " \
                   "or Hash with key parameters"
           end
         end
@@ -101,13 +100,13 @@ module JWT
         end
 
         def verify_key_from_parameters
-          RbNaCl::Signatures::Ed25519::VerifyKey.new(::Base64.urlsafe_decode64(self[:x]))
+          Ed25519::VerifyKey.new(::Base64.urlsafe_decode64(self[:x]))
         end
 
         def signing_key_from_parameters
           return nil unless self[:d]
 
-          RbNaCl::Signatures::Ed25519::SigningKey.new(::Base64.urlsafe_decode64(self[:d]))
+          Ed25519::SigningKey.new(::Base64.urlsafe_decode64(self[:d]))
         end
 
         class << self

data/lib/jwt/eddsa/version.rb

@@ -2,6 +2,6 @@
 
 module JWT
   module EdDSA
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/jwt/eddsa.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "jwt"
+require "ed25519"
 
 require_relative "eddsa/version"
 require_relative "eddsa/jwk/okp"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwt-eddsa
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Joakim Antman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jwt
+  name: ed25519
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rbnacl
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 2.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 2.8.2
 description: Extends the ruby-jwt gem with EdDSA signing, verification and JWK importing/exporting
 email:
 - antmanj@gmail.com
@@ -79,7 +79,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/anakinj/jwt-eddsa
   source_code_uri: https://github.com/anakinj/jwt-eddsa
-  changelog_uri: https://github.com/anakinj/jwt-eddsa/blob/v0.6.0/CHANGELOG.md
+  changelog_uri: https://github.com/anakinj/jwt-eddsa/blob/v0.7.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []