[openafs.git] / doc / txt / winnotes / afs-changes-since-1.2.txt

Since 1.3.64:
   * The timeout logic in the AFS Client Service has been wrong
     for sometime.  It is based on two different assumptions.
     First, the SMB client timeout is a fix value as was the case
     with OS/2 Lan Manager.  This assumption is incorrect.  The
     SMB timeout in Windows is a dynamic value computed based upon
     a fixed minimum timeout to which is added time based upon the
     size of the request and the performance characteristics of
     the connection.  Second, it is the responsibility of the 
     SMB Server to enforce the timeout requirements of the client.
     This is untrue.  The SMB Server cannot be expected to know
     the requirements of the client.  More importantly, if the 
     SMB server uses the SMB client timeout as a value to restrict
     its behavior as an RX client, the performance characteristics
     of the local SMB session would be used to prematurely terminate
     WAN connections with significantly different performance 
     characteristics.

     The timeout logic has therefore been modified in the following
     manner:
      . the Lan Manager Workstation (SMB) Session Timeout is used only
        as a basis for configuring the Connection Dead Timeout 
        and Hard Dead Timeout values.  The Connection Dead Timeout
        must be at least 15 seconds longer than the SMB Timeout
        and the Hard Dead Timeout must be at least double the 
        Connection Dead Timeout.
      . New registry entries have been added to allow the Connection
        Dead Timeout and Hard Dead Timeout values independent of the
        Lan Manager Workstation Session Timeout
      . The test to enforce the SMB Client Timeout has been removed.
        
     One of the side-effects of removing the enforcement of the SMB 
     Client Timeout is that regardless of whether or not the SMB client
     is available to receive the response (and how would the SMB server
     know) the RX protocol response can be used to update the AFS 
     Client Service state for ready access by future SMB client 
     requests.

     This should be the end of the "Server paused or restarting messages"
   
   * Fix "fs mkmount" command to work with UNC paths and when
     started from non-AFS drives

   * Add support for arbitrary UNC paths to the pioctl() support.
     This enables the fs commands as well as the AFS Shell Extension
     to work correctly when UNC paths are being used.

   * Fix afscreds.exe (by updating afskfw.lib) to search for cells via
     DNS if the cell configuration cannot be determined via CellServDB

   * Add debug info to test whether CM_BUF_WAITING or CM_SCACHE_WAITING
     are ever set more than once at a time
 
   * Fix the management of lists of cm_cell_t structures when using 
     DNS to lookup cell information.  The previous code would fail to
     reuse the same cellID for a cell if DNS was used more than once
     for a given cell name.  When the ttl expired, a single cm_cell_t
     could be inserted into the cm_allCellsp list more than once 
     producing a loop.  In addition, the vlServerp list belonging to
     the cell was not freed resulting in improper refCounting of the
     servers.

   * Add DNS support to cm_IoctlNewCell() which previous only examined
     the CellServDB file

   * Add cm_FreeServer() function and call it from cm_FreeServerList()
     to properly garbage collect cm_server_t objects 
     
   * Add numVCs variable to smb.c to track the number of smb_vc_t 
     objects created and use it to initialize the vcID field which 
     previously was set to 0 in all objects resulting in FindByID 
     collisions.

   * Fixed DNS lookups to work consistently throughout the OpenAFS
     product instead of just from within the afsd_service.exe

   * Added a runtime check to ensure that AFS Client Service SMB
     Server is accepting connections before attempting to mount
     global drives.

   * Read IP addresses for volume servers out of the CellServDB
     file if gethostbyname() on the hostname fails.

   * Fix getcellconfig() to populate both the Hostnames as well
     as IP addresses when loading cell data via DNS

   * Increase the Connection Dead Time to 50 from 20 seconds
     Increase the Hard Dead Time to 120 from 40 seconds
     (matches the Unix values)

   * Fixed an assertion validating the number of allocated NCBs

   * Fixed the build environment to consistently build for 
     Windows 2000 and above.  (APPVER = 5.0)

   * Fixed rx_debug to properly validate the receipt in incoming
     data with select() and recvfrom().  Do not copy data out of
     the socket buffer unless success is indicated.

Since 1.3.63:
   * afsd_service.exe will now display a message box to the 
     desktop when it terminates due to an IP Address Change.
  
   * installer no longer deletes AFS Server configuration data
     on uninstall

   * installer generates a warning dialog if the RPC service 
     is not properly configured

   * installer compressed with lzma instead of bzip2

   * afsd_service.exe shutdown crash solved once and for all
 
   * reference counting of smb_vc_t data structures improved
 
   * name space collision of smb_fid_t event objects corrected

   * the output of "fs memdump" is now written to 
     %WINDIR%\TEMP\afsd_alloc.log

   * the file TaAfsApp_1033.dll is now properly installed allowing
     the User Manager to start
  
   * a new algorithm is used for computing filename pattern matches

   * afscreds.exe now accepts user names containing instance
     fields.

   * Fix the Directory Name Lookup Cache to be case-sensitive.
     This is crucial in environments in which a Windows client
     is accessing a directory with more than one filename that
     differs only by case.  If the directory contains "FOO" 
     and "Foo".  You want "DEL Foo" to delete the correct one.
     We still have a problem in that "DEL foo" will delete a
     random filename.  This will be addressed in a future release.

   * Fix afscreds.exe -M option (renewMaps) to work when High
     Security mode is off.  Also, remember to disable the ActiveMap
     flag in afsdsbmt.ini when a drive mapping is removed.

   * Updates to NSIS installer script.  AFS Server configuration
     data will not be destroyed on un-install or re-install.  
     Use a better compression algorithm.
   
   * afslogon.dll now uses KFW to obtain tokens when available
   
   * afslogon.dll when given an all uppercase username will
     attempt to authenticate with both the uppercase name
     and an all lowercase variation

   * DST modification removed.  The fix appears to make things
     worse after a reboot of the machine.

   * fs.exe:  added "cscpolicy" which is used to 
     change client side caching policy for AFS shares

     Usage: fs cscpolicy [-share <AFS share>] [-manual] [-programs] 
                         [-documents] [-disable] [-help]

   * Several uninitialized variables have been initialized

   * It is now possible to obtain tokens using cross realm
     Kerberos within afscreds.exe:
        cell:      dementia.org
        user:      jaltman@ATHENA.MIT.EDU
        password:  xxxxxxxx
     Will obtain a cross realm ticket for jaltman/DEMENTIA.ORG@ATHENA.MIT.EDU
     will will in turn be used to obtain afs@DEMENTIA.ORG.
     The resulting token will be stored with the display name 
       jaltman@ATHENA.MIT.EDU@dementia.org

   * aklog.exe has been added to the client

     Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]] 
                  [[-p | -path] pathname]
                  [-noprdb] [-force]
                  [-5 | -4]

        -d gives debugging information.
        krb_realm is the kerberos realm of a cell.
        pathname is the name of a directory to which you wish to authenticate.
        -noprdb means don't try to determine AFS ID.
        -5 or -4 selects whether to use Kerberos V or Kerberos IV.
           (default is Kerberos V)
        No commandline arguments means authenticate to the local cell.

Since 1.3.62:
   * All of the resource files have been restructured to adhere to
     a set of rules IBM implemented for loading string resources.
     These rules had either been forgotten or were not discovered
     by folks working on the OpenAFS sources.  The end result was
     memory corruption.  This is primary item which was preventing
     the AFS Server from working.

   * Increased the size of the maximum ticket size stored in a token
     from 344 bytes to 12,000.  Increased the buffers used to convey
     messages between the pioctl() caller and the SMB Server from
     1000 bytes to 12,512.  The code appeared to have been writing
     above the top of the stack by quite a few number of bytes.
     (The increased ticket size is necessary for the next item.)

   * When obtaining AFS Tokens via KFW, krb524 is no longer required.
     Instead the raw Kerberos 5 ticket is used in its entirety.  This
     is extremely important as it allows us to use pure Kerberos 5 KDCs
     as the source of the AFS authentication.  The use of up to 12,000 byte
     tickets will allow tickets produced by all versions of Microsoft
     Active Directory to be used.
      - create a user account.       
      - designate it DES only
      - disable pre-auth
      - specify its UPN to be  "afs@realm"
      - assign a SPN of "afs/cellname" to the UPN with setspn.exe

   * Do not enforce the funky 8dot3 pattern matching rule that the first "."
     is special when using long file names.  (you must use "*.*" and not "*")
     Instead only enforce it when performing 8dot3 searches. 

   * Fixed the DST problem with creation times being set one hour ahead

   * Fixed the problem when using \\afs\cell-alias.  For example, 
     \\afs\uncc instead of \\afs\uncc.edu.  Do not a new cell struct
     for the alias name; instead simply expand the name.  One of the
     symptoms of this problem was a loss of acquired tokens.

   * Fixed the AFS Shell Extension.  The Symbolic Link menu was empty 
     of strings.  (Only English strings provided.)

   * Fixed the installer to properly replace in use files.  

   * Fixed the build system to cleanup generated component version files

   * The release build compiled with MSVC 6.0 compiler to avoid the 
     afsd_service.exe shutdown crash.  This does not solve the problem
     but simply avoids it for the time being.

Since 1.3.61:

 * fix afslogon.dll to not corrupt memory when High Security mode
   is not used.  

 * fix afsd_service.exe to not attempt to restore the stack when
   an exception occurs.  (not safe in multi-threaded programs)

 * fix uninstaller to properly remove the CRT and MFC DLLs
 
 * remove a Message Box from afscreds.exe when getcellconfig()
   fails on a kerberos realm which is not a cell

The following is a list of changes to the OpenAFS for Window client
since 1.3.60.

 * "fs setserverprefs" will leave afsd service deadlocked

 * "vos listaddrs" will core dump

 * installer sets the appropriate keys to support Integrated Logon

 * installer disables the "Find Lana by Name" functionality as it
   was causing headaches for many users

 * fix the intermittent crash of the power management thread when
   shutting down the AFS Client Service

 * optimizes the obtain drive mount list functionality which is 
   executed every time the mount tab in afscreds.exe and afs_config.exe
   are refreshed.  (this happens a lot)

 * fix the service shutdown logic.  add the STOP_PENDING state
   and do not accept additional service events after we declare
   ourselves STOPPED.

The following is a list of changes to the OpenAFS for Window client
since 1.2.10.

* flexelint was run against the source tree and hundreds (perhaps 
  thousands) of corrections were applied to ensure prototypes 
  were in use; types were used consistently; variables were 
  initialized; unused variables were removed; etc.

* A wide variety of instrumentation was added including the 
  ability to produce a stack trace from within afsd_service.exe
  when it crashes.

* Dynamic configuration of the RDRtimeout value based upon the
  LanMan Workstation Session Timeout

* The mount root no longer needs to be called "/afs".  This 
  is now set by a registry value "MountRoot" within the key
  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters

* The cell list is now only read out of afsdcell.ini when the
  file changes instead of each time a cell is resolved.

* Thread synchronization was added to cm_server.c and ktc_nt.c

* All calls to GlobalAlloc()/GlobalFree() were replaced with 
  calloc()/free().  The Global functions were needed on Windows 3.x
  but have caused a variety of problems on the Win32 platforms.
  Avoiding them is highly recommended by several Microsoft 
  Knowledgebase articles

* Support for Symbolic Links added to the AFS Shell Extension

* Added a registry value "OverlayEnabled" to determine if
  Shell Extension Overlays should be enabled.  
  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters

* New Build system to support VC6, VC.NET, VC.NET2003 compilers and
  separate trees for checked and free builds.  Build system supports
  a custom directory src\WINNT\extra which can be used as a grafting
  location of organization specific additions to the build tree.

* New installer built using NSIS 2.0.  

* Named all kernel objects in order to allow them to be monitored
  with tools such as SysInternals' ProcExp.exe.
  
* Introduced new EventLog framework for AFSD

* Introduced Power Management interface to AFSD for Standby and 
  Hibernate modes to allow cache to be flushed prior to network
  disconnect

* Utilize Win32 DNSQuery API instead of internal routines.  This 
  allows DNS SRV queries to be sent to all current domain name 
  servers.  Not just one specified in an INI file.  DNS is now
  always activated.

* "NetbiosName" registry value may be used to specify a fixed
  Netbios Name such as "AFS" to be used instead of "HOSTNAME-AFS"
  when the loopback adapter is in use.  If you need to use the 
  old notation with a loopback adapter installed specify a registry
  entry of 

     "NetbiosName" REG_EXPAND_SZ = "%COMPUTERNAME%-AFS"

* Refactor all modules which depend on LAN Adapter and NetbiosName
  determination in a new library: lanahelper.lib.  This allows for
  consistent behavior throughout the product.

* Move the afsd.log and afsd_init.log files to the directory specified
  by the "TEMP" environment variable.  This is usually %WINDIR%\TEMP
  for services.  Added the Date to the log entries.

* New registry value "RxMaxMTU" used to limit the size of the RX 
  packets sent by the AFS Client Service to the Server.  In order
  to enable OpenAFS to work across the Cisco IPSec VPN the packet
  size must be restricted to 1264 or smaller.  The latest NSIS
  installer sets a value of 1260 by default.

* New registry value "RxNoJumbo" to disable the use of Jumbo Rx
  packets.  This is not needed in order to work across the Cisco
  VPN but might be needed for other network environments.  This
  value is not set by the NSIS installer.

* New registry value "HideDotFiles" is used to apply the Hidden
  attribute to files whose names begin with a '.'.   This value
  is set by the NSIS installer.

* New registry value "MaxMpxRequests" allows the maximum number
  of multiplexed sessions to be configured at run time.  This
  value is not set by the NSIS installer.  The default value is
  50.

* New registry value "MaxVCPerServer" allows the maxmimum number
  of VCs per server to be configured at run time.  This value is
  not set by the NSIS installer.  The default value is 100.

* New registry value "AllSubmount" allows the "all" submount to
  be disabled by setting its value to 0x00.

* Allow cells names to be valid mount points 
    \\<netbiosName>\<cellname>

* Store the active state of drive mappings in order for afscreds.exe
  to restore them upon startup

* Add exception handling to generate a Stack Trace to the afsd_init.log
  file if one happens to occur.

* Add lots of logging to help detect the cause of invalid SMB packets

* Enable Kerberos for Windows to be used to obtain AFS Tokens via
  conversion of Kerberos 5 "afs" service tickets.  Supports auto-
  renewal of expiring tokens as long as afscreds.exe is running.

* New afscreds.exe command line options:
    -A = autoinit
    -M = renew drive maps
    -N = ip address change detection
    -Z = unmap drives

* New registry value "EnableKFW" in {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
  determines whether or not MIT Kerberos for Windows should be used
  to obtain tokens via Kerberos 5 tickets.

* New registry value "AfscredsShortcutParams" in 
  {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
  determines the command line parameters to be specified when "fixing"
  the AFS Shortcut in the user's startup folder.

* The "ShowTrayIcon" registry value has been moved from 
  HKLM\Software\TransarcCorporation\AFS Client\AfsCreds to
  {HKCU,HKLM}SOFTWARE\OpenAFS\Client 
  
* The <cell name> registry values used to store the token expiration
  reminders have been moved from 
  HKLM\Software\TransarcCorporation\AFS Client\AfsCreds to
  {HKCU,HKLM}SOFTWARE\OpenAFS\Client\Reminders
 
* Obtain the Logon User Name from the Explorer key when available

* new text document doc\txt\winnotes\registry.txt lists all registry
  values used by OpenAFS (excluding the AFS Server)

* BUG: rx_securityClass objects were not properly reference 
  counted and were never freed.  

* BUG: reduce the number of conditions under which CM_ERROR_TIMEOUT
  would be generated.  The existence of a server does not imply
  that it is not down.  If all of the servers for a cell are down
  return CM_ERROR_NOSUCHVOLUME instead.  This prevents the Explorer
  Shell from hanging.

* BUG: the directory name lookup cache failed to free the entries
  in the cache when the name cache entries cycled.  The entries
  in the cache would become dereferenced without being freed.

* BUG: fs setserverprefs could be executed without Administrator
  privileges

* BUG: the number of allocated NCB objects (100) exceeded the number
  which could actually be waited upon by the kernel (64).  Any objects
  which were utilized above the limit could never have event completions
  detected.

* BUG: smb_username_t objects were not being reference counted and 
  were not properly freed.

* BUG: smb_tid_t objects could under unusual circumstances be freed
  before they were no longer referenced.

* BUG: smb_fid_t object pointer were frequently used even when 
  their value could be NULL.   They were not properly released and
  therefore they were never freed.

* BUG: smb_packet_t data structures were not completely initialized
  upon creation

* BUG: when Rx produces a CM_ERROR_NOIPC error do not return "Access
  Denied" because that causes the Explorer Shell to try again until
  access is obtained.  Instead return "Remote Resources" which allows 
  the shell to move on and treat the error as transient.

* BUG: when initializing the NCBreturns structure, separate Event objects
  were created for each NCB although a single Event object was supposed
  to be shared by all.

* BUG: smb_dirSearch_t objects were not being properly referenced counted
  or freed.

* BUG: smb_tran2Packet_t objects were not being properly referenced 
  counted or freed.

* BUG: directory path creation did not handle the case of multiple
  directories requiring creation in one attempt

* BUG: SMB requests which required an Extended Response were ignored.
  This prevented some files from being written to AFS volumes.

* BUG: character strings were being freed even after they were 
  inserted into in use data structures

* BUG: inconsistent usernames were used when High Security mode was
  enabled.  (there is still much to do in this area)

* BUG: pioctl() calls which require out of band RPC operations were
  susceptible to race conditions when performed by multiple processes

* BUG: memory allocation and deallocation crossed instances of the
  C Runtime Library producing memory leakage and corruption in 
  afscreds and the client configurator.