diff --git a/docs/simplesamlphp-changelog.md b/docs/simplesamlphp-changelog.md index bab62afbedf5f9a1ff2bf2208867f5b78d0b1006..901af9c25381dad771140826ebf2d0ab332f38ba 100644 --- a/docs/simplesamlphp-changelog.md +++ b/docs/simplesamlphp-changelog.md @@ -17,6 +17,8 @@ Released TBD * Dropped support for Symfony 3.x and Twig 1.x * Update the SAML2 library dependency to 4.1.8 * Allow additional audiences to be specified (#1345) + * The `attributename`-setting in the core:TargetedID authproc-filter has been deprecated in + favour of the `identifyingAttribute`-setting. ## Version 1.18.8 diff --git a/modules/core/docs/authproc_targetedid.md b/modules/core/docs/authproc_targetedid.md index f6cea7da7aff57475756832af03995d944d51ecf..f55e4febf96f6a80aaaf80b7a8285371477b411a 100644 --- a/modules/core/docs/authproc_targetedid.md +++ b/modules/core/docs/authproc_targetedid.md @@ -10,6 +10,11 @@ Parameters ---------- `attributename` +: The name of the attribute we should use for the unique user identifier. + Optional, will use the attribute set by the `userid.attribute` metadata option by default. + *deprecated:* Please use `identifyingAttribute` instead. + +`identifyingAttribute` : The name of the attribute we should use for the unique user identifier. Optional, will use the attribute set by the `userid.attribute` metadata option by default. @@ -35,7 +40,7 @@ A custom attribute: 'authproc' => array( 50 => array( 'class' => 'core:TargetedID', - 'attributename' => 'eduPersonPrincipalName' + 'identifyingAttribute' => 'eduPersonPrincipalName' ), ), diff --git a/modules/core/lib/Auth/Process/TargetedID.php b/modules/core/lib/Auth/Process/TargetedID.php index 66095c0c7daa0bbbac1d40a605dbb784e860199b..e6a804cc8f830b6e3b64e010472fb7c590cb762c 100644 --- a/modules/core/lib/Auth/Process/TargetedID.php +++ b/modules/core/lib/Auth/Process/TargetedID.php @@ -66,10 +66,15 @@ class TargetedID extends \SimpleSAML\Auth\ProcessingFilter assert(is_array($config)); - if (array_key_exists('attributename', $config)) { + if (array_key_exists('identifyingAttribute', $config)) { + $this->attribute = $config['identifyingAttribute']; + if (!is_string($this->attribute)) { + throw new \Exception('Invalid `identifyingAttribute` name given to core:TargetedID filter.'); + } + } elseif (array_key_exists('attributename', $config)) { $this->attribute = $config['attributename']; if (!is_string($this->attribute)) { - throw new \Exception('Invalid attribute name given to core:TargetedID filter.'); + throw new \Exception('Invalid `attributename` given to core:TargetedID filter.'); } }