windows-install-notes-20040624
[openafs.git] / doc / txt / winnotes / afs-changes-since-1.2.txt
1 Since 1.3.64:
2    * A second MSI based installer option is now available.
3
4    * Fixed Kerberos 5 kinit functionality in afscreds.exe to properly
5      request tickets for user/instance@REALM instead of just user@REALM
6
7    * Modify the Power Management Notify routine to wait for the Hard Dead
8      timeout period instead of a fixed 19 seconds.  With the longer timeout
9      periods Hibernation and Standby could never succeed when network 
10      connectivity is not available.
11
12    * The following fs.exe commands are now restricted to Administrator:
13      - checkservers with a non-zero timer value
14      - setcachesize
15      - newcell
16      - sysname with a new sysname list
17      - exportafs 
18      - setcell
19      - setserverprefs
20      - storebehind
21      - setcrypt
22      - cscpolicy
23      - trace
24
25      setting the default sysname for a machine should be done via the
26      registry and not via "fs sysname".
27
28    * NSIS installer adds options to install Debugging Symbols
29      and the Microsoft Loopback Adapter; the user is now also
30      given the ability to select the afscreds.exe startup options.
31
32    * Build system modified to generate symbols for FREE (aka RELEASE)
33      builds as well as CHECKED (aka DEBUG) builds
34
35    * Sites which have a volume ID of 0x20000001 assigned to their
36      root.afs volumes have been experiencing problems with accessing
37      the root.afs volume of their cell when Freelance mode has been
38      active.  This was because 0x20000001 was assigned to the fake
39      root.afs volume created by freelance.  The fake volume id is
40      now set to 0x00000001 to prevent conflicts.
41
42    * The timeout logic in the AFS Client Service has been wrong
43      for sometime.  It is based on two different assumptions.
44      First, the SMB client timeout is a fix value as was the case
45      with OS/2 Lan Manager.  This assumption is incorrect.  The
46      SMB timeout in Windows is a dynamic value computed based upon
47      a fixed minimum timeout to which is added time based upon the
48      size of the request and the performance characteristics of
49      the connection.  Second, it is the responsibility of the 
50      SMB Server to enforce the timeout requirements of the client.
51      This is untrue.  The SMB Server cannot be expected to know
52      the requirements of the client.  More importantly, if the 
53      SMB server uses the SMB client timeout as a value to restrict
54      its behavior as an RX client, the performance characteristics
55      of the local SMB session would be used to prematurely terminate
56      WAN connections with significantly different performance 
57      characteristics.
58
59      The timeout logic has therefore been modified in the following
60      manner:
61       . the Lan Manager Workstation (SMB) Session Timeout is used only
62         as a basis for configuring the Connection Dead Timeout 
63         and Hard Dead Timeout values.  The Connection Dead Timeout
64         must be at least 15 seconds longer than the SMB Timeout
65         and the Hard Dead Timeout must be at least double the 
66         Connection Dead Timeout.
67       . New registry entries have been added to allow the Connection
68         Dead Timeout and Hard Dead Timeout values independent of the
69         Lan Manager Workstation Session Timeout
70       . The test to enforce the SMB Client Timeout has been removed.
71         
72      One of the side-effects of removing the enforcement of the SMB 
73      Client Timeout is that regardless of whether or not the SMB client
74      is available to receive the response (and how would the SMB server
75      know) the RX protocol response can be used to update the AFS 
76      Client Service state for ready access by future SMB client 
77      requests.
78
79      This should be the end of the "Server paused or restarting messages"
80    
81    * Fix "fs mkmount" command to work with UNC paths and when
82      started from non-AFS drives
83
84    * Add support for arbitrary UNC paths to the pioctl() support.
85      This enables the fs commands as well as the AFS Shell Extension
86      to work correctly when UNC paths are being used.
87
88    * Fix afscreds.exe (by updating afskfw.lib) to search for cells via
89      DNS if the cell configuration cannot be determined via CellServDB
90
91    * Add debug info to test whether CM_BUF_WAITING or CM_SCACHE_WAITING
92      are ever set more than once at a time
93  
94    * Fix the management of lists of cm_cell_t structures when using 
95      DNS to lookup cell information.  The previous code would fail to
96      reuse the same cellID for a cell if DNS was used more than once
97      for a given cell name.  When the ttl expired, a single cm_cell_t
98      could be inserted into the cm_allCellsp list more than once 
99      producing a loop.  In addition, the vlServerp list belonging to
100      the cell was not freed resulting in improper refCounting of the
101      servers.
102
103    * Add DNS support to cm_IoctlNewCell() which previous only examined
104      the CellServDB file
105
106    * Add cm_FreeServer() function and call it from cm_FreeServerList()
107      to properly garbage collect cm_server_t objects 
108      
109    * Add numVCs variable to smb.c to track the number of smb_vc_t 
110      objects created and use it to initialize the vcID field which 
111      previously was set to 0 in all objects resulting in FindByID 
112      collisions.
113
114    * Fixed DNS lookups to work consistently throughout the OpenAFS
115      product instead of just from within the afsd_service.exe
116
117    * Added a runtime check to ensure that AFS Client Service SMB
118      Server is accepting connections before attempting to mount
119      global drives.
120
121    * Read IP addresses for volume servers out of the CellServDB
122      file if gethostbyname() on the hostname fails.
123
124    * Fix getcellconfig() to populate both the Hostnames as well
125      as IP addresses when loading cell data via DNS
126
127    * Increase the Connection Dead Time to 50 from 20 seconds
128      Increase the Hard Dead Time to 120 from 40 seconds
129      (matches the Unix values)
130
131    * Fixed an assertion validating the number of allocated NCBs
132
133    * Fixed the build environment to consistently build for 
134      Windows 2000 and above.  (APPVER = 5.0)
135
136    * Fixed rx_debug to properly validate the receipt in incoming
137      data with select() and recvfrom().  Do not copy data out of
138      the socket buffer unless success is indicated.
139
140 Since 1.3.63:
141    * afsd_service.exe will now display a message box to the 
142      desktop when it terminates due to an IP Address Change.
143   
144    * installer no longer deletes AFS Server configuration data
145      on uninstall
146
147    * installer generates a warning dialog if the RPC service 
148      is not properly configured
149
150    * installer compressed with lzma instead of bzip2
151
152    * afsd_service.exe shutdown crash solved once and for all
153  
154    * reference counting of smb_vc_t data structures improved
155  
156    * name space collision of smb_fid_t event objects corrected
157
158    * the output of "fs memdump" is now written to 
159      %WINDIR%\TEMP\afsd_alloc.log
160
161    * the file TaAfsApp_1033.dll is now properly installed allowing
162      the User Manager to start
163   
164    * a new algorithm is used for computing filename pattern matches
165
166    * afscreds.exe now accepts user names containing instance
167      fields.
168
169    * Fix the Directory Name Lookup Cache to be case-sensitive.
170      This is crucial in environments in which a Windows client
171      is accessing a directory with more than one filename that
172      differs only by case.  If the directory contains "FOO" 
173      and "Foo".  You want "DEL Foo" to delete the correct one.
174      We still have a problem in that "DEL foo" will delete a
175      random filename.  This will be addressed in a future release.
176
177    * Fix afscreds.exe -M option (renewMaps) to work when High
178      Security mode is off.  Also, remember to disable the ActiveMap
179      flag in afsdsbmt.ini when a drive mapping is removed.
180
181    * Updates to NSIS installer script.  AFS Server configuration
182      data will not be destroyed on un-install or re-install.  
183      Use a better compression algorithm.
184    
185    * afslogon.dll now uses KFW to obtain tokens when available
186    
187    * afslogon.dll when given an all uppercase username will
188      attempt to authenticate with both the uppercase name
189      and an all lowercase variation
190
191    * DST modification removed.  The fix appears to make things
192      worse after a reboot of the machine.
193
194    * fs.exe:  added "cscpolicy" which is used to 
195      change client side caching policy for AFS shares
196
197      Usage: fs cscpolicy [-share <AFS share>] [-manual] [-programs] 
198                          [-documents] [-disable] [-help]
199
200    * Several uninitialized variables have been initialized
201
202    * It is now possible to obtain tokens using cross realm
203      Kerberos within afscreds.exe:
204         cell:      dementia.org
205         user:      jaltman@ATHENA.MIT.EDU
206         password:  xxxxxxxx
207      Will obtain a cross realm ticket for jaltman/DEMENTIA.ORG@ATHENA.MIT.EDU
208      will will in turn be used to obtain afs@DEMENTIA.ORG.
209      The resulting token will be stored with the display name 
210        jaltman@ATHENA.MIT.EDU@dementia.org
211
212    * aklog.exe has been added to the client
213
214      Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]] 
215                   [[-p | -path] pathname]
216                   [-noprdb] [-force]
217                   [-5 | -4]
218
219         -d gives debugging information.
220         krb_realm is the kerberos realm of a cell.
221         pathname is the name of a directory to which you wish to authenticate.
222         -noprdb means don't try to determine AFS ID.
223         -5 or -4 selects whether to use Kerberos V or Kerberos IV.
224            (default is Kerberos V)
225         No commandline arguments means authenticate to the local cell.
226
227 Since 1.3.62:
228    * All of the resource files have been restructured to adhere to
229      a set of rules IBM implemented for loading string resources.
230      These rules had either been forgotten or were not discovered
231      by folks working on the OpenAFS sources.  The end result was
232      memory corruption.  This is primary item which was preventing
233      the AFS Server from working.
234
235    * Increased the size of the maximum ticket size stored in a token
236      from 344 bytes to 12,000.  Increased the buffers used to convey
237      messages between the pioctl() caller and the SMB Server from
238      1000 bytes to 12,512.  The code appeared to have been writing
239      above the top of the stack by quite a few number of bytes.
240      (The increased ticket size is necessary for the next item.)
241
242    * When obtaining AFS Tokens via KFW, krb524 is no longer required.
243      Instead the raw Kerberos 5 ticket is used in its entirety.  This
244      is extremely important as it allows us to use pure Kerberos 5 KDCs
245      as the source of the AFS authentication.  The use of up to 12,000 byte
246      tickets will allow tickets produced by all versions of Microsoft
247      Active Directory to be used.
248       - create a user account.       
249       - designate it DES only
250       - disable pre-auth
251       - specify its UPN to be  "afs@realm"
252       - assign a SPN of "afs/cellname" to the UPN with setspn.exe
253
254    * Do not enforce the funky 8dot3 pattern matching rule that the first "."
255      is special when using long file names.  (you must use "*.*" and not "*")
256      Instead only enforce it when performing 8dot3 searches. 
257
258    * Fixed the DST problem with creation times being set one hour ahead
259
260    * Fixed the problem when using \\afs\cell-alias.  For example, 
261      \\afs\uncc instead of \\afs\uncc.edu.  Do not a new cell struct
262      for the alias name; instead simply expand the name.  One of the
263      symptoms of this problem was a loss of acquired tokens.
264
265    * Fixed the AFS Shell Extension.  The Symbolic Link menu was empty 
266      of strings.  (Only English strings provided.)
267
268    * Fixed the installer to properly replace in use files.  
269
270    * Fixed the build system to cleanup generated component version files
271
272    * The release build compiled with MSVC 6.0 compiler to avoid the 
273      afsd_service.exe shutdown crash.  This does not solve the problem
274      but simply avoids it for the time being.
275
276 Since 1.3.61:
277
278  * fix afslogon.dll to not corrupt memory when High Security mode
279    is not used.  
280
281  * fix afsd_service.exe to not attempt to restore the stack when
282    an exception occurs.  (not safe in multi-threaded programs)
283
284  * fix uninstaller to properly remove the CRT and MFC DLLs
285  
286  * remove a Message Box from afscreds.exe when getcellconfig()
287    fails on a kerberos realm which is not a cell
288
289 The following is a list of changes to the OpenAFS for Window client
290 since 1.3.60.
291
292  * "fs setserverprefs" will leave afsd service deadlocked
293
294  * "vos listaddrs" will core dump
295
296  * installer sets the appropriate keys to support Integrated Logon
297
298  * installer disables the "Find Lana by Name" functionality as it
299    was causing headaches for many users
300
301  * fix the intermittent crash of the power management thread when
302    shutting down the AFS Client Service
303
304  * optimizes the obtain drive mount list functionality which is 
305    executed every time the mount tab in afscreds.exe and afs_config.exe
306    are refreshed.  (this happens a lot)
307
308  * fix the service shutdown logic.  add the STOP_PENDING state
309    and do not accept additional service events after we declare
310    ourselves STOPPED.
311
312 The following is a list of changes to the OpenAFS for Window client
313 since 1.2.10.
314
315 * flexelint was run against the source tree and hundreds (perhaps 
316   thousands) of corrections were applied to ensure prototypes 
317   were in use; types were used consistently; variables were 
318   initialized; unused variables were removed; etc.
319
320 * A wide variety of instrumentation was added including the 
321   ability to produce a stack trace from within afsd_service.exe
322   when it crashes.
323
324 * Dynamic configuration of the RDRtimeout value based upon the
325   LanMan Workstation Session Timeout
326
327 * The mount root no longer needs to be called "/afs".  This 
328   is now set by a registry value "MountRoot" within the key
329   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
330
331 * The cell list is now only read out of afsdcell.ini when the
332   file changes instead of each time a cell is resolved.
333
334 * Thread synchronization was added to cm_server.c and ktc_nt.c
335
336 * All calls to GlobalAlloc()/GlobalFree() were replaced with 
337   calloc()/free().  The Global functions were needed on Windows 3.x
338   but have caused a variety of problems on the Win32 platforms.
339   Avoiding them is highly recommended by several Microsoft 
340   Knowledgebase articles
341
342 * Support for Symbolic Links added to the AFS Shell Extension
343
344 * Added a registry value "OverlayEnabled" to determine if
345   Shell Extension Overlays should be enabled.  
346   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
347
348 * New Build system to support VC6, VC.NET, VC.NET2003 compilers and
349   separate trees for checked and free builds.  Build system supports
350   a custom directory src\WINNT\extra which can be used as a grafting
351   location of organization specific additions to the build tree.
352
353 * New installer built using NSIS 2.0.  
354
355 * Named all kernel objects in order to allow them to be monitored
356   with tools such as SysInternals' ProcExp.exe.
357   
358 * Introduced new EventLog framework for AFSD
359
360 * Introduced Power Management interface to AFSD for Standby and 
361   Hibernate modes to allow cache to be flushed prior to network
362   disconnect
363
364 * Utilize Win32 DNSQuery API instead of internal routines.  This 
365   allows DNS SRV queries to be sent to all current domain name 
366   servers.  Not just one specified in an INI file.  DNS is now
367   always activated.
368
369 * "NetbiosName" registry value may be used to specify a fixed
370   Netbios Name such as "AFS" to be used instead of "HOSTNAME-AFS"
371   when the loopback adapter is in use.  If you need to use the 
372   old notation with a loopback adapter installed specify a registry
373   entry of 
374
375      "NetbiosName" REG_EXPAND_SZ = "%COMPUTERNAME%-AFS"
376
377 * Refactor all modules which depend on LAN Adapter and NetbiosName
378   determination in a new library: lanahelper.lib.  This allows for
379   consistent behavior throughout the product.
380
381 * Move the afsd.log and afsd_init.log files to the directory specified
382   by the "TEMP" environment variable.  This is usually %WINDIR%\TEMP
383   for services.  Added the Date to the log entries.
384
385 * New registry value "RxMaxMTU" used to limit the size of the RX 
386   packets sent by the AFS Client Service to the Server.  In order
387   to enable OpenAFS to work across the Cisco IPSec VPN the packet
388   size must be restricted to 1264 or smaller.  The latest NSIS
389   installer sets a value of 1260 by default.
390
391 * New registry value "RxNoJumbo" to disable the use of Jumbo Rx
392   packets.  This is not needed in order to work across the Cisco
393   VPN but might be needed for other network environments.  This
394   value is not set by the NSIS installer.
395
396 * New registry value "HideDotFiles" is used to apply the Hidden
397   attribute to files whose names begin with a '.'.   This value
398   is set by the NSIS installer.
399
400 * New registry value "MaxMpxRequests" allows the maximum number
401   of multiplexed sessions to be configured at run time.  This
402   value is not set by the NSIS installer.  The default value is
403   50.
404
405 * New registry value "MaxVCPerServer" allows the maxmimum number
406   of VCs per server to be configured at run time.  This value is
407   not set by the NSIS installer.  The default value is 100.
408
409 * New registry value "AllSubmount" allows the "all" submount to
410   be disabled by setting its value to 0x00.
411
412 * Allow cells names to be valid mount points 
413     \\<netbiosName>\<cellname>
414
415 * Store the active state of drive mappings in order for afscreds.exe
416   to restore them upon startup
417
418 * Add exception handling to generate a Stack Trace to the afsd_init.log
419   file if one happens to occur.
420
421 * Add lots of logging to help detect the cause of invalid SMB packets
422
423 * Enable Kerberos for Windows to be used to obtain AFS Tokens via
424   conversion of Kerberos 5 "afs" service tickets.  Supports auto-
425   renewal of expiring tokens as long as afscreds.exe is running.
426
427 * New afscreds.exe command line options:
428     -A = autoinit
429     -M = renew drive maps
430     -N = ip address change detection
431     -Z = unmap drives
432
433 * New registry value "EnableKFW" in {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
434   determines whether or not MIT Kerberos for Windows should be used
435   to obtain tokens via Kerberos 5 tickets.
436
437 * New registry value "AfscredsShortcutParams" in 
438   {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
439   determines the command line parameters to be specified when "fixing"
440   the AFS Shortcut in the user's startup folder.
441
442 * The "ShowTrayIcon" registry value has been moved from 
443   HKLM\Software\TransarcCorporation\AFS Client\AfsCreds to
444   {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
445   
446 * The <cell name> registry values used to store the token expiration
447   reminders have been moved from 
448   HKLM\Software\TransarcCorporation\AFS Client\AfsCreds to
449   {HKCU,HKLM}SOFTWARE\OpenAFS\Client\Reminders
450  
451 * Obtain the Logon User Name from the Explorer key when available
452
453 * new text document doc\txt\winnotes\registry.txt lists all registry
454   values used by OpenAFS (excluding the AFS Server)
455
456 * BUG: rx_securityClass objects were not properly reference 
457   counted and were never freed.  
458
459 * BUG: reduce the number of conditions under which CM_ERROR_TIMEOUT
460   would be generated.  The existence of a server does not imply
461   that it is not down.  If all of the servers for a cell are down
462   return CM_ERROR_NOSUCHVOLUME instead.  This prevents the Explorer
463   Shell from hanging.
464
465 * BUG: the directory name lookup cache failed to free the entries
466   in the cache when the name cache entries cycled.  The entries
467   in the cache would become dereferenced without being freed.
468
469 * BUG: fs setserverprefs could be executed without Administrator
470   privileges
471
472 * BUG: the number of allocated NCB objects (100) exceeded the number
473   which could actually be waited upon by the kernel (64).  Any objects
474   which were utilized above the limit could never have event completions
475   detected.
476
477 * BUG: smb_username_t objects were not being reference counted and 
478   were not properly freed.
479
480 * BUG: smb_tid_t objects could under unusual circumstances be freed
481   before they were no longer referenced.
482
483 * BUG: smb_fid_t object pointer were frequently used even when 
484   their value could be NULL.   They were not properly released and
485   therefore they were never freed.
486
487 * BUG: smb_packet_t data structures were not completely initialized
488   upon creation
489
490 * BUG: when Rx produces a CM_ERROR_NOIPC error do not return "Access
491   Denied" because that causes the Explorer Shell to try again until
492   access is obtained.  Instead return "Remote Resources" which allows 
493   the shell to move on and treat the error as transient.
494
495 * BUG: when initializing the NCBreturns structure, separate Event objects
496   were created for each NCB although a single Event object was supposed
497   to be shared by all.
498
499 * BUG: smb_dirSearch_t objects were not being properly referenced counted
500   or freed.
501
502 * BUG: smb_tran2Packet_t objects were not being properly referenced 
503   counted or freed.
504
505 * BUG: directory path creation did not handle the case of multiple
506   directories requiring creation in one attempt
507
508 * BUG: SMB requests which required an Extended Response were ignored.
509   This prevented some files from being written to AFS volumes.
510
511 * BUG: character strings were being freed even after they were 
512   inserted into in use data structures
513
514 * BUG: inconsistent usernames were used when High Security mode was
515   enabled.  (there is still much to do in this area)
516
517 * BUG: pioctl() calls which require out of band RPC operations were
518   susceptible to race conditions when performed by multiple processes
519
520 * BUG: memory allocation and deallocation crossed instances of the
521   C Runtime Library producing memory leakage and corruption in 
522   afscreds and the client configurator.
523
524
525