From cb39d44cf56f51d6a14a6ba61f4b0662719aac8e Mon Sep 17 00:00:00 2001
From: Jeffrey Altman It can be installed either as a new installation or an
upgrade from previous versions of OpenAFS for Windows or IBM AFS for
@@ -2670,12 +2671,12 @@ style='mso-list:Ignore'>2.  
using WiX and can be customized for organizations via the use of MSI Transforms
(see MSI Deployment Guide)
style='mso-spacerun:yes'> 2. System Requirements
+2. System Requirements
-2.1 Supported
+
2.1 Supported
Operating Systems
Up to 60mb required for the OpenAFS binaries plus 100MB for the default AFSCache file. (The size of the AFSCache file may be adjusted via the Registry after installation.)
-MIT Kerberos for Windows 2.6.x if Kerberos 5 authentication support is desired.
-The Kerberos 4 infrastructure on which the OpenAFS 1.2 @@ -2881,8 +2882,8 @@ style='mso-element:field-begin'>
XE "krb524" -By itself the OpenAFS Client Service does not provide robust @@ -2896,10 +2897,10 @@ OpenAFS Client Service will not be affected by the configuration changes of other network adapters installed on the system.
-The MLA is installed with a name of "AFS" and a -pre-assigned IP address in the 10.x.x.x range. -The MLA is bound to the Client for Microsoft Networks service and not -bound to the File and Printer Sharing for Microsoft Networks.The MLA is installed with a name of "AFS" and a pre-assigned +IP address in the 10.x.x.x range. The +MLA is bound to the Client for Microsoft Networks service and not bound to +the File and Printer Sharing for Microsoft Networks. If the MLA is unbound to "Client Microsoft Networks", the OpenAFS Client Service will become inaccessible when the machine is disconnected from the network.MACHINE-AFS". One of the benefits of using the MLA is that the NETBIOS name does not have to be published on any adapter other than the MLA. Therefore the chosen name is no -longer required to be unique. Instead -the NETBIOS name associated with the AFS Client Service is simply -"AFS" and portable UNC paths of the form \\AFS\cellname\path can now -be used on all machines.
-Traditionally, when the OpenAFS Client Service starts it -must be able to access the "root.afs" volume of the default -cell. The "root.afs" volume -contains the set of mount points to the "root.cell" volumes of -various cells the administrator of the default cell believes should be -accessible. If the "root.afs" -volume is inaccessible when the client service is started, the service will -terminate unexpectedly. Since many users -now use laptops or otherwise operate in disconnected environments in which a -VPN may be required to access the cell's servers, it is often the case that the +
Traditionally, when the OpenAFS Client Service starts it must +be able to access the "root.afs" volume of the default cell. The "root.afs" volume contains the +set of mount points to the "root.cell" volumes of various cells the +administrator of the default cell believes should be accessible. If the "root.afs" volume is +inaccessible when the client service is started, the service will terminate +unexpectedly. Since many users now use +laptops or otherwise operate in disconnected environments in which a VPN may be +required to access the cell's servers, it is often the case that the "root.afs" volume for the default cell is not reachable and the OpenAFS Client Service will not successfully start.
To allow the OpenAFS Client Service to operate in these -environments, a fake "root.afs" volume is dynamically constructed -from mount points and symlinks stored in the local registry. This method of operation is referred to as Freelance mode.
@@ -3053,8 +3054,8 @@ style='mso-spacerun:yes'> style='mso-element:field-end'> -The OpenAFS for Windows client will use DNS AFSDB records to @@ -3067,8 +3068,8 @@ style='mso-element:field-begin'>
XE "afsdb" -OpenAFS for Windows installs a WinLogon Network Provider to @@ -3095,8 +3096,8 @@ obtained during the process of generating AFS tokens are preserved and stored into the default ccache within the user logon session.
Integrated Logon does not have the ability to cache the -user's username and password for the purpose of obtaining tokens if the Kerberos -KDC is inaccessible at logon time.
+user's username and password for the purpose of obtaining tokens if the +Kerberos KDC is inaccessible at logon time.Integrated Login supports the ability to obtain tokens for multiple cells. For further information @@ -3106,8 +3107,8 @@ href="#_Appendix_A:_Registry_Values">Appendix A
. -The AFS System Tray tool (afscreds.exe) supports several @@ -3141,20 +3142,20 @@ tokens dialog on startup
-U = uninstall startup shortcut
--X = test -and do map share
+-X = test and do map share
-Z = unmap drives
autoinit will result in automated attempts to acquire AFS tokens when afscreds.exe is started. -afscreds.exe will attempt to utilize tickets stored in the MSLSA credentials -cache; any existing CCAPI credentials cache; and finally display an Obtain -Tokens dialog to the user. When used in -combination with IP address change detection, afscreds.exe will attempt to -acquire AFS tokens whenever the IP address list changes and the Kerberos KDC is -accessible.
+afscreds.exe will attempt to utilize tickets stored in the MSLSA +credentials cache; any existing CCAPI credentials cache; and finally display an +Obtain Tokens dialog to the user. When +used in combination with IP address change detection, afscreds.exe will attempt +to acquire AFS tokens whenever the IP address list changes and the Kerberos KDC +is accessible.The renew drive maps option is used to ensure that the user drive maps constructed via the OpenAFS tools (not NET USE) are re-constructed @@ -3171,8 +3172,8 @@ href="#_Appendix_A:_Registry_Values">Appendix A
. -The OpenAFS for Windows 1.4 client supports a local Windows @@ -3276,8 +3277,8 @@ style='mso-element:field-begin'>
XE "fs.exe" -The OpenAFS 1.4 client supports UNC paths everywhere. AFS paths can be entered in UNIX notation (e.g., /afs/openafs.org/software), space utilization reports the output of the volume status for the specified -path, and many AFS specific functions and variables have been added to the -command language.
+path, and many AFS specific functions and variables have been added to the command +language.JPSoftware's web site is http://www.jpsoft.com.
-The OpenAFS 1.4 Client ships with its own version of
@@ -3321,11 +3322,11 @@ tokens
Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]] [[-p
-| -path] pathname]
-[-noprdb] [-force]
[-noprdb] [-force]
[-5 [-m]| -4]
@@ -3355,8 +3356,8 @@ krb524d to convert Kerberos V tickets to Kerberos IV -The AFS Server functionality provided with OpenAFS 1.4 might @@ -3388,9 +3389,9 @@ MIT Kerberos for Windows should not be installed or must be disabled.
-The OpenAFS for Windows installers now include Debugging Symbol files which should be installed if you are experiencing problems and @@ -3422,29 +3423,29 @@ additional debug statements were compiled into the binaries
-OpenAFS for Windows does not support files larger than 2GB. The version of the SMB/CIFS protocol implemented imposes this limitation. -Upgrading the SMB/CIFS implementation or replacing it with an Installable -File System will allow larger files to be supported.
-The OpenAFS for Windows installer by default activates a -weak form of encrypted data transfer between the AFS client and the AFS servers. This is often referred to as +weak form of encrypted data transfer between the AFS client and the AFS +servers. This is often referred to as "fcrypt" mode.
-OpenAFS 1.4 supports authenticated SMB connections using @@ -3455,19 +3456,18 @@ another user's tokens on shared machines.
When GSS SPNEGO attempts a Kerberos 5 authentication, the -Windows SMB client will attempt to retrieve service tickets for -"cifs/afs@REALM" (if the loopback adapter is in use) or -"cifs/machine-afs@REALM" (if the loopback adapter is not being -used). It is extremely important that -this service principal not exist in the KDC database as the Kerberos -authentication must fail allowing automatic fallback to NTLM. When NTLM is used a special local -authentication mode will be used that does not require access to the user's -password. Instead, Windows will -internally recognize the request as coming from a local logon session.
- -Previous AFS clients for Windows stored configuration data @@ -3487,8 +3487,8 @@ file to the new CellServDB file. Windows registry. OpenAFS 1.4 will not process the contents of the afsddbmt.ini.
-The OpenAFS 1.4 Client is compatible with the Internet @@ -3499,9 +3499,9 @@ the AFS file server. appropriate Back Connection registry entries are added to allow SMB authentication to be performed across the Microsoft Loopback Adapter.
-The OpenAFS 1.4 Client Service implements the CIFS Remote Admin Protocol which allows Explorer to browse server and share information. @@ -3525,26 +3525,26 @@ range locks. that files not be edited within AFS if they might be accessed by multiple users or multiple processes on a single machine.
-OpenAFS 1.4 will automatically forget a user's tokens upon Logoff unless the user's profile was loaded from an AFS volume. In this situation there is no mechanism to -determine when the profile has been successfully written back to the network. It is therefore unsafe to release the user's -tokens. Whether or not the profile has -been loaded from the registry can be determined for Local Accounts, Active -Directory accounts and NT4 accounts.
+determine when the profile has been successfully written back to the +network. It is therefore unsafe to +release the user's tokens. Whether or +not the profile has been loaded from the registry can be determined for Local +Accounts, Active Directory accounts and NT4 accounts.If there is a need to disable this functionality, the LogoffPreserveTokens registry value can be used. (see Appendix A.)
-When installing the NSIS (.exe) installer under Terminal @@ -3553,8 +3553,8 @@ Panel. AFS not running properly. The AFS Server should not be installed on a machine with Terminal Server installed.
-AFS is a UNIX native file system. automatically given the Hidden attribute so they will not normally be displayed.
-The Status Cache (AFS Configuration Control Panel: Advanced @@ -3584,8 +3584,8 @@ maximum number of Status Cache entries. Each entry requires approximately 1.2K. In OpenAFS 1.4, the default number of Status Cache entries is 10,000.
-"Netbios over TCP/IP" must be active on the @@ -3594,8 +3594,8 @@ style='mso-spacerun:yes'> on the machine, then communication with the AFS Client Service will be impossible.
-The OpenAFS Client Service and related binaries distributed @@ -3615,8 +3615,8 @@ documents the "VerifyServiceSi registry value which can be used to disable the signature check. The file version check cannot be disabled.
-The maximum cache size is approximately 1.3GB.
- OpenAFS for Windows implements an SMB server which is used
@@ -3826,8 +3826,8 @@ setting is not the default setting because making this change would prevent
OpenAFS for Windows from being able to access filenames containing the above
characters which were created without this setting. There is a known issue with storing Windows Roaming Profiles
@@ -3839,8 +3839,8 @@ support UNICODE.
some sites run logoff scripts (assigned by group policy) which rename all files
to use only the supported characters for the locale. The AFS Cache file is stored by default at %TEMP%\AFSCache
@@ -3858,8 +3858,8 @@ compressed and should consist of as few fragments as possible. Significant performance gains can be
achieved by defragmenting the AFSCache file with Sysinternal's Contig utility. A new command line tool, afsdacl.exe, can be used to
@@ -3885,8 +3885,8 @@ afsdacl [-set | -reset] [-show]
-show : Show current DACL (SDSF) The default @sys name list in OpenAFS 1.4 is set to
@@ -3895,8 +3895,8 @@ style='mso-spacerun:yes'>
"ia64_win64" and "amd64_win64" for amd 64-bit processors
when those platforms are supported. In OpenAFS 1.4, symlinks to AFS UNC paths, \\AFS[\all]\...,
@@ -3904,8 +3904,8 @@ are treated the same as symlinks to /afs/...
However, please use /afs/... as the Windows UNC form will not work on
UNIX. OpenAFS for Windows 1.4 implements the Cache Manager
@@ -3928,8 +3928,8 @@ can be queried with cmdebug.exe.3.26. Filename
+
3.26. Filename
Character Sets
3.27. Known
+
3.27. Known
Character Set Issues with Roaming Profiles
3.28. The
+
3.28. The
AFSCache File
3.29. Restricting
+
3.29. Restricting
OpenAFS Client Service Start and Stop
3.30. The @sys
+
3.30. The @sys
Name List
3.31. Symlinks to
+
3.31. Symlinks to
AFS UNC paths
3.32. Cache
+
3.32. Cache
Manager Debugging Now Supported
If you are a site which utilizes MIT/Heimdal Kerberos @@ -3937,8 +3937,8 @@ principals to logon to Windows via a cross-realm relationship with a multi-domain Windows forest, you must enable Windows logon caching unless the workstation is Windows Vista Beta 1 or later.
-VLDB and File Server Preferences can now be provided initial @@ -3948,8 +3948,8 @@ useful for managed machines in a Windows domain which are centrally located href="#_Appendix_A:_Registry_Values">Appendix A
for details on the "Server Preferences" keys. -OpenAFS 1.4 reports timestamps on files stored in AFS in UTC @@ -3974,8 +3974,8 @@ timestamp from the Windows explorer. During DST, these two times will no longer agree even though they are in fact representing the same moment in time.
-If the installer refuses to install and complains about an @@ -3994,8 +3994,8 @@ are present and that they refer to the dll "rpcrt4.dll":
HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_http"
-OpenAFS 1.4 adds a new command, "fs @@ -4005,8 +4005,8 @@ afsd_service.exe process. can be very helpful when debugging the AFS Client Service when it is unresponsive to SMB/CIFS requests.
-The OpenAFS for Windows 1.4 client implements Universally @@ -4020,9 +4020,9 @@ style='mso-spacerun:yes'> client installed, the AFSCache files must be deleted as part of the cloning process.
-OpenAFS for Windows provides a wide range of tools to assist @@ -4030,12 +4030,12 @@ you in debugging problems. techniques available to you are varied because of the wide range of issues that have been discovered over the years.
-pioctl (path-based ioctl) calls are used by various tools to @@ -4124,8 +4124,8 @@ style='mso-spacerun:yes'> KnowledgeBase can be used as a reference to help you determine the configuration probem with your system.
-Every time the AFS Client Service starts it appends data @@ -4145,11 +4145,11 @@ href="#_Value___:_MaxLogSize">MaxLogSize
registry value determines the maximum size of the %WINDIR%\TEMP\afsd_init.log file. If the file is larger than this value when OpenAFS Client Service starts, the file will be reset to 0 bytes. If value is set to 0, the file will be allowed -to grow indefinitely. +style='mso-spacerun:yes'>When attempting to debug the behavior of the SMB/CIFS Server @@ -4160,8 +4160,8 @@ style='mso-spacerun:yes'> any one time is 5000. This can be adjusted with the registry value:
-[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
++[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
REG_DWORD TraceBufferSize
@@ -4171,8 +4171,8 @@ value. to clear to the log and "fs trace -dump" to output the contents of the log to the file. -An alternatve option to the use of "fs trace @@ -4181,9 +4181,10 @@ such as Sysinternal's DbgView to capture real-time debugging output. When the OpenAFS Client Service starts and Bit 2 of the TraceOption value in the registry is set, all trace log events are output using the Windows Debug -Monitor interface (OutputDebugString).
+Monitor interface (OutputDebugString). -[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
++[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
REG_DWORD TraceOption = 0x04
@@ -4203,8 +4204,8 @@ and the resulting OpenAFS Client Service operations. The captured data can be stored to files for inclusion in bug reports. -If you are having trouble with the Integrated Logon @@ -4234,8 +4235,8 @@ href="#_Value__:_TraceOption">TraceOption
registry value: Event Handlers to log information to the Windows Event Log: Application under the name AFS Logon". -The rxdebug.exe tool can be used to query a variety of @@ -4293,8 +4294,8 @@ connections
-peers show peers
-The cmdebug.exe tool can be used to query the state of the @@ -4326,8 +4327,8 @@ interfaces
-cache print only cache configuration -The persistent cache is stored in a Hidden System file at @@ -4338,9 +4339,9 @@ being able to start a validation check on the file can be performed.
afsd_service.exe --validate-cache <cache-path>
-Bug reports should be sent to openafs-bugs@openafs.org.
When reporting a error, please be sure to include the
version of OpenAFS. Contributions to the development of OpenAFS for Windows are
@@ -4459,8 +4460,8 @@ continuously needed.
take many forms including cash donations, support contracts, donated developer
time, and even donated tech writer time. USENIX, a 501c3
@@ -4582,8 +4583,8 @@ mso-break-type:section-break'>
A MSI installer option is available for those who wish to
use Windows Installer for installing OpenAFS and for organizations that wish to
@@ -4687,8 +4688,8 @@ mso-list:l16 level1 lfo28;tab-stops:list 36.0pt'>2.
msitran -a openafs-transform.mst openafs-test.msi and then checking the resulting openafs-test.msi to see if
-all changes you have made above to openafs-modified.msi is present in
+ and then checking the resulting openafs-test.msi to see if all
+changes you have made above to openafs-modified.msi is present in
openafs-test.msi. 'msitran' will
complain if some modification in the transform can not be successfully applied. The logic necessary to implement many of the settings
@@ -4992,8 +4993,8 @@ including such options may not apply to future releases of OpenAFS. Controls whether AFSCreds.exe starts
up automatically when the user logs on.
- When CREDSSTARTUP is '1' a shortcut is added to the 'Startup' folder in
- the 'Program menu' which starts AFSCREDS.EXE with the options that are
+ When CREDSSTARTUP is '1' a shortcut is added to the 'Startup' folder
+ in the 'Program menu' which starts AFSCREDS.EXE with the options that are
determined by the other CREDS* properties. Note that the ComponentId is an uppercase
-GUID. You can generate one using
-GUIDGEN.EXE or UUIDGEN.EXE, both of which are included in the Platform SDK. Note that the ComponentId is an
+uppercase GUID. You can generate one
+using GUIDGEN.EXE or UUIDGEN.EXE, both of which are included in the Platform
+SDK. The Attributes value of 144 is a
-sum of msidbComponentAttributesPermanent (16) and
-msidbComponentAttributesNeverOverwrite (128).
-This ensures that local modifications are not overwritten or lost during
-an installation or uninstallation. These
-are the same settings used on the default configuration files. 'fil_my_CellServDB'
is a key into the 'File' table which we will fill later. It is important to create the
-new feature under the 'feaClient' feature, which will ensure that the
-configuration file will be installed when the client binaries are installed. Setting 'Display' to 0 will hide
this feature from the feature selection dialog during an interactive
@@ -5524,12 +5526,11 @@ a new row with the following values: (leave other fields blank) The 'Attributes' value is
-msidbFileAttributesNonCompressed (8192).
-This is because we will be placing this file in the same directory as the
-MSI instead of embedding the file in it.
-Transforms do not support updating compressed sources or adding new
-cabinet streams. The 'Attributes' value is msidbFileAttributesNonCompressed
+(8192). This is because we will be
+placing this file in the same directory as the MSI instead of embedding the
+file in it. Transforms do not support
+updating compressed sources or adding new cabinet streams. Finally, the 'Sequence' value of
1000 will be used later to distinguish the file as being in a separate source
@@ -5586,8 +5587,8 @@ a row with the following values : (leave other fields blank) The sequence number of 1000 designates
-this as the media source for the newly added file. The sequence number of 1000
+designates this as the media source for the newly added file. Columns that are
unspecified should be left empty. We create a new feature
-and component to hold the new registry keys. We create a new
+feature and component to hold the new registry keys. Type: REG_SZ Specifies the directory
- containing the CellServDB file. When
- this value is not specified, the AFS Client install directory is used. Specifies the directory containing
+ the CellServDB file. When this value
+ is not specified, the AFS Client install directory is used. Type: REG_DWORD This value can be used to force the AFS Client Service
- to store filenames using the Windows system's ANSI character set instead of
- the OEM Code Page character set which has traditionally been used by SMB file
+ to store filenames using the Windows system's ANSI character set instead of the
+ OEM Code Page character set which has traditionally been used by SMB file
systems. Note: The use of ANSI characters will render access to
files with 8-bit OEM file names unaccessible from Windows.
UNIX systems and vice versa. Type: REG_DWORD This value will enable the gathering of RX Statistics
- for connections with the Cache Managers Peers. This functionality can be adjusted at
- runtime with the fs rxstatpeer command. Type: REG_DWORD This value will enable the gathering of RX Statistics
- for the Cache Managers Process. This
- functionality can be adjusted at runtime with the fs rxstatproc command. Type: REG_DWORD This key is used to specify a
- default set of File server preferences. For each entry the value name will be
- either the IP address of a server or a fully qualified domain name.This key is used to specify a default
+ set of File server preferences. For each entry the value name will be either
+ the IP address of a server or a fully qualified domain name. The value will be the ranking. The ranking will be adjusted by a random
value between 0 and 256 prior to the preference being set. Affects the network provider (afslogon.dll). HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider | Type: DWORD NSIS/WiX: depends on user
- configuration NSIS/WiX: depends on user configuration 0x00 - Integrated Logon is not
used High Security Mode generates
- random SMB names for the creation of Drive Mappings. This mode should not be used without
- Integrated Logon. High Security Mode generates random
+ SMB names for the creation of Drive Mappings.
+ This mode should not be used without Integrated Logon. As of 1.3.65 the SMB server
supports SMB authentication. The High
Security Mode should not be used when using SMB authentication (SMBAuthType
@@ -7249,8 +7249,7 @@ computer, the following keys will be looked up. Please be aware of
this when setting this value. Affects the behavior of afscreds.exe Type: DWORD {0, 1} These values are used to save
- and restore the state of the reminder flag for each cell for which the user
- has obtained tokens. These values are used to save and
+ restore the state of the reminder flag for each cell for which the user has
+ obtained tokens. This value used to be stored at
[HKLM\Software\TransarcCorporation\AFS Client\AfsCreds]. These values are used to store
the AFS path in UNIX notation to which the drive letter is to be mapped. These values used to be stored
- in the afsdsbmt.ini file. These values used to be stored in
+ the afsdsbmt.ini file.6. How to Contribute to
+
6. How to Contribute to
the Development of OpenAFS for Windows
6.1. The USENIX
+
6.1. The USENIX
OpenAFS Fund
7.1. Introduction
+7.1. Introduction
7.2.
+
7.2.
Configuration Options
7.2.3.1 Components for Configuration Files
@@ -5608,8 +5609,8 @@ keys.
Regkey:
@@ -6700,9 +6724,9 @@ the AFS client service (afsd_service.exe).
CellServDBDir
Default: <not defined>
@@ -6770,7 +6794,7 @@ the AFS client service (afsd_service.exe).
MiniDumpWithCodeSegs = 0x00002000
-
+
-
Default: 0x0
-
-
-
- Value: RxEnablePeerStats
-
- Default: 0x0
-
-
- Value: RxEnableProcessStats
-
- Default: 0x0Regkey:
@@ -6964,9 +6965,9 @@ _Toc115416253'>Regkey:
ip address"
Default: <none>
-A.2. Integrated
+
Default: <none>
A.2. Integrated
Logon Network provider parameters
Example:
-
LogonOptions
Default: 0x01
0x01 - Integrated Logon is used
0x02 - High Security Mode is used (deprecated)
0x03 - Integrated Logon with High Security Mode is used (deprecated)A.3. AFS
+
A.3. AFS
Credentials System Tray Tool parameters
Default: <none>
Function: LoadRemind(), SaveRemind()A.4 OpenAFS
+
A.4 OpenAFS
Client Service Environment Variables