Client scope / Mappers / Custom protocol mapper (#340)

* add custom protocol mapper

Author: wolfaba

REFERENCE.md

@@ -3201,6 +3201,8 @@ The following parameters are available in the `keycloak_protocol_mapper` type.
 * [`realm`](#-keycloak_protocol_mapper--realm)
 * [`resource_name`](#-keycloak_protocol_mapper--resource_name)
 * [`type`](#-keycloak_protocol_mapper--type)
+* [`custom_type`](#-keycloak_protocol_mapper--custom_type)
+* [`custom_config`](#-keycloak_protocol_mapper--custom_config)
 
 ##### <a name="-keycloak_protocol_mapper--client_scope"></a>`client_scope`
 
@@ -3231,13 +3233,21 @@ The protocol mapper name. Defaults to `name`.
 
 ##### <a name="-keycloak_protocol_mapper--type"></a>`type`
 
-Valid values: `oidc-usermodel-property-mapper`, `oidc-usermodel-attribute-mapper`, `oidc-full-name-mapper`, `oidc-group-membership-mapper`, `oidc-audience-mapper`, `saml-group-membership-mapper`, `saml-user-property-mapper`, `saml-user-attribute-mapper`, `saml-role-list-mapper`
+Valid values: `oidc-usermodel-property-mapper`, `oidc-usermodel-attribute-mapper`, `oidc-full-name-mapper`, `oidc-group-membership-mapper`, `oidc-audience-mapper`, `saml-group-membership-mapper`, `saml-user-property-mapper`, `saml-user-attribute-mapper`, `saml-role-list-mapper`, `custom`
 
 protocolMapper.
 
 Default is `oidc-usermodel-property-mapper` for `protocol` `openid-connect` and
 `saml-user-property-mapper` for `protocol` `saml`.
 
+##### <a name="-keycloak_protocol_mapper--custom_type"></a>`custom_type`
+
+Custom mapper type if `type` is set to `custom`.
+
+##### <a name="-keycloak_protocol_mapper--custom_config"></a>`custom_config`
+
+Custom mapper config for custom type. Simple hash with key-value pair, which will be converted to JSON.
+
 ### <a name="keycloak_realm"></a>`keycloak_realm`
 
 Manage Keycloak realms

lib/puppet/provider/keycloak_protocol_mapper/kcadm.rb

@@ -75,6 +75,12 @@ def self.instances
             protocol_mapper[:single] = d['config']['single'].to_s.to_sym
           end
           protocol_mapper[:multivalued] = d['config']['multivalued'].to_s.to_sym if d['config']['multivalued']
+          unless ['oidc-usermodel-property-mapper', 'oidc-usermodel-attribute-mapper', 'oidc-full-name-mapper', 'oidc-group-membership-mapper', 'oidc-audience-mapper',
+                  'saml-group-membership-mapper', 'saml-user-property-mapper', 'saml-user-attribute-mapper', 'saml-role-list-mapper', 'saml-javascript-mapper',].include?(d['protocolMapper'])
+            protocol_mapper[:type] = 'custom'
+            protocol_mapper[:custom_type] = d['protocolMapper']
+            protocol_mapper[:custom_config] = d['config']
+          end
           protocol_mappers << new(protocol_mapper)
         end
       end
@@ -106,6 +112,10 @@ def create
     data[:protocol] = resource[:protocol]
     data[:protocolMapper] = resource[:type]
     data[:config] = {}
+    if resource[:type] == 'custom'
+      data[:protocolMapper] = resource[:custom_type]
+      data[:config] = resource[:custom_config]
+    end
     if ['oidc-usermodel-property-mapper', 'saml-user-property-mapper', 'saml-user-attribute-mapper', 'oidc-usermodel-attribute-mapper'].include?(resource[:type]) && resource[:user_attribute]
       data[:config][:'user.attribute'] = resource[:user_attribute]
     end
@@ -194,6 +204,10 @@ def flush
       data[:protocol] = resource[:protocol]
       data[:protocolMapper] = resource[:type]
       config = {}
+      if resource[:type] == 'custom'
+        data[:protocolMapper] = resource[:custom_type]
+        config = resource[:custom_config]
+      end
       if ['oidc-usermodel-property-mapper', 'saml-user-property-mapper', 'saml-user-attribute-mapper', 'oidc-usermodel-attribute-mapper'].include?(resource[:type]) && resource[:user_attribute]
         config[:'user.attribute'] = resource[:user_attribute]
       end

lib/puppet/type/keycloak_protocol_mapper.rb

@@ -67,6 +67,7 @@
       'saml-user-attribute-mapper',
       'saml-role-list-mapper',
       %r{script-.+},
+      'custom',
     )
     defaultto do
       case @resource[:protocol]
@@ -222,6 +223,14 @@
     desc 'included.client.audience Required for `type` of `oidc-audience-mapper`'
   end
 
+  newproperty(:custom_config) do
+    desc 'custom configuration data for `custom` protocolMapper type'
+  end
+
+  newproperty(:custom_type) do
+    desc 'custom protocolMapper type'
+  end
+
   autorequire(:keycloak_client_scope) do
     requires = []
     catalog.resources.each do |resource|
@@ -261,6 +270,7 @@ def self.title_patterns
       'oidc-group-membership-mapper',
       'oidc-audience-mapper',
       'oidc-usermodel-attribute-mapper',
+      'custom',
     ]
     if self[:protocol] == 'openid-connect' && !openid_connect_types.include?(self[:type]) && self[:type] !~ %r{script-.+}
       raise Puppet::Error, "type #{self[:type]} is not valid for protocol openid-connect"
@@ -285,5 +295,11 @@ def self.title_patterns
     if self[:type] == 'oidc-audience-mapper' && self[:included_client_audience].nil?
       raise Puppet::Error, 'included_client_audience is required for oidc-audience-mapper'
     end
+    if self[:type] == 'custom' && !self[:custom_type]
+      raise Puppet::Error, 'custom_type is required for `custom` protocol mapper type'
+    end
+    if self[:type] == 'custom' && !self[:custom_config]
+      raise Puppet::Error, 'custom_config is required for `custom` protocol mapper type'
+    end
   end
 end