doc/txt/winnotes/registry.txt

   1 Registry keys and Environment Variables used in the Windows AFS Client
   2 as of release 1.5.0000
   3 ======================================================================
   4
   5 REGISTRY KEYS:
   6
   7 1. Service parameters
   8 ---------------------
   9
  10 The service parameters primarily affect the behavior of the AFS client
  11 service (afsd_service.exe).
  12
  13 Regkey:
  14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
  15
  16 Value   : LANadapter
  17 Type    : DWORD
  18 Default : -1
  19 Variable: LANadapter
  20
  21   LAN adapter number to use.  This is the lana number of the LAN
  22   adapter that the SMB server should bind to.  If unspecified or set
  23   to -1, a LAN adapter with named 'AFS' or a loopback adapter will be
  24   selected.  If neither are present, then all available adapters will
  25   be bound to.  When binding to a non-loopback adapter, the NetBIOS
  26   name '%hostname%-AFS' will be used (where %hostname% is the NetBIOS
  27   name of the host truncated to 11 characters). Otherwise, the NetBIOS
  28   name will be 'AFS'.
  29
  30 Value   : CacheSize
  31 Type    : DWORD
  32 Default : 98304 (CM_CONFIGDEFAULT_CACHESIZE)
  33 Variable: cm_initParams.cacheSize
  34
  35   Size of the AFS cache in 1k blocks.
  36
  37 Value   : ChunkSize
  38 Type    : DWORD
  39 Default : 17 (CM_CONFIGDEFAULT_CHUNKSIZE)
  40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
  41
  42   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
  43
  44 Value   : Daemons
  45 Type    : DWORD
  46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
  47 Variable: numBkgD
  48
  49   Number of background daemons (number of threads of
  50   cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
  51
  52 Value   : ServerThreads
  53 Type    : DWORD
  54 Default : 25 (CM_CONFIGDEFAULT_SVTHREADS)
  55 Variable: numSvThreads
  56
  57   Number of SMB server threads (number of threads of smb_Server). (see
  58   smb_Server in smb.c).
  59
  60 Value   : Stats
  61 Type    : DWORD
  62 Default : 10000 (CM_CONFIGDEFAULT_STATS)
  63 Variable: cm_initParams.nStatCaches
  64
  65   Cache configuration.
  66
  67 Value   : LogoffPreserveTokens
  68 Type    : DWORD {1,0}
  69 Default : 0
  70
  71   If enabled (set to 1), the Logoff Event handler will not attempt
  72   to delete the user's tokens if the user's profile is stored outside
  73   of AFS.
  74
  75 Value   : RootVolume
  76 Type    : REG_SZ
  77 Default : "root.afs"
  78 Variable: cm_rootVolumeName
  79
  80   Root volume name.
  81
  82 Value   : Mountroot
  83 Type    : REG_SZ
  84 Default : "/afs"
  85 Variable: cm_mountRoot
  86
  87   Name of root mount point.  In symlinks, if a path starts with
  88   cm_mountRoot, it is assumed that the path is absolute (as opposed to
  89   relative) and is adjusted accordingly. Eg: if a path is specified as
  90   /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the
  91   path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz.  If a
  92   path does not start with with cm_mountRoot, the path is assumed to
  93   be relative and suffixed to the reference directory (i.e. directory
  94   where the symlink exists)
  95
  96
  97 Value   : CachePath
  98 Type    : REG_SZ or REG_EXPAND_SZ
  99 Default : "%TEMP%\AFSCache"
 100 Variable: cm_CachePath
 101
 102   Location of on-disk cache file.  The default is the SYSTEM account's
 103   TEMP directory.  The attributes assigned to the file are HIDDEN and
 104   SYSTEM.
 105
 106
 107 Value   : NonPersistentCaching
 108 Type    : DWORD [0..1]
 109 Default : 0
 110 Variable: buf_CacheType
 111
 112   When this registry value is set to a non-zero value, the CachePath
 113   value is ignored and the cache data is stored in the windows paging
 114   file.  This prevents the use of persistent caching (when available)
 115   as well as the ability to alter the size of the cache at runtime
 116   using the "fs setcachesize" command.
 117
 118
 119 Value   : ValidateCache
 120 Type    : DWORD [0..2]
 121 Default : 1
 122 Variable: buf_CacheType
 123
 124   This value determines if and when persistent cache validation is
 125   performed.
 126     0 - Validation is disabled
 127     1 - Validation is performed at startup
 128     2 - Validation is performed at shutdown
 129
 130
 131 Value   : TrapOnPanic
 132 Type    : DWORD {1,0}
 133 Default : 0
 134 Variable: traceOnPanic
 135
 136   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
 137
 138 Value   : NetbiosName
 139 Type    : REG_EXPAND_SZ
 140 Default : "AFS"
 141 Variable: cm_NetbiosName
 142
 143   Specifies the NetBIOS name to be used when binding to a Loopback
 144   adapter.  To provide the old behavior specify a value of
 145   "%COMPUTERNAME%-AFS"
 146
 147 Value   : IsGateway
 148 Type    : DWORD {1,0}
 149 Default : 0
 150 Variable: isGateway
 151
 152   Select whether or not this AFS client should act as a gateway.  If
 153   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
 154   other machines in the subnet can access AFS via SMB connections to
 155   hostname-AFS.
 156
 157   When IsGateway is non-zero, the LAN adapter detection code will
 158   avoid binding to a loopback adapter.  This will ensure that the
 159   NetBIOS name will be of the form hostname-AFS instead of the value
 160   set by the "NetbiosName" registry value.
 161
 162 Value   : ReportSessionStartups
 163 Type    : DWORD {1,0}
 164 Default : 0
 165 Variable: reportSessionStartups
 166
 167   If enabled, all SMB sessions created are recorded in the Application
 168   event log.  This also enables other events such as drive mappings
 169   or various error types to be logged.
 170
 171 Value   : TraceBufferSize
 172 Type    : DWORD
 173 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
 174 Variable: traceBufSize
 175
 176   Number of entries to keep in trace log.
 177
 178 Value   : SysName
 179 Type    : REG_SZ
 180 Default : "i386_nt40"
 181 Variable: cm_sysName
 182
 183   Provides an initial value for "fs sysname".  The string can contain
 184   one or more replacement values for @sys in order of preference separated
 185   by whitespace.
 186
 187 Value   : SecurityLevel
 188 Type    : DWORD {1,0}
 189 Default : 0
 190 Variable: cryptall
 191
 192   Enables encryption on RX calls.
 193
 194 Value   : UseDNS
 195 Type    : DWORD {1,0}
 196 Default : 1
 197 Variable: cm_dnsEnabled
 198
 199   Enables resolving volservers using AFSDB DNS queries. (see
 200   afsdb-freelance-notes).
 201
 202   As of 1.3.60, this value is ignored as the DNS query support
 203   utilizes the Win32 DNSQuery API which is available on Win2000
 204   and above.
 205
 206 Value   : FreelanceClient
 207 Type    : DWORD {1,0}
 208 Default : 0
 209 Variable: cm_freelanceEnabled
 210
 211   Enables freelance client. (see afsdb-freelance-notes)
 212
 213 Value   : HideDotFiles
 214 Type    : DWORD {1,0}
 215 Default : 1
 216 Variable: smb_hideDotFiles
 217
 218   Enables marking dotfiles with the hidden attribute.  Dot files are
 219   files whose name starts with a period (excluding "." and "..").
 220
 221 Value   : MaxMpxRequests
 222 Type    : DWORD
 223 Default : 50
 224 Variable: smb_maxMpxRequests
 225
 226   Maximum number of multiplexed SMB requests that can be made.
 227
 228 Value   : MaxVCPerServer
 229 Type    : DWORD
 230 Default : 100
 231 Variable: smb_maxVCPerServer
 232
 233   Maximum number of SMB virtual circuits.
 234
 235 Value   : Cell
 236 Type    : REG_SZ
 237 Default : <none>
 238 Variable: rootCellName
 239
 240   Name of root cell (the cell from which root.afs should be mounted in
 241   \\afs\all).
 242
 243 Value   : RxNoJumbo
 244 Type    : DWORD {0,1}
 245 Default : 0
 246 Variable: rx_nojumbo
 247
 248   If enabled, does not send or indicate that we are able to send or
 249   receive RX jumbograms.
 250
 251 Value   : RxMaxMTU
 252 Type    : DWORD
 253 Default : -1
 254 Variable: rx_mtu
 255
 256   If set to anything other than -1, uses that value as the maximum MTU
 257   supported by the RX interface.
 258
 259   In order to enable OpenAFS to operate across the Cisco IPSec VPN
 260   client, this value must be set to 1264 or smaller.
 261
 262 Value   : ConnDeadTimeout
 263 Type    : DWORD
 264 Default : 60 (seconds)
 265 Variable: ConnDeadtimeout
 266
 267   The Connection Dead Time is enforced to be at a minimum 15 seconds
 268   longer than the minimum SMB timeout as specified by
 269
 270   HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
 271     SessTimeout
 272
 273   If the minimum SMB timeout is not specified the value is 45 seconds.
 274   See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
 275
 276
 277 Value   : HardDeadTimeout
 278 Type    : DWORD
 279 Default : 120 (seconds)
 280 Variable: HardDeadtimeout
 281
 282   The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
 283   The provides an opportunity for at least one retry.
 284
 285
 286 Value  : TraceOption
 287 Type   : DWORD {0-15}
 288 Default : 0
 289
 290   Enables logging of debug output to the Windows Event Log.
 291   Bit 0 enables logging of "Logon Events" processed by the Network Provider
 292   and Winlogon Event Notification Handler.
 293   Bit 1 enables logging of events captured by the AFS Client Service.
 294   Bit 2 enables real-time viewing of "fs trace" logging with DbgView
 295   or similar tools.
 296   Bit 3 enables "fs trace" logging on startup.
 297
 298 Value   : AllSubmount
 299 Type    : DWORD {0, 1}
 300 Default : 1
 301 Variable: allSubmount (smb.c)
 302
 303   By setting this value to 0, the "\\NetbiosName\all" mount point
 304   will not be created.  This allows the read-write versions of
 305   root.afs to be hidden.
 306
 307 Value   : NoFindLanaByName
 308 Type    : DWORD {0, 1}
 309 Default : 0
 310
 311   Disables the attempt to identity the network adapter to use by
 312   looking for an adapter with a display name of "AFS".
 313
 314 Value   : MaxCPUs
 315 Type    : DWORD {1..32} or {1..64} depending on the architecture
 316 Default : <no default>
 317
 318   If this value is specified, afsd_service.exe will restrict itself
 319   to executing on the specified number of CPUs if there are a greater
 320   number installed in the machine.
 321
 322   NOTE: Setting this entry to "1" may be required on hyperthreaded
 323   systems to avoid crashes in the RX library.
 324
 325 Value   : smbAuthType
 326 Type    : DWORD {0..2}
 327 Default : 2
 328
 329   If this value is specified, it defines the type of SMB authentication
 330   which must be present in order for the Windows SMB client to connect
 331   to the AFS Client Service's SMB server.  The values are:
 332     0 = No authentication required
 333     1 = NTLM authentication required
 334     2 = Extended (GSS SPNEGO) authentication required
 335   The default is Extended authentication
 336
 337 Value   : MaxLogSize
 338 Type    : DWORD {0 .. MAXDWORD}
 339 Default : 100K
 340
 341   This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log
 342   file.  If the file is larger than this value when afsd_service.exe starts
 343   the file will be reset to 0 bytes.  If this value is 0, it means the file
 344   should be allowed to grow indefinitely.
 345
 346 Value   : FlushOnHibernate
 347 Type    : DWORD {0,1}
 348 Default : 1
 349
 350   If set, flushes all volumes before the machine goes on hibernate or
 351   stand-by.
 352
 353 Regkey:
 354 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
 355
 356 Value   : <Drive Letter:> for example "G:"
 357 Type    : SZ
 358
 359     Specifies the submount name to be mapped by afsd_service.exe at startup
 360     to the provided drive letter.
 361
 362
 363 Regkey:
 364 [HKLM\SOFTWARE\OpenAFS\Client]
 365
 366 Value   : CellServDBDir
 367 Type    : REG_SZ
 368 Default : <not defined>
 369
 370   Specifies the directory containing the CellServDB file.
 371   When this value is not specified, the AFS Client install
 372   directory is used.
 373
 374
 375 Value   : VerifyServiceSignature
 376 Type    : REG_DWORD
 377 Default : 0x1
 378
 379   This value can be used to disable the runtime verification of
 380   the digital signatures applied to afsd_service.exe and the
 381   OpenAFS DLLs it loads.  This test is performed to verify that
 382   the DLLs which are loaded by afsd_service.exe are from the
 383   same distribution as afsd_service.exe.  This is to prevent
 384   random errors caused when DLLs from one distribution of AFS
 385   are loaded by another one.  This is not a security test.  The
 386   reason for disabling this test is to free up additional memory
 387   which can be used for a large cache size.
 388
 389
 390 Value   : IoctlDebug
 391 Type    : REG_DWORD
 392 Default : 0x0
 393
 394   This value can be used to debug the cause of pioctl() failures.
 395   Set a non-zero value and the pioctl() library will output status
 396   information to stdout.  Executing command line tools such as
 397   tokens.exe, fs.exe, etc can then be used to determine why the
 398   pioctl() call is failing.
 399
 400
 401 Value   : MiniDumpType
 402 Type    : REG_DWORD
 403 Default : 0x0 (MiniDumpNormal)
 404
 405   This value is used to specify the type of minidump generated by
 406   afsd_service.exe either when the process crashes or when a user
 407   initiated is dump file is generated with the "fs.exe minidump"
 408   command.
 409
 410   Valid values are dependent on the version of DbgHelp.dll installed
 411   on the machine.  See the Microsoft Developer Library for further
 412   information.
 413
 414   MiniDumpNormal = 0x00000000,
 415   MiniDumpWithDataSegs = 0x00000001,
 416   MiniDumpWithFullMemory = 0x00000002,
 417   MiniDumpWithHandleData = 0x00000004,
 418   MiniDumpFilterMemory = 0x00000008,
 419   MiniDumpScanMemory = 0x00000010,
 420   MiniDumpWithUnloadedModules = 0x00000020,
 421   MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
 422   MiniDumpFilterModulePaths = 0x00000080,
 423   MiniDumpWithProcessThreadData = 0x00000100,
 424   MiniDumpWithPrivateReadWriteMemory = 0x00000200,
 425   MiniDumpWithoutOptionalData = 0x00000400,
 426   MiniDumpWithFullMemoryInfo = 0x00000800,
 427   MiniDumpWithThreadInfo = 0x00001000,
 428   MiniDumpWithCodeSegs = 0x00002000
 429
 430
 431 Value   : StoreAnsiFilenames
 432 Type    : REG_DWORD
 433 Default : 0x0
 434
 435   This value can be used to force the AFS Client Service to
 436   store filenames using the Windows system's ANSI character set
 437   instead of the OEM Code Page character set which has traditionally
 438   been used by SMB file systems.
 439
 440   Note: The use of ANSI characters will render access to files
 441   with 8-bit OEM file names unaccessible from Windows.  This option
 442   is of use primarily when you wish to allow file names produced
 443   on Windows to be accessible from Latin-1 Unix systems and vice
 444   versa.
 445
 446
 447 Regkey:
 448 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
 449
 450 Value   : "smb/cifs share name"
 451 Type    : REG_SZ
 452 Default : <none>
 453
 454     This key is used to map SMB/CIFS shares to Client Side Caching
 455     (off-line access) policies. For each share one of the following
 456     policies may be used: "manual", "programs", "documents", "disable"
 457
 458     These values used to be stored in afsdsbmt.ini
 459
 460 Regkey:
 461 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
 462
 463 Value   : "numeric value"
 464 Type    : REG_SZ
 465 Default : <none>
 466
 467     This key is used to store dot terminated mount point strings
 468     for use in constructing the fake root.afs volume when Freelance
 469     (dynamic roots) mode is activated.
 470
 471         "athena.mit.edu#athena.mit.edu:root.cell."
 472         ".athena.mit.edu%athena.mit.edu:root.cell."
 473
 474     These values used to be stored in afs_freelance.ini
 475
 476
 477 Regkey:
 478 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
 479
 480 Value   : "numeric value"
 481 Type    : REG_SZ
 482 Default : <none>
 483
 484     This key is used to store a dot terminated symlink strings
 485     for use in constructing the fake root.afs volume when Freelance
 486     (dynamic roots) mode is activated.
 487
 488         "linkname:destination-path."
 489         "athena:athena.mit.edu."
 490         "home:athena.mit.edu\user\j\a\jaltman."
 491         "filename:path\file."
 492
 493
 494 Regkey:
 495 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
 496
 497 Value   : "submount name"
 498 Type    : REG_EXPAND_SZ
 499 Default : <none>
 500
 501     This key is used to store mappings of unix style AFS paths
 502     to submount names which can be referenced as UNC paths.
 503     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
 504     can be associated with the submount name "jaltman.home".
 505     This can then be referenced as the UNC path \\AFS\jaltman.home.
 506
 507     These values used to be stored in afsdsbmt.ini
 508
 509     NOTE: Submounts should no longer be used with OpenAFS.
 510     Use the Windows Explorer to create drive mappings to AFS UNC
 511     paths instead of using the AFS Submount mechanism.
 512
 513
 514 Regkey:
 515 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
 516
 517 Value   : "hostname or ip address"
 518 Type    : REG_DWORD
 519 Default : <none>
 520
 521     This key is used to specify a default set of VLDB server preferences.
 522     For each entry the value name will be either the IP address of a server
 523     or a fully qualified domain name.  The value will be the ranking.  The
 524     ranking will be adjusted by a random value between 0 and 256 prior to
 525     the preference being set.
 526
 527
 528 Regkey:
 529 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
 530
 531 Value   : "hostname or ip address"
 532 Type    : REG_DWORD
 533 Default : <none>
 534
 535     This key is used to specify a default set of File server preferences.
 536     For each entry the value name will be either the IP address of a server
 537     or a fully qualified domain name.  The value will be the ranking.  The
 538     ranking will be adjusted by a random value between 0 and 256 prior to
 539     the preference being set.
 540
 541
 542
 543 2. Network provider parameters
 544 ------------------------------
 545 Affects the network provider (afslogon.dll).
 546
 547 Regkey:
 548 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
 549
 550 Value   : FailLoginsSilently
 551 Type    : DWORD
 552 Default : 0
 553
 554   Do not display message boxes if the login fails.
 555
 556 Regkey:
 557 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
 558
 559 Value   : NoWarnings
 560 Type    : DWORD
 561 Default : 0
 562
 563   Disables visible warnings during logon.
 564
 565 Value   : AuthentProviderPath
 566 Type    : REG_SZ
 567 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
 568
 569   Specifies the install location of the authentication provider dll.
 570
 571 Value   : Class
 572 Type    : DWORD
 573 NSIS    : 0x02
 574
 575   Specifies the class of network provider
 576
 577 Value   : DependOnGroup
 578 Type    : REG_MULTI_SZ
 579 NSIS    : PNP_TDI
 580
 581   Specifies the service groups upon which the AFS Client Service
 582   depends.  Windows should not attempt to start the AFS Client Service
 583   until all of the services within these groups have successfully
 584   started.
 585
 586 Value   : DependOnService
 587 Type    : REG_MULTI_SZ
 588 NSIS    : Tcpip NETBIOS RpcSs
 589
 590   Specifies a list of services upon which the AFS Client Service
 591   depends.  Windows should not attempt to start the AFS Client Service
 592   until all of the specified services have successfully started.
 593
 594 Value   : Name
 595 Type    : REG_SZ
 596 NSIS    : "OpenAFSDaemon"
 597
 598   Specifies the display name of the AFS Client Service
 599
 600 Value   : ProviderPath
 601 Type    : REG_SZ
 602 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
 603
 604   Specifies the DLL to use for the network provider
 605
 606
 607 2.1 Domain specific configuration keys for the Network Provider
 608 ---------------------------------------------------------------
 609
 610 The network provider can be configured to have different behavior
 611 depending on the domain that the user logs into.  These settings are
 612 only relevant when using integrated login.  A domain refers to an
 613 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
 614 local machine (i.e. local account logins).  The domain name that is
 615 used for selecting the domain would be the domain that is passed into
 616 the NPLogonNotify function of the network provider.
 617
 618 Domain specific registry keys are :
 619
 620 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
 621   (NP key)
 622
 623 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
 624   (Domains key)
 625
 626 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
 627   (Specific domain key. One per domain.)
 628
 629 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
 630   (Localhost key)
 631
 632 eg:
 633  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
 634   |
 635   +- Domain
 636      +-AD1.EXAMPLE.COM
 637      +-AD2.EXAMPLE.NET
 638      +-LOCALHOST
 639
 640 Each of the domain specific keys can have the set of values described
 641 in 2.1.1.  The effective values are chosen as described in 2.1.2.
 642
 643 2.1.1  Domain specific configuration values
 644 -------------------------------------------
 645 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
 646 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
 647 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
 648 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
 649
 650   Value   : LogonOptions
 651   Type    : DWORD
 652   Default : 0x01
 653   NSIS/WiX: depends on user configuration
 654
 655   0x00 - Integrated Logon is not used
 656   0x01 - Integrated Logon is used
 657   0x02 - High Security Mode is used
 658   0x03 - Integrated Logon with High Security Mode is used
 659
 660   High Security Mode generates random SMB names for the creation of
 661   Drive Mappings.  This mode should not be used without Integrated Logon.
 662
 663   As of 1.3.65 the SMB server supports SMB authentication.  The High
 664   Security Mode should not be used when using SMB authentication
 665   (SMBAuthType setting is non zero).
 666
 667   Value   : FailLoginsSilently
 668   Type    : DWORD (1|0)
 669   Default : 0
 670   NSIS/WiX: (not set)
 671
 672      If true, does not display any visible warnings in the event of an
 673      error during the integrated login process.
 674
 675   Value   : LogonScript
 676   Type    : REG_SZ or REG_EXPAND_SZ
 677   Default : (null)
 678   NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
 679
 680      A logon script that will be scheduled to be run after the profile
 681      load is complete.  If using the REG_EXPAND_SZ type, you can use
 682      any system environment variable as "%varname%" which would be
 683      expanded at the time the network provider is run.  Optionally
 684      using a "%s" in the value would result in it being expanded into
 685      the AFS SMB username for the session.
 686
 687   Value   : LoginRetryInterval
 688   Type    : DWORD
 689   Default : 30
 690   NSIS/WiX: (not set)
 691
 692      If the OpenAFS client service has not started yet, the network
 693      provider will wait for a maximum of "LoginRetryInterval" seconds
 694      while retrying every "LoginSleepInterval" seconds to check if the
 695      service is up.
 696
 697   Value   : LoginSleepInterval
 698   Type    : DWORD
 699   Default : 5
 700   NSIS/WiX: (not set)
 701
 702      See description of LoginRetryInterval.
 703
 704   Value   : TheseCells
 705   Type    : REG_MULTI_SZ
 706   NSIS    : <not set>
 707
 708     When Kerberos 5 is being used, TheseCells provides a list of additional
 709     cells for which tokens should be obtained with the default Kerberos 5
 710     principal.
 711
 712
 713 2.1.2  Selection of effective values for domain specific configuration
 714 ----------------------------------------------------------------------
 715
 716   During login to domain X, where X is the domain passed into
 717   NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
 718   'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
 719   computer, the following keys will be looked up.
 720
 721     1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
 722     2. Domains key. (NP key\"Domain")
 723     3. Specific domain key. (Domains key\X)
 724
 725   If the specific domain key does not exist, then the domains key will
 726   be ignored.  All the configuration information in this case will
 727   come from the NP key.
 728
 729   If the specific domain key exists, then for each of the values
 730   metioned in (2), they will be looked up in the specific domain key,
 731   domains key and the NP key successively until the value is found.
 732   The first instance of the value found this way will be the effective
 733   for the login session.  If no such instance can be found, the
 734   default will be used.  To re-iterate, a value in a more specific key
 735   supercedes a value in a less specific key.  The exceptions to this
 736   rule are stated below.
 737
 738 2.1.3  Exceptions to 2.1.2
 739 --------------------------
 740
 741   To retain backwards compatibility, the following exceptions are made
 742   to 2.1.2.
 743
 744 2.1.3.1 'FailLoginsSilently'
 745
 746   Historically, the 'FailLoginsSilently' value was in
 747   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
 748   key and not in the NP key.  Therefore, for backwards compatibility,
 749   the value in the Parameters key will supercede all instances of this
 750   value in other keys.  In the absence of this value in the Parameters
 751   key, normal scope rules apply.
 752
 753 2.1.3.2 'LogonScript'
 754
 755   If a 'LogonScript' is not specified in the specific domain key nor
 756   in the domains key, the value in the NP key will only be checked if
 757   the effective 'LogonOptions' specify a high security integrated
 758   login.  If a logon script is specified in the specific domain key or
 759   the domains key, it will be used regardless of the high security
 760   setting.  Please be aware of this when setting this value.
 761
 762
 763 3. AFS Credentials System Tray Tool parameters
 764 ----------------------------------------------
 765 Affects the behavior of afscreds.exe
 766
 767 Regkey:
 768 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
 769
 770 Value   : Gateway
 771 Type    : REG_SZ
 772 Default : ""
 773 Function: GetGatewayName()
 774
 775   If the AFS client is utilizing a gateway to obtain AFS access,
 776   the name of the gateway is specified by this value.
 777
 778 Value   : Cell
 779 Type    : REG_SZ
 780 Default : <none>
 781 Variable: IsServiceConfigured()
 782
 783   The value Cell is used to determine if the AFS Client Service has
 784   been properly configured or not.
 785
 786
 787 Regkey:
 788 [HKLM\SOFTWARE\OpenAFS\Client]
 789 [HKCU\SOFTWARE\OpenAFS\Client]
 790
 791 Value   : ShowTrayIcon
 792 Type    : DWORD {0, 1}
 793 Default : 1
 794 Function: InitApp(), Main_OnCheckTerminate()
 795
 796   This value is used to determine whether or not a shortcut should be
 797   maintained in the user's Start Menu->Programs->Startup folder.
 798
 799   This value used to be stored at
 800   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 801
 802   The current user value is checked first; if it does not exist the local
 803   machine value is checked.
 804
 805
 806 Value   : EnableKFW
 807 Type    : DWORD {0, 1}
 808 Default : 1
 809 Function: KFW_is_available()
 810
 811   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
 812   to obtain AFS credentials.  By setting this value to 0, the internal
 813   Kerberos 4 implementation will be used instead.  The current user value
 814   is checked first; if it does not exist the local machine value is checked.
 815
 816 Value   : Use524
 817 Type    : DWORD {0, 1}
 818 Default : 0
 819 Function: KFW_use_krb524()
 820
 821   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
 822   to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
 823   tickets will be converted to Kerberos 4 tokens via a call to the krb524
 824   daemon.  The current user value is checked first; if it does not exist
 825   the local machine value is checked.
 826
 827 Value   : AfscredsShortcutParams
 828 Type    : REG_SZ
 829 Default : "-A -M -N -Q"
 830 Function: Shortcut_FixStartup
 831
 832   This value specifies the command line options which should be set
 833   as part of the shortcut to afscreds.exe.  afscreds.exe rewrites the
 834   shortcut each time it exits so as to ensure that the shortcut points
 835   to the latest version of the program.  This value is used to determine
 836   which values should be used for command line parameters.  The current
 837   user value is checked first; if it does not exist the local machine
 838   value is checked.
 839
 840   The following subset of the command line options are appropriate for
 841   use in this registry setting:
 842
 843     -A = autoinit
 844     -M = renew drive maps
 845     -N = ip address change detection
 846     -Q = quiet mode.  do not display start service dialog
 847          if afsd_service is not already running
 848     -S = show tokens dialog on startup
 849     -Z = unmap drives
 850
 851
 852 Regkey:
 853 [HKCU\SOFTWARE\OpenAFS\Client]
 854
 855 Value   : Authentication Cell
 856 Type    : REG_SZ
 857 Default : <none>
 858 Function: Afscreds.exe GetDefaultCell()
 859
 860   This value allows the user to configure a different cell name to
 861   be used as the default cell when acquiring tokens in afscreds.exe
 862
 863
 864 Regkey:
 865 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
 866
 867 Value   : "afs cell name"
 868 Type    : DWORD {0, 1}
 869 Default : <none>
 870 Function: LoadRemind(), SaveRemind()
 871
 872   These values are used to save and restore the state of the reminder
 873   flag for each cell for which the user has obtained tokens.
 874
 875   This value used to be stored at
 876   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 877
 878
 879 Regkey:
 880 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
 881
 882 Value   : "upper case drive letter"
 883 Type    : DWORD {0, 1}
 884 Default : <none>
 885
 886   These values are used to store the persistence state of the AFS
 887   drive mappings as listed in the [...\Client\Mappings] key
 888
 889   These values used to be stored in the afsdsbmt.ini file
 890
 891 Regkey:
 892 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
 893
 894 Value   : "upper case drive letter"
 895 Type    : REG_SZ
 896 Default : <none>
 897
 898   These values are used to store the AFS path in Unix notation
 899   to which the drive letter is to be mapped.
 900
 901   These values used to be stored in the afsdsbmt.ini file.
 902
 903
 904 ENVIRONMENT VARIABLES:
 905
 906 Variable: AFS_RPC_ENCRYPT
 907 Values:   "OFF" disables the use of RPC encryption
 908           any other value allows RPC encryption to be used
 909 Default:  RPC encryption is on
 910
 911
 912 Variable: AFS_RPC_PROTSEQ
 913 Values:   "ncalrpc"  - local RPC
 914           "ncacn_np" - named pipes
 915           "ncacn_ip_tcp" - tcp/ip
 916 Default:  local RPC
 917