authlete 1.26.1 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0a0d1cdf37a68632b896d2e69f2d9a40b9e5465cf30de8fc5ca1c42ac8fd8a
-  data.tar.gz: ff5bda944050f3ca97696573c3c7b45f4b958bf233135db376c85c09c0ca8ca9
+  metadata.gz: 998f791a1e948dc8aeee643775ab8236b5fcfcd19d23388a9ff0155b95486db5
+  data.tar.gz: fa726f604cb3d6527676125f748ca76529083224753dfc88c16ac959118fcab0
 SHA512:
-  metadata.gz: b58b1609f1b72fe535c5ea743db94aa111d7a2662d44d5936c879cd865544286fdbae382de7b376be5312bbfc8e2a03d2cd11dcb28be5f86fa630e034e0609f3
-  data.tar.gz: 9d5424767bff36a0ab39f8e9f295cdc4829fa619ecec665284cd8ed44794a7400b0f7b2205d369198846e950ba14104e7d989b0bd9bbed8695812e748e35754b
+  metadata.gz: a3109b33580df6d4822cfad82e53c93f71308be514608302e5ee5ff1b99243afc4e490f45207435532644001a17c407685094ef8eae4c8107a2e61368b03ed8c
+  data.tar.gz: 25b65a63e5fbad1335986a9018ba12420e5494d8e22dcd3a7d6785ff2accc0a583b967f94ae3e375fbb8e1ec2173f07a98b88495f4ff6e0a6f7b9c506e5b1342

data/authlete.gemspec

@@ -6,7 +6,7 @@ require 'authlete/version'
 Gem::Specification.new do |spec|
   spec.name          = "authlete"
   spec.version       = Authlete::VERSION
-  spec.authors       = ["Takahiko Kawasaki", "Hideki Ikeda"]
+  spec.authors       = ["Takahiko Kawasaki", "Hideki Ikeda", "Seth Wright"]
   spec.email         = ["admin@authlete.com"]
   spec.summary       = "A library for Authlete Web APIs"
   spec.description   = "A library for Authlete Web APIs. See https://docs.authlete.com/ for details."

data/lib/authlete/model/client.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2020 Authlete, Inc.
+# Copyright (C) 2014-2022 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,9 @@
 # limitations under the License.
 
 
+require 'json'
+
+
 module Authlete
   module Model
     class Client < Authlete::Model::Base
@@ -321,6 +324,14 @@ module Authlete
       alias_method  :pkce_s256_required,  :pkceS256Required
       alias_method  :pkce_s256_required=, :pkceS256Required=
 
+      attr_accessor :automaticallyRegistered
+      alias_method  :automatically_registered,  :automaticallyRegistered
+      alias_method  :automatically_registered=, :automaticallyRegistered=
+
+      attr_accessor :explicitlyRegistered
+      alias_method  :explicitly_registered,  :explicitlyRegistered
+      alias_method  :explicitly_registered=, :explicitlyRegistered=
+
       private
 
       def defaults
@@ -404,6 +415,8 @@ module Authlete
           singleAccessTokenPerSubject:                 false,
           pkceRequired:                                false,
           pkceS256Required:                            false,
+          automaticallyRegistered:                     false,
+          explicitlyRegistered:                        false,
         }
       end
 
@@ -487,6 +500,8 @@ module Authlete
         @singleAccessTokenPerSubject                 = hash[:singleAccessTokenPerSubject]
         @pkceRequired                                = hash[:pkceRequired]
         @pkceS256Required                            = hash[:pkceS256Required]
+        @automaticallyRegistered                     = hash[:automaticallyRegistered]
+        @explicitlyRegistered                        = hash[:explicitlyRegistered]
       end
 
       def to_hash_value(key, var)
@@ -502,6 +517,121 @@ module Authlete
             raw_val
         end
       end
+
+      public
+
+      def standard_metadata(delete_zero = true, delete_false = true, delete_nil = true)
+        metadata = {
+          client_id:                                      "#{@clientId}",
+          redirect_uris:                                  @redirectUris,
+          response_types:                                 standard_response_types(@responseTypes),
+          grant_types:                                    standard_grant_types(@grantTypes),
+          application_type:                               from_application_type(@applicationType),
+          contacts:                                       @contacts,
+          client_name:                                    @clientName,
+          logo_uri:                                       @logoUri,
+          client_uri:                                     @clientUri,
+          policy_uri:                                     @policyUri,
+          tos_uri:                                        @tosUri,
+          jwks_uri:                                       @jwksUri,
+          jwks:                                           json_parse(@jwks),
+          sector_identifier_uri:                          @sectorIdentifierUri,
+          subject_type:                                   from_subject_type(@subjectType),
+          id_token_signed_response_alg:                   from_jwsalg(@idTokenSignAlg),
+          id_token_encrypted_response_alg:                from_jwealg(@idTokenEncryptionAlg),
+          id_token_encrypted_response_enc:                from_jweenc(@idTokenEncryptionEnc),
+          userinfo_signed_response_alg:                   from_jwsalg(@userInfoSignAlg),
+          userinfo_encrypted_response_alg:                from_jwealg(@userInfoEncryptionAlg),
+          userinfo_encrypted_response_enc:                from_jweenc(@userInfoEncryptionEnc),
+          request_object_signing_alg:                     from_jwsalg(@requestSignAlg),
+          request_object_encryption_alg:                  from_jwealg(@requestEncryptionAlg),
+          request_object_encryption_enc:                  from_jweenc(@requestEncryptionEnc),
+          token_endpoint_auth_method:                     from_client_auth_method(@tokenAuthMethod),
+          token_endpoint_auth_signing_alg:                from_jwsalg(@tokenAuthSignAlg),
+          default_max_age:                                @defaultMaxAge,
+          default_acr_values:                             @defaultAcrs,
+          require_auth_time:                              @authTimeRequired,
+          initiate_login_uri:                             @loginUri,
+          request_uris:                                   @requestUris,
+          tls_client_auth_subject_dn:                     @tlsClientAuthSubjectDn,
+          tls_client_auth_san_dns:                        @tlsClientAuthSanDns,
+          tls_client_auth_san_uri:                        @tlsClientAuthSanUri,
+          tls_client_auth_san_ip:                         @tlsClientAuthSanIp,
+          tls_client_auth_san_email:                      @tlsClientAuthSanEmail,
+          tls_client_certificate_bound_access_tokens:     @tlsClientCertificateBoundAccessTokens,
+          software_id:                                    @softwareId,
+          software_version:                               @softwareVersion,
+          authorization_signed_response_alg:              from_jwsalg(@authorizationSignAlg),
+          authorization_encrypted_response_alg:           from_jwealg(@authorizationEncryptionAlg),
+          authorization_encrypted_response_enc:           from_jweenc(@authorizationEncryptionEnc),
+          backchannel_token_delivery_mode:                from_delivery_mode(@bcDeliveryMode),
+          backchannel_client_notification_endpoint:       @bcNotificationEndpoint,
+          backchannel_authentication_request_signing_alg: from_jwsalg(@bcRequestSignAlg),
+          backchannel_user_code_parameter:                @bcUserCodeRequired,
+          authorization_details_types:                    @authorizationDetailsTypes,
+          digest_algorithm:                               @digestAlgorithm
+        }
+
+        if delete_nil
+          metadata.compact!
+        end
+
+        if delete_false
+          metadata = metadata.delete_if {|key, value| value == false}
+        end
+
+        if delete_zero
+          metadata = metadata.delete_if {|key, value| value == 0}
+        end
+
+        metadata
+      end
+
+      private
+
+      def standard_response_types(array)
+        array.nil? ? nil : array.map do |element|
+          Authlete::Types::ResponseType::constant_get(element)
+        end
+      end
+
+      def standard_grant_types(array)
+        array.nil? ? nil : array.map do |element|
+          Authlete::Types::GrantType::constant_get(element)
+        end
+      end
+
+      def json_parse(json)
+        json.nil? ? nil : JSON.parse(json)
+      end
+
+      def from_application_type(constant_name)
+        Authlete::Types::ApplicationType::constant_get(constant_name)
+      end
+
+      def from_client_auth_method(constant_name)
+        Authlete::Types::ClientAuthMethod::constant_get(constant_name)
+      end
+
+      def from_delivery_mode(constant_name)
+        Authlete::Types::DeliveryMode::constant_get(constant_name)
+      end
+
+      def from_jwealg(constant_name)
+        Authlete::Types::JWEAlg::constant_get(constant_name)
+      end
+
+      def from_jweenc(constant_name)
+        Authlete::Types::JWEEnc::constant_get(constant_name)
+      end
+
+      def from_jwsalg(constant_name)
+        Authlete::Types::JWSAlg::constant_get(constant_name)
+      end
+
+      def from_subject_type(constant_name)
+        Authlete::Types::SubjectType::constant_get(constant_name)
+      end
     end
   end
 end

data/lib/authlete/model/service.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2020 Authlete, Inc.
+# Copyright (C) 2014-2022 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -607,6 +607,10 @@ module Authlete
       alias_method  :dcr_duplicate_software_id_blocked,  :dcrDuplicateSoftwareIdBlocked
       alias_method  :dcr_duplicate_software_id_blocked=, :dcrDuplicateSoftwareIdBlocked=
 
+      attr_accessor :openidDroppedOnRefreshWithoutOfflineAccess
+      alias_method  :openid_dropped_on_refresh_without_offline_access,  :openidDroppedOnRefreshWithoutOfflineAccess
+      alias_method  :openid_dropped_on_refresh_without_offline_access=, :openidDroppedOnRefreshWithoutOfflineAccess=
+
       private
       
       def defaults
@@ -761,6 +765,7 @@ module Authlete
           federationSignatureKeyId:                    nil,
           federationConfigurationDuration:             0,
           dcrDuplicateSoftwareIdBlocked:               false,
+          openidDroppedOnRefreshWithoutOfflineAccess:  false,
         }
       end
 
@@ -915,6 +920,7 @@ module Authlete
         @federationSignatureKeyId                    = hash[:federationSignatureKeyId]
         @federationConfigurationDuration             = hash[:federationConfigurationDuration]
         @dcrDuplicateSoftwareIdBlocked               = hash[:dcrDuplicateSoftwareIdBlocked]
+        @openidDroppedOnRefreshWithoutOfflineAccess  = hash[:openidDroppedOnRefreshWithoutOfflineAccess]
 
       end
 

data/lib/authlete/types/application-type.rb

@@ -0,0 +1,27 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module ApplicationType
+      extend Authlete::Types::ConstantUtility
+
+      WEB    = "web"
+      NATIVE = "native"
+    end
+  end
+end

data/lib/authlete/types/client-auth-method.rb

@@ -0,0 +1,32 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module ClientAuthMethod
+      extend Authlete::Types::ConstantUtility
+
+      NONE                        = "none"
+      CLIENT_SECRET_BASIC         = "client_secret_basic"
+      CLIENT_SECRET_POST          = "client_secret_post"
+      CLIENT_SECRET_JWT           = "client_secret_jwt"
+      PRIVATE_KEY_JWT             = "private_key_jwt"
+      TLS_CLIENT_AUTH             = "tls_client_auth"
+      SELF_SIGNED_TLS_CLIENT_AUTH = "self_signed_tls_client_auth"
+    end
+  end
+end

data/lib/authlete/types/constant-utility.rb

@@ -0,0 +1,34 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module ConstantUtility
+      def constant_get(constant_name)
+        if constant_name.nil?
+          return nil
+        end
+
+        begin
+          const_get(constant_name)
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/authlete/types/delivery-mode.rb

@@ -0,0 +1,28 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module DeliveryMode
+      extend Authlete::Types::ConstantUtility
+
+      POLL = "poll"
+      PING = "ping"
+      PUSH = "push"
+    end
+  end
+end

data/lib/authlete/types/grant-type.rb

@@ -0,0 +1,34 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module GrantType
+      extend Authlete::Types::ConstantUtility
+
+      AUTHORIZATION_CODE = "authorization_code"
+      IMPLICIT           = "implicit"
+      PASSWORD           = "password"
+      CLIENT_CREDENTIALS = "client_credentials"
+      REFRESH_TOKEN      = "refresh_token"
+      CIBA               = "urn:openid:params:grant-type:ciba"
+      DEVICE_CODE        = "urn:ietf:params:oauth:grant-type:device_code"
+      TOKEN_EXCHANGE     = "urn:ietf:params:oauth:grant-type:token-exchange"
+      JWT_BEARER         = "urn:ietf:params:oauth:grant-type:jwt-bearer"
+    end
+  end
+end

data/lib/authlete/types/jwealg.rb

@@ -0,0 +1,42 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module JWEAlg
+      extend Authlete::Types::ConstantUtility
+
+      RSA1_5             = "RSA1_5"
+      RSA_OAEP           = "RSA-OAEP"
+      RSA_OAEP_256       = "RSA-OAEP-256"
+      A128KW             = "A128KW"
+      A192KW             = "A192KW"
+      A256KW             = "A256KW"
+      DIR                = "dir"
+      ECDH_ES            = "ECDH-ES"
+      ECDH_ES_A128KW     = "ECDH-ES+A128KW"
+      ECDH_ES_A192KW     = "ECDH-ES+A192KW"
+      ECDH_ES_A256KW     = "ECDH-ES+A256KW"
+      A128GCMKW          = "A128GCMKW"
+      A192GCMKW          = "A192GCMKW"
+      A256GCMKW          = "A256GCMKW"
+      PBES2_HS256_A128KW = "PBES2-HS256+A128KW"
+      PBES2_HS384_A192KW = "PBES2-HS384+A192KW"
+      PBES2_HS512_A256KW = "PBES2-HS512+A256KW"
+    end
+  end
+end

data/lib/authlete/types/jweenc.rb

@@ -0,0 +1,31 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module JWEEnc
+      extend Authlete::Types::ConstantUtility
+
+      A128CBC_HS256 = "A128CBC-HS256"
+      A192CBC_HS384 = "A192CBC-HS384"
+      A256CBC_HS512 = "A256CBC-HS512"
+      A128GCM       = "A128GCM"
+      A192GCM       = "A192GCM"
+      A256GCM       = "A256GCM"
+    end
+  end
+end

data/lib/authlete/types/jwsalg.rb

@@ -0,0 +1,40 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module JWSAlg
+      extend Authlete::Types::ConstantUtility
+
+      NONE   = "none"
+      HS256  = "HS256"
+      HS384  = "HS384"
+      HS512  = "HS512"
+      RS256  = "RS256"
+      RS384  = "RS384"
+      RS512  = "RS512"
+      ES256  = "ES256"
+      ES384  = "ES384"
+      ES512  = "ES512"
+      PS256  = "PS256"
+      PS384  = "PS384"
+      PS512  = "PS512"
+      ES256K = "ES256K"
+      EdDSA  = "EdDSA"
+    end
+  end
+end

data/lib/authlete/types/response-type.rb

@@ -0,0 +1,33 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module ResponseType
+      extend Authlete::Types::ConstantUtility
+
+      NONE                = "none"
+      CODE                = "code"
+      TOKEN               = "token"
+      ID_TOKEN            = "id_token"
+      CODE_TOKEN          = "code token"
+      CODE_ID_TOKEN       = "code id_token"
+      ID_TOKEN_TOKEN      = "id_token token"
+      CODE_ID_TOKEN_TOKEN = "code id_token token"
+    end
+  end
+end

data/lib/authlete/types/subject-type.rb

@@ -0,0 +1,27 @@
+# :nodoc:
+#
+# Copyright (C) 2022 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 Types
+    module SubjectType
+      extend Authlete::Types::ConstantUtility
+
+      PUBLIC   = "public"
+      PAIRWISE = "pairwise"
+    end
+  end
+end

data/lib/authlete/version.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2020 Authlete, Inc.
+# Copyright (C) 2014-2022 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,5 +16,5 @@
 
 
 module Authlete
-  VERSION = "1.26.1"
+  VERSION = "1.28.0"
 end

data/lib/authlete.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2020 Authlete, Inc.
+# Copyright (C) 2014-2022 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -111,4 +111,17 @@ module Authlete
       autoload :UserInfoResponse, 'authlete/model/response/user-info-response'
     end
   end
+
+  module Types
+    autoload :ApplicationType, 'authlete/types/application-type'
+    autoload :ClientAuthMethod, 'authlete/types/client-auth-method'
+    autoload :ConstantUtility, 'authlete/types/constant-utility'
+    autoload :DeliveryMode, 'authlete/types/delivery-mode'
+    autoload :GrantType, 'authlete/types/grant-type'
+    autoload :JWEAlg, 'authlete/types/jwealg'
+    autoload :JWEEnc, 'authlete/types/jweenc'
+    autoload :JWSAlg, 'authlete/types/jwsalg'
+    autoload :ResponseType, 'authlete/types/response-type'
+    autoload :SubjectType, 'authlete/types/subject-type'
+  end
 end