json-jwt 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4956348cf3828c6139ccc4d07759b219e57bb251
-  data.tar.gz: 68f781f2de2c2503eda3abf3418f8f80f908d5dc
+  metadata.gz: 1815ea41a4fd9ae6a1d6232259a7956ba070b713
+  data.tar.gz: 2efa46ef39b82e61e5d58817cd804eb3dd50d053
 SHA512:
-  metadata.gz: c3f0df77b65f72a920743330dd3fbc9338c73e6df493746abafdf4ca2b370090892eb6b6b7c636b4db569af03a6e0e288425ea0d0df56fee28b6ae7dbee90cf3
-  data.tar.gz: 66b3c28180bd8573f1813e1db5922de6b7253ac4965cf30c9b307ffb6820520b4e76fdd1ba9d0d467bee2533a8eb6ba7a5b510d2e5ca480b5ab9e0d31abd966d
+  metadata.gz: a3ecc9a34475f36916f12242f2293db9d9c5a0382619bf250ef1b5aa5650ae0030cfbcc533a56ebbd63a2f43e065f27322c4dc747fee850310f6d8ecab30ce93
+  data.tar.gz: e4c2d71d75053fc1357e1d0e88b9f88e048587d11189dfdb934e24f3a74b33f7e9dec885aeb1874ffff16609e4bcae15b893efd68d5e5cf6490a90771a4dd3e3

data/README.md

@@ -15,7 +15,9 @@ JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON
 
 ## Examples
 
-### Encoding
+### JWT, JWS and JWE
+
+#### Encoding
 
 ```ruby
 require 'json/jwt'
@@ -40,11 +42,38 @@ jwe = jws.encrypt(key, algorithm, encryption_method) # algorithm & encryption_me
 jwe.to_s # => header.encrypted_key.iv.cipher_text.authentication_tag
 ```
 
-For details about `key` and `algorithm`, see
-[JWS Spec](https://github.com/nov/json-jwt/blob/master/spec/json/jws_spec.rb) and
-[Sign Key Fixture Generator](https://github.com/nov/json-jwt/blob/master/spec/helpers/sign_key_fixture_helper.rb).
-
-### Decoding
+Supported `key` are
+* `String`
+* `OpenSSL::PKey::RSA`
+* `OpenSSL::PKey::EC`
+* `JSON::JWK`
+* `JSON::JWK::Set` # NOTE: proper `JSON::JWK` in the set will be selected by `kid` in the header.
+
+Supported `algorithm` are
+
+For JWS
+* `HS256`
+* `HS384`
+* `HS512`
+* `RS256`
+* `RS384`
+* `RS512`
+* `ES256`
+* `ES384`
+* `ES512`
+
+For JWE
+* `RSA1_5`
+* `RSA-OAEP`
+* `dir`
+
+Supported `encryption_method` are
+* `A128GCM`
+* `A256GCM`
+* `A128CBC-HS256`
+* `A256CBC-HS512`
+
+#### Decoding
 
 ```ruby
 jwt_string = "jwt_header.jwt_claims.jwt_signature"
@@ -52,6 +81,44 @@ jwt_string = "jwt_header.jwt_claims.jwt_signature"
 JSON::JWT.decode(jwt_string, key)
 ```
 
+### JWK
+
+#### RSA
+
+```ruby
+k = OpenSSL::PKey::RSA.new(2048)
+p k.to_jwk
+# => JSON::JWK
+
+jwk = JSON::JWK.new(
+  kty: "RSA",
+  e: "AQAB",
+  n: "utwietJHu65N7kIa52bMkKgbS1CGmhKNDx3gTBEvQmQhg1BbKHfdmqapMt699T-aloeslYxeO9ItOhprnE0vG-pbDUE7Jg51gtK6kjpLFZOLNpRHJnRikyF6dav1IdJa4fSpOiEJiHk_DuFnAMI04_1H_NISn1TzEBflbyb6BSyIPkfO9433zR2-clvHdIXppq-N272vHA64Xp5hslzY91QodXo5--9iIblPVxzd9aH-aBMSkRbmlIKuz14tWhR-6RLNsWtqxWfKvgeoBLh5e9E5MrlNuRnaaLqHOMWrW1l9985eqmCD3PD4wjwINFKrU4L0fMBCHgCDAZLhbLfUJw",
+  d: "NtFBpDpwJNT7s7vc3KnBtWY7q5qSAj0S-K5REL-x1448bqNyOqr_bdEarfu-SmZAWYyvyqeFNZNxBSyfCRlzioLz9y19xqpTOu_LH_7N7CR-oKJbRSK7kGIv5Llvjl6BnuwBgTYT799x6lGhwA05KvEw3zBZmjh3ne8Etdj_W-i2LDBDUimgmVrgXWY1KvWFgh2zpptIINX2Q8UxV121bdcBIbj008Cs64m2mMpaa3ggqqNoXnYb8HnJDnYx-WIbUMHJ2-hpZAsVFNet8ZVEMt4cTKaTHY23m9Ditj-7VfFzkoiH9Yj45ewJMpcssadnAPrBgKbjTFuTdJfP8IqMoQ"
+)
+jwk.to_key
+# => OpenSSL::PKey::RSA
+```
+
+#### EC
+
+```ruby
+k = OpenSSL::PKey::RSA.new(2048)
+k.to_jwk
+# => JSON::JWK
+
+jwk = JSON::JWK.new(
+  kty: "RSA",
+  e: "AQAB",
+  n: "0OIOijENzP0AXnxP-X8Dnazt3m4NTamfNsSCkH4xzgZAJj2Eur9-zmq9IukwN37lIrm3oAE6lL4ytNkv-DQpAivKLE8bh4c9qlB9o32VWyg-mg-2af-JlfGXYoaCW2GDMOV6EKqHBxE0x1EI0tG4gcNwO6A_kYtK6_ACgTQudWz_gnPrL-QCunjIMbbrK9JqgMZhgMARMQpB-j8oet2FFsEcquR5MWtBeAn7qC1AD2ya0EmzplZJP6oCka_VVuxAnyWfRGA0bzCBRIVbcGUXVNIXpRtA_4960e7AlGfMSA-ofN-vo7v0CMkA8BwpZHai9CAJ-cTCX1AVbov83LVIWw",
+  d: "BZCgNopMBdQPuHSzZMA_hmnfBHgGHrWQKlNd7x-NkCGWf-5PpPIJHNK3K0DvKetVi3FLNRYTS3ctvqeyoXgyR36HKlsJLrkpqWnvjvV_jygpUs1sXLKUJcyD7foLawfUCO90KxF_-24367967rLrqXldehkw2F3Ppy2Dw5FyU2qBqcpLeruBt6-UdMmBufzNQLisPJ67vhCTVrTNaHDDeCK2gHI3gqsnnbzOMS45VknmFOgKUp1C8GZu5BsT-AdDApEtY-DRZqnr6BxZv4-hG5OdEUA4_LCaI6JwlaAzv0Z74jpBZDC73cXWKJPgVuhARZcll5cexB2_EpgZDB6akQ",
+  p: "6GFVNgaXcW39NG-sRqKPzFtz1usfAkdCydPmfZirfHRhSh3OojX3Glbe7BI_SRSOLc2d2xw2_ZwKRlruY44aGEf4s5gD_nKgq2QS-1cA5uNAU91wRtY2rdoAuCnk2BX3WTZPnzyxkokFY0S0R_9IpJhRz72ggxYyhx0ymRUBIWc",
+  q: "5h1QX2JWLbcIT_cfrkmMoES1z06Fu88MLORYppiRDqkXl3CJFxKFtKJtDPLTf0MeTFexh81V52Ztsd8UttPInyDl9l5T0AOy8NmqHKqjI1063uy4bnHWetN7ovHftc_TOlnldAoQh9bmhZAhEyGlwa5Kros2YD2amIgDhcOmRO0"
+)
+jwk.to_key
+# => OpenSSL::PKey::EC
+```
+
 ## Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.2.3

data/lib/json/jwk.rb

@@ -2,15 +2,19 @@ module JSON
   class JWK < ActiveSupport::HashWithIndifferentAccess
     class UnknownAlgorithm < JWT::Exception; end
 
-    def initialize(constructor = {}, ex_params = {})
-      if constructor.is_a? OpenSSL::PKey::PKey
-        if constructor.respond_to? :to_jwk
-          super constructor.to_jwk(ex_params)
-        else
-          raise UnknownAlgorithm.new('Unknown Key Type')
-        end
+    def initialize(params = {}, ex_params = {})
+      case params
+      when OpenSSL::PKey::RSA, OpenSSL::PKey::EC
+        super params.to_jwk(ex_params)
+      when OpenSSL::PKey::PKey
+        raise UnknownAlgorithm.new('Unknown Key Type')
+      when String
+        super(
+          k: params,
+          kty: :oct
+        )
       else
-        super constructor
+        super params
         merge! ex_params
       end
     end
@@ -88,7 +92,7 @@ module JSON
     end
 
     def to_rsa_key
-      e, n, d = [:e, :n, :d].collect do |key|
+      e, n, d, p, q = [:e, :n, :d, :p, :q].collect do |key|
         if self[key]
           OpenSSL::BN.new UrlSafeBase64.decode64(self[key]), 2
         end
@@ -97,6 +101,8 @@ module JSON
       key.e = e
       key.n = n
       key.d = d if d
+      key.p = p if p
+      key.q = q if q
       key
     end
 

data/lib/json/jwk/jwkizable.rb

@@ -8,7 +8,13 @@ module JSON
             e: UrlSafeBase64.encode64(e.to_s(2)),
             n: UrlSafeBase64.encode64(n.to_s(2))
           }.merge ex_params
-          params[:d] = UrlSafeBase64.encode64(d.to_s(2)) if private?
+          if private?
+            params.merge!(
+              d: UrlSafeBase64.encode64(d.to_s(2)),
+              p: UrlSafeBase64.encode64(p.to_s(2)),
+              q: UrlSafeBase64.encode64(q.to_s(2))
+            )
+          end
           JWK.new params
         end
       end

data/spec/json/jwk_spec.rb

@@ -2,7 +2,42 @@ require 'spec_helper'
 
 describe JSON::JWK do
   describe '#initialize' do
-    it :TODO
+    subject { JSON::JWK.new key }
+
+    context 'with OpenSSL::PKey::RSA' do
+      let(:key) { public_key }
+      it { should be_instance_of JSON::JWK }
+    end
+
+    context 'with OpenSSL::PKey::EC' do
+      let(:key) { public_key :ecdsa }
+      it { should be_instance_of JSON::JWK }
+    end
+
+    context 'with String' do
+      let(:key) { 'secret' }
+      it { should be_instance_of JSON::JWK }
+    end
+
+    context 'with JSON::JWK' do
+      let(:key) do
+        JSON::JWK.new(
+          k: 'secret',
+          kty: :oct
+        )
+      end
+      it { should be_instance_of JSON::JWK }
+    end
+
+    context 'with Hash' do
+      let(:key) do
+        {
+          k: 'secret',
+          kty: :oct
+        }
+      end
+      it { should be_instance_of JSON::JWK }
+    end
   end
 
   describe '#content_type' do
@@ -85,6 +120,41 @@ describe JSON::JWK do
     end
   end
 
+  describe '#thumbprint' do
+    context 'when kty=RSA' do
+      subject do
+        JSON::JWK.new(
+          kty: :RSA,
+          e: 'AQAB',
+          n: '0OIOijENzP0AXnxP-X8Dnazt3m4NTamfNsSCkH4xzgZAJj2Eur9-zmq9IukwN37lIrm3oAE6lL4ytNkv-DQpAivKLE8bh4c9qlB9o32VWyg-mg-2af-JlfGXYoaCW2GDMOV6EKqHBxE0x1EI0tG4gcNwO6A_kYtK6_ACgTQudWz_gnPrL-QCunjIMbbrK9JqgMZhgMARMQpB-j8oet2FFsEcquR5MWtBeAn7qC1AD2ya0EmzplZJP6oCka_VVuxAnyWfRGA0bzCBRIVbcGUXVNIXpRtA_4960e7AlGfMSA-ofN-vo7v0CMkA8BwpZHai9CAJ-cTCX1AVbov83LVIWw'
+        )
+      end
+      its(:thumbprint) { should == 'fFn3D1P0H7Qo1ugQ-5LM6LC63LtArbkPsbQcs2F-1yA' }
+    end
+
+    context 'when kty=EC' do
+      subject do
+        JSON::JWK.new(
+          kty: 'EC',
+          crv: 'P-256',
+          x: 'saPyrO4Lh9kh2FxrF9y1QVmZznWnRRJwpr12UHqzrVY',
+          y: 'MMz4W9zzqlrJhqr-JyrpvlnaIIyZQE6DfrgPkxMAw1M'
+        )
+      end
+      its(:thumbprint) { should == '-egRpLjyZCqxBh4OOfd8JSvXwayHmNFAUNkbi8exfhc' }
+    end
+
+    context 'when kty=oct' do
+      subject do
+        JSON::JWK.new(
+          kty: 'oct',
+          k: 'secret'
+        )
+      end
+      its(:thumbprint) { should == 'XZPWsTEZFIerowAF9GHzBtq5CkAOcVvIBnkMu0IIQH0' }
+    end
+  end
+
   describe '.decode' do
     context 'when RSA' do
       subject do

data/spec/json/jws_spec.rb

@@ -55,25 +55,45 @@ describe JSON::JWS do
 
     [:HS256, :HS384, :HS512].each do |algorithm|
       describe algorithm do
-        let(:private_key_or_secret) { shared_secret }
         let(:alg) { algorithm }
-        it_behaves_like :jwt_with_alg
-        it_behaves_like :generate_expected_signature
+
+        context 'when String key given' do
+          let(:private_key_or_secret) { shared_secret }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :generate_expected_signature
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:private_key_or_secret) { JSON::JWK.new shared_secret }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :generate_expected_signature
+        end
       end
     end
 
     [:RS256, :RS384, :RS512].each do |algorithm|
       describe algorithm do
-        let(:private_key_or_secret) { private_key }
         let(:alg) { algorithm }
-        it_behaves_like :jwt_with_alg
-        it_behaves_like :generate_expected_signature
+
+        context 'when OpenSSL::PKey::RSA key given' do
+          let(:private_key_or_secret) { private_key }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :generate_expected_signature
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:private_key_or_secret) { JSON::JWK.new private_key }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :generate_expected_signature
+        end
       end
+    end
 
-      [:ES256, :ES384, :ES512].each do |algorithm|
-        describe algorithm do
-          let(:private_key_or_secret) { private_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
-          let(:public_key_or_secret)  { public_key  :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
+    [:ES256, :ES384, :ES512].each do |algorithm|
+      describe algorithm do
+        let(:alg) { algorithm }
+
+        shared_examples_for :self_verifiable do
           it 'should be self-verifiable' do
             expect do
               JSON::JWT.decode(
@@ -84,9 +104,27 @@ describe JSON::JWS do
             end.not_to raise_error
           end
         end
+
+        context 'when OpenSSL::PKey::EC key given' do
+          let(:private_key_or_secret) { private_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
+          let(:public_key_or_secret)  { public_key  :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :self_verifiable
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:private_key_or_secret) { JSON::JWK.new(private_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i) }
+          let(:public_key_or_secret)  { JSON::JWK.new(public_key  :ecdsa, digest_length: algorithm.to_s[2,3].to_i) }
+          it_behaves_like :jwt_with_alg
+          it_behaves_like :self_verifiable
+        end
       end
     end
 
+    context 'when JSON::JWK::Set key given' do
+      it :TODO
+    end
+
     describe 'unknown algorithm' do
       let(:alg) { :unknown }
       it do
@@ -124,28 +162,52 @@ describe JSON::JWS do
 
     [:HS256, :HS384, :HS512].each do |algorithm|
       describe algorithm do
-        let(:private_key_or_secret) { shared_secret }
-        let(:public_key_or_secret) { shared_secret }
         let(:alg) { algorithm }
-        it_behaves_like :success_signature_verification
+        let(:private_key_or_secret) { shared_secret }
+
+        context 'when String key given' do
+          let(:public_key_or_secret) { shared_secret }
+          it_behaves_like :success_signature_verification
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:public_key_or_secret) { JSON::JWK.new shared_secret }
+          it_behaves_like :success_signature_verification
+        end
       end
     end
 
     [:RS256, :RS384, :RS512].each do |algorithm|
       describe algorithm do
-        let(:private_key_or_secret) { private_key }
-        let(:public_key_or_secret) { public_key }
         let(:alg) { algorithm }
-        it_behaves_like :success_signature_verification
+        let(:private_key_or_secret) { private_key }
+
+        context 'when OpenSSL::PKey::RSA key given' do
+          let(:public_key_or_secret) { public_key }
+          it_behaves_like :success_signature_verification
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:public_key_or_secret) { JSON::JWK.new public_key }
+          it_behaves_like :success_signature_verification
+        end
       end
     end
 
     [:ES256, :ES384, :ES512].each do |algorithm|
       describe algorithm do
-        let(:private_key_or_secret) { private_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
-        let(:public_key_or_secret)  { public_key  :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
         let(:alg) { algorithm }
-        it_behaves_like :success_signature_verification
+        let(:private_key_or_secret) { private_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
+
+        context 'when OpenSSL::PKey::EC key given' do
+          let(:public_key_or_secret) { public_key :ecdsa, digest_length: algorithm.to_s[2,3].to_i }
+          it_behaves_like :success_signature_verification
+        end
+
+        context 'when JSON::JWK key given' do
+          let(:public_key_or_secret) { JSON::JWK.new public_key(:ecdsa, digest_length: algorithm.to_s[2,3].to_i) }
+          it_behaves_like :success_signature_verification
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-jwt
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - nov matake