One of those LdapWordEdit was not meant to be
[mspang/pyceo.git] / ceo / ldapi.py
1 """
2 LDAP Utilities
3
4 This module makes use of python-ldap, a Python module with bindings
5 to libldap, OpenLDAP's native C client library.
6 """
7 import ldap.modlist, os, pwd
8 from subprocess import Popen, PIPE
9
10
11 def connect_sasl(uri, mech, realm, password):
12
13     try:
14         # open the connection
15         ld = ldap.initialize(uri)
16         
17         # authenticate
18         sasl = Sasl(mech, realm, password)
19         ld.sasl_interactive_bind_s('', sasl)
20
21     except ldap.LOCAL_ERROR, e:
22         raise e
23
24     except:
25         print "Shit, something went wrong!"
26
27     return ld
28
29
30 def abslookup(ld, dn, objectclass=None):
31
32     # search for the specified dn
33     try:
34         if objectclass:
35             search_filter = '(objectclass=%s)' % escape(objectclass)
36             matches = ld.search_s(dn, ldap.SCOPE_BASE, search_filter)
37         else:
38             matches = ld.search_s(dn, ldap.SCOPE_BASE)
39     except ldap.NO_SUCH_OBJECT:
40         return None
41
42     # dn was found, but didn't match the objectclass filter
43     if len(matches) < 1:
44         return None
45
46     # return the attributes of the single successful match
47     match = matches[0]
48     match_dn, match_attributes = match
49     return match_attributes
50
51
52 def lookup(ld, rdntype, rdnval, base, objectclass=None):
53     dn = '%s=%s,%s' % (rdntype, escape(rdnval), base)
54     return abslookup(ld, dn, objectclass)
55
56
57 def search(ld, base, search_filter, params=[], scope=ldap.SCOPE_SUBTREE, attrlist=None, attrsonly=0):
58
59     real_filter = search_filter % tuple(escape(x) for x in params)
60
61     # search for entries that match the filter
62     matches = ld.search_s(base, scope, real_filter, attrlist, attrsonly)
63     return matches
64
65
66 def modify(ld, rdntype, rdnval, base, mlist):
67     dn = '%s=%s,%s' % (rdntype, escape(rdnval), base)
68     ld.modify_s(dn, mlist)
69
70
71 def modify_attrs(ld, rdntype, rdnval, base, old, attrs):
72     dn = '%s=%s,%s' % (rdntype, escape(rdnval), base)
73
74     # build list of modifications to make
75     changes = ldap.modlist.modifyModlist(old, attrs)
76
77     # apply changes
78     ld.modify_s(dn, changes)
79
80
81 def modify_diff(ld, rdntype, rdnval, base, old, new):
82     dn = '%s=%s,%s' % (rdntype, escape(rdnval), base)
83
84     # build list of modifications to make
85     changes = make_modlist(old, new)
86
87     # apply changes
88     ld.modify_s(dn, changes)
89
90
91 def escape(value):
92     """
93     Escapes special characters in a value so that it may be safely inserted
94     into an LDAP search filter.
95     """
96
97     value = str(value)
98     value = value.replace('\\', '\\5c').replace('*', '\\2a')
99     value = value.replace('(', '\\28').replace(')', '\\29')
100     value = value.replace('\x00', '\\00')
101     return value
102
103
104 def make_modlist(old, new):
105     keys = set(old.keys()).union(set(new))
106     mlist = []
107     for key in keys:
108         if key in old and not key in new:
109             mlist.append((ldap.MOD_DELETE, key, list(set(old[key]))))
110         elif key in new and not key in old:
111             mlist.append((ldap.MOD_ADD, key, list(set(new[key]))))
112         else:
113             to_add = list(set(new[key]) - set(old[key]))
114             if len(to_add) > 0:
115                 mlist.append((ldap.MOD_ADD, key, to_add))
116             to_del = list(set(old[key]) - set(new[key]))
117             if len(to_del) > 0:
118                 mlist.append((ldap.MOD_DELETE, key, to_del))
119     return mlist
120
121
122 def format_ldaperror(ex):
123     desc = ex[0].get('desc', '')
124     info = ex[0].get('info', '')
125     if desc and info:
126         return "%s: %s" % (desc, info)
127     elif desc:
128         return desc
129     else:
130         return str(ex)
131
132
133 class Sasl:
134
135     def __init__(self, mech, realm, password):
136         self.mech = mech
137         self.realm = realm
138
139         if mech == 'GSSAPI' and password is not None:
140             userid = pwd.getpwuid(os.getuid()).pw_name
141             kinit = '/usr/bin/kinit'
142             kinit_args = [ kinit, '%s@%s' % (userid, realm) ]
143             kinit = Popen(kinit_args, stdin=PIPE, stdout=PIPE, stderr=PIPE)
144             kinit.stdin.write('%s\n' % password)
145             kinit.wait()
146
147     def callback(self, id, challenge, prompt, defresult):
148         return ''