posix -> os
[mirror/userdir-ldap.git] / userdir_ldap.py
1 # Some routines and configuration that are used by the ldap progams
2 import termios, TERMIOS, re, string, imp, ldap, sys, whrandom, crypt, rfc822;
3 import userdir_gpg
4
5 try:
6    File = open("/etc/userdir-ldap/userdir-ldap.conf");
7 except:
8    File = open("userdir-ldap.conf");
9 ConfModule = imp.load_source("userdir_config","/etc/userdir-ldap.conf",File);
10 File.close();
11
12 # Cheap hack
13 BaseDn = ConfModule.basedn;
14 BaseDn = ConfModule.basedn;
15 LDAPServer = ConfModule.ldaphost;
16 EmailAppend = ConfModule.emailappend;
17 AdminUser = ConfModule.adminuser;
18 GenerateDir = ConfModule.generatedir;
19 GenerateConf = ConfModule.generateconf;
20 DefaultGID = ConfModule.defaultgid;
21 TemplatesDir = ConfModule.templatesdir;
22 PassDir = ConfModule.passdir;
23 Ech_ErrorLog = ConfModule.ech_errorlog;
24 Ech_MainLog = ConfModule.ech_mainlog;
25
26 # Break up the keyring list
27 userdir_gpg.SetKeyrings(string.split(ConfModule.keyrings,":"));
28
29 # This is a list of common last-name prefixes
30 LastNamesPre = {"van": None, "le": None, "de": None, "di": None};
31
32 # SSH Key splitting. The result is:
33 # (options,size,modulous,exponent,comment)
34 SSHAuthSplit = re.compile('^(.* )?(\d+) (\d+) (\d+) ?(.+)$');
35 #'^([^\d](?:[^ "]+(?:".*")?)*)? ?(\d+) (\d+) (\d+) (.+)$');
36
37 AddressSplit = re.compile("(.*).*<([^@]*)@([^>]*)>");
38
39 # Safely get an attribute from a tuple representing a dn and an attribute
40 # list. It returns the first attribute if there are multi.
41 def GetAttr(DnRecord,Attribute,Default = ""):
42    try:
43       return DnRecord[1][Attribute][0];
44    except IndexError:
45       return Default;
46    except KeyError:
47       return Default;
48    return Default;
49
50 # Return a printable email address from the attributes.
51 def EmailAddress(DnRecord):
52    cn = GetAttr(DnRecord,"cn");
53    sn = GetAttr(DnRecord,"sn");
54    uid = GetAttr(DnRecord,"uid");
55    if cn == "" and sn == "":
56       return "<" + uid + "@" + EmailAppend + ">";
57    return cn + " " + sn + " <" + uid + "@" + EmailAppend + ">"
58
59 # Show a dump like ldapsearch
60 def PrettyShow(DnRecord):
61    Result = "";
62    List = DnRecord[1].keys();
63    List.sort();
64    for x in List:
65       Rec = DnRecord[1][x];
66       for i in Rec:
67          Result = Result + "%s: %s\n" % (x,i);
68    return Result[:-1];
69
70 # Function to prompt for a password 
71 def getpass(prompt = "Password: "):
72    import termios, TERMIOS, sys;
73    fd = sys.stdin.fileno();
74    old = termios.tcgetattr(fd);
75    new = termios.tcgetattr(fd);
76    new[3] = new[3] & ~TERMIOS.ECHO;          # lflags
77    try:
78       termios.tcsetattr(fd, TERMIOS.TCSADRAIN, new);
79       passwd = raw_input(prompt);
80    finally:
81       termios.tcsetattr(fd, TERMIOS.TCSADRAIN, old);
82    print;
83    return passwd;
84
85 # Split up a name into multiple components. This tries to best guess how
86 # to split up a name
87 def NameSplit(Name):
88    Words = re.split(" ",string.strip(Name));
89
90    # Insert an empty middle name
91    if (len(Words) == 2):
92       Words.insert(1,"");
93    if (len(Words) < 2):
94       Words.append("");
95
96    # Put a dot after any 1 letter words, must be an initial
97    for x in range(0,len(Words)):
98       if len(Words[x]) == 1:
99          Words[x] = Words[x] + '.';
100
101    # If a word starts with a -, ( or [ we assume it marks the start of some
102    # Non-name information and remove the remainder of the string
103    for x in range(0,len(Words)):
104       if len(Words[x]) != 0 and (Words[x][0] == '-' or \
105           Words[x][0] == '(' or Words[x][0] == '['):
106          Words = Words[0:x];
107          break;
108          
109    # Merge any of the middle initials
110    while len(Words) > 2 and len(Words[2]) == 2 and Words[2][1] == '.':
111       Words[1] = Words[1] +  Words[2];
112       del Words[2];
113
114    while len(Words) < 2:
115       Words.append('');
116    
117    # Merge any of the last name prefixes into one big last name
118    while LastNamesPre.has_key(string.lower(Words[-2])):
119       Words[-1] = Words[-2] + " " + Words[-1];
120       del Words[-2];
121
122    # Fix up a missing middle name after lastname globbing
123    if (len(Words) == 2):
124       Words.insert(1,"");
125
126    # If the name is multi-word then we glob them all into the last name and
127    # do not worry about a middle name
128    if (len(Words) > 3):
129       Words[2] = string.join(Words[1:]);
130       Words[1] = "";
131
132    return (string.strip(Words[0]),string.strip(Words[1]),string.strip(Words[2]));
133
134 # Compute a random password using /dev/urandom
135 def GenPass():   
136    # Generate a 10 character random string
137    SaltVals = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ/.";
138    Rand = open("/dev/urandom");
139    Password = "";
140    for i in range(0,10):
141       Password = Password + SaltVals[ord(Rand.read(1)[0]) % len(SaltVals)];
142    return Password;
143
144 # Compute the MD5 crypted version of the given password
145 def HashPass(Password):
146    # Hash it telling glibc to use the MD5 algorithm - if you dont have
147    # glibc then just change Salt = "$1$" to Salt = "";
148    SaltVals = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ/.";
149    Salt  = "$1$";
150    for x in range(0,10):
151       Salt = Salt + SaltVals[whrandom.randint(0,len(SaltVals)-1)];
152    Pass = crypt.crypt(Password,Salt);
153    if len(Pass) < 14:
154       raise "Password Error", "MD5 password hashing failed, not changing the password!";
155    return Pass;
156
157 # Sync with the server, we count the number of async requests that are pending
158 # and make sure result has been called that number of times
159 def FlushOutstanding(l,Outstanding,Fast=0):
160    # Sync with the remote end
161    if Fast == 0:
162       print "Waiting for",Outstanding,"requests:",
163    while (Outstanding > 0):
164       try:
165          if Fast == 0 or Outstanding > 50:
166             sys.stdout.write(".",);
167             sys.stdout.flush();
168             if (l.result(ldap.RES_ANY,1) != (None,None)):
169                Outstanding = Outstanding - 1;
170          else:
171             if (l.result(ldap.RES_ANY,1,0) != (None,None)):
172                Outstanding = Outstanding - 1;
173             else:
174                break;
175       except ldap.TYPE_OR_VALUE_EXISTS:
176          Outstanding = Outstanding - 1;
177       except ldap.NO_SUCH_ATTRIBUTE:
178          Outstanding = Outstanding - 1;
179       except ldap.NO_SUCH_OBJECT:
180          Outstanding = Outstanding - 1;
181    if Fast == 0:
182       print;
183    return Outstanding;
184
185 # Convert a lat/long attribute into Decimal degrees
186 def DecDegree(Posn,Anon=0):
187   Parts = re.match('[+-]?(\d*)\\.?(\d*)?',Posn).groups();
188   Val = string.atof(Posn);
189
190   if (abs(Val) >= 1806060.0):
191      raise ValueError,"Too Big";
192
193   # Val is in DGMS
194   if abs(Val) >= 18060.0 or len(Parts[0]) > 5:
195      Val = Val/100.0;
196      Secs = Val - long(Val);
197      Val = long(Val)/100.0;
198      Min = Val - long(Val);
199      Val = long(Val) + (Min*100.0 + Secs*100.0/60.0)/60.0;
200
201   # Val is in DGM
202   elif abs(Val) >= 180 or len(Parts[0]) > 3:
203      Val = Val/100.0;
204      Min = Val - long(Val);
205      Val = long(Val) + Min*100.0/60.0;
206      
207   if Anon != 0:
208       Str = "%3.2f"%(Val);
209   else:
210       Str = str(Val);
211   if Val >= 0:
212      return "+" + Str;
213   return Str;
214
215 def FormatSSHAuth(Str):
216    Match = SSHAuthSplit.match(Str);
217    if Match == None:
218       return "<unknown format>";
219    G = Match.groups();
220
221    # No options
222    if G[0] == None:
223       return "%s %s %s..%s %s"%(G[1],G[2],G[3][:8],G[3][-8:],G[4]);
224    return "%s %s %s %s..%s %s"%(G[0],G[1],G[2],G[3][:8],G[3][-8:],G[4]);
225
226 def FormatPGPKey(Str):
227    Res = "";
228
229    # PGP 2.x Print
230    if (len(Str) == 32):
231       I = 0;
232       while (I < len(Str)):
233          if I+2 == 32/2:
234             Res = "%s %s%s "%(Res,Str[I],Str[I+1]);
235          else:
236             Res = "%s%s%s "%(Res,Str[I],Str[I+1]);
237          I = I + 2;
238    elif (len(Str) == 40):
239       # OpenPGP Print
240       I = 0;
241       while (I < len(Str)):
242          if I+4 == 40/2:
243             Res = "%s %s%s%s%s "%(Res,Str[I],Str[I+1],Str[I+2],Str[I+3]);
244          else:
245             Res = "%s%s%s%s%s "%(Res,Str[I],Str[I+1],Str[I+2],Str[I+3]);
246          I = I + 4;
247    else:
248       Res = Str;
249    return string.strip(Res);
250
251 # Take an email address and split it into 3 parts, (Name,UID,Domain)
252 def SplitEmail(Addr):
253    Res1 = rfc822.AddrlistClass(Addr).getaddress();
254    if len(Res1) != 1:
255       return ("","",Addr);
256    Res1 = Res1[0];
257    if Res1[1] == None:
258       return (Res1[0],"","");
259
260    # If there is no @ then the address was not parsed well. Try the alternate
261    # Parsing scheme. This is particularly important when scanning PGP keys.
262    Res2 = string.split(Res1[1],"@");
263    if len(Res2) != 2:
264       Match = AddressSplit.match(Addr);
265       if Match == None:
266          return ("","",Addr);
267       return Match.groups();
268
269    return (Res1[0],Res2[0],Res2[1]);
270
271 # Convert the PGP name string to a uid value. The return is a tuple of
272 # (uid,[message strings]). UnknownMpa is a hash from email to uid that 
273 # overrides normal searching.
274 def GetUID(l,Name,UnknownMap = {}):
275    # Crack up the email address into a best guess first/middle/last name
276    (cn,mn,sn) = NameSplit(re.sub('["]','',Name[0]))
277    
278    # Brackets anger the ldap searcher
279    cn = re.sub('[(")]','?',cn);
280    sn = re.sub('[(")]','?',sn);
281
282    # First check the unknown map for the email address
283    if UnknownMap.has_key(Name[1] + '@' + Name[2]):
284       Stat = "unknown map hit for "+str(Name);
285       return (UnknownMap[Name[1] + '@' + Name[2]],[Stat]);
286
287    # Then the cruft component (ie there was no email address to match)
288    if UnknownMap.has_key(Name[2]):
289       Stat = "unknown map hit for"+str(Name);
290       return (UnknownMap[Name[2]],[Stat]);
291
292    # Search for a possible first/last name hit
293    try:
294       Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(&(cn=%s)(sn=%s))"%(cn,sn),["uid"]);
295    except ldap.FILTER_ERROR:
296       Stat = "Filter failure: (&(cn=%s)(sn=%s))"%(cn,sn);
297       return (None,[Stat]);
298
299    # Try matching on the email address
300    if (len(Attrs) != 1):
301       try:
302          Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"emailforward=%s"%(Name[2]),["uid"]);
303       except ldap.FILTER_ERROR:
304          pass;
305
306    # Hmm, more than one/no return
307    if (len(Attrs) != 1):
308       # Key claims a local address
309       if Name[2] == EmailAppend:
310
311          # Pull out the record for the claimed user
312          Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(uid=%s)"%(Name[1]),["uid","sn","cn"]);
313
314          # We require the UID surname to be someplace in the key name, this
315          # deals with special purpose keys like 'James Troup (Alternate Debian key)'
316          # Some people put their names backwards on their key too.. check that as well
317          if len(Attrs) == 1 and \
318             (string.find(string.lower(sn),string.lower(Attrs[0][1]["sn"][0])) != -1 or \
319             string.find(string.lower(cn),string.lower(Attrs[0][1]["sn"][0])) != -1):
320             Stat = EmailAppend+" hit for "+str(Name);
321             return (Name[1],[Stat]);
322
323       # Attempt to give some best guess suggestions for use in editing the
324       # override file.
325       Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"(sn~=%s)"%(sn),["uid","sn","cn"]);
326
327       Stat = [];
328       if len(Attrs) != 0:
329          Stat = ["None for %s"%(str(Name))];
330       for x in Attrs:
331          Stat.append("But might be: %s %s <%s@debian.org>"%(x[1]["cn"][0],x[1]["sn"][0],x[1]["uid"][0]));
332       return (None,Stat);        
333    else:
334       return (Attrs[0][1]["uid"][0],None);
335
336    return (None,None);
337
338