authlete 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97d78dd039d8f22081dd1085109d84809e5ee772
-  data.tar.gz: 7b3569794b98ad7c59eb28d0e458d4d05be474c6
+SHA256:
+  metadata.gz: 164290174c960b47c0108dbde641e0c01e37f38b2bdbafa9f36fcbb68f5dd053
+  data.tar.gz: 625eba82bcdee17d39a2635199e6228e6e9a001729fdf64a1343c486ecd23998
 SHA512:
-  metadata.gz: b737891b85b5507471f8ffe9ababe62ca7b2134b1b31a0e08c97ab8c36d862e296bc78649e2fc95768c2ce93895ca8dab189d74c0c13c609075268d89de9d27a
-  data.tar.gz: 3b1c04aba0b8e84bf1d0306ca93f0a9e93b0841442deba6d5e170c5cca75b9d8694338a91906671e44a37d97c9913f59d4f253f4e3b7486d1e6047d29a3f71a5
+  metadata.gz: 9a5224c845954deb1f327f7c726c5c61368800563225abe58190208bbd18a158764d656dff2576816faf1ef13772153004beb77dbd7555b9a587c6ddeb2df74a
+  data.tar.gz: 6a51b9016c348e583f1d5b43285c021aea1e60d6d3371a059d997f12e731cedc70dca2d5bdf883657c815d609fd3ea5ed293ddecbafb67f20a39d9dfb04ccd4b

data/lib/authlete.rb

@@ -39,6 +39,7 @@ module Authlete
     autoload :SnsCredentials, 'authlete/model/sns-credentials'
     autoload :TaggedValue, 'authlete/model/tagged-value'
     autoload :NamedUri, 'authlete/model/named-uri'
+    autoload :Hsk, 'authlete/model/hsk'
 
     module Request
       autoload :AuthenticationCallbackRequest, 'authlete/model/request/authentication-callback-request'

data/lib/authlete/model/hsk.rb

@@ -0,0 +1,67 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2021 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    class Hsk < Authlete::Model::Base
+      include Authlete::Model::Hashable
+      include Authlete::Utility
+
+      attr_accessor :kty
+
+      attr_accessor :use
+
+      attr_accessor :alg
+
+      attr_accessor :kid
+
+      attr_accessor :hsmName
+      alias_method  :hsm_name,  :hsmName
+      alias_method  :hsm_name=, :hsmName=
+
+      attr_accessor :handle
+
+      attr_accessor :publicKey
+      alias_method  :public_key,  :publicKey
+      alias_method  :public_key=, :publicKey=
+
+      private
+
+      def defaults
+        {
+          kty:       nil,
+          use:       nil,
+          alg:       nil,
+          kid:       nil,
+          hsmName:   nil,
+          handle:    nil,
+          publicKey: nil,
+        }
+      end
+
+      def set_params(hash)
+        @kty       = hash[:kty]
+        @use       = hash[:use]
+        @alg       = hash[:alg]
+        @kid       = hash[:kid]
+        @hsmName   = hash[:hsmName]
+        @handle    = hash[:handle]
+        @publicKey = hash[:publicKey]
+      end
+    end
+  end
+end

data/lib/authlete/model/service.rb

@@ -457,6 +457,12 @@ module Authlete
       alias_method  :request_object_encryption_enc_match_required,  :requestObjectEncryptionEncMatchRequired
       alias_method  :request_object_encryption_enc_match_required=, :requestObjectEncryptionEncMatchRequired=
 
+      attr_accessor :hsks
+
+      attr_accessor :hsmEnabled
+      alias_method  :hsm_enabled,  :hsmEnabled
+      alias_method  :hsm_enabled=, :hsmEnabled=
+
       private
 
       def defaults
@@ -572,7 +578,9 @@ module Authlete
           tokenExpirationLinked:                       false,
           frontChannelRequestObjectEncryptionRequired: false,
           requestObjectEncryptionAlgMatchRequired:     false,
-          requestObjectEncryptionEncMatchRequired:     false
+          requestObjectEncryptionEncMatchRequired:     false,
+          hsks:                                        nil,
+          hsmEnabled:                                  false
         }
       end
 
@@ -689,6 +697,8 @@ module Authlete
         @frontChannelRequestObjectEncryptionRequired = hash[:frontChannelRequestObjectEncryptionRequired]
         @requestObjectEncryptionAlgMatchRequired     = hash[:requestObjectEncryptionAlgMatchRequired]
         @requestObjectEncryptionEncMatchRequired     = hash[:requestObjectEncryptionEncMatchRequired]
+        @hsks                                        = get_parsed_array(hash[:hsks]) { |e| Authlete::Model::Hsk.parse(e) }
+        @hsmEnabled                                  = hash[:hsmEnabled]
       end
 
       def to_hash_value(key, var)
@@ -696,7 +706,7 @@ module Authlete
 
         case key
           when :snsCredentials, :developerSnsCredentials, :supportedScopes,
-               :metadata, :mtlsEndpointAliases, :attributes
+               :metadata, :mtlsEndpointAliases, :attributes, :hsks
             raw_val&.map { |e| e.to_hash }
           else
             raw_val

data/lib/authlete/version.rb

@@ -16,5 +16,5 @@
 
 
 module Authlete
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/test/authlete/model/test_hsk.rb

@@ -0,0 +1,108 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2021 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'authlete'
+require 'json'
+require 'minitest/autorun'
+
+
+class HskTest < Minitest::Test
+  KTY        = 'EC'
+  USE        = 'sig'
+  ALG        = 'ES256'
+  KID        = 'jane'
+  HSM_NAME   = 'google'
+  HANDLE     = '<handle>'
+  PUBLIC_KEY = '<public-key>'
+
+
+  def generate_json
+    return <<~JSON
+      {
+        "kty":       "EC",
+        "use":       "sig",
+        "alg":       "ES256",
+        "kid":       "jane",
+        "hsmName":   "google",
+        "handle":    "<handle>",
+        "publicKey": "<public-key>"
+      }
+    JSON
+  end
+
+
+  def generate_hash
+    {
+      kty:       'EC',
+      use:       'sig',
+      alg:       'ES256',
+      kid:       'jane',
+      hsmName:   'google',
+      handle:    '<handle>',
+      publicKey: '<public-key>'
+    }
+  end
+
+
+  def set_params(obj)
+    obj.kty       = KTY
+    obj.use       = USE
+    obj.alg       = ALG
+    obj.kid       = KID
+    obj.hsmName   = HSM_NAME
+    obj.handle    = HANDLE
+    obj.publicKey = PUBLIC_KEY
+  end
+
+
+  def match(obj)
+    assert_equal KTY,        obj.kty
+    assert_equal USE,        obj.use
+    assert_equal ALG,        obj.alg
+    assert_equal KID,        obj.kid
+    assert_equal HSM_NAME,   obj.hsmName
+    assert_equal HANDLE,     obj.handle
+    assert_equal PUBLIC_KEY, obj.publicKey
+  end
+
+
+  def test_from_json
+    jsn    = generate_json
+    hsh    = JSON.parse(jsn)
+    actual = Authlete::Model::Hsk.new(hsh)
+
+    match(actual)
+  end
+
+
+  def test_setters
+    actual = Authlete::Model::Hsk.new
+    set_params(actual)
+
+    match(actual)
+  end
+
+
+  def test_to_hash
+    obj = Authlete::Model::Hsk.new
+    set_params(obj)
+    actual   = obj.to_hash
+    expected = generate_hash
+
+    assert_equal expected, actual
+  end
+end

data/test/authlete/model/test_service.rb

@@ -147,6 +147,15 @@ class ServiceTest < Minitest::Test
   FRONT_CHANNEL_REQUEST_OBJECT_ENCRYPTION_REQUIRED = false
   REQUEST_OBJECT_ENCRYPTION_ALG_MATCH_REQUIRED     = false
   REQUEST_OBJECT_ENCRYPTION_ENC_MATCH_REQUIRED     = false
+  HSKS_KTY                                         = 'EC'
+  HSKS_USE                                         = 'sig'
+  HSKS_ALG                                         = 'ES256'
+  HSKS_KID                                         = 'jane'
+  HSKS_HSMNAME                                     = 'google'
+  HSKS_HANDLE                                      = '<handle>'
+  HSKS_PUBLICKEY                                   = '<public-key>'
+  HSKS                                             = [ Authlete::Model::Hsk.new(kty: HSKS_KTY, use: HSKS_USE, alg: HSKS_ALG, kid: HSKS_KID, hsmName: HSKS_HSMNAME, handle: HSKS_HANDLE, publicKey: HSKS_PUBLICKEY) ]
+  HSM_ENABLED                                      = false
 
 
   def generate_json
@@ -165,6 +174,8 @@ class ServiceTest < Minitest::Test
         "userInfoEndpoint":                            "<user-info-endpoint>",
         "jwksUri":                                     "<jwks-uri>",
         "jwks":                                        "<jwks>",
+        "hsks":                                        [ { "kty": "EC", "use": "sig", "alg": "ES256", "kid": "jane", "hsmName": "google", "handle": "<handle>", "publicKey": "<public-key>" } ],
+        "hsmEnabled":                                  false,
         "registrationEndpoint":                        "<registration-endpoint>",
         "registrationManagementEndpoint":              "<registration-management-endpoint>",
         "supportedScopes":                             [ { "name": "scope0", "description": "<scope0-description>" } ],
@@ -382,7 +393,9 @@ class ServiceTest < Minitest::Test
       tokenExpirationLinked:                       false,
       frontChannelRequestObjectEncryptionRequired: false,
       requestObjectEncryptionAlgMatchRequired:     false,
-      requestObjectEncryptionEncMatchRequired:     false
+      requestObjectEncryptionEncMatchRequired:     false,
+      hsks:                                        [ { kty: 'EC', use: 'sig', alg: 'ES256', kid: 'jane', hsmName: 'google', handle: '<handle>', publicKey: '<public-key>' } ],
+      hsmEnabled:                                  false
     }
   end
 
@@ -500,6 +513,8 @@ class ServiceTest < Minitest::Test
     obj.frontChannelRequestObjectEncryptionRequired   = FRONT_CHANNEL_REQUEST_OBJECT_ENCRYPTION_REQUIRED
     obj.requestObjectEncryptionAlgMatchRequired       = REQUEST_OBJECT_ENCRYPTION_ALG_MATCH_REQUIRED
     obj.requestObjectEncryptionEncMatchRequired       = REQUEST_OBJECT_ENCRYPTION_ENC_MATCH_REQUIRED
+    obj.hsks                                          = HSKS
+    obj.hsm_enabled                                   = HSM_ENABLED
   end
 
 
@@ -624,6 +639,14 @@ class ServiceTest < Minitest::Test
     assert_equal FRONT_CHANNEL_REQUEST_OBJECT_ENCRYPTION_REQUIRED, obj.frontChannelRequestObjectEncryptionRequired
     assert_equal REQUEST_OBJECT_ENCRYPTION_ALG_MATCH_REQUIRED,     obj.requestObjectEncryptionAlgMatchRequired
     assert_equal REQUEST_OBJECT_ENCRYPTION_ENC_MATCH_REQUIRED,     obj.requestObjectEncryptionEncMatchRequired
+    assert_equal HSKS_KTY,                                         obj.hsks[0].kty
+    assert_equal HSKS_USE,                                         obj.hsks[0].use
+    assert_equal HSKS_ALG,                                         obj.hsks[0].alg
+    assert_equal HSKS_KID,                                         obj.hsks[0].kid
+    assert_equal HSKS_HSMNAME,                                     obj.hsks[0].hsmName
+    assert_equal HSKS_HANDLE,                                      obj.hsks[0].handle
+    assert_equal HSKS_PUBLICKEY,                                   obj.hsks[0].publicKey
+    assert_equal HSM_ENABLED,                                      obj.hsmEnabled
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authlete
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Takahiko Kawasaki
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-26 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,6 +75,7 @@ files:
 - lib/authlete/model/client-extension.rb
 - lib/authlete/model/client.rb
 - lib/authlete/model/hashable.rb
+- lib/authlete/model/hsk.rb
 - lib/authlete/model/named-uri.rb
 - lib/authlete/model/pair.rb
 - lib/authlete/model/param-initializer.rb
@@ -207,6 +208,7 @@ files:
 - test/authlete/model/response/test_user-info-response.rb
 - test/authlete/model/test_client-extension.rb
 - test/authlete/model/test_client.rb
+- test/authlete/model/test_hsk.rb
 - test/authlete/model/test_named-uri.rb
 - test/authlete/model/test_pair.rb
 - test/authlete/model/test_property.rb
@@ -236,8 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.8
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A library for Authlete Web APIs
@@ -300,6 +301,7 @@ test_files:
 - test/authlete/model/response/test_user-info-response.rb
 - test/authlete/model/test_client-extension.rb
 - test/authlete/model/test_client.rb
+- test/authlete/model/test_hsk.rb
 - test/authlete/model/test_named-uri.rb
 - test/authlete/model/test_pair.rb
 - test/authlete/model/test_property.rb