1 # Copyright (c) 1999-2000 Jason Gunthorpe <jgg@debian.org>
2 # Copyright (c) 2001-2003 Ryan Murray <rmurray@debian.org>
3 # Copyright (c) 2004-2005 Joey Schulze <joey@infodrom.org>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 # Some routines and configuration that are used by the ldap progams
20 import termios, re, imp, ldap, sys, crypt, rfc822;
24 File = open("/etc/userdir-ldap/userdir-ldap.conf");
26 File = open("userdir-ldap.conf");
27 ConfModule = imp.load_source("userdir_config","/etc/userdir-ldap.conf",File);
31 BaseDn = ConfModule.basedn;
32 HostBaseDn = ConfModule.hostbasedn;
33 LDAPServer = ConfModule.ldaphost;
34 EmailAppend = ConfModule.emailappend;
35 AdminUser = ConfModule.adminuser;
36 GenerateDir = ConfModule.generatedir;
37 GenerateConf = ConfModule.generateconf;
38 DefaultGID = ConfModule.defaultgid;
39 TemplatesDir = ConfModule.templatesdir;
40 PassDir = ConfModule.passdir;
41 Ech_ErrorLog = ConfModule.ech_errorlog;
42 Ech_MainLog = ConfModule.ech_mainlog;
44 # Break up the keyring list
45 userdir_gpg.SetKeyrings(ConfModule.keyrings.split(":"))
47 # This is a list of common last-name prefixes
48 LastNamesPre = {"van": None, "von": None, "le": None, "de": None, "di": None};
50 # This is a list of common groups on Debian hosts
57 # ObjectClasses for different object types
58 UserObjectClasses = ("top", "inetOrgPerson", "debianAccount", "shadowAccount", "debianDeveloper")
59 RoleObjectClasses = ("top", "debianAccount", "shadowAccount", "debianRoleAccount")
60 GroupObjectClasses = ("top", "debianGroup")
62 # SSH Key splitting. The result is:
63 # (options,size,modulous,exponent,comment)
64 SSHAuthSplit = re.compile('^(.* )?(\d+) (\d+) (\d+) ?(.+)$');
65 SSH2AuthSplit = re.compile('^(.* )?ssh-(dss|rsa) ([a-zA-Z0-9=/+]+) ?(.+)$');
66 #'^([^\d](?:[^ "]+(?:".*")?)*)? ?(\d+) (\d+) (\d+) (.+)$');
68 AddressSplit = re.compile("(.*).*<([^@]*)@([^>]*)>");
70 # Safely get an attribute from a tuple representing a dn and an attribute
71 # list. It returns the first attribute if there are multi.
72 def GetAttr(DnRecord,Attribute,Default = ""):
74 return DnRecord[1][Attribute][0];
81 # Return a printable email address from the attributes.
82 def EmailAddress(DnRecord):
83 cn = GetAttr(DnRecord,"cn");
84 sn = GetAttr(DnRecord,"sn");
85 uid = GetAttr(DnRecord,"uid");
86 if cn == "" and sn == "":
87 return "<" + uid + "@" + EmailAppend + ">";
88 return cn + " " + sn + " <" + uid + "@" + EmailAppend + ">"
90 # Show a dump like ldapsearch
91 def PrettyShow(DnRecord):
93 List = DnRecord[1].keys();
98 Result = Result + "%s: %s\n" % (x,i);
101 # Function to prompt for a password
102 def getpass(prompt = "Password: "):
104 fd = sys.stdin.fileno();
105 old = termios.tcgetattr(fd);
106 new = termios.tcgetattr(fd);
107 new[3] = new[3] & ~termios.ECHO; # lflags
109 termios.tcsetattr(fd, termios.TCSADRAIN, new);
111 passwd = raw_input(prompt);
112 except KeyboardInterrupt:
113 termios.tcsetattr(fd, termios.TCSADRAIN, old);
119 termios.tcsetattr(fd, termios.TCSADRAIN, old);
123 def passwdAccessLDAP(LDAPServer, BaseDn, AdminUser):
125 Ask for the AdminUser's password and connect to the LDAP server.
126 Returns the connection handle.
128 print "Accessing LDAP directory as '" + AdminUser + "'";
130 Password = getpass(AdminUser + "'s password: ");
132 if len(Password) == 0:
135 l = ldap.open(LDAPServer);
136 UserDn = "uid=" + AdminUser + "," + BaseDn;
138 # Connect to the ldap server
140 l.simple_bind_s(UserDn,Password);
141 except ldap.INVALID_CREDENTIALS:
146 # Split up a name into multiple components. This tries to best guess how
149 Words = re.split(" ", Name.strip())
151 # Insert an empty middle name
152 if (len(Words) == 2):
157 # Put a dot after any 1 letter words, must be an initial
158 for x in range(0,len(Words)):
159 if len(Words[x]) == 1:
160 Words[x] = Words[x] + '.';
162 # If a word starts with a -, ( or [ we assume it marks the start of some
163 # Non-name information and remove the remainder of the string
164 for x in range(0,len(Words)):
165 if len(Words[x]) != 0 and (Words[x][0] == '-' or \
166 Words[x][0] == '(' or Words[x][0] == '['):
170 # Merge any of the middle initials
171 while len(Words) > 2 and len(Words[2]) == 2 and Words[2][1] == '.':
172 Words[1] = Words[1] + Words[2];
175 while len(Words) < 2:
178 # Merge any of the last name prefixes into one big last name
179 while LastNamesPre.has_key(Words[-2].lower()):
180 Words[-1] = Words[-2] + " " + Words[-1];
183 # Fix up a missing middle name after lastname globbing
184 if (len(Words) == 2):
187 # If the name is multi-word then we glob them all into the last name and
188 # do not worry about a middle name
190 Words[2] = " ".join(Words[1:])
193 return (Words[0].strip(), Words[1].strip(), Words[2].strip());
195 # Compute a random password using /dev/urandom
197 # Generate a 10 character random string
198 SaltVals = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ/.";
199 Rand = open("/dev/urandom");
201 for i in range(0,15):
202 Password = Password + SaltVals[ord(Rand.read(1)[0]) % len(SaltVals)];
205 # Compute the MD5 crypted version of the given password
206 def HashPass(Password):
207 # Hash it telling glibc to use the MD5 algorithm - if you dont have
208 # glibc then just change Salt = "$1$" to Salt = "";
209 SaltVals = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/.";
211 Rand = open("/dev/urandom");
212 for x in range(0,10):
213 Salt = Salt + SaltVals[ord(Rand.read(1)[0]) % len(SaltVals)];
214 Pass = crypt.crypt(Password,Salt);
216 raise "Password Error", "MD5 password hashing failed, not changing the password!";
219 # Sync with the server, we count the number of async requests that are pending
220 # and make sure result has been called that number of times
221 def FlushOutstanding(l,Outstanding,Fast=0):
222 # Sync with the remote end
224 print "Waiting for",Outstanding,"requests:",
225 while (Outstanding > 0):
227 if Fast == 0 or Outstanding > 50:
228 sys.stdout.write(".",);
230 if (l.result(ldap.RES_ANY,1) != (None,None)):
231 Outstanding = Outstanding - 1;
233 if (l.result(ldap.RES_ANY,1,0) != (None,None)):
234 Outstanding = Outstanding - 1;
237 except ldap.TYPE_OR_VALUE_EXISTS:
238 Outstanding = Outstanding - 1;
239 except ldap.NO_SUCH_ATTRIBUTE:
240 Outstanding = Outstanding - 1;
241 except ldap.NO_SUCH_OBJECT:
242 Outstanding = Outstanding - 1;
247 # Convert a lat/long attribute into Decimal degrees
248 def DecDegree(Posn,Anon=0):
249 Parts = re.match('[-+]?(\d*)\\.?(\d*)',Posn).groups();
252 if (abs(Val) >= 1806060.0):
253 raise ValueError,"Too Big";
256 if abs(Val) >= 18060.0 or len(Parts[0]) > 5:
258 Secs = Val - long(Val);
259 Val = long(Val)/100.0;
260 Min = Val - long(Val);
261 Val = long(Val) + (Min*100.0 + Secs*100.0/60.0)/60.0;
264 elif abs(Val) >= 180 or len(Parts[0]) > 3:
266 Min = Val - long(Val);
267 Val = long(Val) + Min*100.0/60.0;
277 def FormatSSH2Auth(Str):
278 Match = SSH2AuthSplit.match(Str);
280 return "<unknown format>";
284 return "ssh-%s %s..%s %s"%(G[1],G[2][:8],G[2][-8:],G[3]);
285 return "%s ssh-%s %s..%s %s"%(G[0],G[1],G[2][:8],G[2][-8:],G[3]);
287 def FormatSSHAuth(Str):
288 Match = SSHAuthSplit.match(Str);
290 return FormatSSH2Auth(Str);
295 return "%s %s %s..%s %s"%(G[1],G[2],G[3][:8],G[3][-8:],G[4]);
296 return "%s %s %s %s..%s %s"%(G[0],G[1],G[2],G[3][:8],G[3][-8:],G[4]);
298 def FormatPGPKey(Str):
304 while (I < len(Str)):
306 Res = "%s %s%s "%(Res,Str[I],Str[I+1]);
308 Res = "%s%s%s "%(Res,Str[I],Str[I+1]);
310 elif (len(Str) == 40):
313 while (I < len(Str)):
315 Res = "%s %s%s%s%s "%(Res,Str[I],Str[I+1],Str[I+2],Str[I+3]);
317 Res = "%s%s%s%s%s "%(Res,Str[I],Str[I+1],Str[I+2],Str[I+3]);
323 # Take an email address and split it into 3 parts, (Name,UID,Domain)
324 def SplitEmail(Addr):
325 # Is not an email address at all
326 if Addr.find('@') == -1:
329 Res1 = rfc822.AddrlistClass(Addr).getaddress();
334 return (Res1[0],"","");
336 # If there is no @ then the address was not parsed well. Try the alternate
337 # Parsing scheme. This is particularly important when scanning PGP keys.
338 Res2 = Res1[1].split("@");
340 Match = AddressSplit.match(Addr);
343 return Match.groups();
345 return (Res1[0],Res2[0],Res2[1]);
347 # Convert the PGP name string to a uid value. The return is a tuple of
348 # (uid,[message strings]). UnknownMpa is a hash from email to uid that
349 # overrides normal searching.
350 def GetUID(l,Name,UnknownMap = {}):
351 # Crack up the email address into a best guess first/middle/last name
352 (cn,mn,sn) = NameSplit(re.sub('["]','',Name[0]))
354 # Brackets anger the ldap searcher
355 cn = re.sub('[(")]','?',cn);
356 sn = re.sub('[(")]','?',sn);
358 # First check the unknown map for the email address
359 if UnknownMap.has_key(Name[1] + '@' + Name[2]):
360 Stat = "unknown map hit for "+str(Name);
361 return (UnknownMap[Name[1] + '@' + Name[2]],[Stat]);
363 # Then the cruft component (ie there was no email address to match)
364 if UnknownMap.has_key(Name[2]):
365 Stat = "unknown map hit for"+str(Name);
366 return (UnknownMap[Name[2]],[Stat]);
368 # Then the name component (another ie there was no email address to match)
369 if UnknownMap.has_key(Name[0]):
370 Stat = "unknown map hit for"+str(Name);
371 return (UnknownMap[Name[0]],[Stat]);
373 # Search for a possible first/last name hit
375 Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(&(cn=%s)(sn=%s))"%(cn,sn),["uid"]);
376 except ldap.FILTER_ERROR:
377 Stat = "Filter failure: (&(cn=%s)(sn=%s))"%(cn,sn);
378 return (None,[Stat]);
380 # Try matching on the email address
381 if (len(Attrs) != 1):
383 Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"emailforward=%s"%(Name[2]),["uid"]);
384 except ldap.FILTER_ERROR:
387 # Hmm, more than one/no return
388 if (len(Attrs) != 1):
389 # Key claims a local address
390 if Name[2] == EmailAppend:
392 # Pull out the record for the claimed user
393 Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(uid=%s)"%(Name[1]),["uid","sn","cn"]);
395 # We require the UID surname to be someplace in the key name, this
396 # deals with special purpose keys like 'James Troup (Alternate Debian key)'
397 # Some people put their names backwards on their key too.. check that as well
398 if len(Attrs) == 1 and \
399 ( sn.lower().find(Attrs[0][1]["sn"][0].lower()) != -1 or \
400 cn.lower().find(Attrs[0][1]["sn"][0].lower()) != -1 ):
401 Stat = EmailAppend+" hit for "+str(Name);
402 return (Name[1],[Stat]);
404 # Attempt to give some best guess suggestions for use in editing the
406 Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(sn~=%s)"%(sn),["uid","sn","cn"]);
410 Stat = ["None for %s"%(str(Name))];
412 Stat.append("But might be: %s %s <%s@debian.org>"%(x[1]["cn"][0],x[1]["sn"][0],x[1]["uid"][0]));
415 return (Attrs[0][1]["uid"][0],None);
419 def Group2GID(l, name):
421 Returns the numerical id of a common group
424 for g in DebianGroups.keys():
426 return DebianGroups[g]
428 filter = "(gid=%s)" % name
429 res = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,filter,["gidNumber"]);
431 return int(GetAttr(res[0], "gidNumber"))