commit rspec bug fixes.
[sfa.git] / sfa / senslab / LDAPapi.py
index 381b431..63b4431 100644 (file)
@@ -1,40 +1,50 @@
 
-import string
+#import string
 import random
 from passlib.hash import ldap_salted_sha1 as lssha
 from sfa.util.xrn import Xrn,get_authority 
 import ldap
 from sfa.util.config import Config
-#from sfa.trust.gid import *
 from sfa.trust.hierarchy import Hierarchy
-#from sfa.trust.auth import *
-from sfa.trust.certificate import *
+#from sfa.trust.certificate import *
 import ldap.modlist as modlist
 from sfa.util.sfalogging import logger
-
+import os.path
 
 #API for OpenLDAP
 
+
+class ldap_config():
+    def __init__(self, config_file =  '/etc/sfa/ldap_config.py'):
+        self.load(config_file)
+
+    def load(self, config_file):
+        try:
+            execfile(config_file, self.__dict__)
+            self.config_file = config_file
+            # path to configuration data
+            self.config_path = os.path.dirname(config_file)
+        except IOError, error:
+            raise IOError, "Could not find or load the configuration file: %s" % config_file
+        
 class ldap_co:
     """ Set admin login and server configuration variables."""
+    
     def __init__(self):
-        
-        #self.login = 'cn=admin,dc=senslab,dc=info'
-        #self.passwd = 'sfa'  
-        self.server_ip = "194.199.16.161"
-
         #Senslab PROD LDAP parameters 
-        #TODO : Use config file /etc/senslab/config.properties if it is possible
-       self.ldapPort = ldap.PORT
-       self.ldapVersion  = ldap.VERSION3
-       self.ldapSearchScope = ldap.SCOPE_SUBTREE
+        LdapConfig = ldap_config()
+        self.config = LdapConfig
+        self.ldapHost = LdapConfig.LDAP_IP_ADDRESS 
+        self.ldapPeopleDN = LdapConfig.LDAP_PEOPLE_DN
+        self.ldapGroupDN = LdapConfig.LDAP_GROUP_DN
+        self.ldapAdminDN = LdapConfig.LDAP_WEB_DN
+        self.ldapAdminPassword = LdapConfig.LDAP_WEB_PASSWORD
+
 
+        self.ldapPort = ldap.PORT
+        self.ldapVersion  = ldap.VERSION3
+        self.ldapSearchScope = ldap.SCOPE_SUBTREE
 
-       self.ldapHost = "" #set ldap.OPT_HOST_NAME maybe ?
-       self.ldapPeopleDN = 'ou=People,dc=senslab,dc=info';
-       self.ldapGroupDN = 'ou=Group,dc=senslab,dc=info';
-       self.ldapAdminDN = 'uid=web,ou=Service,dc=senslab,dc=info';
-       self.ldapAdminPassword = 'XNB+1z(C'
 
     def connect(self, bind = True):
         """Enables connection to the LDAP server.
@@ -44,29 +54,28 @@ class ldap_co:
         
         """
         try:
-            self.ldapserv = ldap.open(self.server_ip)
-        except ldap.LDAPError, e:
-            return {'bool' : False, 'message' : e }
+            self.ldapserv = ldap.open(self.ldapHost)
+        except ldap.LDAPError, error:
+            return {'bool' : False, 'message' : error }
         
         # Bind with authentification
         if(bind): 
             return self.bind()
         
         else:     
-            return {'bool': True}
-    
+            return {'bool': True} 
     
     def bind(self):
         """ Binding method. """
         try:
             # Opens a connection after a call to ldap.open in connect:
-            self.ldapserv = ldap.initialize("ldap://" + self.server_ip )
+            self.ldapserv = ldap.initialize("ldap://" + self.ldapHost)
                 
             # Bind/authenticate with a user with apropriate rights to add objects
             self.ldapserv.simple_bind_s(self.ldapAdminDN, self.ldapAdminPassword)
 
-        except ldap.LDAPError, e:
-            return {'bool' : False, 'message' : e }
+        except ldap.LDAPError, error:
+            return {'bool' : False, 'message' : error }
 
         return {'bool': True}
     
@@ -74,8 +83,8 @@ class ldap_co:
         """ Close the LDAP connection """
         try:
             self.ldapserv.unbind_s()
-        except ldap.LDAPError, e:
-            return {'bool' : False, 'message' : e }
+        except ldap.LDAPError, error:
+            return {'bool' : False, 'message' : error }
             
         
 class LDAPapi :
@@ -86,8 +95,14 @@ class LDAPapi :
         config=Config()
         
         self.authname=config.SFA_REGISTRY_ROOT_AUTH
-        #self.baseDN = "ou=people,dc=senslab,dc=info"
-        self.conn =  ldap_co()  
+
+        self.conn =  ldap_co() 
+        self.ldapUserQuotaNFS = self.conn.config.LDAP_USER_QUOTA_NFS 
+        self.ldapUserUidNumberMin = self.conn.config.LDAP_USER_UID_NUMBER_MIN 
+        self.ldapUserGidNumber = self.conn.config.LDAP_USER_GID_NUMBER 
+        self.ldapUserHomePath = self.conn.config.LDAP_USER_HOME_PATH 
+        
+        self.lengthPassword = 8
         self.baseDN = self.conn.ldapPeopleDN
         #authinfo=self.senslabauth.get_auth_info(self.authname)
         
@@ -97,27 +112,12 @@ class LDAPapi :
                                 'A','B','C','D','E','F','G','H','I','J',\
                                 'K','L','M','N','O','P','Q','R','S','T',\
                                 'U','V','W','X','Y','Z','_','a','b','c',\
-                                'd','e','f','g','h','i','j','k','l','m',\
+                                'd','error','f','g','h','i','j','k','l','m',\
                                 'n','o','p','q','r','s','t','u','v','w',\
                                 'x','y','z','\'']
-        self.ldapUserQuotaNFS = '/dev/vdb:2000000:2500000:0:0'
-        self.lengthPassword = 8;
-        self.ldapUserHomePath = '/senslab/users/' 
-        self.ldapUserGidNumber = '2000'
-        self.ldapUserUidNumberMin = '2000' 
+        
         self.ldapShell = '/bin/bash'
-        #self.auth=Auth()
-        #gid=authinfo.get_gid_object()
-        #self.ldapdictlist = ['type',
-                        #'pkey',
-                        #'uid',
-                        #'serial',
-                        #'authority',
-                        #'peer_authority',
-                        #'pointer' ,
-                        #'hrn']
-          
-                        
+
     
     def generate_login(self, record):
         """Generate login for adding a new user in LDAP Directory 
@@ -141,7 +141,7 @@ class LDAPapi :
         getAttrs = ['uid']
         if length_last_name >= login_max_length :
             login = lower_last_name[0:login_max_length]
-            index = 0;
+            index = 0
             logger.debug("login : %s index : %s" %(login,index))
         elif length_last_name >= 4 :
             login = lower_last_name
@@ -167,11 +167,11 @@ class LDAPapi :
                             impossible to generate unique login for %s %s" \
                             %(lower_first_name,lower_last_name))
             
-        filter = '(uid=' + login + ')'
+        login_filter = '(uid=' + login + ')'
         
         try :
             #Check if login already in use
-            while (len(self.LdapSearch(filter, getAttrs)) is not 0 ):
+            while (len(self.LdapSearch(login_filter, getAttrs)) is not 0 ):
             
                 index += 1
                 if index >= 9:
@@ -181,15 +181,15 @@ class LDAPapi :
                     try:
                         login = lower_first_name[0:index] + \
                                     lower_last_name[0:login_max_length-index]
-                        filter = '(uid='+ login+ ')'
+                        login_filter = '(uid='+ login+ ')'
                     except KeyError:
                         print "lower_first_name - lower_last_name too short"
                         
             logger.debug("LDAP.API \t generate_login login %s" %(login))
             return login
                     
-        except  ldap.LDAPError,e :
-            logger.log_exc("LDAP generate_login Error %s" %e)
+        except  ldap.LDAPError,error :
+            logger.log_exc("LDAP generate_login Error %s" %error)
             return None
 
         
@@ -201,20 +201,21 @@ class LDAPapi :
         
         """
         password = str()
+        length = len(self.charsPassword)
         for index in range(self.lengthPassword):
-            password += self.charsPassword[random.randint(0, \
-                                            len(self.charsPassword))]
+            char_index = random.randint(0,length-1)
+            password += self.charsPassword[char_index]
 
         return password
 
     def encrypt_password(self, password):
-       """ Use passlib library to make a RFC2307 LDAP encrypted password
-       salt size = 8, use sha-1 algorithm. Returns encrypted password.
-       
-       """
-       #Keep consistency with Java Senslab's LDAP API 
-       #RFC2307SSHAPasswordEncryptor so set the salt size to 8 bytres
-       return lssha.encrypt(password,salt_size = 8)
+        """ Use passlib library to make a RFC2307 LDAP encrypted password
+        salt size = 8, use sha-1 algorithm. Returns encrypted password.
+        
+        """
+        #Keep consistency with Java Senslab's LDAP API 
+        #RFC2307SSHAPasswordEncryptor so set the salt size to 8 bytres
+        return lssha.encrypt(password,salt_size = 8)
     
 
 
@@ -227,9 +228,9 @@ class LDAPapi :
         """
         #First, get all the users in the LDAP
         getAttrs = "(uidNumber=*)"
-        filter = ['uidNumber']
+        login_filter = ['uidNumber']
 
-        result_data = self.LdapSearch(getAttrs, filter) 
+        result_data = self.LdapSearch(getAttrs, login_filter) 
         #It there is no user in LDAP yet, First LDAP user
         if result_data == []:
             max_uidnumber = self.ldapUserUidNumberMin
@@ -242,17 +243,18 @@ class LDAPapi :
             max_uidnumber = max(uidNumberList) + 1
             
         return str(max_uidnumber)
-        
-    #TODO ; Get ssh public key from sfa record   
-    #To be filled by N. Turro                
-    def get_ssh_pkey(self, record):
-        return 'A REMPLIR '
          
          
-    #TODO Handle OR filtering in the ldap query when 
-    #dealing with a list of records instead of doing a for loop in GetPersons   
-    def make_ldap_filters_from_record(self, record=None):
+    def get_ssh_pkey(self, record):
+        """TODO ; Get ssh public key from sfa record  
+        To be filled by N. Turro ? or using GID pl way?
+        
         """
+        return 'A REMPLIR '
+
+    def make_ldap_filters_from_record(self, record=None):
+        """TODO Handle OR filtering in the ldap query when 
+        dealing with a list of records instead of doing a for loop in GetPersons   
         Helper function to make LDAP filter requests out of SFA records.
         """
         req_ldapdict = {}
@@ -265,16 +267,22 @@ class LDAPapi :
             if 'mail' in record:
                 req_ldapdict['mail'] = record['mail']
                 
-            if 'hrn' in record :
-                splited_hrn = record['hrn'].split(".")
-                if splited_hrn[0] != self.authname :
-                    logger.warning(" \r\n LDAP.PY \
-                        make_ldap_filters_from_record I know nothing \
-                        about %s my authname is %s not %s" \
-                        %(record['hrn'], self.authname, splited_hrn[0]) )
+            #Hrn should not be part of the filter because the hrn 
+            #presented by a certificate of a SFA user not imported in 
+            #Senslab  does not include the senslab login in it 
+            #Plus, the SFA user may already have an account with senslab
+            #using another login.
+                
+            #if 'hrn' in record :
+                #splited_hrn = record['hrn'].split(".")
+                #if splited_hrn[0] != self.authname :
+                    #logger.warning(" \r\n LDAP.PY \
+                        #make_ldap_filters_from_record I know nothing \
+                        #about %s my authname is %s not %s" \
+                        #%(record['hrn'], self.authname, splited_hrn[0]) )
                         
-                login=splited_hrn[1]
-                req_ldapdict['uid'] = login
+                #login=splited_hrn[1]
+                #req_ldapdict['uid'] = login
             
             req_ldap=''
             logger.debug("\r\n \t LDAP.PY make_ldap_filters_from_record \
@@ -313,7 +321,7 @@ class LDAPapi :
         attrs['quota'] = self.ldapUserQuotaNFS 
         attrs['homeDirectory'] = self.ldapUserHomePath + attrs['uid']
         attrs['loginShell'] = self.ldapShell
-        attrs['gidNumber'] = '2000'    
+        attrs['gidNumber'] = self.ldapUserGidNumber
         attrs['uidNumber'] = self.find_max_uidNumber()
         attrs['mail'] = record['mail'].lower()
         
@@ -335,11 +343,11 @@ class LDAPapi :
 
         #Motivation field in Senslab
         attrs['description'] = 'SFA USER FROM OUTSIDE SENSLAB'
-        
-        attrs['ou'] = "SFA"         #Optional: organizational unit
+
+        attrs['ou'] = 'SFA'         #Optional: organizational unit
         #No info about those here:
-        attrs['l'] = 'Grenoble - TBD'#Optional: Locality. 
-        attrs['st'] = 'FRANCE - TBD' #Optional: state or province (country).
+        attrs['l'] = 'To be defined'#Optional: Locality. 
+        attrs['st'] = 'To be defined' #Optional: state or province (country).
 
         return attrs
 
@@ -381,9 +389,9 @@ class LDAPapi :
                         %(user_ldap_attrs['cn'] ,user_ldap_attrs['uid']))
                         
                         
-            except ldap.LDAPError, e:
-                logger.log_exc("LDAP Add Error %s" %e)
-                return {'bool' : False, 'message' : e }
+            except ldap.LDAPError, error:
+                logger.log_exc("LDAP Add Error %s" %error)
+                return {'bool' : False, 'message' : error }
         
             self.conn.close()
             return {'bool': True}  
@@ -403,8 +411,8 @@ class LDAPapi :
                 self.conn.close()
                 return {'bool': True}
             
-            except ldap.LDAPError, e:
-                logger.log_exc("LDAP Delete Error %s" %e)
+            except ldap.LDAPError, error:
+                logger.log_exc("LDAP Delete Error %s" %error)
                 return {'bool': False}
         
     
@@ -437,26 +445,26 @@ class LDAPapi :
                 self.conn.ldapserv.modify_s(dn,ldif)
                 self.conn.close()
                 return {'bool' : True }
-            except ldap.LDAPError, e:
-                logger.log_exc("LDAP LdapModify Error %s" %e)
+            except ldap.LDAPError, error:
+                logger.log_exc("LDAP LdapModify Error %s" %error)
                 return {'bool' : False }
     
         
-    def LdapModifyUser(self, user_uid_login, new_attributes_dict):
+    def LdapModifyUser(self, user_record, new_attributes_dict):
         """
         Gets the record from one user_uid_login based on record_filter 
         and changes the attributes according to the specified new_attributes.
         Does not use this if we need to modify the uid. Use a ModRDN 
         #operation instead ( modify relative DN )
         """
-        if user_uid_login is None:
-            logger.error("LDAP \t LdapModifyUser Need user_uid_login  ")
+        if user_record is None:
+            logger.error("LDAP \t LdapModifyUser Need user record  ")
             return {'bool': False} 
         
         #Get all the attributes of the user_uid_login 
         #person = self.LdapFindUser(record_filter,[])
-        req_ldap = "(uid=" + user_uid_login + ')'
-        person_list = self.LdapSearch(req_ldap, [], bind = True)
+        req_ldap = self.make_ldap_filters_from_record(user_record)
+        person_list = self.LdapSearch(req_ldap,[])
         logger.debug("LDAPapi.py \t LdapModifyUser person_list : %s" %(person_list))
         if person_list and len(person_list) > 1 :
             logger.error("LDAP \t LdapModifyUser Too many users returned")
@@ -470,10 +478,14 @@ class LDAPapi :
         #One result only from ldapSearch
         person = person_list[0][1]
         dn  = 'uid=' + person['uid'][0] + "," +self.baseDN  
+       
         if new_attributes_dict:
             old = {}
             for k in new_attributes_dict:
-                old[k] =  person[k]
+                if k not in person:
+                    old[k] =  ''
+                else :
+                    old[k] = person[k]
             logger.debug(" LDAPapi.py \t LdapModifyUser  new_attributes %s"\
                                 %( new_attributes_dict))  
             result = self.LdapModify(dn, old,new_attributes_dict)
@@ -492,19 +504,20 @@ class LDAPapi :
         password = self.generate_password()
         attrs = {}
         attrs['userPassword'] = self.encrypt_password(password)
-        logger.debug("LDAP LdapModifyUser Error %s" %e)
+        logger.debug("LDAP LdapResetPassword encrypt_password %s"\
+                    %(attrs['userPassword']))
         result = self.LdapModifyUser(record, attrs)
         return result
         
-
-    def LdapSearch (self, req_ldap = None, expected_fields = None, bind = False):
+        
+    def LdapSearch (self, req_ldap = None, expected_fields = None ):
         """
         Used to search directly in LDAP, by using ldap filters and
         return fields. 
         When req_ldap is None, returns all the entries in the LDAP.
-        
+      
         """
-        result = self.conn.connect(bind )
+        result = self.conn.connect(bind = False)
         if (result['bool']) :
             
             return_fields_list = []
@@ -514,7 +527,7 @@ class LDAPapi :
                 return_fields_list = expected_fields
             #No specifc request specified, gert the whole LDAP    
             if req_ldap == None:
-               req_ldap = '(cn=*)'
+                req_ldap = '(cn=*)'
                
             logger.debug("LDAP.PY \t LdapSearch  req_ldap %s \
                             return_fields_list %s" %(req_ldap,return_fields_list))
@@ -535,8 +548,8 @@ class LDAPapi :
 
                 return result_data
             
-            except  ldap.LDAPError,e :
-                logger.log_exc("LDAP LdapSearch Error %s" %e)
+            except  ldap.LDAPError,error :
+                logger.log_exc("LDAP LdapSearch Error %s" %error)
                 return []
             
             else:
@@ -602,9 +615,9 @@ class LDAPapi :
                             'pointer' : -1,
                             'hrn': hrn,
                             }
-            except KeyError,e:
+            except KeyError,error:
                 logger.log_exc("LDAPapi \t LdaFindUser KEyError %s" \
-                                %e )
+                                %error )
                 return
         else:
         #Asked for all users in ldap
@@ -639,8 +652,8 @@ class LDAPapi :
                             'pointer' : -1,
                             'hrn': hrn,
                             } ) 
-                except KeyError,e:
-                    logger.log_exc("LDAPapi.PY \t LdapFindUser EXCEPTION %s" %(e))
+                except KeyError,error:
+                    logger.log_exc("LDAPapi.PY \t LdapFindUser EXCEPTION %s" %(error))
                     return
         return results