Legacy Entry methods such as setValue are added to LDAPEntry directly, so that we can use connection classes that return LDAPEntry with code that expects Entries. The Entry and its unique __init__ are still kept for compatibility. Part of the work for: https://fedorahosted.org/freeipa/ticket/2660
760 lines
28 KiB
Python
760 lines
28 KiB
Python
# Authors: Rich Megginson <richm@redhat.com>
|
|
# Rob Crittenden <rcritten@redhat.com>
|
|
# John Dennis <jdennis@redhat.com>
|
|
#
|
|
# Copyright (C) 2007 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# 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 sys
|
|
import os
|
|
import os.path
|
|
import socket
|
|
import string
|
|
import ldap
|
|
import time
|
|
import struct
|
|
import ldap.sasl
|
|
import ldapurl
|
|
from ldap.controls import LDAPControl
|
|
from ipapython.ipa_log_manager import log_mgr
|
|
from ipapython import ipautil
|
|
from ipalib import errors
|
|
from ipapython.ipautil import format_netloc, wait_for_open_socket, wait_for_open_ports
|
|
from ipapython.dn import DN
|
|
from ipaserver.plugins.ldap2 import IPASimpleLDAPObject
|
|
|
|
# Global variable to define SASL auth
|
|
SASL_AUTH = ldap.sasl.sasl({}, 'GSSAPI')
|
|
DEFAULT_TIMEOUT = 10
|
|
|
|
class IPAEntryLDAPObject(IPASimpleLDAPObject):
|
|
def __init__(self, *args, **kwds):
|
|
IPASimpleLDAPObject.__init__(self, *args, **kwds)
|
|
|
|
def result(self, msgid=ldap.RES_ANY, all=1, timeout=None):
|
|
objtype, data = IPASimpleLDAPObject.result(self, msgid, all, timeout)
|
|
# data is either a 2-tuple or a list of 2-tuples
|
|
if data:
|
|
if isinstance(data, (LDAPEntry, tuple)):
|
|
return objtype, Entry(data)
|
|
elif isinstance(data, list):
|
|
return objtype, [Entry(x) for x in data]
|
|
else:
|
|
raise TypeError, "unknown data type %s returned by result" % type(data)
|
|
else:
|
|
return objtype, data
|
|
|
|
def add(self, dn, modlist):
|
|
if isinstance(dn, Entry):
|
|
return IPASimpleLDAPObject.add(self, dn.dn, dn.toTupleList())
|
|
else:
|
|
return IPASimpleLDAPObject.add(self, dn, modlist)
|
|
|
|
def add_s(self, dn, modlist):
|
|
if isinstance(dn, Entry):
|
|
return IPASimpleLDAPObject.add_s(self, dn.dn, dn.toTupleList())
|
|
else:
|
|
return IPASimpleLDAPObject.add_s(self, dn, modlist)
|
|
|
|
def add_ext(self, dn, modlist, serverctrls=None, clientctrls=None):
|
|
if isinstance(dn, Entry):
|
|
return IPASimpleLDAPObject.add_ext(self, dn.dn, dn.toTupleList(), serverctrls, clientctrls)
|
|
else:
|
|
return IPASimpleLDAPObject.add_ext(self, dn, modlist, serverctrls, clientctrls)
|
|
|
|
def add_ext_s(self, dn, modlist, serverctrls=None, clientctrls=None):
|
|
if isinstance(dn, Entry):
|
|
return IPASimpleLDAPObject.add_ext_s(self, dn.dn, dn.toTupleList(), serverctrls, clientctrls)
|
|
else:
|
|
return IPASimpleLDAPObject.add_ext_s(self, dn, modlist, serverctrls, clientctrls)
|
|
|
|
|
|
# Make python-ldap tuple style result compatible with Entry and Entity
|
|
# objects by allowing access to the dn (tuple index 0) via the 'dn'
|
|
# attribute name and the attr dict (tuple index 1) via the 'data'
|
|
# attribute name. Thus:
|
|
# r = result[0]
|
|
# r[0] == r.dn
|
|
# r[1] == r.data
|
|
class LDAPEntry(dict):
|
|
__slots__ = ('_dn',)
|
|
|
|
def __init__(self, _dn=None, _obj=None, **kwargs):
|
|
if isinstance(_dn, LDAPEntry):
|
|
assert _obj is None
|
|
_obj = _dn
|
|
self._dn = DN(_obj._dn) #pylint: disable=E1103
|
|
else:
|
|
assert isinstance(_dn, DN)
|
|
if _obj is None:
|
|
_obj = {}
|
|
self._dn = _dn
|
|
|
|
super(LDAPEntry, self).__init__(self._init_iter(_obj, **kwargs))
|
|
|
|
# properties for Entry and Entity compatibility
|
|
@property
|
|
def dn(self):
|
|
return self._dn
|
|
|
|
@dn.setter
|
|
def dn(self, value):
|
|
assert isinstance(value, DN)
|
|
self._dn = value
|
|
|
|
@property
|
|
def data(self):
|
|
# FIXME: for backwards compatibility only
|
|
return self
|
|
|
|
def _attr_name(self, name):
|
|
if not isinstance(name, basestring):
|
|
raise TypeError(
|
|
"attribute name must be unicode or str, got %s object %r" % (
|
|
name.__class__.__name__, name))
|
|
if isinstance(name, str):
|
|
name = name.decode('ascii')
|
|
return name.lower()
|
|
|
|
def _init_iter(self, _obj, **kwargs):
|
|
_obj = dict(_obj, **kwargs)
|
|
for (k, v) in _obj.iteritems():
|
|
yield (self._attr_name(k), v)
|
|
|
|
def __repr__(self):
|
|
dict_repr = super(LDAPEntry, self).__repr__()
|
|
return '%s(%s, %s)' % (type(self).__name__, repr(self._dn), dict_repr)
|
|
|
|
def copy(self):
|
|
return LDAPEntry(self)
|
|
|
|
def __setitem__(self, name, value):
|
|
super(LDAPEntry, self).__setitem__(self._attr_name(name), value)
|
|
|
|
def setdefault(self, name, default):
|
|
return super(LDAPEntry, self).setdefault(self._attr_name(name), default)
|
|
|
|
def update(self, _obj={}, **kwargs):
|
|
super(LDAPEntry, self).update(self._init_iter(_obj, **kwargs))
|
|
|
|
def __getitem__(self, name):
|
|
# for python-ldap tuple compatibility
|
|
if name == 0:
|
|
return self._dn
|
|
elif name == 1:
|
|
return self
|
|
|
|
return super(LDAPEntry, self).__getitem__(self._attr_name(name))
|
|
|
|
def get(self, name, default=None):
|
|
return super(LDAPEntry, self).get(self._attr_name(name), default)
|
|
|
|
def __delitem__(self, name):
|
|
super(LDAPEntry, self).__delitem__(self._attr_name(name))
|
|
|
|
def pop(self, name, *default):
|
|
return super(LDAPEntry, self).pop(self._attr_name(name), *default)
|
|
|
|
def __contains__(self, name):
|
|
return super(LDAPEntry, self).__contains__(self._attr_name(name))
|
|
|
|
def has_key(self, name):
|
|
return super(LDAPEntry, self).has_key(self._attr_name(name))
|
|
|
|
# for python-ldap tuple compatibility
|
|
def __iter__(self):
|
|
yield self._dn
|
|
yield self
|
|
|
|
def getValues(self, name):
|
|
# FIXME: for backwards compatibility only
|
|
"""Get the list (array) of values for the attribute named name"""
|
|
return self.data.get(name)
|
|
|
|
def getValue(self, name, default=None):
|
|
# FIXME: for backwards compatibility only
|
|
"""Get the first value for the attribute named name"""
|
|
value = self.data.get(name, default)
|
|
if isinstance(value, (list, tuple)):
|
|
return value[0]
|
|
return value
|
|
|
|
def setValue(self, name, *value):
|
|
# FIXME: for backwards compatibility only
|
|
"""
|
|
Set a value on this entry.
|
|
|
|
The value passed in may be a single value, several values, or a
|
|
single sequence. For example:
|
|
|
|
* ent.setValue('name', 'value')
|
|
* ent.setValue('name', 'value1', 'value2', ..., 'valueN')
|
|
* ent.setValue('name', ['value1', 'value2', ..., 'valueN'])
|
|
* ent.setValue('name', ('value1', 'value2', ..., 'valueN'))
|
|
|
|
Since value is a tuple, we may have to extract a list or tuple from
|
|
that tuple as in the last two examples above.
|
|
"""
|
|
if isinstance(value[0],list) or isinstance(value[0],tuple):
|
|
self.data[name] = value[0]
|
|
else:
|
|
self.data[name] = value
|
|
|
|
setValues = setValue
|
|
|
|
def toTupleList(self):
|
|
# FIXME: for backwards compatibility only
|
|
"""Convert the attrs and values to a list of 2-tuples. The first element
|
|
of the tuple is the attribute name. The second element is either a
|
|
single value or a list of values."""
|
|
r = []
|
|
for i in self.data.iteritems():
|
|
n = ipautil.utf8_encode_values(i[1])
|
|
r.append((i[0], n))
|
|
return r
|
|
|
|
def toDict(self):
|
|
# FIXME: for backwards compatibility only
|
|
"""Convert the attrs and values to a dict. The dict is keyed on the
|
|
attribute name. The value is either single value or a list of values."""
|
|
assert isinstance(self.dn, DN)
|
|
result = ipautil.CIDict(self.data)
|
|
for i in result.keys():
|
|
result[i] = ipautil.utf8_encode_values(result[i])
|
|
result['dn'] = self.dn
|
|
return result
|
|
|
|
|
|
class Entry(LDAPEntry):
|
|
"""For compatibility with old code only
|
|
|
|
This class represents an LDAP Entry object. An LDAP entry consists of
|
|
a DN and a list of attributes. Each attribute consists of a name and
|
|
a list of values. In python-ldap, entries are returned as a list of
|
|
2-tuples. Instance variables:
|
|
|
|
* dn - DN object - the DN of the entry
|
|
* data - CIDict - case insensitive dict of the attributes and values
|
|
"""
|
|
def __init__(self, entrydata):
|
|
"""data is the raw data returned from the python-ldap result method, which is
|
|
a search result entry or a reference or None.
|
|
If creating a new empty entry, data is the string DN."""
|
|
if entrydata:
|
|
if isinstance(entrydata, (tuple, LDAPEntry)):
|
|
dn = entrydata[0]
|
|
data = ipautil.CIDict(entrydata[1])
|
|
elif isinstance(entrydata, DN):
|
|
dn = entrydata
|
|
data = ipautil.CIDict()
|
|
elif isinstance(entrydata, basestring):
|
|
dn = DN(entrydata)
|
|
data = ipautil.CIDict()
|
|
elif isinstance(entrydata, dict):
|
|
if hasattr(entrydata, 'dn'):
|
|
entrydata['dn'] = entrydata.dn
|
|
dn = entrydata['dn']
|
|
del entrydata['dn']
|
|
data = ipautil.CIDict(entrydata)
|
|
else:
|
|
raise TypeError(
|
|
"entrydata must be 2-tuple, DN, or basestring, got %s" %
|
|
type(entrydata))
|
|
else:
|
|
dn = DN()
|
|
data = ipautil.CIDict()
|
|
|
|
super(Entry, self).__init__(dn, data)
|
|
|
|
|
|
class IPAdmin(IPAEntryLDAPObject):
|
|
|
|
def __localinit(self):
|
|
if self.protocol == 'ldaps':
|
|
IPAEntryLDAPObject.__init__(self,'ldaps://%s' % format_netloc(self.host, self.port))
|
|
elif self.protocol == 'ldapi':
|
|
IPAEntryLDAPObject.__init__(self,'ldapi://%%2fvar%%2frun%%2fslapd-%s.socket' % "-".join(self.realm.split(".")))
|
|
elif self.protocol == 'ldap':
|
|
IPAEntryLDAPObject.__init__(self,'ldap://%s' % format_netloc(self.host, self.port))
|
|
else:
|
|
raise ValueError('Protocol %r not supported' % self.protocol)
|
|
|
|
def __guess_protocol(self):
|
|
"""Return the protocol to use based on flags passed to the constructor
|
|
|
|
Only used when "protocol" is not specified explicitly.
|
|
|
|
If a CA certificate is provided then it is assumed that we are
|
|
doing SSL client authentication with proxy auth.
|
|
|
|
If a CA certificate is not present then it is assumed that we are
|
|
using a forwarded kerberos ticket for SASL auth. SASL provides
|
|
its own encryption.
|
|
"""
|
|
if self.cacert is not None:
|
|
return 'ldaps'
|
|
elif self.ldapi:
|
|
return 'ldapi'
|
|
else:
|
|
return 'ldap'
|
|
|
|
def __init__(self, host='', port=389, cacert=None, bindcert=None,
|
|
bindkey=None, proxydn=None, debug=None, ldapi=False,
|
|
realm=None, protocol=None):
|
|
"""We just set our instance variables and wrap the methods - the real
|
|
work is done in __localinit. This is separated out this way so
|
|
that we can call it from places other than instance creation
|
|
e.g. when we just need to reconnect
|
|
"""
|
|
log_mgr.get_logger(self, True)
|
|
if debug and debug.lower() == "on":
|
|
ldap.set_option(ldap.OPT_DEBUG_LEVEL,255)
|
|
if cacert is not None:
|
|
ldap.set_option(ldap.OPT_X_TLS_CACERTFILE,cacert)
|
|
if bindcert is not None:
|
|
ldap.set_option(ldap.OPT_X_TLS_CERTFILE,bindcert)
|
|
if bindkey is not None:
|
|
ldap.set_option(ldap.OPT_X_TLS_KEYFILE,bindkey)
|
|
|
|
self.port = port
|
|
self.host = host
|
|
self.cacert = cacert
|
|
self.bindcert = bindcert
|
|
self.bindkey = bindkey
|
|
self.proxydn = proxydn
|
|
self.ldapi = ldapi
|
|
self.realm = realm
|
|
self.suffixes = {}
|
|
self.protocol = protocol or self.__guess_protocol()
|
|
self.__localinit()
|
|
|
|
def __lateinit(self):
|
|
"""
|
|
This is executed after the connection is bound to fill in some useful
|
|
values.
|
|
"""
|
|
try:
|
|
ent = self.getEntry(DN(('cn', 'config'), ('cn', 'ldbm database'), ('cn', 'plugins'), ('cn', 'config')),
|
|
ldap.SCOPE_BASE, '(objectclass=*)',
|
|
[ 'nsslapd-directory' ])
|
|
|
|
self.dbdir = os.path.dirname(ent.getValue('nsslapd-directory'))
|
|
except ldap.LDAPError, e:
|
|
self.__handle_errors(e)
|
|
|
|
def __str__(self):
|
|
return self.host + ":" + str(self.port)
|
|
|
|
def __get_server_controls(self):
|
|
"""Create the proxy user server control. The control has the form
|
|
0x04 = Octet String
|
|
4|0x80 sets the length of the string length field at 4 bytes
|
|
the struct() gets us the length in bytes of string self.proxydn
|
|
self.proxydn is the proxy dn to send"""
|
|
|
|
if self.proxydn is not None:
|
|
proxydn = chr(0x04) + chr(4|0x80) + struct.pack('l', socket.htonl(len(self.proxydn))) + self.proxydn;
|
|
|
|
# Create the proxy control
|
|
sctrl=[]
|
|
sctrl.append(LDAPControl('2.16.840.1.113730.3.4.18',True,proxydn))
|
|
else:
|
|
sctrl=None
|
|
|
|
return sctrl
|
|
|
|
def __handle_errors(self, e, **kw):
|
|
"""
|
|
Centralize error handling in one place.
|
|
|
|
e is the error to be raised
|
|
**kw is an exception-specific list of options
|
|
"""
|
|
if not isinstance(e,ldap.TIMEOUT):
|
|
desc = e.args[0]['desc'].strip()
|
|
info = e.args[0].get('info','').strip()
|
|
arg_desc = kw.get('arg_desc')
|
|
if arg_desc is not None:
|
|
info += " arguments: %s" % arg_desc
|
|
else:
|
|
desc = ''
|
|
info = ''
|
|
|
|
try:
|
|
# re-raise the error so we can handle it
|
|
raise e
|
|
except ldap.NO_SUCH_OBJECT, e:
|
|
arg_desc = kw.get('arg_desc', "entry not found")
|
|
raise errors.NotFound(reason=arg_desc)
|
|
except ldap.ALREADY_EXISTS, e:
|
|
raise errors.DuplicateEntry()
|
|
except ldap.CONSTRAINT_VIOLATION, e:
|
|
# This error gets thrown by the uniqueness plugin
|
|
if info.startswith('Another entry with the same attribute value already exists'):
|
|
raise errors.DuplicateEntry()
|
|
else:
|
|
raise errors.DatabaseError(desc=desc,info=info)
|
|
except ldap.INSUFFICIENT_ACCESS, e:
|
|
raise errors.ACIError(info=info)
|
|
except ldap.NO_SUCH_ATTRIBUTE:
|
|
# this is raised when a 'delete' attribute isn't found.
|
|
# it indicates the previous attribute was removed by another
|
|
# update, making the oldentry stale.
|
|
raise errors.MidairCollision()
|
|
except ldap.ADMINLIMIT_EXCEEDED, e:
|
|
raise errors.LimitsExceeded()
|
|
except ldap.SIZELIMIT_EXCEEDED, e:
|
|
raise errors.LimitsExceeded()
|
|
except ldap.TIMELIMIT_EXCEEDED, e:
|
|
raise errors.LimitsExceeded()
|
|
except ldap.LDAPError, e:
|
|
raise errors.DatabaseError(desc=desc,info=info)
|
|
|
|
def __wait_for_connection(self, timeout):
|
|
lurl = ldapurl.LDAPUrl(self.uri)
|
|
if lurl.urlscheme == 'ldapi':
|
|
wait_for_open_socket(lurl.hostport, timeout)
|
|
else:
|
|
(host,port) = lurl.hostport.split(':')
|
|
wait_for_open_ports(host, int(port), timeout)
|
|
|
|
def __bind_with_wait(self, bind_func, timeout, *args, **kwargs):
|
|
try:
|
|
bind_func(*args, **kwargs)
|
|
except (ldap.CONNECT_ERROR, ldap.SERVER_DOWN), e:
|
|
if not timeout or 'TLS' in e.args[0].get('info', ''):
|
|
# No connection to continue on if we have a TLS failure
|
|
# https://bugzilla.redhat.com/show_bug.cgi?id=784989
|
|
raise e
|
|
try:
|
|
self.__wait_for_connection(timeout)
|
|
except:
|
|
raise e
|
|
bind_func(*args, **kwargs)
|
|
|
|
def do_simple_bind(self, binddn=DN(('cn', 'directory manager')), bindpw="", timeout=DEFAULT_TIMEOUT):
|
|
self.binddn = binddn # FIXME, self.binddn & self.bindpwd never referenced.
|
|
self.bindpwd = bindpw
|
|
self.__bind_with_wait(self.simple_bind_s, timeout, binddn, bindpw)
|
|
self.__lateinit()
|
|
|
|
def do_sasl_gssapi_bind(self, timeout=DEFAULT_TIMEOUT):
|
|
self.__bind_with_wait(self.sasl_interactive_bind_s, timeout, None, SASL_AUTH)
|
|
self.__lateinit()
|
|
|
|
def do_external_bind(self, user_name=None, timeout=DEFAULT_TIMEOUT):
|
|
auth_tokens = ldap.sasl.external(user_name)
|
|
self.__bind_with_wait(self.sasl_interactive_bind_s, timeout, None, auth_tokens)
|
|
self.__lateinit()
|
|
|
|
def getEntry(self, base, scope, filterstr='(objectClass=*)', attrlist=None, attrsonly=0):
|
|
"""This wraps the search function. It is common to just get one entry"""
|
|
|
|
sctrl = self.__get_server_controls()
|
|
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
|
|
try:
|
|
res = self.search(base, scope, filterstr, attrlist, attrsonly)
|
|
objtype, obj = self.result(res)
|
|
except ldap.LDAPError, e:
|
|
arg_desc = 'base="%s", scope=%s, filterstr="%s"' % (base, scope, filterstr)
|
|
self.__handle_errors(e, arg_desc=arg_desc)
|
|
|
|
if not obj:
|
|
arg_desc = 'base="%s", scope=%s, filterstr="%s"' % (base, scope, filterstr)
|
|
raise errors.NotFound(reason=arg_desc)
|
|
|
|
elif isinstance(obj,Entry):
|
|
return obj
|
|
else: # assume list/tuple
|
|
return obj[0]
|
|
|
|
def getList(self, base, scope, filterstr='(objectClass=*)', attrlist=None, attrsonly=0):
|
|
"""This wraps the search function to find multiple entries."""
|
|
|
|
sctrl = self.__get_server_controls()
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
|
|
try:
|
|
res = self.search(base, scope, filterstr, attrlist, attrsonly)
|
|
objtype, obj = self.result(res)
|
|
except ldap.LDAPError, e:
|
|
arg_desc = 'base="%s", scope=%s, filterstr="%s"' % (base, scope, filterstr)
|
|
self.__handle_errors(e, arg_desc=arg_desc)
|
|
|
|
if not obj:
|
|
arg_desc = 'base="%s", scope=%s, filterstr="%s"' % (base, scope, filterstr)
|
|
raise errors.NotFound(reason=arg_desc)
|
|
|
|
entries = []
|
|
for s in obj:
|
|
entries.append(s)
|
|
|
|
return entries
|
|
|
|
def addEntry(self, entry):
|
|
"""This wraps the add function. It assumes that the entry is already
|
|
populated with all of the desired objectclasses and attributes"""
|
|
|
|
if not isinstance(entry, Entry):
|
|
raise TypeError('addEntry expected an Entry object, got %s instead' % entry.__class__)
|
|
|
|
sctrl = self.__get_server_controls()
|
|
|
|
try:
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
self.add_s(entry.dn, entry.toTupleList())
|
|
except ldap.LDAPError, e:
|
|
arg_desc = 'entry=%s: %s' % (entry.dn, entry.toTupleList())
|
|
self.__handle_errors(e, arg_desc=arg_desc)
|
|
return True
|
|
|
|
def updateEntry(self,dn,oldentry,newentry):
|
|
"""This wraps the mod function. It assumes that the entry is already
|
|
populated with all of the desired objectclasses and attributes"""
|
|
|
|
assert isinstance(dn, DN)
|
|
sctrl = self.__get_server_controls()
|
|
|
|
modlist = self.generateModList(oldentry, newentry)
|
|
|
|
if len(modlist) == 0:
|
|
raise errors.EmptyModlist
|
|
|
|
try:
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
self.modify_s(dn, modlist)
|
|
except ldap.LDAPError, e:
|
|
self.__handle_errors(e)
|
|
return True
|
|
|
|
def generateModList(self, old_entry, new_entry):
|
|
"""A mod list generator that computes more precise modification lists
|
|
than the python-ldap version. For single-value attributes always
|
|
use a REPLACE operation, otherwise use ADD/DEL.
|
|
"""
|
|
|
|
# Some attributes, like those in cn=config, need to be replaced
|
|
# not deleted/added.
|
|
FORCE_REPLACE_ON_UPDATE_ATTRS = ('nsslapd-ssl-check-hostname', 'nsslapd-lookthroughlimit', 'nsslapd-idlistscanlimit', 'nsslapd-anonlimitsdn', 'nsslapd-minssf-exclude-rootdse')
|
|
modlist = []
|
|
|
|
old_entry = ipautil.CIDict(old_entry)
|
|
new_entry = ipautil.CIDict(new_entry)
|
|
|
|
keys = set(map(string.lower, old_entry.keys()))
|
|
keys.update(map(string.lower, new_entry.keys()))
|
|
|
|
for key in keys:
|
|
new_values = new_entry.get(key, [])
|
|
if not(isinstance(new_values,list) or isinstance(new_values,tuple)):
|
|
new_values = [new_values]
|
|
new_values = filter(lambda value:value!=None, new_values)
|
|
|
|
old_values = old_entry.get(key, [])
|
|
if not(isinstance(old_values,list) or isinstance(old_values,tuple)):
|
|
old_values = [old_values]
|
|
old_values = filter(lambda value:value!=None, old_values)
|
|
|
|
# We used to convert to sets and use difference to calculate
|
|
# the changes but this did not preserve order which is important
|
|
# particularly for schema
|
|
adds = [x for x in new_values if x not in old_values]
|
|
removes = [x for x in old_values if x not in new_values]
|
|
|
|
if len(adds) == 0 and len(removes) == 0:
|
|
continue
|
|
|
|
is_single_value = self.get_single_value(key)
|
|
force_replace = False
|
|
if key in FORCE_REPLACE_ON_UPDATE_ATTRS or is_single_value:
|
|
force_replace = True
|
|
|
|
# You can't remove schema online. An add will automatically
|
|
# replace any existing schema.
|
|
if old_entry.get('dn', DN()) == DN(('cn', 'schema')):
|
|
if len(adds) > 0:
|
|
modlist.append((ldap.MOD_ADD, key, adds))
|
|
else:
|
|
if adds:
|
|
if force_replace:
|
|
modlist.append((ldap.MOD_REPLACE, key, adds))
|
|
else:
|
|
modlist.append((ldap.MOD_ADD, key, adds))
|
|
if removes:
|
|
if not force_replace:
|
|
modlist.append((ldap.MOD_DELETE, key, removes))
|
|
|
|
return modlist
|
|
|
|
def inactivateEntry(self,dn, has_key):
|
|
"""Rather than deleting entries we mark them as inactive.
|
|
has_key defines whether the entry already has nsAccountlock
|
|
set so we can determine which type of mod operation to run."""
|
|
|
|
assert isinstance(dn, DN)
|
|
sctrl = self.__get_server_controls()
|
|
modlist=[]
|
|
|
|
if has_key:
|
|
operation = ldap.MOD_REPLACE
|
|
else:
|
|
operation = ldap.MOD_ADD
|
|
|
|
modlist.append((operation, "nsAccountlock", "TRUE"))
|
|
|
|
try:
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
self.modify_s(dn, modlist)
|
|
except ldap.LDAPError, e:
|
|
self.__handle_errors(e)
|
|
return True
|
|
|
|
def deleteEntry(self, dn):
|
|
"""This wraps the delete function. Use with caution."""
|
|
|
|
assert isinstance(dn, DN)
|
|
sctrl = self.__get_server_controls()
|
|
|
|
try:
|
|
if sctrl is not None:
|
|
self.set_option(ldap.OPT_SERVER_CONTROLS, sctrl)
|
|
self.delete_s(dn)
|
|
except ldap.LDAPError, e:
|
|
arg_desc = 'dn=%s' % (dn)
|
|
self.__handle_errors(e, arg_desc=arg_desc)
|
|
return True
|
|
|
|
def waitForEntry(self, dn, timeout=7200, attr='', quiet=True):
|
|
scope = ldap.SCOPE_BASE
|
|
filter = "(objectclass=*)"
|
|
attrlist = []
|
|
if attr:
|
|
filter = "(%s=*)" % attr
|
|
attrlist.append(attr)
|
|
timeout += int(time.time())
|
|
|
|
if isinstance(dn,Entry):
|
|
dn = dn.dn
|
|
assert isinstance(dn, DN)
|
|
|
|
# wait for entry and/or attr to show up
|
|
if not quiet:
|
|
sys.stdout.write("Waiting for %s %s:%s " % (self,dn,attr))
|
|
sys.stdout.flush()
|
|
entry = None
|
|
while not entry and int(time.time()) < timeout:
|
|
try:
|
|
entry = self.getEntry(dn, scope, filter, attrlist)
|
|
except ldap.NO_SUCH_OBJECT:
|
|
pass # no entry yet
|
|
except ldap.LDAPError, e: # badness
|
|
print "\nError reading entry", dn, e
|
|
break
|
|
if not entry:
|
|
if not quiet:
|
|
sys.stdout.write(".")
|
|
sys.stdout.flush()
|
|
time.sleep(1)
|
|
|
|
if not entry and int(time.time()) > timeout:
|
|
print "\nwaitForEntry timeout for %s for %s" % (self,dn)
|
|
elif entry and not quiet:
|
|
print "\nThe waited for entry is:", entry
|
|
elif not entry:
|
|
print "\nError: could not read entry %s from %s" % (dn,self)
|
|
|
|
return entry
|
|
|
|
def checkTask(self, dn, dowait=False, verbose=False):
|
|
"""check task status - task is complete when the nsTaskExitCode attr
|
|
is set return a 2 tuple (true/false,code) first is false if task is
|
|
running, true if done - if true, second is the exit code - if dowait
|
|
is True, this function will block until the task is complete
|
|
"""
|
|
assert isinstance(dn, DN)
|
|
attrlist = ['nsTaskLog', 'nsTaskStatus', 'nsTaskExitCode', 'nsTaskCurrentItem', 'nsTaskTotalItems']
|
|
done = False
|
|
exitCode = 0
|
|
while not done:
|
|
try:
|
|
entry = self.getEntry(dn, ldap.SCOPE_BASE, "(objectclass=*)", attrlist)
|
|
except errors.NotFound:
|
|
break
|
|
if verbose:
|
|
print entry
|
|
if entry.getValue('nsTaskExitCode'):
|
|
exitCode = int(entry.getValue('nsTaskExitCode'))
|
|
done = True
|
|
if dowait: time.sleep(1)
|
|
else: break
|
|
return (done, exitCode)
|
|
|
|
def get_single_value(self, attr):
|
|
"""
|
|
Check the schema to see if the attribute is single-valued.
|
|
|
|
If the attribute is in the schema then returns True/False
|
|
|
|
If there is a problem loading the schema or the attribute is
|
|
not in the schema return None
|
|
"""
|
|
obj = self.schema.get_obj(ldap.schema.AttributeType, attr)
|
|
return obj and obj.single_value
|
|
|
|
def get_dns_sorted_by_length(self, entries, reverse=False):
|
|
"""
|
|
Sorts a list of entries [(dn, entry_attrs)] based on their DN.
|
|
Entries within the same node are not sorted in any meaningful way.
|
|
If Reverse is set to True, leaf entries are returned first. This is
|
|
useful to perform recursive deletes where you need to delete entries
|
|
starting from the leafs and go up to delete nodes only when all its
|
|
leafs are removed.
|
|
|
|
Returns a list of list of dn's. Every dn in the dn list has
|
|
the same number of RDN's. The outer list is sorted according
|
|
to the number of RDN's in each inner list.
|
|
|
|
Example:
|
|
|
|
[['cn=bob', cn=tom], ['cn=bob,ou=people', cn=tom,ou=people]]
|
|
|
|
dn's in list[0] have 1 RDN
|
|
dn's in list[1] have 2 RDN's
|
|
"""
|
|
|
|
res = dict()
|
|
|
|
for e in entries:
|
|
dn = e.dn
|
|
assert isinstance(dn, DN)
|
|
rdn_count = len(dn)
|
|
rdn_count_list = res.setdefault(rdn_count, [])
|
|
if dn not in rdn_count_list:
|
|
rdn_count_list.append(dn)
|
|
|
|
keys = res.keys()
|
|
keys.sort(reverse=reverse)
|
|
|
|
return map(res.get, keys)
|