UserPassOrgBase.php

Go to the documentation of this file.

<?php

abstract class sspmod_core_Auth_UserPassOrgBase extends SimpleSAML_Auth_Source {


        const STAGEID = 'sspmod_core_Auth_UserPassOrgBase.state';


        const AUTHID = 'sspmod_core_Auth_UserPassOrgBase.AuthId';


        const ORGID = 'sspmod_core_Auth_UserPassOrgBase.SelectedOrg';


        private $usernameOrgMethod;

        protected $rememberUsernameEnabled = FALSE;

        protected $rememberUsernameChecked = FALSE;


        public function __construct($info, &$config) {
                assert('is_array($info)');
                assert('is_array($config)');

                // Call the parent constructor first, as required by the interface
                parent::__construct($info, $config);

                // Get the remember username config options
                if (isset($config['remember.username.enabled'])) {
                        $this->rememberUsernameEnabled = (bool) $config['remember.username.enabled'];
                        unset($config['remember.username.enabled']);
                }
                if (isset($config['remember.username.checked'])) {
                        $this->rememberUsernameChecked = (bool) $config['remember.username.checked'];
                        unset($config['remember.username.checked']);
                }

                $this->usernameOrgMethod = 'none';
        }


        protected function setUsernameOrgMethod($usernameOrgMethod) {
                assert('in_array($usernameOrgMethod, array("none", "allow", "force"), TRUE)');

                $this->usernameOrgMethod = $usernameOrgMethod;
        }


        public function getUsernameOrgMethod() {
                return $this->usernameOrgMethod;
        }

        public function getRememberUsernameEnabled() {
                return $this->rememberUsernameEnabled;
        }

        public function getRememberUsernameChecked() {
                return $this->rememberUsernameChecked;
        }


        public function authenticate(&$state) {
                assert('is_array($state)');

                // We are going to need the authId in order to retrieve this authentication source later
                $state[self::AUTHID] = $this->authId;

                $id = SimpleSAML_Auth_State::saveState($state, self::STAGEID);

                $url = SimpleSAML\Module::getModuleURL('core/loginuserpassorg.php');
                $params = array('AuthState' => $id);
                \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $params);
        }


        abstract protected function login($username, $password, $organization);


        abstract protected function getOrganizations();


        public static function handleLogin($authStateId, $username, $password, $organization) {
                assert('is_string($authStateId)');
                assert('is_string($username)');
                assert('is_string($password)');
                assert('is_string($organization)');

                /* Retrieve the authentication state. */
                $state = SimpleSAML_Auth_State::loadState($authStateId, self::STAGEID);

                /* Find authentication source. */
                assert('array_key_exists(self::AUTHID, $state)');
                $source = SimpleSAML_Auth_Source::getById($state[self::AUTHID]);
                if ($source === NULL) {
                        throw new Exception('Could not find authentication source with id ' . $state[self::AUTHID]);
                }

                $orgMethod = $source->getUsernameOrgMethod();
                if ($orgMethod !== 'none') {
                        $tmp = explode('@', $username, 2);
                        if (count($tmp) === 2) {
                                $username = $tmp[0];
                                $organization = $tmp[1];
                        } else {
                                if ($orgMethod === 'force') {
                                        /* The organization should be a part of the username, but isn't. */
                                        throw new SimpleSAML_Error_Error('WRONGUSERPASS');
                                }
                        }
                }

                /* Attempt to log in. */
                $attributes = $source->login($username, $password, $organization);

                // Add the selected Org to the state
                $state[self::ORGID] = $organization;
                $state['PersistentAuthData'][] = self::ORGID;

                $state['Attributes'] = $attributes;
                SimpleSAML_Auth_Source::completeAuth($state);
        }


        public static function listOrganizations($authStateId) {
                assert('is_string($authStateId)');

                /* Retrieve the authentication state. */
                $state = SimpleSAML_Auth_State::loadState($authStateId, self::STAGEID);

                /* Find authentication source. */
                assert('array_key_exists(self::AUTHID, $state)');
                $source = SimpleSAML_Auth_Source::getById($state[self::AUTHID]);
                if ($source === NULL) {
                        throw new Exception('Could not find authentication source with id ' . $state[self::AUTHID]);
                }

                $orgMethod = $source->getUsernameOrgMethod();
                if ($orgMethod === 'force') {
                        return NULL;
                }

                return $source->getOrganizations();
        }
}