1"""
2Demo script for Persistent Search Control
3(see https://tools.ietf.org/html/draft-ietf-ldapext-psearch)
4
5See https://www.python-ldap.org/ for project details.
6This needs the following software:
7Python
8pyasn1
9pyasn1-modules
10python-ldap 2.4+
11"""
12
13import sys,ldap,ldapurl,getpass
14
15from ldap.controls.psearch import PersistentSearchControl,EntryChangeNotificationControl,CHANGE_TYPES_STR
16
17try:
18  ldap_url = ldapurl.LDAPUrl(sys.argv[1])
19except IndexError:
20  print('Usage: psearch.py <LDAP URL>')
21  sys.exit(1)
22
23# Set debugging level
24#ldap.set_option(ldap.OPT_DEBUG_LEVEL,255)
25ldapmodule_trace_level = 2
26ldapmodule_trace_file = sys.stderr
27
28ldap_conn = ldap.ldapobject.LDAPObject(
29  ldap_url.initializeUrl(),
30  trace_level=ldapmodule_trace_level,
31  trace_file=ldapmodule_trace_file
32)
33
34if ldap_url.cred is None:
35  print('Password for %s:' % (repr(ldap_url.who)))
36  ldap_url.cred = getpass.getpass()
37
38try:
39  ldap_conn.simple_bind_s(ldap_url.who,ldap_url.cred)
40
41except ldap.INVALID_CREDENTIALS as e:
42  print('Simple bind failed:',str(e))
43  sys.exit(1)
44
45psc = PersistentSearchControl()
46
47msg_id = ldap_conn.search_ext(
48  ldap_url.dn,
49  ldap_url.scope,
50  ldap_url.filterstr,
51  attrlist = ldap_url.attrs or ['*','+'],
52  serverctrls=[psc],
53)
54
55while True:
56  try:
57    res_type,res_data,res_msgid,_,_,_ = ldap_conn.result4(
58      msg_id,
59      all=0,
60      timeout=10.0,
61      add_ctrls=1,
62      add_intermediates=1,
63      resp_ctrl_classes={EntryChangeNotificationControl.controlType:EntryChangeNotificationControl},
64    )
65  except ldap.TIMEOUT:
66    print('Timeout waiting for results...')
67  else:
68    for dn,entry,srv_ctrls in res_data:
69      ecn_ctrls = [
70        c
71        for c in srv_ctrls
72        if c.controlType == EntryChangeNotificationControl.controlType
73      ]
74
75      if ecn_ctrls:
76        changeType,previousDN,changeNumber = ecn_ctrls[0].changeType,ecn_ctrls[0].previousDN,ecn_ctrls[0].changeNumber
77        change_type_desc = CHANGE_TYPES_STR[changeType]
78        print('changeType: %s (%d), changeNumber: %s, previousDN: %s' % (change_type_desc,changeType,changeNumber,repr(previousDN)))
79