Updated docs
[mirror/userdir-ldap.git] / ud-info
1 #!/usr/bin/env python
2 # -*- mode: python -*-
3 # This script is an interactive way to manipulate fields in the LDAP directory.
4 # When run it connects to the directory using the current users ID and fetches
5 # all the attributes for that user. It then formats them nicely and allows
6 # the user to change them.
7 # It is possible to authenticate as someone differnt than you are viewing/changing
8 # this allows administrative functions and also allows users to view 
9 # restricted information about others, such as phone numbers and addresses.
10 #
11 #  Usage: userinfo -a <user> -u <user> -c <user> -r
12 #    -a    Set the authentication user (the user whose password you are 
13 #          going to enter)
14 #    -u    Set the user to display
15 #    -c    Set both -a and -u, use this if your login uid is not in the 
16 #          database
17 #    -r    Enable 'root' functions, do this if your uid has access to
18 #          restricted variables.
19 #
20 # http://www.geocode.com/eagle.html-ssi
21
22 import string, time, posix, pwd, sys, getopt, ldap, crypt, whrandom, readline, copy;
23 from userdir_ldap import *;
24
25 RootMode = 0;
26 AttrInfo = {"cn": ["First Name", 101],
27             "mn": ["Middle Name", 102],
28             "sn": ["Surname", 103],
29             "c": ["Country Code",1],
30             "l": ["Locality",2],
31             "ou": ["Membership",0],
32             "facsimiletelephonenumber": ["Fax Phone Number",3],
33             "telephonenumber": ["Phone Number",4],
34             "postaladdress": ["Mailing Address",5],
35             "postalcode": ["Postal Code",6],
36             "uid": ["Unix User ID",0],
37             "loginshell": ["Unix Shell",7],
38             "supplementarygid": ["Unix Groups",0],
39             "allowedhosts": ["Host ACL",0],
40             "member": ["LDAP Group",0],
41             "emailforward": ["Email Forwarding",8],
42             "ircnick": ["IRC Nickname",9],
43             "onvacation": ["Vacation Message",10],
44             "labeledurl": ["Home Page",11],
45             "latitude": ["Latitude",12],
46             "longitude": ["Longitude",13],
47             "comment": ["Comment",114],
48             "userpassword": ["Crypted Password",115]};
49
50 AttrPrompt = {"cn": ["Common name or first name"],
51               "mn": ["Middle name (or initial if it ends in a dot)"],
52               "sn": ["Surname or last name"],
53               "c": ["ISO 2 letter country code, such as US, DE, etc"],
54               "l": ["City name, State/Provice (Locality)\n e.g. Dallas, Texas"],
55               "facsimiletelephonenumber": ["Fax phone number, with area code and country code"],
56               "telephonenumber": ["Voice phone number"],
57               "postaladdress": ["Complete mailing address including postal codes and country designations\nSeperate lines using a $ character"],
58               "postalcode": ["Postal Code or Zip Code"],
59               "loginshell": ["Login shell with full path (no check is done for validity)"],
60               "emailforward": ["EMail address to send all mail to or blank to disable"],
61               "ircnick": ["IRC nickname if you use IRC"],
62               "onvacation": ["A message if on vaction, indicating the time of departure and return"],
63               "userpassword": ["The users Crypt'd password"],
64               "comment": ["Admin Comment about the account"],
65               "supplementarygid": ["Groups the user is in"],
66               "allowedhosts": ["Grant access to certain hosts"],
67               "member": ["LDAP Group Member for slapd ACLs"],
68               "latitude": ["XEarth latitude in ISO 6709 format - see /usr/share/zoneinfo/zone.tab or etak.com"],
69               "longitude": ["XEarth latitude in ISO 6709 format - see /usr/share/zoneinfo/zone.tab or etak.com"],
70               "labeledurl": ["Web home page"]};
71
72 # Create a map of IDs to desc,value,attr
73 OrderedIndex = {};
74 for at in AttrInfo.keys():
75    if (AttrInfo[at][1] != 0):
76       OrderedIndex[AttrInfo[at][1]] = [AttrInfo[at][0], "", at];
77 OrigOrderedIndex = copy.deepcopy(OrderedIndex);
78
79 # Show shadow information
80 def PrintShadow(Attrs):
81    Changed = int(GetAttr(Attrs,"shadowlastchange","0"));
82    MinDays = int(GetAttr(Attrs,"shadowmin","0"));
83    MaxDays = int(GetAttr(Attrs,"shadowmax","0"));
84    WarnDays = int(GetAttr(Attrs,"shadowwarning","0"));
85    InactDays = int(GetAttr(Attrs,"shadowinactive","0"));
86    Expire = int(GetAttr(Attrs,"shadowexpire","0"));
87
88    print "%-24s:" % ("Password last changed"),
89    print time.strftime("%a %d/%m/%Y %Z",time.localtime(Changed*24*60*60));
90    if (Expire > 0):
91       print "%-24s:" % ("Account expires on"),
92       print time.strftime("%a %d/%m/%Y %Z",time.localtime(Expire*24*60*60));
93    if (InactDays >= 0 and MaxDays < 99999):
94       print "Account aging is active, you must change your password every", MaxDays, "days."
95
96 # Print out the automatic time stamp information
97 def PrintModTime(Attrs):
98    Stamp = GetAttr(Attrs,"modifytimestamp","");
99    if len(Stamp) >= 13:
100       Time = (int(Stamp[0:4]),int(Stamp[4:6]),int(Stamp[6:8]),
101               int(Stamp[8:10]),int(Stamp[10:12]),int(Stamp[12:14]),0,0,-1);
102       print "%-24s:" % ("Record last modified on"), time.strftime("%a %d/%m/%Y %X UTC",Time),
103       print "by",ldap.explode_dn(GetAttr(Attrs,"modifiersname"),1)[0];
104
105    Stamp = GetAttr(Attrs,"createtimestamp","");
106    if len(Stamp) >= 13:
107       Time = (int(Stamp[0:4]),int(Stamp[4:6]),int(Stamp[6:8]),
108               int(Stamp[8:10]),int(Stamp[10:12]),int(Stamp[12:14]),0,0,-1);
109       print "%-24s:" % ("Record created on"), time.strftime("%a %d/%m/%Y %X UTC",Time);
110
111 # Print the PGP key for a user
112 def PrintKeys(Attrs):
113    if Attrs[1].has_key("keyfingerprint") == 0:
114       return;
115    First = 0;
116    for x in Attrs[1]["keyfingerprint"]:
117       if First == 0:
118          print "%-24s:" % ("PGP/GPG Key Fingerprints"),
119          First = 1;
120       else:
121          print "%-24s:" % (""),
122
123       # PGP Print
124       if (len(x) == 32):
125          I = 0;
126          while (I < len(x)):
127             print x[I]+x[I+1],
128             I = I + 2;
129             if I == 32/2:
130                print "",
131       elif (len(x) == 40):
132          # GPG Print
133          I = 0;
134          while (I < len(x)):
135             print x[I]+x[I+1]+x[I+2]+x[I+3],
136             I = I + 4;
137             if I == 40/2:
138                print "",
139       else:
140          print x,
141       print;
142
143 # Print the SSH RSA Authentication keys for a user
144 def PrintSshRSAKeys(Attrs):
145    if Attrs[1].has_key("sshrsaauthkey") == 0:
146       return;
147    First = 0;
148    for x in Attrs[1]["sshrsaauthkey"]:
149       if First == 0:
150          print "%-24s:" % ("SSH RSA Auth Keys"),
151          First = 1;
152       else:
153          print "%-24s:" % (""),
154       Split = string.split(x," ");
155       
156       if len(Split) != 4:
157          del Split[0];
158       print Split[0],Split[1],Split[2][:8]+".."+Split[2][-8:],string.join(Split[3:]);
159       
160 # Display all of the attributes in a numbered list
161 def ShowAttrs(Attrs):
162    print;
163    print EmailAddress(Attrs);   
164    PrintModTime(Attrs);
165    PrintShadow(Attrs);
166    PrintKeys(Attrs);
167    PrintSshRSAKeys(Attrs);
168
169    for at in Attrs[1].keys():
170       if AttrInfo.has_key(at):
171          if AttrInfo[at][1] == 0:
172             print "      %-18s:" % (AttrInfo[at][0]),
173             for x in Attrs[1][at]:
174                print "'%s'" % (x),
175             if at == "uid":
176                print "(id=%s, gid=%s)" % (GetAttr(Attrs,"uidnumber","-1"),GetAttr(Attrs,"gidnumber","-1")),
177             print;
178          else:
179             OrderedIndex[AttrInfo[at][1]][1] = Attrs[1][at];
180                                        
181    Keys = OrderedIndex.keys();
182    Keys.sort();
183    for at in Keys:
184       if at < 100 or RootMode != 0:
185          print " %3u) %-18s: " % (at,OrderedIndex[at][0]),
186          for x in OrderedIndex[at][1]:
187             print "'%s'" % (re.sub('[\n\r]','?',x)),
188          print;
189
190 # Change a single attribute
191 def ChangeAttr(Attrs,Attr):
192    if (Attr == "supplementarygid" or Attr == "allowedhosts" or Attr == "member"):
193       return MultiChangeAttr(Attrs,Attr);
194
195    print "Old value: '%s'" % (GetAttr(Attrs,Attr,""));
196    print "Press enter to leave unchanged and a single space to set to empty";
197    NewValue = raw_input("New? ");
198   
199    # Empty string
200    if (NewValue == ""):
201       print "Leaving unchanged.";
202       return;
203
204    # Single space designates delete, trap the delete error
205    if (NewValue == " "):
206       print "Deleting.",;
207       try:
208          l.modify_s(UserDn,[(ldap.MOD_DELETE,Attr,None)]);
209       except ldap.NO_SUCH_ATTRIBUTE:
210          pass;
211
212       print;
213       Attrs[1][Attr] = [""];
214       return;
215
216    # Set a new value
217    print "Setting.",;
218    l.modify_s(UserDn,[(ldap.MOD_REPLACE,Attr,NewValue)]);
219    Attrs[1][Attr] = [NewValue];
220    print;
221
222 def MultiChangeAttr(Attrs,Attr):
223    # Make sure that we have an entry
224    if not Attrs[1].has_key(Attr):
225       Attrs[1][Attr] = [];
226
227    Attrs[1][Attr].sort();
228    print "Old values: ",Attrs[1][Attr];
229
230    Mode = string.upper(raw_input("[D]elete or [A]dd? "));
231    if (Mode != 'D' and Mode != 'A'):
232       return;
233
234    NewValue = raw_input("Value? ");
235    # Empty string
236    if (NewValue == ""):
237       print "Leaving unchanged.";
238       return;
239    
240    # Delete   
241    if (Mode == "D"):
242       print "Deleting.",;
243       try:
244          l.modify_s(UserDn,[(ldap.MOD_DELETE,Attr,NewValue)]);
245       except ldap.NO_SUCH_ATTRIBUTE:
246          print "Failed";
247
248       print;
249       Attrs[1][Attr].remove(NewValue);
250       return;
251
252    # Set a new value
253    print "Setting.",;
254    l.modify_s(UserDn,[(ldap.MOD_ADD,Attr,NewValue)]);
255    Attrs[1][Attr].append(NewValue);
256    print;
257
258 # Main program starts here
259 User = pwd.getpwuid(posix.getuid())[0];
260 BindUser = User;
261 # Process options
262 (options, arguments) = getopt.getopt(sys.argv[1:], "nu:c:a:r")
263 for (switch, val) in options:
264    if (switch == '-u'):
265       User = val;
266    elif (switch == '-a'):
267       BindUser = val;
268    elif (switch == '-c'):
269       BindUser = val;
270       User = val;
271    elif (switch == '-r'):
272       RootMode = 1;
273    elif (switch == '-n'):
274       BindUser = "";
275
276 if (BindUser != ""):
277    print "Accessing LDAP entry for '" + User + "'",
278 if (BindUser != User):
279    if (BindUser != ""):
280       print "as '" + BindUser + "'";
281 else:
282    print;
283 if (BindUser != ""):
284    Password = getpass(BindUser + "'s password: ");
285
286 # Connect to the ldap server
287 l = ldap.open(LDAPServer);
288 UserDn = "uid=" + BindUser + "," + BaseDn;
289 if (BindUser != ""):
290    l.simple_bind_s(UserDn,Password);
291 else:
292    l.simple_bind_s("","");
293 UserDn = "uid=" + User + "," + BaseDn;
294
295 # Enable changing of supplementary gid's
296 if (RootMode == 1):
297    # Items that root can edit
298    list = ["supplementarygid","allowedhosts","member"];
299    Count = 0;
300    for x in list:
301       AttrInfo[x][1] = 200 + Count;
302       OrderedIndex[AttrInfo[x][1]] = [AttrInfo[x][0], "",x];
303       OrigOrderedIndex[AttrInfo[x][1]] = [AttrInfo[x][0], "",x];
304       Count = Count + 1;
305
306 # Query the server for all of the attributes
307 Attrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"uid=" + User);
308 if len(Attrs) == 0:
309    print "User",User,"was not found.";
310    sys.exit(0); 
311
312 # repeatedly show the account configuration
313 while(1):
314    ShowAttrs(Attrs[0]);
315    if (BindUser == ""):
316       sys.exit(0);
317
318    if RootMode == 1:
319       print "   a) Arbitary Change";
320    print "   p) Change Password";
321    print "   u) Switch Users";
322    print "   x) Exit";
323    
324    # Prompt
325    Response = raw_input("Change? ");
326    if (Response == "x" or Response == "X" or Response == "q" or 
327        Response == "quit" or Response == "exit"):
328       break;
329
330    # Change who we are looking at
331    if (Response == 'u' or Response == 'U'):
332       NewUser = raw_input("User? ");
333       if NewUser == "":
334          continue;
335       NAttrs = l.search_s(BaseDn,ldap.SCOPE_ONELEVEL,"uid=" + NewUser);
336       if len(NAttrs) == 0:
337          print "User",NewUser,"was not found.";
338          continue;
339       Attrs = NAttrs;
340       User = NewUser;
341       UserDn = "uid=" + User + "," + BaseDn;
342       OrderedIndex = copy.deepcopy(OrigOrderedIndex);
343       continue;
344
345    # Handle changing the password
346    if (Response == "p"):
347       print "Please enter a new password. Your password can be of unlimited length,";
348       print "contain spaces and other special characters. No checking is done on the";
349       print "strength of the passwords so pick good ones please!";
350
351       Pass1 = getpass(User + "'s new password: ");
352       Pass2 = getpass(User + "'s new password again: ");
353       if Pass1 != Pass2:
354          print "Passwords did not match";
355          raw_input("Press a key");
356          continue;
357
358       # Hash it telling glibc to use the MD5 algorithm - if you dont have
359       # glibc then just change Salt = "$1$" to Salt = "";
360       SaltVals = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ/.";
361       Salt  = "$1$";
362       for x in range(0,10):
363          Salt = Salt + SaltVals[whrandom.randint(0,len(SaltVals)-1)];
364       Pass = crypt.crypt(Pass1,Salt);
365       if len(Pass) < 14:
366          print "Caution! MD5 Password hashing failed, not changing password!";
367          raw_input("Press a key");
368          continue;
369
370       print "Setting password..";
371       Pass = "{crypt}" + Pass;
372       l.modify_s(UserDn,[(ldap.MOD_REPLACE,"userpassword",Pass)]);
373       continue;
374
375    # Handle changing an arbitary value
376    if (Response == "a"):
377       Attr = raw_input("Attr? ");
378       ChangeAttr(Attrs[0],Attr);
379       continue;
380
381    # Convert the integer response
382    try:
383       ID = int(Response);
384       if (not OrderedIndex.has_key(ID) or (ID > 100 and RootMode == 0)):
385          raise ValueError;
386    except ValueError:
387       print "Invalid";
388       continue;
389
390    # Print the what to do prompt
391    print "Changing LDAP entry '%s' (%s)" % (OrderedIndex[ID][0],OrderedIndex[ID][2]);
392    print AttrPrompt[OrderedIndex[ID][2]][0];
393    ChangeAttr(Attrs[0],OrderedIndex[ID][2]);