appypod-rattail/bin/checkldap.py

'''This script allows to check a LDAP connection.'''
import sys
from appy.shared.ldap import LdapConnector

# ------------------------------------------------------------------------------
class LdapTester:
    '''Usage: python checkldap.py ldapUri login password base attrs filter scope

         ldapUri is, for example, "ldap://127.0.0.1:389"
         login is the login user DN, ie: "cn=gdy,o=geezteem"
         password is the password for this login
         base is the base DN where to perform the search, ie "ou=hr,o=GeezTeem"
         attrs is a comma-separated list of attrs we will retrieve in the LDAP,
               ie "uid,login"
         filter is the query filter, ie "(&(attr1=Geez*)(status=OK))"
         scope is the scope of the search, and can be:
           BASE     To search the object itself on base
           ONELEVEL To search base's immediate children
           SUBTREE  To search base and all its descendants
    '''
    def __init__(self):
        # Get params from shell args.
        if len(sys.argv) != 8:
            print(LdapTester.__doc__)
            sys.exit(0)
        s = self
        s.uri,s.login,s.password,s.base,s.attrs,s.filter,s.scope = sys.argv[1:]
        self.attrs = self.attrs.split(',')
        self.tentatives = 5
        self.timeout = 5
        self.attributes = ['cn']
        self.ssl = False

    def test(self):
        # Connect the the LDAP
        print('Connecting to... %s' % self.uri)
        connector = LdapConnector(self.uri)
        success, msg = connector.connect(self.login, self.password)
        if not success: return
        # Perform the query.
        print ('Querying %s...' % self.base)
        res = connector.search(self.base, self.scope, self.filter,
                               self.attributes)
        print('Got %d results' % len(res))

# ------------------------------------------------------------------------------
if __name__ == '__main__': LdapTester().test()
# ------------------------------------------------------------------------------