init.py
No OneTemporary
Actions

Authored By

Unknown

Size

54 KB

Referenced Files

None

Subscribers

None

init.py
View Options

	# Copyright 2010-2012 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; version 3 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 Library General Public License for more details.
	#
	# You should have received a copy of the GNU General Public License
	# along with this program; if not, write to the Free Software
	# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	#

	import datetime
	import _ldap
	import ldap
	import ldap.async
	import ldap.controls
	import logging
	import time

	import pykolab
	import pykolab.base

	from pykolab import utils
	from pykolab.constants import *
	from pykolab.errors import *
	from pykolab.translate import _

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

	import cache

	# Catch python-ldap-2.4 changes
	from distutils import version

	if version.StrictVersion('2.4.0') <= version.StrictVersion(ldap.__version__):
	LDAP_CONTROL_PAGED_RESULTS = ldap.CONTROL_PAGEDRESULTS
	else:
	LDAP_CONTROL_PAGED_RESULTS = ldap.LDAP_CONTROL_PAGE_OID

	try:
	from ldap.controls import psearch
	except:
	log.warning(_("Python LDAP library does not support persistent search"))

	class SimplePagedResultsControl(ldap.controls.SimplePagedResultsControl):
	"""

	Python LDAP 2.4 and later breaks the API. This is an abstraction class
	so that we can handle either.
	"""

	def __init__(self, page_size=0, cookie=''):
	if version.StrictVersion(
	'2.4.0'
	) <= version.StrictVersion(
	ldap.__version__
	):

	ldap.controls.SimplePagedResultsControl.__init__(
	self,
	size=page_size,
	cookie=cookie
	)
	else:
	ldap.controls.SimplePagedResultsControl.__init__(
	self,
	LDAP_CONTROL_PAGED_RESULTS,
	True,
	(page_size, '')
	)

	def cookie(self):
	if version.StrictVersion(
	'2.4.0'
	) <= version.StrictVersion(
	ldap.__version__
	):

	return self.cookie
	else:
	return self.controlValue[1]

	def size(self):
	if version.StrictVersion(
	'2.4.0'
	) <= version.StrictVersion(
	ldap.__version__
	):

	return self.size
	else:
	return self.controlValue[0]

	class LDAP(pykolab.base.Base):
	"""
	Abstraction layer for the LDAP authentication / authorization backend,
	for use with Kolab.
	"""

	def __init__(self, domain=None):
	"""
	Initialize the LDAP object for domain. If no domain is specified,
	domain name space configured as 'kolab'.'primary_domain' is used.
	"""
	pykolab.base.Base.__init__(self)

	self.ldap = None
	self.bind = False
	if domain == None:
	self.domain = conf.get('kolab', 'primary_domain')
	else:
	self.domain = domain

	def authenticate(self, login, realm):
	"""
	Find the entry corresponding to login, and attempt a bind.

	login is a tuple with 4 values. In order of appearance;

	[0] - the login username.

	[1] - the password

	[2] - the service (optional)

	[3] - the realm

	Called from pykolab.auth.Auth, the realm parameter is derived, while
	login[3] preserves the originally specified realm.
	"""

	log.debug(
	_("Attempting to authenticate user %s in realm %s") % (
	login,
	realm
	),
	level=8
	)

	self.connect()
	self._bind()

	user_filter = self.config_get('user_filter')

	_filter = '(&(\|'

	auth_attrs = self.config_get_list('auth_attributes')

	for attr in auth_attrs:
	_filter += "(%s=%s)" % (attr, login[0])
	_filter += "(%s=%s@%s)" % (attr, login[0], realm)

	_filter += ')%s)' % (user_filter)

	_search = self.ldap.search_ext(
	self.config_get('base_dn'),
	ldap.SCOPE_SUBTREE,
	_filter,
	['entrydn']
	)

	(
	_result_type,
	_result_data,
	_result_msgid,
	_result_controls
	) = self.ldap.result3(_search)

	if len(_result_data) >= 1:
	(entry_dn, entry_attrs) = _result_data[0]

	try:
	log.debug(_("Binding with user_dn %s and password %s")
	% (entry_dn, login[1]))

	# Needs to be synchronous or succeeds and continues setting retval
	# to True!!
	self.ldap.simple_bind_s(entry_dn, login[1])
	retval = True
	except:
	log.debug(
	_("Failed to authenticate as user %s") % (entry_dn),
	level=8
	)

	retval = False

	return retval

	def connect(self):
	"""
	Connect to the LDAP server through the uri configured.
	"""
	if not self.ldap == None:
	return

	log.debug(_("Connecting to LDAP..."), level=8)

	uri = self.config_get('ldap_uri')

	log.debug(_("Attempting to use LDAP URI %s") % (uri), level=8)

	trace_level = 0

	if conf.debuglevel > 8:
	trace_level = 1

	self.ldap = ldap.initialize(uri, trace_level=trace_level)
	self.ldap.protocol_version = 3
	self.ldap.supported_controls = []

	def entry_dn(self, entry_id):
	"""
	Get a entry's distinguished name for an entry ID.

	The entry ID may be any of:

	- an entry's value for the configured unique_attribute,
	- a (syntactically valid) Distinguished Name,
	- a dictionary such as previously returned as (part of) the result
	of a search.
	"""
	entry_dn = None

	if self._entry_dn(entry_id):
	return entry_id

	if self._entry_dict(entry_id):
	return entry_id['dn']

	unique_attribute = self.config_get('unique_attribute')
	base_dn = self.config_get('base_dn')

	_search = self.ldap.search_ext(
	base_dn,
	ldap.SCOPE_SUBTREE,
	'(%s=%s)' % (unique_attribute, entry_id),
	['entrydn']
	)

	(
	_result_type,
	_result_data,
	_result_msgid,
	_result_controls
	) = self.ldap.result3(_search)

	if len(_result_data) >= 1:
	(entry_dn, entry_attrs) = _result_data[0]

	return entry_dn

	def get_entry_attribute(self, entry_id, attribute):
	"""
	Get an attribute for an entry.

	Return the attribute value if successful, or None if not.
	"""

	entry_attrs = self.get_entry_attributes(entry_id, [attribute])

	if entry_attrs.has_key(attribute):
	return entry_attrs[attribute]
	else:
	return None

	def get_entry_attributes(self, entry_id, attributes):
	"""
	Get multiple attributes for an entry.
	"""

	entry_dn = self.entry_dn(entry_id)

	_search = self.ldap.search_ext(
	entry_dn,
	ldap.SCOPE_BASE,
	'(objectclass=*)',
	[ 'dn' ] + attributes
	)

	(
	_result_type,
	_result_data,
	_result_msgid,
	_result_controls
	) = self.ldap.result3(_search)

	if len(_result_data) >= 1:
	(_entry_dn, _entry_attrs) = _result_data[0]
	else:
	return None

	return utils.normalize(_entry_attrs)

	def find_recipient(self, address="*", exclude_entry_id=None):
	"""
	Given an address string or list of addresses, find one or more valid
	recipients.

	Use this function only to detect whether an address is already in
	use by any entry in the tree.

	Specify an additional entry_id to exclude to exclude matches against
	the current entry.
	"""

	if not exclude_entry_id == None:
	__filter_prefix = "(&"
	__filter_suffix = "(!(%s=%s)))" % (
	self.config_get('unique_attribute'),
	exclude_entry_id
	)

	else:
	__filter_prefix = ""
	__filter_suffix = ""

	kolab_filter = self._kolab_filter()
	recipient_address_attrs = self.config_get_list("mail_attributes")
	result_attributes = recipient_address_attrs
	result_attributes.append(self.config_get('unique_attribute'))

	_filter = "(\|"

	for recipient_address_attr in recipient_address_attrs:
	if isinstance(address, basestring):
	_filter += "(%s=%s)" % (recipient_address_attr, address)
	else:
	for _address in address:
	_filter += "(%s=%s)" % (recipient_address_attr, _address)

	_filter += ")"

	_filter = "%s%s%s" % (__filter_prefix,_filter,__filter_suffix)


	log.debug(_("Finding recipient with filter %r") % (_filter), level=8)

	if len(_filter) <= 6:
	return None

	_results = self.ldap.search_s(
	self.config_get('base_dn'),
	scope=ldap.SCOPE_SUBTREE,
	filterstr=_filter,
	attrlist=result_attributes,
	attrsonly=True
	)

	_entry_dns = []

	for _result in _results:
	(_entry_id, _entry_attrs) = _result
	_entry_dns.append(_entry_id)

	return _entry_dns

	def get_latest_sync_timestamp(self):
	return cache.last_modify_timestamp(self.domain)

	def list_secondary_domains(self):
	"""
	List alias domain name spaces for the current domain name space.
	"""
	return [s for s, p in self.secondary_domains.iteritems() if p == self.domain]

	def recipient_policy(self, entry):
	"""
	Apply a recipient policy, if configured.

	Given an entry, returns the entry's attribute values to be set.
	"""

	entry_dn = self.entry_dn(entry)
	entry_modifications = {}
	entry_type = self._entry_type(entry)
	primary_mail = None
	primary_mail_attribute = self.config_get_list('mail_attributes')[0]
	secondary_mail = None
	secondary_mail_attribute = self.config_get_list('mail_attributes')[1]
	want_attrs = []

	# See which mail attributes we would want to control.
	#
	# 'mail' is considered for primary_mail,
	# 'alias' and 'mailalternateaddress' are considered for secondary mail.
	#
	primary_mail = self.config_get_raw('%s_primary_mail' % (entry_type))
	if primary_mail == None and entry_type == 'user':
	primary_mail = self.config_get_raw('primary_mail')

	secondary_mail = self.config_get_raw('%s_secondary_mail' % (entry_type))
	if secondary_mail == None and entry_type == 'user':
	secondary_mail = self.config_get_raw('secondary_mail')

	# See if the relevant mail attributes exist
	_mail_attrs = self.config_get('mail_attributes')
	for _mail_attr in _mail_attrs:
	if not entry.has_key(_mail_attr):
	if _mail_attr == primary_mail_attribute:
	if not primary_mail == None:
	want_attrs.append(_mail_attr)
	elif _mail_attr == secondary_mail_attribute:
	if not secondary_mail == None:
	want_attrs.append(_mail_attr)

	# Also append the preferredlanguage or 'native tongue' configured
	# for the entry.
	if not entry.has_key('preferredlanguage'):
	want_attrs.append('preferredlanguage')

	# If we wanted anything, now is the type to get it.
	if len(want_attrs) > 0:
	attributes = self.get_entry_attributes(entry_dn, want_attrs)

	for attribute in attributes.keys():
	entry[attribute] = attributes[attribute]

	# Primary mail address
	if not primary_mail == None:
	if not entry.has_key(primary_mail_attribute) or entry[primary_mail_attribute] == None:
	primary_mail_address = conf.plugins.exec_hook(
	"set_primary_mail",
	kw={
	'primary_mail': primary_mail,
	'entry': entry,
	'primary_domain': self.domain
	}
	)
	else:
	primary_mail_address = entry[primary_mail_attribute]

	i = 1
	_primary_mail = primary_mail_address

	done = False
	while not done:
	results = self.find_recipient(_primary_mail, entry['id'])

	# Length of results should be 0 (no entry found)
	# or 1 (which should be the entry we're looking at here)
	if len(results) == 0:
	log.debug(
	_("No results for mail address %s found") % (
	_primary_mail
	),
	level=8
	)

	done = True
	continue

	if len(results) == 1:
	log.debug(
	_("1 result for address %s found, verifying") % (
	_primary_mail
	),
	level=8
	)

	almost_done = True
	for result in results:
	if not result == entry_dn:
	log.debug(
	_("Too bad, primary email address %s " + \
	"already in use for %s (we are %s)") % (
	_primary_mail,
	result,
	entry_dn
	),
	level=8
	)

	almost_done = False
	else:
	log.debug(_("Address assigned to us"), level=8)

	if almost_done:
	done = True
	continue

	i += 1
	_primary_mail = "%s%d@%s" % (
	primary_mail_address.split('@')[0],
	i,
	primary_mail_address.split('@')[1]
	)

	primary_mail_address = _primary_mail

	###
	### FIXME
	###
	if not primary_mail_address == None:
	if not entry.has_key(primary_mail_attribute):
	self.set_entry_attribute(entry, primary_mail_attribute, primary_mail_address)
	entry_modifications[primary_mail_attribute] = primary_mail_address
	else:
	if not primary_mail_address == entry[primary_mail_attribute]:
	self.set_entry_attribute(entry, primary_mail_attribute, primary_mail_address)

	entry_modifications[primary_mail_attribute] = primary_mail_address

	if not secondary_mail == None:
	# Execute the plugin hook
	suggested_secondary_mail = conf.plugins.exec_hook(
	"set_secondary_mail",
	kw={
	'secondary_mail': secondary_mail,
	'entry': entry,
	'domain': self.domain,
	'primary_domain': self.domain,
	'secondary_domains': self.list_secondary_domains()
	}
	) # end of conf.plugins.exec_hook() call

	secondary_mail_addresses = []

	for _secondary_mail in suggested_secondary_mail:
	i = 1
	__secondary_mail = _secondary_mail

	done = False
	while not done:
	results = self.find_recipient(__secondary_mail, entry['id'])

	# Length of results should be 0 (no entry found)
	# or 1 (which should be the entry we're looking at here)
	if len(results) == 0:
	log.debug(
	_("No results for address %s found") % (
	__secondary_mail
	),
	level=8
	)

	done = True
	continue

	if len(results) == 1:
	log.debug(
	_("1 result for address %s found, " + \
	"verifying...") % (
	__secondary_mail
	),
	level=8
	)

	almost_done = True
	for result in results:
	if not result == entry_dn:
	log.debug(
	_("Too bad, secondary email " + \
	"address %s already in use for " + \
	"%s (we are %s)") % (
	__secondary_mail,
	result,
	entry_dn
	),
	level=8
	)

	almost_done = False
	else:
	log.debug(_("Address assigned to us"), level=8)

	if almost_done:
	done = True
	continue

	i += 1
	__secondary_mail = "%s%d@%s" % (
	_secondary_mail.split('@')[0],
	i,
	_secondary_mail.split('@')[1]
	)

	secondary_mail_addresses.append(__secondary_mail)

	if not secondary_mail_addresses == None:
	secondary_mail_addresses = list(set(secondary_mail_addresses))
	# Avoid duplicates
	while primary_mail_address in secondary_mail_addresses:
	secondary_mail_addresses.pop(
	secondary_mail_addresses.index(primary_mail_address)
	)

	if not entry.has_key(secondary_mail_attribute):
	if not len(secondary_mail_addresses) == 0:
	self.set_entry_attribute(
	entry,
	secondary_mail_attribute,
	secondary_mail_addresses
	)

	entry_modifications[secondary_mail_attribute] = secondary_mail_addresses
	else:
	if not secondary_mail_addresses == entry[secondary_mail_attribute]:
	self.set_entry_attribute(
	entry,
	secondary_mail_attribute,
	secondary_mail_addresses
	)

	entry_modifications[secondary_mail_attribute] = secondary_mail_addresses

	return entry_modifications

	def set_entry_attribute(self, entry_id, attribute, value):
	self.set_entry_attributes(entry_id, { attribute: value })

	def set_entry_attributes(self, entry_id, attributes):
	self._bind()

	entry_dn = self.entry_dn(entry_id)

	print entry_dn

	attrs = {}
	for attribute in attributes.keys():
	attrs[attribute.lower()] = attributes[attribute]

	def synchronize(self):
	"""
	Synchronize with LDAP
	"""
	self._bind()

	_filter = self._kolab_filter()

	modified_after = self.get_latest_sync_timestamp()
	_filter = "(&%s(modifytimestamp>=%s))" % (_filter,modified_after)

	log.debug(_("Using filter %r") % (_filter), level=8)

	self._search(
	self.config_get('base_dn'),
	filterstr=_filter,
	attrlist=[
	'*',
	self.config_get('unique_attribute'),
	'modifytimestamp'
	],
	callback=self._synchronize_callback,
	)

	###
	### API depth level increasing!
	###

	def _bind(self):
	if self.ldap == None:
	self.connect()

	if not self.bind:
	bind_dn = self.config_get('bind_dn')
	bind_pw = self.config_get('bind_pw')

	# TODO: Binding errors control
	try:
	self.ldap.simple_bind_s(bind_dn, bind_pw)
	self.bind = True
	except ldap.SERVER_DOWN:
	# Can't contact LDAP server
	#
	# - Service not started
	# - Service faulty
	# - Firewall
	pass
	except ldap.INVALID_CREDENTIALS:
	log.error(_("Invalid bind credentials"))

	def _change_add_user(self, entry, change):
	"""
	An entry of type user was added.
	"""
	mailserver_attribute = self.config_get('mailserver_attribute')
	result_attribute = conf.get('cyrus-sasl', 'result_attribute')

	if not entry.has_key(mailserver_attribute):
	entry[mailserver_attribute] = \
	self.get_entry_attribute(entry, mailserver_attribute)

	rcpt_addrs = self.recipient_policy(entry)
	for key in rcpt_addrs:
	entry[key] = rcpt_addrs[key]

	if not entry.has_key(result_attribute):
	return

	if entry[result_attribute] == None:
	return

	cache.get_entry(self.domain, entry)

	self.imap.connect(domain=self.domain)

	if not self.imap.user_mailbox_exists(entry[result_attribute]):
	folder = self.imap.user_mailbox_create(
	entry[result_attribute],
	entry[mailserver_attribute]
	)
	else:
	folder = "user%s%s" % (self.imap.separator,entry[result_attribute])

	server = self.imap.user_mailbox_server(folder)

	if not entry[mailserver_attribute] == server:
	self.set_entry_attribute(entry, mailserver_attribute, server)

	def _change_add_group(self, entry, change):
	"""
	An entry of type group was added.

	The Kolab daemon has little to do for this type of action on this
	type of entry.
	"""
	pass

	def _change_add_role(self, entry, change):
	"""
	An entry of type role was added.

	The Kolab daemon has little to do for this type of action on this
	type of entry.
	"""
	pass

	def _change_add_sharedfolder(self, entry, change):
	"""
	An entry of type sharedfolder was added.
	"""
	self.imap.connect(domain=self.domain)

	server = None
	mailserver_attribute = self.config_get('mailserver_attribute')

	if entry.has_key(mailserver_attribute):
	server = entry['mailserver_attribute']

	if not entry.has_key('kolabtargetfolder'):
	entry['kolabtargetfolder'] = self.get_entry_attribute(
	entry['id'],
	'kolabtargetfolder'
	)

	if not entry.has_key('kolabfoldertype'):
	entry['kolabfoldertype'] = self.get_entry_attribute(
	entry['id'],
	'kolabfoldertype'
	)

	#if not entry.has_key('kolabmailfolderaclentry'):
	#entry['kolabmailfolderaclentry'] = self.get_entry_attribute(
	#entry['id'],
	#'kolabmailfolderaclentry'
	#)

	if entry.has_key('kolabtargetfolder') and not entry['kolabtargetfolder'] == None:
	folder_path = entry['kolabtargetfolder']
	else:
	# TODO: What is the way to see if we need to create an @domain
	# shared mailbox?
	# TODO^2: self.domain, really? Presumes any mail attribute is
	# set to the primary domain name space...
	# TODO^3: Test if the cn is already something@domain
	result_attribute = conf.get('cyrus-sasl', 'result_attribute')
	if result_attribute in ['mail']:
	folder_path = "%s@%s" % (entry['cn'], self.domain)
	else:
	folder_path = entry['cn']

	if not self.imap.shared_folder_exists(folder_path):
	self.imap.shared_folder_create(folder_path, server)

	if entry.has_key('kolabfoldertype') and not entry['kolabfoldertype'] == None:
	self.imap.shared_folder_set_type(folder_path, entry['kolabfoldertype'])

	#if entry.has_key('kolabmailfolderaclentry') and not entry['kolabmailfolderaclentry'] == None:
	#self.imap._set_kolab_mailfolder_acls(entry['kolabmailfolderaclentry'])

	#if server == None:
	#self.entry_set_attribute(mailserver_attribute, server)

	def _change_delete_group(self, entry, change):
	"""
	An entry of type group was deleted.
	"""

	result_attribute = conf.get('cyrus-sasl', 'result_attribute')

	if not entry.has_key(result_attribute):
	return None

	if entry[result_attribute] == None:
	return None

	self.imap.cleanup_acls(entry[result_attribute])


	def _change_delete_None(self, entry, change):
	"""
	Redirect to _change_delete_unknown
	"""
	self._change_delete_unknown(entry, change)

	def _change_delete_sharedfolder(self, entry, change):
	pass

	def _change_delete_unknown(self, entry, change):
	"""
	An entry has been deleted, and we do not know of what object type
	the entry was - user, group, role or sharedfolder.
	"""
	result_attribute = conf.get('cyrus-sasl', 'result_attribute')
	if not entry.has_key(result_attribute):
	return None

	if entry[result_attribute] == None:
	return None

	success = True
	for _type in ['user','group','role','sharedfolder']:
	try:
	eval("_change_delete_%s(entry, change)" % (_type))
	except:
	success = False

	if success:
	break

	def _change_delete_user(self, entry, change):
	"""
	An entry of type user was deleted.
	"""

	result_attribute = conf.get('cyrus-sasl', 'result_attribute')

	if not entry.has_key(result_attribute):
	return None

	if entry[result_attribute] == None:
	return None

	cache.delete_entry(self.domain, entry)

	self.imap.user_mailbox_delete(entry[result_attribute])
	self.imap.cleanup_acls(entry[result_attribute])


	def _change_moddn_group(self, entry, change):
	# TODO: If the rdn attribute is the same as the result attribute...
	pass

	def _change_moddn_role(self, entry, change):
	pass

	def _change_moddn_user(self, entry, change):
	old_dn = change['previous_dn']
	new_dn = change['dn']

	import ldap.dn
	old_rdn = ldap.dn.explode_dn(old_dn)[0].split('=')[0]
	new_rdn = ldap.dn.explode_dn(new_dn)[0].split('=')[0]

	result_attribute = conf.get('cyrus-sasl', 'result_attribute')

	old_canon_attr = None

	cache_entry = cache.get_entry(self.domain, entry)
	if not cache_entry == None:
	old_canon_attr = cache_entry['result_attribute']

	# See if we have to trigger the recipient policy. Only really applies to
	# situations in which the result_attribute is used in the old or in the
	# new DN.
	trigger_recipient_policy = False

	if old_rdn == result_attribute:
	if new_rdn == result_attribute:
	if new_rdn == old_rdn:
	trigger_recipient_policy = True
	else:
	if not new_rdn == old_rdn:
	trigger_recipient_policy = True
	else:
	if new_rdn == result_attribute:
	if not new_rdn == old_rdn:
	trigger_recipient_policy = True

	if trigger_recipient_policy:
	entry_changes = self.recipient_policy(entry)

	for key in entry_changes.keys():
	entry[key] = entry_changes[key]

	# Now look at entry_changes and old_canon_attr, and see if they're the
	# same value.
	if entry_changes.has_key(result_attribute):
	if not old_canon_attr == None:
	self.imap.user_mailbox_create(entry_changes[result_attribute])
	elif not entry_changes[result_attribute] == old_canon_attr:
	self.imap.user_mailbox_rename(old_canon_attr, entry_changes[result_attribute])

	cache.get_entry(self.domain, entry)

	def _change_moddn_sharedfolder(self, entry, change):
	pass

	def _change_modify_group(self, entry, change):
	pass

	def _change_modify_role(self, entry, change):
	pass

	def _change_modify_sharedfolder(self, entry, change):
	pass

	def _change_modify_user(self, entry, change):
	for entry_key in conf.changelog.keys():
	log.debug(_("Current changelog entry %s with %s") % (entry_key,conf.changelog[entry_key]), level=8)

	if conf.changelog.has_key(entry['id']):
	old_canon_attr = conf.changelog[entry['id']]

	entry_changes = self.recipient_policy(entry)

	log.debug(_("Result from recipient policy: %r") % (entry_changes), level=8)

	result_attribute = conf.get('cyrus-sasl','result_attribute')
	if entry_changes.has_key(result_attribute):
	if not entry_changes[result_attribute] == old_canon_attr:
	self.imap.user_mailbox_rename(old_canon_attr, entry_changes[result_attribute])
	conf.changelog[entry['id']] = entry_changes[result_attribute]

	def _change_none_group(self, entry, change):
	"""
	A group entry as part of the initial search result set.

	The Kolab daemon has little to do for this type of action on this
	type of entry.
	"""
	pass

	def _change_none_role(self, entry, change):
	"""
	A role entry as part of the initial search result set.

	The Kolab daemon has little to do for this type of action on this
	type of entry.
	"""
	pass

	def _change_none_sharedfolder(self, entry, change):
	"""
	A sharedfolder entry as part of the initial search result set.
	"""
	self.imap.connect(domain=self.domain)

	server = None
	mailserver_attribute = self.config_get('mailserver_attribute')

	if entry.has_key(mailserver_attribute):
	server = entry['mailserver_attribute']

	if not entry.has_key('kolabtargetfolder'):
	entry['kolabtargetfolder'] = self.get_entry_attribute(
	entry['id'],
	'kolabtargetfolder'
	)

	if not entry.has_key('kolabfoldertype'):
	entry['kolabfoldertype'] = self.get_entry_attribute(
	entry['id'],
	'kolabfoldertype'
	)

	#if not entry.has_key('kolabmailfolderaclentry'):
	#entry['kolabmailfolderaclentry'] = self.get_entry_attribute(
	#entry['id'],
	#'kolabmailfolderaclentry'
	#)

	if entry.has_key('kolabtargetfolder') and not entry['kolabtargetfolder'] == None:
	folder_path = entry['kolabtargetfolder']
	else:
	# TODO: What is the way to see if we need to create an @domain
	# shared mailbox?
	# TODO^2: self.domain, really? Presumes any mail attribute is
	# set to the primary domain name space...
	# TODO^3: Test if the cn is already something@domain
	result_attribute = conf.get('cyrus-sasl', 'result_attribute')
	if result_attribute in ['mail']:
	folder_path = "%s@%s" % (entry['cn'], self.domain)
	else:
	folder_path = entry['cn']

	if not self.imap.shared_folder_exists(folder_path):
	self.imap.shared_folder_create(folder_path, server)

	if entry.has_key('kolabfoldertype') and not entry['kolabfoldertype'] == None:
	self.imap.shared_folder_set_type(folder_path, entry['kolabfoldertype'])

	#if entry.has_key('kolabmailfolderaclentry') and not entry['kolabmailfolderaclentry'] == None:
	#self.imap._set_kolab_mailfolder_acls(entry['kolabmailfolderaclentry'])

	#if server == None:
	#self.entry_set_attribute(mailserver_attribute, server)

	def _change_none_user(self, entry, change):
	"""
	A user entry as part of the initial search result set.
	"""
	result_attribute = conf.get('cyrus-sasl', 'result_attribute')

	rcpt_addrs = self.recipient_policy(entry)
	for key in rcpt_addrs.keys():
	entry[key] = rcpt_addrs[key]

	db = cache.init_db(self.domain)
	_entry = db.query(cache.Entry).filter_by(uniqueid=entry['id']).first()
	if _entry == None:
	db.add(cache.Entry(
	entry['id'],
	entry[result_attribute],
	entry['modifytimestamp']
	))

	_entry = db.query(cache.Entry).filter_by(uniqueid=entry['id']).first()

	db.commit()

	if not conf.changelog.has_key(entry['id']):
	conf.changelog[entry['id']] = entry[result_attribute]

	self.imap.connect(domain=self.domain)

	if not self.imap.user_mailbox_exists(entry[result_attribute]):
	folder = self.imap.user_mailbox_create(entry[result_attribute])
	server = self.imap.user_mailbox_server(folder)

	def _disconnect(self):
	self._unbind()
	del self.ldap
	self.ldap = None
	self.bind = False

	def _entry_dict(self, value):
	"""
	Tests if 'value' is a valid entry dictionary with a DN contained
	within key 'dn'.

	Returns True or False
	"""
	if isinstance(value, dict):
	if value.has_key('dn'):
	return True

	return False

	def _entry_dn(self, value):
	"""
	Tests if 'value' is a valid DN.

	Returns True or False
	"""

	# Only basestrings can be DNs
	if not isinstance(value, basestring):
	return False

	try:
	import ldap.dn
	ldap_dn = ldap.dn.explode_dn(value)
	except ldap.DECODING_ERROR:
	# This is not a DN.
	return False

	return True

	def _entry_type(self, entry_id):
	"""
	Return the type of object for an entry.
	"""

	entry_dn = self.entry_dn(entry_id)

	base_dn = self.config_get('base_dn')

	for _type in ['user', 'group', 'sharedfolder']:
	__filter = self.config_get('kolab_%s_filter' % (_type))
	if __filter == None:
	__filter = self.config_get('%s_filter' % (_type))

	if not __filter == None:
	try:
	result = self._regular_search(entry_dn, filterstr=__filter)
	except:
	result = self._regular_search(
	base_dn,
	filterstr="(%s=%s)" %(
	self.config_get('unique_attribute'),
	entry_id['id'])
	)

	if not result:
	continue
	else:
	return _type

	def _find_user_dn(self, login, realm):
	"""
	Find the distinguished name (DN) for an entry in LDAP.
	"""

	domain_root_dn = self._kolab_domain_root_dn(self.domain)

	base_dn = self.config_get('user_base_dn')
	if base_dn == None:
	base_dn = self.config_get('base_dn')

	auth_attrs = self.config_get_list('auth_attributes')

	auth_search_filter = [ '(\|' ]

	for auth_attr in auth_attrs:
	auth_search_filter.append('(%s=%s)' % (auth_attr,login))
	auth_search_filter.append('(%s=%s@%s)' % (auth_attr,login,self.domain))

	auth_search_filter.append(')')

	auth_search_filter = ''.join(auth_search_filter)

	search_filter = "(&%s%s)" % (
	auth_search_filter,
	user_filter
	)

	_results = self._search(
	user_base_dn,
	filterstr=search_filter,
	attrlist=[ 'dn' ],
	override_search='_regular_search'
	)

	if len(_results) == 1:
	(_user_dn, _user_attrs) = _results[0]
	else:
	# Retry to find the user_dn with just uid=%s against the root_dn,
	# if the login is not fully qualified
	if len(login.split('@')) < 2:
	search_filter = "(uid=%s)" % (login)
	_results = self._search(
	domain,
	filterstr=search_filter,
	attrlist=[ 'dn' ]
	)

	if len(_results) == 1:
	(_user_dn, _user_attrs) = _results[0]
	else:
	# Overall fail
	return False
	else:
	return False

	return _user_dn

	def _kolab_domain_root_dn(self, domain):
	self._bind()

	log.debug(_("Finding domain root dn for domain %s") % (domain), level=8)

	bind_dn = conf.get('ldap', 'bind_dn')
	bind_pw = conf.get('ldap', 'bind_pw')

	domain_base_dn = conf.get('ldap', 'domain_base_dn', quiet=True)

	if not domain_base_dn == "":

	# If we haven't returned already, let's continue searching
	domain_name_attribute = conf.get('ldap', 'domain_name_attribute')

	_results = self._search(
	domain_base_dn,
	ldap.SCOPE_SUBTREE,
	"(%s=%s)" % (domain_name_attribute,domain),
	override_search='_regular_search'
	)

	domains = []
	for _domain in _results:
	(domain_dn, _domain_attrs) = _domain
	domain_rootdn_attribute = conf.get(
	'ldap',
	'domain_rootdn_attribute'
	)
	_domain_attrs = utils.normalize(_domain_attrs)
	if _domain_attrs.has_key(domain_rootdn_attribute):
	return _domain_attrs[domain_rootdn_attribute]

	else:
	if conf.has_option('ldap', 'base_dn'):
	return conf.get('ldap', 'base_dn')

	return utils.standard_root_dn(domain)

	def _kolab_filter(self):
	"""
	Compose a filter using the relevant settings from configuration.
	"""
	_filter = "(\|"
	for _type in ['user', 'group', 'sharedfolder']:
	__filter = self.config_get('kolab_%s_filter' % (_type))
	if __filter == None:
	__filter = self.config_get('%s_filter' % (_type))

	if not __filter == None:
	_filter = "%s%s" % (_filter,__filter)

	_filter = "%s)" % (_filter)

	return _filter

	def _list_domains(self):
	"""
	Find the domains related to this Kolab setup, and return a list of
	DNS domain names.

	Returns a list of tuples, each tuple containing the primary domain
	name and a list of secondary domain names.

	This function should only be called by the primary instance of Auth.
	"""

	log.debug(_("Listing domains..."), level=8)

	self.connect()

	bind_dn = conf.get('ldap', 'bind_dn')
	bind_pw = conf.get('ldap', 'bind_pw')

	domain_base_dn = conf.get('ldap', 'domain_base_dn', quiet=True)

	if domain_base_dn == "":
	# No domains are to be found in LDAP, return an empty list.
	# Note that the Auth() base itself handles this case.
	return []

	# If we haven't returned already, let's continue searching
	domain_filter = conf.get('ldap', 'domain_filter')

	if domain_base_dn == None or domain_filter == None:
	return []

	# TODO: this function should be wrapped for error handling
	try:
	self.ldap.simple_bind_s(bind_dn, bind_pw)
	except ldap.SERVER_DOWN, e:
	raise AuthBackendError, _("Authentication database DOWN")

	try:
	_search = self._search(
	domain_base_dn,
	ldap.SCOPE_SUBTREE,
	domain_filter,
	# TODO: Where we use associateddomain is actually configurable
	[ 'associateddomain' ],
	override_search='_regular_search'
	)
	except:
	return []

	domains = []

	for domain_dn, domain_attrs in _search:
	primary_domain = None
	secondary_domains = []

	domain_attrs = utils.normalize(domain_attrs)

	# TODO: Where we use associateddomain is actually configurable
	if type(domain_attrs['associateddomain']) == list:
	primary_domain = domain_attrs['associateddomain'].pop(0)
	secondary_domains = domain_attrs['associateddomain']
	else:
	primary_domain = domain_attrs['associateddomain']

	domains.append((primary_domain,secondary_domains))

	return domains

	def _reconnect(self):
	"""
	Reconnect to LDAP
	"""
	self._disconnect()
	self.connect()

	def _synchronize_callback(self, args, *kw):
	change_type = None

	change_dict = {
	'change_type': kw['change_type'],
	'previous_dn': kw['previous_dn'],
	'change_number': kw['change_number'],
	'dn': kw['dn']
	}

	entry = utils.normalize(kw['entry'])
	entry['dn'] = kw['dn']

	unique_attr = self.config_get('unique_attribute')
	entry['id'] = entry[unique_attr]

	try:
	entry['type'] = self._entry_type(entry)
	except:
	entry['type'] = "unknown"

	log.debug(_("Entry type: %s") % (entry['type']), level=8)

	if change_dict['change_type'] == None:
	# This entry was in the start result set
	eval("self._change_none_%s(entry, change_dict)" % (entry['type']))
	else:
	change = psearch.CHANGE_TYPES_STR[change_dict['change_type']].lower()
	eval("self._change_%s_%s(entry, change_dict)" % (change, entry['type']))

	def _unbind(self):
	"""
	Discard the current set of bind credentials.

	Virtually disconnects the LDAP connection, and should be followed by
	a call to _bind() afterwards.
	"""

	self.ldap.unbind()
	self.bind = False

	###
	### Backend search functions
	###

	def _persistent_search(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):
	_results = []

	psearch_server_controls = []

	psearch_server_controls.append(psearch.PersistentSearchControl(
	criticality=True,
	changeTypes=[ 'add', 'delete', 'modify', 'modDN' ],
	changesOnly=False,
	returnECs=True
	)
	)

	_search = self.ldap.search_ext(
	base_dn,
	scope=scope,
	filterstr=filterstr,
	attrlist=attrlist,
	attrsonly=attrsonly,
	timeout=timeout,
	serverctrls=psearch_server_controls
	)

	ecnc = psearch.EntryChangeNotificationControl

	while True:
	res_type,res_data,res_msgid,_None,_None,_None = self.ldap.result4(
	_search,
	all=0,
	add_ctrls=1,
	add_intermediates=1,
	resp_ctrl_classes={ecnc.controlType:ecnc}
	)

	change_type = None
	previous_dn = None
	change_number = None

	for dn,entry,srv_ctrls in res_data:
	log.debug(_("LDAP Search Result Data Entry:"), level=8)
	log.debug(" DN: %r" % (dn), level=8)
	log.debug(" Entry: %r" % (entry), level=8)

	ecn_ctrls = [
	c for c in srv_ctrls
	if c.controlType == ecnc.controlType
	]

	if ecn_ctrls:
	change_type = ecn_ctrls[0].changeType
	previous_dn = ecn_ctrls[0].previousDN
	change_number = ecn_ctrls[0].changeNumber
	change_type_desc = psearch.CHANGE_TYPES_STR[change_type]

	log.debug(
	_("Entry Change Notification attributes:"),
	level=8
	)

	log.debug(
	" " + _("Change Type: %r (%r)") % (
	change_type,
	change_type_desc
	),
	level=8
	)

	log.debug(
	" " + _("Previous DN: %r") % (previous_dn),
	level=8
	)

	if callback:
	callback(
	dn=dn,
	entry=entry,
	previous_dn=previous_dn,
	change_type=change_type,
	change_number=change_number,
	primary_domain=primary_domain,
	secondary_domains=secondary_domains
	)

	def _paged_search(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):

	page_size = 500
	critical = True
	_results = []

	server_page_control = SimplePagedResultsControl(page_size=page_size)

	_search = self.ldap.search_ext(
	base_dn,
	scope=scope,
	filterstr=filterstr,
	attrlist=attrlist,
	attrsonly=attrsonly,
	serverctrls=[server_page_control]
	)

	pages = 0
	while True:
	pages += 1
	try:
	(
	_result_type,
	_result_data,
	_result_msgid,
	_result_controls
	) = self.ldap.result3(_search)

	except ldap.NO_SUCH_OBJECT, e:
	log.warning(_("Object %s searched no longer exists") % (base_dn))
	break

	if callback:
	callback(
	user=_result_data,
	primary_domain=primary_domain,
	secondary_domains=secondary_domains
	)

	_results.extend(_result_data)
	if (pages % 2) == 0:
	log.debug(_("%d results...") % (len(_results)))

	pctrls = [
	c for c in _result_controls
	if c.controlType == LDAP_CONTROL_PAGED_RESULTS
	]

	if pctrls:
	size = pctrls[0].size
	cookie = pctrls[0].cookie
	if cookie:
	server_page_control.cookie = cookie
	_search = self.ldap.search_ext(
	base_dn,
	scope=scope,
	filterstr=filterstr,
	attrlist=attrlist,
	attrsonly=attrsonly,
	serverctrls=[server_page_control]
	)
	else:
	# TODO: Error out more verbose
	break
	else:
	# TODO: Error out more verbose
	print "Warning: Server ignores RFC 2696 control."
	break

	return _results

	def _vlv_search(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):
	pass

	def _sync_repl(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):

	import syncrepl

	ldap_sync_conn = syncrepl.DNSync(
	'/var/lib/pykolab/syncrepl.db',
	ldap_url.initializeUrl(),
	trace_level=ldapmodule_trace_level,
	trace_file=ldapmodule_trace_file
	)

	msgid = ldap_sync_conn.syncrepl_search(
	base_dn,
	scope,
	mode='refreshAndPersist',
	filterstr=filterstr
	)

	try:
	# Here's where returns need to be taken into account...
	while ldap_sync_conn.syncrepl_poll(all=1, msgid=msgid):
	pass
	except KeyboardInterrupt:
	pass

	def _regular_search(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):

	log.debug(_("Searching with filter %r") % (filterstr), level=8)

	_search = self.ldap.search(
	base_dn,
	scope=scope,
	filterstr=filterstr,
	attrlist=attrlist,
	attrsonly=attrsonly
	)

	_results = []
	_result_type = None

	while not _result_type == ldap.RES_SEARCH_RESULT:
	(_result_type, _result) = self.ldap.result(_search, False, 0)

	if not _result == None:
	for result in _result:
	_results.append(result)

	return _results

	def _search(self,
	base_dn,
	scope=ldap.SCOPE_SUBTREE,
	filterstr="(objectClass=*)",
	attrlist=None,
	attrsonly=0,
	timeout=-1,
	override_search=False,
	callback=False,
	primary_domain=None,
	secondary_domains=[]
	):
	"""
	Search LDAP.

	Use the priority ordered SUPPORTED_LDAP_CONTROLS and use
	the first one supported.
	"""

	if len(self.ldap.supported_controls) < 1:
	for control_num in SUPPORTED_LDAP_CONTROLS.keys():
	log.debug(
	_("Checking for support for %s on %s") % (
	SUPPORTED_LDAP_CONTROLS[control_num]['desc'],
	self.domain
	),
	level=8
	)

	_search = self.ldap.search_s(
	'',
	scope=ldap.SCOPE_BASE,
	attrlist=['supportedControl']
	)

	for (_result,_supported_controls) in _search:
	supported_controls = _supported_controls.values()[0]
	for control_num in SUPPORTED_LDAP_CONTROLS.keys():
	if SUPPORTED_LDAP_CONTROLS[control_num]['oid'] in \
	supported_controls:

	self.ldap.supported_controls.append(
	SUPPORTED_LDAP_CONTROLS[control_num]['func']
	)

	_results = []

	if not override_search == False:
	_use_ldap_controls = [ override_search ]
	else:
	_use_ldap_controls = self.ldap.supported_controls

	for supported_control in _use_ldap_controls:
	exec("""_results = self.%s(
	%r,
	scope=%r,
	filterstr=%r,
	attrlist=%r,
	attrsonly=%r,
	timeout=%r,
	callback=callback,
	primary_domain=%r,
	secondary_domains=%r
	)""" % (
	supported_control,
	base_dn,
	scope,
	filterstr,
	attrlist,
	attrsonly,
	timeout,
	primary_domain,
	secondary_domains
	)
	)

	return _results

File Metadata

Mime Type: text/x-script.python
Expires: Mon, Apr 6, 12:38 AM (6 d, 2 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 18831730
Default Alt Text: __init__.py (54 KB)

__init__.pyNo OneTemporaryActions

__init__.pyView Options

File Metadata

Event Timeline

init.py
No OneTemporary
Actions

init.py
View Options