zendesk_apps_support 4.51.0 → 4.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae23f0eaea19caf577b8a373b4c05d30ef8f393b165fd5deba9099a929e59bf2
-  data.tar.gz: 632938fb1ec7dd277df16c74198bcd17994a22912451c20fda6b45f486d055ae
+  metadata.gz: b97eb1a2194b8abdccf09feffc8d107e538d4bfa9868746b58e0719d3a59c25e
+  data.tar.gz: 661447396aedf9da4286ad1712c2f131d622eed2cf67e816616dcfb7dd216bad
 SHA512:
-  metadata.gz: 4bf4dfd3d8e5741a7986a49052982682ed8b0627030120b0abaf14045f49a26e173bb23f0a400bd148a20bdfce8a98595cccfafef83b8be3c5dae83d9b9eaa66
-  data.tar.gz: eb10fdc524d3d61b580e0eeee1db8122957f7f2c2396641e08bb1de9bf531a7a0b23b0bd4ed1f1c977b8b2cc20fb06b9cdca93be093e41a899f74c26828a2888
+  metadata.gz: 36ec44324414e0bcb0d4c4924b7eaf6e4d2e41e38fc5552b696c604829485baecde48e432bf3c555b3015a41a87be7f786c4cbcae88ffdd814bfd4e8fed249e8
+  data.tar.gz: cf492e02bbcd1daddf87b9128fdd449fcfedbb4edc0ca7cff8fccb2869d6f77c04c60f29be35f48f3a66fe5f4f66d634d89a57d1dbe6cba3c2f21134ea405a6b

data/config/locales/en.yml

@@ -314,6 +314,16 @@ en:
             object_types_not_supported: objectTypes is not supported for the %{location}
               location.
             object_types_required: objectTypes is required for the %{location} location.
+            mtls_parameter_cannot_have_certain_settings: mtls parameter cannot have
+              default, secure, or scopes settings.
+            too_many_mtls_parameters: 'Too many parameters with type ''mtls'': three
+              permitted'
+            mtls_allowed_domain_contains_scheme: "%{field} must not include a protocol
+              or scheme."
+            mtls_allowed_domain_too_long: "%{field} must not exceed 253 characters."
+            mtls_allowed_domain_invalid_wildcard: "%{field} can only use a wildcard
+              as the first two characters, e.g. *.example.com."
+            mtls_allowed_domain_invalid_format: "%{field} must be a valid domain name."
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -700,3 +700,35 @@ parts:
         Do not translate 'scopes'. %{params} refers to secure parameters with no scopes configured.
         Scopes in manifest refers to https://developer.zendesk.com/documentation/apps/getting-started/setting-up-new-apps/#scopes"
       value: "The scopes property is not configured for parameter(s): %{params}. This may cause token exposure vulnerabilities. Learn about: %{link}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.mtls_parameter_cannot_have_certain_settings"
+      title: "Validation message to indicate that mtls parameter cannot have default, secure, or scopes settings.
+        Do not translate 'mtls', 'secure', 'default' and 'scopes' as they are manifest properties.
+        'secure' in manifest refers to https://developer.zendesk.com/documentation/apps/getting-started/setting-up-new-apps/#secure
+        'scopes' in manifest refers to https://developer.zendesk.com/documentation/apps/getting-started/setting-up-new-apps/#scopes
+        'default' in manifest refers to https://developer.zendesk.com/documentation/apps/getting-started/setting-up-new-apps/#default"
+      value: "mtls parameter cannot have default, secure, or scopes settings."
+  - translation:
+      key: "txt.apps.admin.error.app_build.too_many_mtls_parameters"
+      title: "Validation message to indicate that mtls parameter cannot exceed three parameters. Do not translate 'mtls' as it is a manifest property."
+      value: "Too many parameters with type 'mtls': three permitted"
+  - translation:
+      key: "txt.apps.admin.error.app_build.mtls_allowed_domain_contains_scheme"
+      title: "Validation message to indicate that the allowed_domain property of an mtls parameter must not include a protocol or scheme.
+        %{field} refers to the manifest field path."
+      value: "%{field} must not include a protocol or scheme."
+  - translation:
+      key: "txt.apps.admin.error.app_build.mtls_allowed_domain_too_long"
+      title: "Validation message to indicate that the allowed_domain property of an mtls parameter exceeds the maximum length of 253 characters.
+        %{field} refers to the manifest field path."
+      value: "%{field} must not exceed 253 characters."
+  - translation:
+      key: "txt.apps.admin.error.app_build.mtls_allowed_domain_invalid_wildcard"
+      title: "Validation message to indicate that the allowed_domain property of an mtls parameter uses a wildcard incorrectly.
+        %{field} refers to the manifest field path."
+      value: "%{field} can only use a wildcard as the first two characters, e.g. *.example.com."
+  - translation:
+      key: "txt.apps.admin.error.app_build.mtls_allowed_domain_invalid_format"
+      title: "Validation message to indicate that the allowed_domain property of an mtls parameter is not a valid domain name.
+        %{field} refers to the manifest field path."
+      value: "%{field} must be a valid domain name."

data/lib/zendesk_apps_support/manifest/parameter.rb

@@ -3,8 +3,8 @@
 module ZendeskAppsSupport
   class Manifest
     class Parameter
-      TYPES = %w[text checkbox url number multiline hidden oauth].freeze
-      ATTRIBUTES = %i[name type required secure default scopes].freeze
+      TYPES = %w[text checkbox url number multiline hidden oauth mtls].freeze
+      ATTRIBUTES = %i[name type required secure default scopes allowed_domain].freeze
       attr_reader(*ATTRIBUTES)
       def default?
         @has_default
@@ -18,6 +18,7 @@ module ZendeskAppsSupport
         @has_default = p.key? 'default'
         @default = p['default'] if @has_default
         @scopes = p['scopes']
+        @allowed_domain = p['allowed_domain']
       end
     end
   end

data/lib/zendesk_apps_support/package.rb

@@ -35,9 +35,14 @@ module ZendeskAppsSupport
       marketplace = options.fetch(:marketplace, true)
       skip_marketplace_translations = options.fetch(:skip_marketplace_translations, false)
       validate_custom_object_record_sidebar_location = options.fetch(:validate_custom_object_record_sidebar_location, false)
+      validate_mtls_param = options.fetch(:validate_mtls_param, false)
 
       errors = []
-      errors << Validations::Manifest.call(self, validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location)
+      errors << Validations::Manifest.call(
+        self,
+        validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location,
+        validate_mtls_param: validate_mtls_param
+      )
 
       if has_valid_manifest?(errors)
         errors << Validations::Marketplace.call(self) if marketplace

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -12,9 +12,13 @@ module ZendeskAppsSupport
       PARAMETER_TYPES = ZendeskAppsSupport::Manifest::Parameter::TYPES
       OAUTH_MANIFEST_LINK = 'https://developer.zendesk.com/apps/docs/developer-guide/manifest#oauth'
       SECURE_PARAM_SCOPES = %w[header body url jwt_secret_key jwt_claim basic_auth_username basic_auth_password].freeze
+      MTLS = 'mtls'
+      MTLS_ALLOWED_DOMAIN_MAX_LENGTH = 253
+      MTLS_ALLOWED_DOMAIN_LABEL_MAX_LENGTH = 63
+      MTLS_ALLOWED_DOMAIN_LABEL_REGEXP = /\A[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?\z/
 
       class << self
-        def call(package, validate_custom_object_record_sidebar_location: false)
+        def call(package, validate_custom_object_record_sidebar_location: false, validate_mtls_param: false)
           unless package.has_file?('manifest.json')
             nested_manifest = package.files.find { |file| file =~ %r{\A[^/]+?/manifest\.json\Z} }
             if nested_manifest
@@ -23,7 +27,8 @@ module ZendeskAppsSupport
             return [ValidationError.new(:missing_manifest)]
           end
           collate_manifest_errors(package,
-                                  validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location)
+                                  validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location,
+                                  validate_mtls_param: validate_mtls_param)
         rescue JSON::ParserError => e
           return [ValidationError.new(:manifest_not_json, errors: e)]
         rescue ZendeskAppsSupport::Manifest::OverrideError => e
@@ -32,7 +37,8 @@ module ZendeskAppsSupport
 
         private
 
-        def collate_manifest_errors(package, validate_custom_object_record_sidebar_location: false)
+        def collate_manifest_errors(package, validate_custom_object_record_sidebar_location: false,
+                                    validate_mtls_param: false)
           manifest = package.manifest
 
           errors = [
@@ -41,7 +47,7 @@ module ZendeskAppsSupport
             oauth_error(manifest),
             default_locale_error(manifest, package),
             validate_urls(manifest),
-            validate_parameters(manifest),
+            validate_parameters(manifest, validate_mtls_param: validate_mtls_param),
             if manifest.requirements_only? || manifest.marketing_only?
               [ ban_location(manifest),
                 ban_framework_version(manifest) ]
@@ -82,18 +88,21 @@ module ZendeskAppsSupport
           errors
         end
 
-        def validate_parameters(manifest)
+        def validate_parameters(manifest, validate_mtls_param: false)
           if manifest.marketing_only?
             marketing_only_errors(manifest)
           else
             [
               parameters_error(manifest),
               invalid_hidden_parameter_error(manifest),
-              invalid_type_error(manifest),
+              invalid_type_error(manifest, validate_mtls_param: validate_mtls_param),
               too_many_oauth_parameters(manifest),
               oauth_cannot_be_secure(manifest),
               name_as_parameter_name_error(manifest),
-              invalid_secure_param_scopes_errors(manifest)
+              invalid_secure_param_scopes_errors(manifest),
+              (mtls_cannot_have_certain_settings(manifest) if validate_mtls_param),
+              (too_many_mtls_parameters(manifest) if validate_mtls_param),
+              (mtls_allowed_domain_errors(manifest) if validate_mtls_param)
             ]
           end
         end
@@ -475,12 +484,14 @@ module ZendeskAppsSupport
           end
         end
 
-        def invalid_type_error(manifest)
+        def invalid_type_error(manifest, validate_mtls_param: false)
+          allowed_types = validate_mtls_param ? PARAMETER_TYPES : PARAMETER_TYPES - [MTLS]
+
           invalid_types = []
           manifest.parameters.each do |parameter|
             parameter_type = parameter.type
 
-            invalid_types << parameter_type unless PARAMETER_TYPES.include?(parameter_type)
+            invalid_types << parameter_type unless allowed_types.include?(parameter_type)
           end
 
           if invalid_types.any?
@@ -531,6 +542,82 @@ module ZendeskAppsSupport
         rescue URI::InvalidURIError
           false
         end
+
+        def mtls_cannot_have_certain_settings(manifest)
+          manifest.parameters.map do |parameter|
+            if parameter.type == MTLS && invalid_mtls_settings?(parameter)
+              return ValidationError.new(:mtls_parameter_cannot_have_certain_settings)
+            end
+          end
+        end
+
+        def invalid_mtls_settings?(parameter)
+          parameter.secure || parameter.default? || !parameter.scopes.nil?
+        end
+
+        def too_many_mtls_parameters(manifest)
+          mtls_parameter_count = manifest.parameters.count { |parameter| parameter.type == MTLS }
+          ValidationError.new(:too_many_mtls_parameters) if mtls_parameter_count > 3
+        end
+
+        def mtls_allowed_domain_errors(manifest)
+          manifest.parameters.each_with_object([]) do |parameter, errors|
+            next unless parameter.type == MTLS
+
+            errors.concat(mtls_allowed_domain_error_for(parameter))
+          end
+        end
+
+        def mtls_allowed_domain_error_for(parameter)
+          field = "parameters[name=\"#{parameter.name}\"].allowed_domain"
+          allowed_domain = parameter.allowed_domain
+
+          presence_or_type_error = mtls_allowed_domain_presence_or_type_error(allowed_domain, field)
+          return [presence_or_type_error] if presence_or_type_error
+
+          errors = mtls_allowed_domain_syntax_errors(allowed_domain, field)
+          return errors if errors.any?
+
+          errors << mtls_allowed_domain_format_error(allowed_domain, field)
+          errors.compact
+        end
+
+        def mtls_allowed_domain_presence_or_type_error(allowed_domain, field)
+          if allowed_domain.nil? || allowed_domain == ''
+            return ValidationError.new(:field_cannot_be_empty, field: field)
+          end
+
+          return if allowed_domain.is_a?(String)
+
+          ValidationError.new(:unacceptable_string, field: field, value: allowed_domain)
+        end
+
+        def mtls_allowed_domain_syntax_errors(allowed_domain, field)
+          errors = []
+          if allowed_domain.include?('://')
+            errors << ValidationError.new(:mtls_allowed_domain_contains_scheme, field: field)
+          end
+          if allowed_domain.length > MTLS_ALLOWED_DOMAIN_MAX_LENGTH
+            errors << ValidationError.new(:mtls_allowed_domain_too_long, field: field)
+          end
+          if allowed_domain.include?('*') && !allowed_domain.start_with?('*.')
+            errors << ValidationError.new(:mtls_allowed_domain_invalid_wildcard, field: field)
+          end
+          errors
+        end
+
+        def mtls_allowed_domain_format_error(allowed_domain, field)
+          hostname = allowed_domain.start_with?('*.') ? allowed_domain[2..] : allowed_domain
+          labels = hostname.split('.')
+
+          return if labels.size >= 2 && labels.all? { |label| valid_mtls_domain_label?(label) }
+
+          ValidationError.new(:mtls_allowed_domain_invalid_format, field: field)
+        end
+
+        def valid_mtls_domain_label?(label)
+          label.length <= MTLS_ALLOWED_DOMAIN_LABEL_MAX_LENGTH && label.match?(MTLS_ALLOWED_DOMAIN_LABEL_REGEXP)
+        end
       end
     end
   end

data/lib/zendesk_apps_support/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAppsSupport
-  VERSION = '4.51.0'
+  VERSION = '4.52.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.51.0
+  version: 4.52.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-15 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n