Merge pull request #41 from BaranekD/updateUserExtSource

Update user ext source

Author: Dominik František Bučík

CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to this project will be documented in this file.
  - Added new model Resource
  - New methods for getting data from Perun LDAP and Perun RPC
  - Added function for generating metadata for SimpleSAMLphp Proxy AAI from Perun
+ - Added UpdateUserExtSource filter
 
  [Changed]
  - Connectors methods are not static for now.

lib/Adapter.php

@@ -131,6 +131,31 @@ public abstract function searchFacilitiesByAttributeValue($attribute);
 	 */
 	public abstract function getFacilityAttributes($facility, $attrNames);
 
+	/**
+	 * @param $extSourceName string name of ext source
+	 * @param $extSourceLogin string login
+	 * @return array user ext source
+	 */
+	public abstract function getUserExtSource($extSourceName, $extSourceLogin);
+
+	/**
+	 * @param $userExtSource array ext source
+	 */
+	public abstract function updateUserExtSourceLastAccess($userExtSource);
+
+	/**
+	 * @param $userExtSourceId int userExtSourceId
+	 * @param $attributes array attributes
+	 * @return array attributes
+	 */
+	public abstract function getUserExtSourceAttributes($userExtSourceId, $attributes);
+
+	/**
+	 * @param $userExtSourceId int userExtSourceId
+	 * @param $attributes array attributes
+	 */
+	public abstract function setUserExtSourceAttributes($userExtSourceId, $attributes);
+
 	/**
 	 * @param sspmod_perun_model_HasId[] $entities
 	 * @return sspmod_perun_model_HasId[] without duplicates

lib/AdapterLdap.php

@@ -213,6 +213,26 @@ public function getFacilityAttributes($facility, $attrNames)
 		// TODO: Implement getFacilityAttributes() method.
 	}
 
+	public function getUserExtSource($extSourceName, $extSourceLogin)
+	{
+		// TODO: Implement getUserExtSource() method.
+	}
+
+	public function updateUserExtSourceLastAccess($userExtSource)
+	{
+		// TODO: Implement updateUserExtSourceLastAccess() method.
+	}
+
+	public function getUserExtSourceAttributes($userExtSourceId, $attrNames)
+	{
+		// TODO: Implement getAttributes() method.
+	}
+
+	public function setUserExtSourceAttributes($userExtSourceId, $attributes)
+	{
+		// TODO: Implement setAttributes() method.
+	}
+
 	public function getUsersGroupsOnFacility($spEntityId, $userId)
 	{
 		$resources = $this->connector->searchForEntities($this->ldapBase,

lib/AdapterRpc.php

@@ -362,4 +362,33 @@ public function getFacilityAttributes($facility, $attrNames) {
 		}
 		return $attributes;
 	}
+
+	public function getUserExtSource($extSourceName, $extSourceLogin) {
+		return $this->connector->get('usersManager', 'getUserExtSourceByExtLoginAndExtSourceName', array(
+			"extSourceName" => $extSourceName,
+			"extSourceLogin" => $extSourceLogin
+		));
+	}
+
+	public function updateUserExtSourceLastAccess($userExtSource) {
+		$this->connector->post( 'usersManager', 'updateUserExtSourceLastAccess', array(
+			"userExtSource" => $userExtSource
+		));
+	}
+
+	public function getUserExtSourceAttributes($userExtSourceId, $attrNames)
+	{
+		return $this->connector->get('attributesManager', 'getAttributes', array(
+			"userExtSource" => $userExtSourceId,
+			"attrNames" => $attrNames
+		));
+	}
+
+	public function setUserExtSourceAttributes($userExtSourceId, $attributes)
+	{
+		$this->connector->post('attributesManager', 'setAttributes', array(
+			"userExtSource" => $userExtSourceId,
+			"attributes" => $attributes
+		));
+	}
 }

lib/Auth/Process/UpdateUserExtSource.php

@@ -0,0 +1,89 @@
+<?php
+
+/**
+ * Class sspmod_perun_Auth_Process_UpdateUserExtSource
+ *
+ * This filter updates userExtSource attributes when he logs in.
+ *
+ * @author Dominik Baránek <[email protected]>
+ */
+class sspmod_perun_Auth_Process_UpdateUserExtSource extends SimpleSAML_Auth_ProcessingFilter
+{
+	private $attrMap;
+	private $attrsToConversion;
+	private $adapter;
+	const UES_ATTR_NMS = 'urn:perun:ues:attribute-def:def:';
+
+	public function __construct($config, $reserved)
+	{
+		parent::__construct($config, $reserved);
+
+		assert('is_array($config)');
+
+		if (!isset($config['attrMap'])) {
+			throw new SimpleSAML_Error_Exception("perun:UpdateUserExtSource: missing mandatory configuration option 'attrMap'.");
+		}
+
+		if (isset($config['arrayToStringConversion'])) {
+			$this->attrsToConversion = (array) $config['arrayToStringConversion'];
+		} else {
+			$this->attrsToConversion = array();
+		}
+
+		$this->attrMap = (array)$config['attrMap'];
+		$this->adapter = sspmod_perun_Adapter::getInstance(sspmod_perun_Adapter::RPC);
+	}
+
+	public function process(&$request)
+	{
+		assert('is_array($request)');
+		try {
+			$userExtSource = $this->adapter->getUserExtSource($request['Attributes']['sourceIdPEntityID'][0], $request['Attributes']['sourceIdPEppn'][0]);
+			if (is_null($userExtSource)) {
+				throw new SimpleSAML_Error_Exception("sspmod_perun_Auth_Process_UpdateUserExtSource: there is no UserExtSource with ExtSource " . $request['Attributes']['sourceIdPEntityID'][0] . " and Login " . $request['Attributes']['sourceIdPEppn'][0]);
+			}
+
+			$attributes = $this->adapter->getUserExtSourceAttributes($userExtSource['id'], array_keys($this->attrMap));
+
+			if (is_null($attributes)) {
+				throw new SimpleSAML_Error_Exception("sspmod_perun_Auth_Process_UpdateUserExtSource: getting attributes was not successful.");
+			}
+
+			$attributesToUpdate = array();
+			foreach ($attributes as $attribute) {
+				$attr = $request['Attributes'][$this->attrMap[self::UES_ATTR_NMS . $attribute['friendlyName']]];
+
+				if (in_array(self::UES_ATTR_NMS . $attribute['friendlyName'], $this->attrsToConversion)) {
+					$arrayAsString = array();
+					foreach ($attr as $value) {
+						$arrayAsString[0] .= $value . ';';
+					}
+					if (!empty($arrayAsString[0])) {
+						$arrayAsString[0] = substr($arrayAsString[0], 0, -1);
+					}
+					$attr = $arrayAsString;
+				}
+
+				if (strpos($attribute['type'], 'String') || strpos($attribute['type'], 'Integer') || strpos($attribute['type'], 'Boolean')) {
+					$valueFromIdP = $attr[0];
+
+				} elseif (strpos($attribute['type'], 'Array') || strpos($attribute['type'], 'Map')) {
+					$valueFromIdP = $attr;
+				} else {
+					throw new SimpleSAML_Error_Exception("sspmod_perun_Auth_Process_UpdateUserExtSource: unsupported type of attribute.");
+				}
+				if ($valueFromIdP != $attribute['value']) {
+					$attribute['value'] = $valueFromIdP;
+					array_push($attributesToUpdate, $attribute);
+				}
+			}
+
+			if (!empty($attributesToUpdate)) {
+				$this->adapter->setUserExtSourceAttributes($userExtSource['id'], $attributesToUpdate);
+			}
+			$this->adapter->updateUserExtSourceLastAccess($userExtSource['id']);
+		} catch (Exception $ex) {
+			SimpleSAML\Logger::warning("sspmod_perun_Auth_Process_UpdateUserExtSource: update was not successful: " . $ex->getMessage() . " Skip to next filter.");
+		}
+	}
+}