summaryrefslogtreecommitdiffstats
path: root/pykolab/auth/__init__.py
blob: 79d65618f756b817232630ce719ba9db4b78580e (plain)
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
#
# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import logging
import os
import time

import pykolab
import pykolab.base

from pykolab.translate import _

log = pykolab.getLogger('pykolab.auth')
conf = pykolab.getConf()

class Auth(pykolab.base.Base):
    """
        This is the Authentication and Authorization module for PyKolab.
    """

    def __init__(self, domain=None):
        """
            Initialize the authentication class.
        """
        pykolab.base.Base.__init__(self, domain=domain)

        self._auth = None

    def authenticate(self, login):
        """
            Verify login credentials supplied in login against the appropriate
            authentication backend.

            Login is a simple list of username, password, service and,
            optionally, the realm.
        """

        if len(login) == 3:
            # The realm has not been specified. See if we know whether or not
            # to use virtual_domains, as this may be a cause for the realm not
            # having been specified seperately.
            use_virtual_domains = conf.get('imap', 'virtual_domains')

            # TODO: Insert debug statements
            #if use_virtual_domains == "userid":
                #print "# Derive domain from login[0]"
            #elif not use_virtual_domains:
                #print "# Explicitly do not user virtual domains??"
            #else:
                ## Do use virtual domains, derive domain from login[0]
                #print "# Derive domain from login[0]"

        if len(login[0].split('@')) > 1:
            domain = login[0].split('@')[1]
        elif len(login) >= 4:
            domain = login[3]
        else:
            domain = conf.get("kolab", "primary_domain")

        # realm overrides domain
        if len(login) == 4:
            domain = login[3]

        retval = self._auth.authenticate(login, domain)

        return retval

    def connect(self, domain=None):
        """
            Connect to the domain authentication backend using domain, or fall
            back to the primary domain specified by the configuration.
        """

        log.debug(_("Called for domain %r") % (domain), level=9)

        if not self._auth == None:
            return

        if domain == None:
            if not self.domain == None:
                section = self.domain
                domain = self.domain
            else:
                section = 'kolab'
                domain = conf.get('kolab', 'primary_domain')
        else:
            self.list_domains(domain)
            section = domain

        log.debug(
                _("Using section %s and domain %s") % (section,domain),
                level=9
            )

        if not self.domains == None and self.domains.has_key(domain):
            section = self.domains[domain]
            domain = self.domains[domain]

        log.debug(
                _("Using section %s and domain %s") % (section,domain),
                level=9
            )

        log.debug(
                _("Connecting to Authentication backend for domain %s") % (
                        domain
                    ),
                level=8
            )

        if not conf.has_section(section):
            section = 'kolab'

        if not conf.has_option(section, 'auth_mechanism'):
            log.debug(
                    _("Section %s has no option 'auth_mechanism'") % (section),
                    level=9
                )

            section = 'kolab'
        else:
            log.debug(
                    _("Section %s has auth_mechanism: %r") % (
                            section,
                            conf.get(section,'auth_mechanism')
                        ),
                    level=9
                )

        # Get the actual authentication and authorization backend.
        if conf.get(section, 'auth_mechanism') == 'ldap':
            log.debug(_("Starting LDAP..."), level=9)
            from pykolab.auth import ldap
            self._auth = ldap.LDAP(self.domain)

        elif conf.get(section, 'auth_mechanism') == 'sql':
            from pykolab.auth import sql
            self._auth = sql.SQL(self.domain)

        else:
            log.debug(_("Starting LDAP..."), level=9)
            from pykolab.auth import ldap
            self._auth = ldap.LDAP(self.domain)

        self._auth.connect()

    def disconnect(self, domain=None):
        """
            Connect to the domain authentication backend using domain, or fall
            back to the primary domain specified by the configuration.
        """

        if domain == None:
            section = 'kolab'
            domain = conf.get('kolab', 'primary_domain')
        else:
            section = domain

        if not self._auth or self._auth == None:
            return

        self._auth._disconnect()

        del self._auth
        self._auth = None

    def find_recipient(self, address, domain=None):
        """
            Find one or more entries corresponding to the recipient address.
        """
        if not domain == None and not self.domain == domain:
            self.connect(domain=domain)

        if not self._auth or self._auth == None:
            self.connect(domain=domain)

        result = self._auth.find_recipient(address)

        if isinstance(result, list) and len(result) == 1:
            return result[0]
        else:
            return result

    def find_resource(self, address):
        """
            Find one or more resources corresponding to the recipient address.
        """
        if not self._auth or self._auth == None:
            self.connect()

        result = self._auth.find_resource(address)

        if isinstance(result, list) and len(result) == 1:
            return result[0]
        else:
            return result

    def find_user(self, attr, value, **kw):
        return self._auth.search_entry_by_attribute(attr, value, **kw)

    def find_user_dn(self, login, kolabuser=False):
        return self._auth._find_user_dn(login, kolabuser);

    def list_recipient_addresses(self, user):
        return self._auth.list_recipient_addresses(user)

    def extract_recipient_addresses(self, entry):
        return self._auth.extract_recipient_addresses(entry)

    def list_delegators(self, user):
        return self._auth.list_delegators(user)

    def list_domains(self, domain=None):
        """
            List the domains using the auth_mechanism setting in the kolab
            section of the configuration file, either ldap or sql or (...).

            The actual setting would be used by self.connect(), and stuffed
            into self._auth, for use with self._auth._list_domains()

            For each domain found, returns a two-part tuple of the primary
            domain and a list of secondary domains (aliases).
        """

        # Connect to the global namespace
        self.connect()

        # Find the domains in the authentication backend.
        kolab_primary_domain = conf.get('kolab', 'primary_domain')

        if self.domains == None:

            try:
                domains = self._auth._list_domains(domain)
            except:
                if not self.domain == kolab_primary_domain:
                    return { self.domain: self.domain }
                else:
                    domains = {}

            # If no domains are found, the primary domain is used.
            if len(domains) < 1:
                self.domains = { kolab_primary_domain: kolab_primary_domain }
            else:
                self.domains = {}
                for primary, secondaries in domains:
                    self.domains[primary.lower()] = primary.lower()
                    for secondary in secondaries:
                        self.domains[secondary.lower()] = primary.lower()

        return self.domains

    def synchronize(self, mode=0, callback=None):
        self._auth.synchronize(mode=mode, callback=callback)

    def domain_default_quota(self, domain):
        return self._auth._domain_default_quota(domain)

    def domain_naming_context(self, domain):
        return self._auth._domain_naming_context(domain)

    def get_entry_attribute(self, domain, entry, attribute):
        return self._auth.get_entry_attribute(entry, attribute)

    def get_entry_attributes(self, domain, entry, attributes):
        return self._auth.get_entry_attributes(entry, attributes)

    def get_user_attribute(self, domain, user, attribute):
        return self._auth.get_entry_attribute(user, attribute)

    def get_user_attributes(self, domain, user, attributes):
        return self._auth.get_entry_attributes(user, attributes)

    def search_entry_by_attribute(self, attr, value, **kw):
        return self._auth.search_entry_by_attribute(attr, value, **kw)

    def search_mail_address(self, domain, mail_address):
        return self._auth._search_mail_address(domain, mail_address)

    def set_entry_attribute(self, domain, entry, attribute, value):
        return self._auth.set_entry_attribute(entry, attribute, value)

    def set_entry_attributes(self, domain, entry, attributes):
        return self._auth.set_entry_attributes(entry, attributes)

    def set_user_attribute(self, domain, user, attribute, value):
        self._auth._set_user_attribute(user, attribute, value)