2 This API is adapted for OpenLDAP. The file contains all LDAP classes and methods
4 - Load the LDAP connection configuration file (login, address..) with LdapConfig
5 - Connect to LDAP with ldap_co
6 - Create a unique LDAP login and password for a user based on his email or last
7 name and first name with LoginPassword.
8 - Manage entries in LDAP using SFA records with LDAPapi (Search, Add, Delete,
13 from passlib.hash import ldap_salted_sha1 as lssha
15 from sfa.util.xrn import get_authority
16 from sfa.util.sfalogging import logger
17 from sfa.util.config import Config
20 import ldap.modlist as modlist
27 Ldap configuration class loads the configuration file and sets the
28 ldap IP address, password, people dn, web dn, group dn. All these settings
29 were defined in a separate file ldap_config.py to avoid sharing them in
30 the SFA git as it contains sensible information.
33 def __init__(self, config_file='/etc/sfa/ldap_config.py'):
34 """Loads configuration from file /etc/sfa/ldap_config.py and set the
35 parameters for connection to LDAP.
40 execfile(config_file, self.__dict__)
42 self.config_file = config_file
43 # path to configuration data
44 self.config_path = os.path.dirname(config_file)
46 raise IOError, "Could not find or load the configuration file: %s" \
51 """ Set admin login and server configuration variables."""
54 """Fetch LdapConfig attributes (Ldap server connection parameters and
55 defines port , version and subtree scope.
58 #Iotlab PROD LDAP parameters
60 ldap_config = LdapConfig()
61 self.config = ldap_config
62 self.ldapHost = ldap_config.LDAP_IP_ADDRESS
63 self.ldapPeopleDN = ldap_config.LDAP_PEOPLE_DN
64 self.ldapGroupDN = ldap_config.LDAP_GROUP_DN
65 self.ldapAdminDN = ldap_config.LDAP_WEB_DN
66 self.ldapAdminPassword = ldap_config.LDAP_WEB_PASSWORD
67 self.ldapPort = ldap.PORT
68 self.ldapVersion = ldap.VERSION3
69 self.ldapSearchScope = ldap.SCOPE_SUBTREE
71 def connect(self, bind=True):
72 """Enables connection to the LDAP server.
74 :param bind: Set the bind parameter to True if a bind is needed
75 (for add/modify/delete operations). Set to False otherwise.
77 :returns: dictionary with status of the connection. True if Successful,
78 False if not and in this case the error
79 message( {'bool', 'message'} ).
84 self.ldapserv = ldap.open(self.ldapHost)
85 except ldap.LDAPError, error:
86 return {'bool': False, 'message': error}
88 # Bind with authentification
98 :returns: dictionary with the bind status. True if Successful,
99 False if not and in this case the error message({'bool','message'})
104 # Opens a connection after a call to ldap.open in connect:
105 self.ldapserv = ldap.initialize("ldap://" + self.ldapHost)
107 # Bind/authenticate with a user with apropriate
108 #rights to add objects
109 self.ldapserv.simple_bind_s(self.ldapAdminDN,
110 self.ldapAdminPassword)
112 except ldap.LDAPError, error:
113 return {'bool': False, 'message': error}
115 return {'bool': True}
118 """Close the LDAP connection.
120 Can throw an exception if the unbinding fails.
122 :returns: dictionary with the bind status if the unbinding failed and
123 in this case the dict contains an error message. The dictionary keys
124 are : ({'bool','message'})
129 self.ldapserv.unbind_s()
130 except ldap.LDAPError, error:
131 return {'bool': False, 'message': error}
134 class LoginPassword():
137 Class to handle login and password generation, using custom login generation
144 Sets password and login maximum length, and defines the characters that
145 can be found in a random generated password.
148 self.login_max_length = 8
149 self.length_password = 8
150 self.chars_password = ['!', '$', '(',')', '*', '+', ',', '-', '.',
151 '0', '1', '2', '3', '4', '5', '6', '7', '8',
152 '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
153 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q',
154 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
155 '_', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h',
156 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q',
157 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
161 def clean_user_names(record):
164 Removes special characters such as '-', '_' , '[', ']' and ' ' from the
165 first name and last name.
167 :param record: user's record
169 :returns: lower_first_name and lower_last_name if they were found
170 in the user's record. Return None, none otherwise.
171 :rtype: string, string or None, None.
174 if 'first_name' in record and 'last_name' in record:
175 #Remove all special characters from first_name/last name
176 lower_first_name = record['first_name'].replace('-', '')\
177 .replace('_', '').replace('[', '')\
178 .replace(']', '').replace(' ', '')\
180 lower_last_name = record['last_name'].replace('-', '')\
181 .replace('_', '').replace('[', '')\
182 .replace(']', '').replace(' ', '')\
184 return lower_first_name, lower_last_name
189 def extract_name_from_email(record):
192 When there is no valid first name and last name in the record,
193 the email is used to generate the login. Here, we assume the email
194 is firstname.lastname@something.smthg. The first name and last names
195 are extracted from the email, special charcaters are removed and
196 they are changed into lower case.
198 :param record: user's data
200 :returns: the first name and last name taken from the user's email.
201 lower_first_name, lower_last_name.
202 :rtype: string, string
206 email = record['email']
207 email = email.split('@')[0].lower()
208 lower_first_name = None
209 lower_last_name = None
210 #Assume there is first name and last name in email
211 #if there is a separator
212 separator_list = ['.', '_', '-']
213 for sep in separator_list:
215 mail = email.split(sep)
216 lower_first_name = mail[0]
217 lower_last_name = mail[1]
220 #Otherwise just take the part before the @ as the
221 #lower_first_name and lower_last_name
222 if lower_first_name is None:
223 lower_first_name = email
224 lower_last_name = email
226 return lower_first_name, lower_last_name
228 def get_user_firstname_lastname(self, record):
231 Get the user first name and last name from the information we have in
234 :param record: user's information
236 :returns: the user's first name and last name.
238 .. seealso:: clean_user_names
239 .. seealso:: extract_name_from_email
242 lower_first_name, lower_last_name = self.clean_user_names(record)
244 #No first name and last name check email
245 if lower_first_name is None and lower_last_name is None:
247 lower_first_name, lower_last_name = \
248 self.extract_name_from_email(record)
250 return lower_first_name, lower_last_name
252 def choose_sets_chars_for_login(self, lower_first_name, lower_last_name):
255 Algorithm to select sets of characters from the first name and last
256 name, depending on the lenght of the last name and the maximum login
257 length which in our case is set to 8 characters.
259 :param lower_first_name: user's first name in lower case.
260 :param lower_last_name: usr's last name in lower case.
261 :returns: user's login
265 length_last_name = len(lower_last_name)
266 self.login_max_length = 8
268 #Try generating a unique login based on first name and last name
270 if length_last_name >= self.login_max_length:
271 login = lower_last_name[0:self.login_max_length]
273 logger.debug("login : %s index : %s" % (login, index))
274 elif length_last_name >= 4:
275 login = lower_last_name
277 logger.debug("login : %s index : %s" % (login, index))
278 elif length_last_name == 3:
279 login = lower_first_name[0:1] + lower_last_name
281 logger.debug("login : %s index : %s" % (login, index))
282 elif length_last_name == 2:
283 if len(lower_first_name) >= 2:
284 login = lower_first_name[0:2] + lower_last_name
286 logger.debug("login : %s index : %s" % (login, index))
288 logger.error("LoginException : \
289 Generation login error with \
290 minimum four characters")
293 logger.error("LDAP LdapGenerateUniqueLogin failed : \
294 impossible to generate unique login for %s %s"
295 % (lower_first_name, lower_last_name))
298 def generate_password(self):
301 Generate a password upon adding a new user in LDAP Directory
302 (8 characters length). The generated password is composed of characters
303 from the chars_password list.
305 :returns: the randomly generated password
311 length = len(self.chars_password)
312 for index in range(self.length_password):
313 char_index = random.randint(0, length - 1)
314 password += self.chars_password[char_index]
319 def encrypt_password(password):
322 Use passlib library to make a RFC2307 LDAP encrypted password salt size
323 is 8, use sha-1 algorithm.
325 :param password: password not encrypted.
326 :type password: string
327 :returns: Returns encrypted password.
331 #Keep consistency with Java Iotlab's LDAP API
332 #RFC2307SSHAPasswordEncryptor so set the salt size to 8 bytes
333 return lssha.encrypt(password, salt_size=8)
337 """Defines functions to insert and search entries in the LDAP.
339 .. note:: class supposes the unix schema is used
343 logger.setLevelDebug()
348 self.login_pwd = LoginPassword()
349 self.authname = config.SFA_REGISTRY_ROOT_AUTH
350 self.conn = ldap_co()
351 self.ldapUserQuotaNFS = self.conn.config.LDAP_USER_QUOTA_NFS
352 self.ldapUserUidNumberMin = self.conn.config.LDAP_USER_UID_NUMBER_MIN
353 self.ldapUserGidNumber = self.conn.config.LDAP_USER_GID_NUMBER
354 self.ldapUserHomePath = self.conn.config.LDAP_USER_HOME_PATH
355 self.baseDN = self.conn.ldapPeopleDN
356 self.ldapShell = '/bin/bash'
359 def LdapGenerateUniqueLogin(self, record):
362 Generate login for adding a new user in LDAP Directory
363 (four characters minimum length). Get proper last name and
364 first name so that the user's login can be generated.
366 :param record: Record must contain first_name and last_name.
368 :returns: the generated login for the user described with record if the
369 login generation is successful, None if it fails.
370 :rtype: string or None
373 #For compatibility with other ldap func
374 if 'mail' in record and 'email' not in record:
375 record['email'] = record['mail']
377 lower_first_name, lower_last_name = \
378 self.login_pwd.get_user_firstname_lastname(record)
380 index, login = self.login_pwd.choose_sets_chars_for_login(
381 lower_first_name, lower_last_name)
383 login_filter = '(uid=' + login + ')'
386 #Check if login already in use
388 while (len(self.LdapSearch(login_filter, get_attrs)) is not 0):
392 logger.error("LoginException : Generation login error \
393 with minimum four characters")
397 lower_first_name[0:index] + \
399 self.login_pwd.login_max_length
401 login_filter = '(uid=' + login + ')'
403 print "lower_first_name - lower_last_name too short"
405 logger.debug("LDAP.API \t LdapGenerateUniqueLogin login %s"
409 except ldap.LDAPError, error:
410 logger.log_exc("LDAP LdapGenerateUniqueLogin Error %s" % (error))
413 def find_max_uidNumber(self):
414 """Find the LDAP max uidNumber (POSIX uid attribute).
416 Used when adding a new user in LDAP Directory
418 :returns: max uidNumber + 1
422 #First, get all the users in the LDAP
423 get_attrs = "(uidNumber=*)"
424 login_filter = ['uidNumber']
426 result_data = self.LdapSearch(get_attrs, login_filter)
427 #It there is no user in LDAP yet, First LDAP user
428 if result_data == []:
429 max_uidnumber = self.ldapUserUidNumberMin
430 #Otherwise, get the highest uidNumber
432 uidNumberList = [int(r[1]['uidNumber'][0])for r in result_data]
433 logger.debug("LDAPapi.py \tfind_max_uidNumber \
434 uidNumberList %s " % (uidNumberList))
435 max_uidnumber = max(uidNumberList) + 1
437 return str(max_uidnumber)
440 def get_ssh_pkey(self, record):
441 """TODO ; Get ssh public key from sfa record
442 To be filled by N. Turro ? or using GID pl way?
448 #TODO Handle OR filtering in the ldap query when
449 #dealing with a list of records instead of doing a for loop in GetPersons
450 def make_ldap_filters_from_record(record=None):
451 """Helper function to make LDAP filter requests out of SFA records.
453 :param record: user's sfa record. Should contain first_name,last_name,
454 email or mail, and if the record is enabled or not. If the dict
455 record does not have all of these, must at least contain the user's
458 :returns: LDAP request
465 if 'first_name' in record and 'last_name' in record:
466 if record['first_name'] != record['last_name']:
467 req_ldapdict['cn'] = str(record['first_name'])+" "\
468 + str(record['last_name'])
469 if 'email' in record:
470 req_ldapdict['mail'] = record['email']
472 req_ldapdict['mail'] = record['mail']
473 if 'enabled' in record:
474 if record['enabled'] is True:
475 req_ldapdict['shadowExpire'] = '-1'
477 req_ldapdict['shadowExpire'] = '0'
479 #Hrn should not be part of the filter because the hrn
480 #presented by a certificate of a SFA user not imported in
481 #Iotlab does not include the iotlab login in it
482 #Plus, the SFA user may already have an account with iotlab
483 #using another login.
485 logger.debug("\r\n \t LDAP.PY make_ldap_filters_from_record \
486 record %s req_ldapdict %s"
487 % (record, req_ldapdict))
489 for k in req_ldapdict:
490 req_ldap += '(' + str(k) + '=' + str(req_ldapdict[k]) + ')'
491 if len(req_ldapdict.keys()) >1 :
492 req_ldap = req_ldap[:0]+"(&"+req_ldap[0:]
494 req_ldap = req_ldap[:(size-1)] + ')' + req_ldap[(size-1):]
500 def make_ldap_attributes_from_record(self, record):
503 When adding a new user to Iotlab's LDAP, creates an attributes
504 dictionnary from the SFA record understandable by LDAP. Generates the
505 user's LDAP login.User is automatically validated (account enabled)
506 and described as a SFA USER FROM OUTSIDE IOTLAB.
508 :param record: must contain the following keys and values:
509 first_name, last_name, mail, pkey (ssh key).
511 :returns: dictionary of attributes using LDAP data structure model.
517 attrs['objectClass'] = ["top", "person", "inetOrgPerson",
518 "organizationalPerson", "posixAccount",
519 "shadowAccount", "systemQuotas",
522 attrs['uid'] = self.LdapGenerateUniqueLogin(record)
524 attrs['givenName'] = str(record['first_name']).lower().capitalize()
525 attrs['sn'] = str(record['last_name']).lower().capitalize()
526 attrs['cn'] = attrs['givenName'] + ' ' + attrs['sn']
527 attrs['gecos'] = attrs['givenName'] + ' ' + attrs['sn']
530 attrs['givenName'] = attrs['uid']
531 attrs['sn'] = attrs['uid']
532 attrs['cn'] = attrs['uid']
533 attrs['gecos'] = attrs['uid']
535 attrs['quota'] = self.ldapUserQuotaNFS
536 attrs['homeDirectory'] = self.ldapUserHomePath + attrs['uid']
537 attrs['loginShell'] = self.ldapShell
538 attrs['gidNumber'] = self.ldapUserGidNumber
539 attrs['uidNumber'] = self.find_max_uidNumber()
540 attrs['mail'] = record['mail'].lower()
542 attrs['sshPublicKey'] = record['pkey']
544 attrs['sshPublicKey'] = self.get_ssh_pkey(record)
547 #Password is automatically generated because SFA user don't go
548 #through the Iotlab website used to register new users,
549 #There is no place in SFA where users can enter such information
551 #If the user wants to set his own password , he must go to the Iotlab
553 password = self.login_pwd.generate_password()
554 attrs['userPassword'] = self.login_pwd.encrypt_password(password)
556 #Account automatically validated (no mail request to admins)
557 #Set to 0 to disable the account, -1 to enable it,
558 attrs['shadowExpire'] = '-1'
560 #Motivation field in Iotlab
561 attrs['description'] = 'SFA USER FROM OUTSIDE SENSLAB'
563 attrs['ou'] = 'SFA' #Optional: organizational unit
564 #No info about those here:
565 attrs['l'] = 'To be defined'#Optional: Locality.
566 attrs['st'] = 'To be defined' #Optional: state or province (country).
572 def LdapAddUser(self, record) :
573 """Add SFA user to LDAP if it is not in LDAP yet.
575 :param record: dictionnary with the user's data.
576 :returns: a dictionary with the status (Fail= False, Success= True)
577 and the uid of the newly added user if successful, or the error
578 message it is not. Dict has keys bool and message in case of
579 failure, and bool uid in case of success.
582 .. seealso:: make_ldap_filters_from_record
585 logger.debug(" \r\n \t LDAP LdapAddUser \r\n\r\n ================\r\n ")
586 user_ldap_attrs = self.make_ldap_attributes_from_record(record)
588 #Check if user already in LDAP wih email, first name and last name
589 filter_by = self.make_ldap_filters_from_record(user_ldap_attrs)
590 user_exist = self.LdapSearch(filter_by)
592 logger.warning(" \r\n \t LDAP LdapAddUser user %s %s \
593 already exists" % (user_ldap_attrs['sn'],
594 user_ldap_attrs['mail']))
595 return {'bool': False}
598 result = self.conn.connect()
602 # A dict to help build the "body" of the object
603 logger.debug(" \r\n \t LDAP LdapAddUser attrs %s "
606 # The dn of our new entry/object
607 dn = 'uid=' + user_ldap_attrs['uid'] + "," + self.baseDN
610 ldif = modlist.addModlist(user_ldap_attrs)
611 logger.debug("LDAPapi.py add attrs %s \r\n ldif %s"
612 % (user_ldap_attrs, ldif))
613 self.conn.ldapserv.add_s(dn, ldif)
615 logger.info("Adding user %s login %s in LDAP"
616 % (user_ldap_attrs['cn'], user_ldap_attrs['uid']))
617 except ldap.LDAPError, error:
618 logger.log_exc("LDAP Add Error %s" % error)
619 return {'bool': False, 'message': error}
622 return {'bool': True, 'uid': user_ldap_attrs['uid']}
626 def LdapDelete(self, person_dn):
627 """Deletes a person in LDAP. Uses the dn of the user.
629 :param person_dn: user's ldap dn.
630 :type person_dn: string
631 :returns: dictionary with bool True if successful, bool False
632 and the error if not.
637 result = self.conn.connect()
640 self.conn.ldapserv.delete_s(person_dn)
642 return {'bool': True}
644 except ldap.LDAPError, error:
645 logger.log_exc("LDAP Delete Error %s" % error)
646 return {'bool': False, 'message': error}
648 def LdapDeleteUser(self, record_filter):
649 """Deletes a SFA person in LDAP, based on the user's hrn.
651 :param record_filter: Filter to find the user to be deleted. Must
652 contain at least the user's email.
653 :type record_filter: dict
654 :returns: dict with bool True if successful, bool False and error
658 .. seealso:: LdapFindUser docstring for more info on record filter.
659 .. seealso:: LdapDelete for user deletion
662 #Find uid of the person
663 person = self.LdapFindUser(record_filter, [])
664 logger.debug("LDAPapi.py \t LdapDeleteUser record %s person %s"
665 % (record_filter, person))
668 dn = 'uid=' + person['uid'] + "," + self.baseDN
670 return {'bool': False}
672 result = self.LdapDelete(dn)
675 def LdapModify(self, dn, old_attributes_dict, new_attributes_dict):
676 """ Modifies a LDAP entry, replaces user's old attributes with
679 :param dn: user's absolute name in the LDAP hierarchy.
680 :param old_attributes_dict: old user's attributes. Keys must match
681 the ones used in the LDAP model.
682 :param new_attributes_dict: new user's attributes. Keys must match
683 the ones used in the LDAP model.
685 :type old_attributes_dict: dict
686 :type new_attributes_dict: dict
687 :returns: dict bool True if Successful, bool False if not.
692 ldif = modlist.modifyModlist(old_attributes_dict, new_attributes_dict)
693 # Connect and bind/authenticate
694 result = self.conn.connect()
697 self.conn.ldapserv.modify_s(dn, ldif)
699 return {'bool': True}
700 except ldap.LDAPError, error:
701 logger.log_exc("LDAP LdapModify Error %s" % error)
702 return {'bool': False}
705 def LdapModifyUser(self, user_record, new_attributes_dict):
708 Gets the record from one user based on the user sfa recordand changes
709 the attributes according to the specified new_attributes. Do not use
710 this if we need to modify the uid. Use a ModRDN operation instead
711 ( modify relative DN ).
713 :param user_record: sfa user record.
714 :param new_attributes_dict: new user attributes, keys must be the
715 same as the LDAP model.
716 :type user_record: dict
717 :type new_attributes_dict: dict
718 :returns: bool True if successful, bool False if not.
721 .. seealso:: make_ldap_filters_from_record for info on what is mandatory
723 .. seealso:: make_ldap_attributes_from_record for the LDAP objectclass.
726 if user_record is None:
727 logger.error("LDAP \t LdapModifyUser Need user record ")
728 return {'bool': False}
730 #Get all the attributes of the user_uid_login
731 #person = self.LdapFindUser(record_filter,[])
732 req_ldap = self.make_ldap_filters_from_record(user_record)
733 person_list = self.LdapSearch(req_ldap, [])
734 logger.debug("LDAPapi.py \t LdapModifyUser person_list : %s"
737 if person_list and len(person_list) > 1:
738 logger.error("LDAP \t LdapModifyUser Too many users returned")
739 return {'bool': False}
740 if person_list is None:
741 logger.error("LDAP \t LdapModifyUser User %s doesn't exist "
743 return {'bool': False}
745 # The dn of our existing entry/object
746 #One result only from ldapSearch
747 person = person_list[0][1]
748 dn = 'uid=' + person['uid'][0] + "," + self.baseDN
750 if new_attributes_dict:
752 for k in new_attributes_dict:
757 logger.debug(" LDAPapi.py \t LdapModifyUser new_attributes %s"
758 % (new_attributes_dict))
759 result = self.LdapModify(dn, old, new_attributes_dict)
762 logger.error("LDAP \t LdapModifyUser No new attributes given. ")
763 return {'bool': False}
766 def LdapMarkUserAsDeleted(self, record):
769 Sets shadowExpire to 0, disabling the user in LDAP. Calls LdapModifyUser
770 to change the shadowExpire of the user.
772 :param record: the record of the user who has to be disabled.
773 Should contain first_name,last_name, email or mail, and if the
774 record is enabled or not. If the dict record does not have all of
775 these, must at least contain the user's email.
777 :returns: {bool: True} if successful or {bool: False} if not
780 .. seealso:: LdapModifyUser, make_ldap_attributes_from_record
785 new_attrs['shadowExpire'] = '0'
786 logger.debug(" LDAPapi.py \t LdapMarkUserAsDeleted ")
787 ret = self.LdapModifyUser(record, new_attrs)
790 def LdapResetPassword(self, record):
791 """Resets password for the user whose record is the parameter and
792 changes the corresponding entry in the LDAP.
794 :param record: user's sfa record whose Ldap password must be reset.
795 Should contain first_name,last_name,
796 email or mail, and if the record is enabled or not. If the dict
797 record does not have all of these, must at least contain the user's
800 :returns: return value of LdapModifyUser. True if successful, False
803 .. seealso:: LdapModifyUser, make_ldap_attributes_from_record
806 password = self.login_pwd.generate_password()
808 attrs['userPassword'] = self.login_pwd.encrypt_password(password)
809 logger.debug("LDAP LdapResetPassword encrypt_password %s"
810 % (attrs['userPassword']))
811 result = self.LdapModifyUser(record, attrs)
815 def LdapSearch(self, req_ldap=None, expected_fields=None):
817 Used to search directly in LDAP, by using ldap filters and return
818 fields. When req_ldap is None, returns all the entries in the LDAP.
820 :param req_ldap: ldap style request, with appropriate filters,
822 :param expected_fields: Fields in the user ldap entry that has to be
823 returned. If None is provided, will return 'mail', 'givenName',
824 'sn', 'uid', 'sshPublicKey', 'shadowExpire'.
825 :type req_ldap: string
826 :type expected_fields: list
828 .. seealso:: make_ldap_filters_from_record for req_ldap format.
831 result = self.conn.connect(bind=False)
834 return_fields_list = []
835 if expected_fields is None:
836 return_fields_list = ['mail', 'givenName', 'sn', 'uid',
837 'sshPublicKey', 'shadowExpire']
839 return_fields_list = expected_fields
840 #No specifc request specified, get the whole LDAP
844 logger.debug("LDAP.PY \t LdapSearch req_ldap %s \
845 return_fields_list %s" \
846 %(req_ldap, return_fields_list))
849 msg_id = self.conn.ldapserv.search(
850 self.baseDN, ldap.SCOPE_SUBTREE,
851 req_ldap, return_fields_list)
852 #Get all the results matching the search from ldap in one
854 result_type, result_data = \
855 self.conn.ldapserv.result(msg_id, 1)
859 logger.debug("LDAP.PY \t LdapSearch result_data %s"
864 except ldap.LDAPError, error:
865 logger.log_exc("LDAP LdapSearch Error %s" % error)
869 logger.error("LDAP.PY \t Connection Failed")
872 def _process_ldap_info_for_all_users(self, result_data):
873 """Process the data of all enabled users in LDAP.
875 :param result_data: Contains information of all enabled users in LDAP
876 and is coming from LdapSearch.
877 :param result_data: list
879 .. seealso:: LdapSearch
883 logger.debug(" LDAP.py _process_ldap_info_for_all_users result_data %s "
885 for ldapentry in result_data:
886 logger.debug(" LDAP.py _process_ldap_info_for_all_users \
887 ldapentry name : %s " % (ldapentry[1]['uid'][0]))
888 tmpname = ldapentry[1]['uid'][0]
889 hrn = self.authname + "." + tmpname
891 tmpemail = ldapentry[1]['mail'][0]
892 if ldapentry[1]['mail'][0] == "unknown":
898 'pkey': ldapentry[1]['sshPublicKey'][0],
899 #'uid': ldapentry[1]['uid'][0],
902 #'email': ldapentry[1]['mail'][0],
903 'first_name': ldapentry[1]['givenName'][0],
904 'last_name': ldapentry[1]['sn'][0],
907 'authority': self.authname,
908 'peer_authority': '',
912 except KeyError, error:
913 logger.log_exc("LDAPapi.PY \t LdapFindUser EXCEPTION %s"
919 def _process_ldap_info_for_one_user(self, record, result_data):
922 Put the user's ldap data into shape. Only deals with one user
923 record and one user data from ldap.
925 :param record: user record
926 :param result_data: Raw ldap data coming from LdapSearch
927 :returns: user's data dict with 'type','pkey','uid', 'email',
928 'first_name' 'last_name''serial''authority''peer_authority'
931 :type result_data: list
935 #One entry only in the ldap data because we used a filter
936 #to find one user only
937 ldapentry = result_data[0][1]
938 logger.debug("LDAP.PY \t LdapFindUser ldapentry %s" % (ldapentry))
939 tmpname = ldapentry['uid'][0]
941 tmpemail = ldapentry['mail'][0]
942 if ldapentry['mail'][0] == "unknown":
946 peer_authority = None
949 parent_hrn = get_authority(hrn)
950 if parent_hrn != self.authname:
951 peer_authority = parent_hrn
952 #In case the user was not imported from Iotlab LDAP
953 #but from another federated site, has an account in
954 #iotlab but currently using his hrn from federated site
955 #then the login is different from the one found in its hrn
956 if tmpname != hrn.split('.')[1]:
963 'pkey': ldapentry['sshPublicKey'],
964 #'uid': ldapentry[1]['uid'][0],
967 #'email': ldapentry[1]['mail'][0],
968 'first_name': ldapentry['givenName'][0],
969 'last_name': ldapentry['sn'][0],
972 'authority': parent_hrn,
973 'peer_authority': peer_authority,
979 def LdapFindUser(self, record=None, is_user_enabled=None,
980 expected_fields=None):
983 Search a SFA user with a hrn. User should be already registered
986 :param record: sfa user's record. Should contain first_name,last_name,
987 email or mail. If no record is provided, returns all the users found
990 :param is_user_enabled: is the user's iotlab account already valid.
991 :type is_user_enabled: Boolean.
992 :returns: LDAP entries from ldap matching the filter provided. Returns
993 a single entry if one filter has been given and a list of
1000 custom_record['enabled'] = is_user_enabled
1002 custom_record.update(record)
1004 req_ldap = self.make_ldap_filters_from_record(custom_record)
1005 return_fields_list = []
1006 if expected_fields is None:
1007 return_fields_list = ['mail', 'givenName', 'sn', 'uid',
1010 return_fields_list = expected_fields
1012 result_data = self.LdapSearch(req_ldap, return_fields_list)
1013 logger.debug("LDAP.PY \t LdapFindUser result_data %s" % (result_data))
1015 if len(result_data) == 0:
1017 #Asked for a specific user
1018 if record is not None:
1019 results = self._process_ldap_info_for_one_user(record, result_data)
1022 #Asked for all users in ldap
1023 results = self._process_ldap_info_for_all_users(result_data)