File: LDAPMulti.php

package info (click to toggle)
simplesamlphp 1.16.3-1%2Bdeb10u2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 21,036 kB
  • sloc: php: 73,175; ansic: 875; sh: 83; perl: 82; xml: 52; makefile: 46
file content (124 lines) | stat: -rw-r--r-- 3,880 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php

/**
 * LDAP authentication source.
 *
 * See the ldap-entry in config-templates/authsources.php for information about
 * configuration of this authentication source.
 *
 * This class is based on www/auth/login.php.
 *
 * @package SimpleSAMLphp
 */
class sspmod_ldap_Auth_Source_LDAPMulti extends sspmod_core_Auth_UserPassOrgBase
{

    /**
     * An array with descriptions for organizations.
     */
    private $orgs;

    /**
     * An array of organization IDs to LDAP configuration objects.
     */
    private $ldapOrgs;

    /**
     * Whether we should include the organization as part of the username.
     */
    private $includeOrgInUsername;


    /**
     * Constructor for this authentication source.
     *
     * @param array $info  Information about this authentication source.
     * @param array $config  Configuration.
     */
    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);

        $cfgHelper = SimpleSAML_Configuration::loadFromArray($config,
            'Authentication source ' . var_export($this->authId, true));


        $this->orgs = array();
        $this->ldapOrgs = array();
        foreach ($config as $name => $value) {

            if ($name === 'username_organization_method') {
                $usernameOrgMethod = $cfgHelper->getValueValidate(
                    'username_organization_method',
                    array('none', 'allow', 'force'));
                $this->setUsernameOrgMethod($usernameOrgMethod);
                continue;
            }

            if ($name === 'include_organization_in_username') {
                $this->includeOrgInUsername = $cfgHelper->getBoolean(
                    'include_organization_in_username', false);
                continue;
            }

            $orgCfg = $cfgHelper->getArray($name);
            $orgId = $name;

            if (array_key_exists('description', $orgCfg)) {
                $this->orgs[$orgId] = $orgCfg['description'];
            } else {
                $this->orgs[$orgId] = $orgId;
            }

            $orgCfg = new sspmod_ldap_ConfigHelper($orgCfg,
                'Authentication source ' . var_export($this->authId, true) .
                ', organization ' . var_export($orgId, true));
            $this->ldapOrgs[$orgId] = $orgCfg;
        }
    }


    /**
     * Attempt to log in using the given username and password.
     *
     * @param string $username  The username the user wrote.
     * @param string $password  The password the user wrote.
     * @param string $org  The organization the user chose.
     * @return array  Associative array with the users attributes.
     */
    protected function login($username, $password, $org, array $sasl_args = null)
    {
        assert(is_string($username));
        assert(is_string($password));
        assert(is_string($org));

        if (!array_key_exists($org, $this->ldapOrgs)) {
            // The user has selected an organization which doesn't exist anymore.
            SimpleSAML\Logger::warning('Authentication source ' . var_export($this->authId, true) .
                ': Organization seems to have disappeared while the user logged in.' .
                ' Organization was ' . var_export($org, true));
            throw new SimpleSAML_Error_Error('WRONGUSERPASS');
        }

        if ($this->includeOrgInUsername) {
            $username = $username . '@' . $org;
        }

        return $this->ldapOrgs[$org]->login($username, $password, $sasl_args);
    }


    /**
     * Retrieve list of organizations.
     *
     * @return array  Associative array with the organizations.
     */
    protected function getOrganizations()
    {
        return $this->orgs;
    }
}