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