windows-trace-log-to-dbgview-20050820
[openafs.git] / 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-7}
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
297 Value   : AllSubmount
298 Type    : DWORD {0, 1}
299 Default : 1
300 Variable: allSubmount (smb.c)
301
302   By setting this value to 0, the "\\NetbiosName\all" mount point 
303   will not be created.  This allows the read-write versions of 
304   root.afs to be hidden.
305
306 Value   : NoFindLanaByName
307 Type    : DWORD {0, 1}
308 Default : 0
309
310   Disables the attempt to identity the network adapter to use by 
311   looking for an adapter with a display name of "AFS".
312
313 Value   : MaxCPUs
314 Type    : DWORD {1..32} or {1..64} depending on the architecture
315 Default : <no default>
316
317   If this value is specified, afsd_service.exe will restrict itself
318   to executing on the specified number of CPUs if there are a greater
319   number installed in the machine.  
320
321   NOTE: Setting this entry to "1" may be required on hyperthreaded 
322   systems to avoid crashes in the RX library.
323
324 Value   : smbAuthType
325 Type    : DWORD {0..2} 
326 Default : 2
327
328   If this value is specified, it defines the type of SMB authentication    
329   which must be present in order for the Windows SMB client to connect
330   to the AFS Client Service's SMB server.  The values are:
331     0 = No authentication required
332     1 = NTLM authentication required
333     2 = Extended (GSS SPNEGO) authentication required
334   The default is Extended authentication
335
336 Value   : MaxLogSize
337 Type    : DWORD {0 .. MAXDWORD}
338 Default : 100K
339
340   This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log 
341   file.  If the file is larger than this value when afsd_service.exe starts
342   the file will be reset to 0 bytes.  If this value is 0, it means the file
343   should be allowed to grow indefinitely.
344
345 Value   : FlushOnHibernate
346 Type    : DWORD {0,1}
347 Default : 1
348
349   If set, flushes all volumes before the machine goes on hibernate or
350   stand-by.
351
352 Regkey:
353 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
354
355 Value   : <Drive Letter:> for example "G:"
356 Type    : SZ
357
358     Specifies the submount name to be mapped by afsd_service.exe at startup
359     to the provided drive letter.
360
361
362 Regkey:
363 [HKLM\SOFTWARE\OpenAFS\Client]
364
365 Value   : CellServDBDir
366 Type    : REG_SZ
367 Default : <not defined>
368
369   Specifies the directory containing the CellServDB file.
370   When this value is not specified, the AFS Client install
371   directory is used.
372
373
374 Value   : VerifyServiceSignature
375 Type    : REG_DWORD
376 Default : 0x1
377
378   This value can be used to disable the runtime verification of 
379   the digital signatures applied to afsd_service.exe and the 
380   OpenAFS DLLs it loads.  This test is performed to verify that 
381   the DLLs which are loaded by afsd_service.exe are from the 
382   same distribution as afsd_service.exe.  This is to prevent
383   random errors caused when DLLs from one distribution of AFS
384   are loaded by another one.  This is not a security test.  The
385   reason for disabling this test is to free up additional memory
386   which can be used for a large cache size.
387
388
389 Value   : IoctlDebug
390 Type    : REG_DWORD
391 Default : 0x0
392
393   This value can be used to debug the cause of pioctl() failures.
394   Set a non-zero value and the pioctl() library will output status
395   information to stdout.  Executing command line tools such as
396   tokens.exe, fs.exe, etc can then be used to determine why the
397   pioctl() call is failing. 
398
399
400 Value   : MiniDumpType
401 Type    : REG_DWORD
402 Default : 0x0 (MiniDumpNormal)
403
404   This value is used to specify the type of minidump generated by
405   afsd_service.exe either when the process crashes or when a user
406   initiated is dump file is generated with the "fs.exe minidump"
407   command.
408
409   Valid values are dependent on the version of DbgHelp.dll installed
410   on the machine.  See the Microsoft Developer Library for further
411   information.
412
413   MiniDumpNormal = 0x00000000,
414   MiniDumpWithDataSegs = 0x00000001,
415   MiniDumpWithFullMemory = 0x00000002,
416   MiniDumpWithHandleData = 0x00000004,
417   MiniDumpFilterMemory = 0x00000008,
418   MiniDumpScanMemory = 0x00000010,
419   MiniDumpWithUnloadedModules = 0x00000020,
420   MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
421   MiniDumpFilterModulePaths = 0x00000080,
422   MiniDumpWithProcessThreadData = 0x00000100,
423   MiniDumpWithPrivateReadWriteMemory = 0x00000200,
424   MiniDumpWithoutOptionalData = 0x00000400,
425   MiniDumpWithFullMemoryInfo = 0x00000800,
426   MiniDumpWithThreadInfo = 0x00001000,
427   MiniDumpWithCodeSegs = 0x00002000
428
429
430 Value   : StoreAnsiFilenames
431 Type    : REG_DWORD
432 Default : 0x0
433
434   This value can be used to force the AFS Client Service to
435   store filenames using the Windows system's ANSI character set
436   instead of the OEM Code Page character set which has traditionally
437   been used by SMB file systems.  
438
439   Note: The use of ANSI characters will render access to files
440   with 8-bit OEM file names unaccessible from Windows.  This option
441   is of use primarily when you wish to allow file names produced
442   on Windows to be accessible from Latin-1 Unix systems and vice
443   versa.
444
445
446 Regkey:
447 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
448
449 Value   : "smb/cifs share name"
450 Type    : REG_SZ
451 Default : <none>
452
453     This key is used to map SMB/CIFS shares to Client Side Caching 
454     (off-line access) policies. For each share one of the following
455     policies may be used: "manual", "programs", "documents", "disable"
456
457     These values used to be stored in afsdsbmt.ini
458
459 Regkey:
460 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
461
462 Value   : "numeric value"
463 Type    : REG_SZ
464 Default : <none>
465
466     This key is used to store dot terminated mount point strings 
467     for use in constructing the fake root.afs volume when Freelance
468     (dynamic roots) mode is activated.
469
470         "athena.mit.edu#athena.mit.edu:root.cell."
471         ".athena.mit.edu%athena.mit.edu:root.cell."
472
473     These values used to be stored in afs_freelance.ini
474
475
476 Regkey:
477 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
478
479 Value   : "numeric value"
480 Type    : REG_SZ
481 Default : <none>
482
483     This key is used to store a dot terminated symlink strings 
484     for use in constructing the fake root.afs volume when Freelance
485     (dynamic roots) mode is activated.
486
487         "linkname:destination-path."
488         "athena:athena.mit.edu."
489         "home:athena.mit.edu\user\j\a\jaltman."
490         "filename:path\file."
491
492
493 Regkey:
494 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
495
496 Value   : "submount name"
497 Type    : REG_EXPAND_SZ
498 Default : <none>
499
500     This key is used to store mappings of unix style AFS paths
501     to submount names which can be referenced as UNC paths.
502     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
503     can be associated with the submount name "jaltman.home".
504     This can then be referenced as the UNC path \\AFS\jaltman.home.
505
506     These values used to be stored in afsdsbmt.ini
507
508     NOTE: Submounts should no longer be used with OpenAFS.
509     Use the Windows Explorer to create drive mappings to AFS UNC
510     paths instead of using the AFS Submount mechanism.
511
512
513 Regkey:
514 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
515
516 Value   : "hostname or ip address"
517 Type    : REG_DWORD
518 Default : <none>
519
520     This key is used to specify a default set of VLDB server preferences.
521     For each entry the value name will be either the IP address of a server
522     or a fully qualified domain name.  The value will be the ranking.  The
523     ranking will be adjusted by a random value between 0 and 256 prior to
524     the preference being set.
525
526
527 Regkey:
528 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
529
530 Value   : "hostname or ip address"
531 Type    : REG_DWORD
532 Default : <none>
533
534     This key is used to specify a default set of File server preferences.
535     For each entry the value name will be either the IP address of a server
536     or a fully qualified domain name.  The value will be the ranking.  The
537     ranking will be adjusted by a random value between 0 and 256 prior to
538     the preference being set.
539
540
541
542 2. Network provider parameters
543 ------------------------------
544 Affects the network provider (afslogon.dll).
545
546 Regkey:
547 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
548
549 Value   : FailLoginsSilently
550 Type    : DWORD
551 Default : 0
552
553   Do not display message boxes if the login fails.
554
555 Regkey:
556 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
557
558 Value   : NoWarnings
559 Type    : DWORD
560 Default : 0
561
562   Disables visible warnings during logon.
563
564 Value   : AuthentProviderPath
565 Type    : REG_SZ
566 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
567
568   Specifies the install location of the authentication provider dll.
569
570 Value   : Class
571 Type    : DWORD
572 NSIS    : 0x02
573
574   Specifies the class of network provider
575
576 Value   : DependOnGroup
577 Type    : REG_MULTI_SZ
578 NSIS    : PNP_TDI
579
580   Specifies the service groups upon which the AFS Client Service 
581   depends.  Windows should not attempt to start the AFS Client Service
582   until all of the services within these groups have successfully 
583   started.
584
585 Value   : DependOnService
586 Type    : REG_MULTI_SZ
587 NSIS    : Tcpip NETBIOS RpcSs
588
589   Specifies a list of services upon which the AFS Client Service 
590   depends.  Windows should not attempt to start the AFS Client Service
591   until all of the specified services have successfully started.
592   
593 Value   : Name
594 Type    : REG_SZ
595 NSIS    : "OpenAFSDaemon"
596
597   Specifies the display name of the AFS Client Service
598
599 Value   : ProviderPath
600 Type    : REG_SZ
601 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
602
603   Specifies the DLL to use for the network provider
604
605
606 2.1 Domain specific configuration keys for the Network Provider
607 ---------------------------------------------------------------
608
609 The network provider can be configured to have different behavior
610 depending on the domain that the user logs into.  These settings are
611 only relevant when using integrated login.  A domain refers to an
612 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
613 local machine (i.e. local account logins).  The domain name that is
614 used for selecting the domain would be the domain that is passed into
615 the NPLogonNotify function of the network provider.
616
617 Domain specific registry keys are :
618
619 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
620   (NP key)
621
622 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
623   (Domains key)
624
625 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
626   (Specific domain key. One per domain.)
627
628 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
629   (Localhost key)
630
631 eg:
632  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
633   |
634   +- Domain
635      +-AD1.EXAMPLE.COM
636      +-AD2.EXAMPLE.NET
637      +-LOCALHOST
638
639 Each of the domain specific keys can have the set of values described
640 in 2.1.1.  The effective values are chosen as described in 2.1.2.
641
642 2.1.1  Domain specific configuration values
643 -------------------------------------------
644 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
645 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
646 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
647 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
648
649   Value   : LogonOptions
650   Type    : DWORD
651   Default : 0x01
652   NSIS/WiX: depends on user configuration
653
654   0x00 - Integrated Logon is not used
655   0x01 - Integrated Logon is used
656   0x02 - High Security Mode is used
657   0x03 - Integrated Logon with High Security Mode is used
658
659   High Security Mode generates random SMB names for the creation of
660   Drive Mappings.  This mode should not be used without Integrated Logon.
661
662   As of 1.3.65 the SMB server supports SMB authentication.  The High
663   Security Mode should not be used when using SMB authentication
664   (SMBAuthType setting is non zero).
665
666   Value   : FailLoginsSilently
667   Type    : DWORD (1|0)
668   Default : 0
669   NSIS/WiX: (not set)
670
671      If true, does not display any visible warnings in the event of an
672      error during the integrated login process.
673
674   Value   : LogonScript
675   Type    : REG_SZ or REG_EXPAND_SZ
676   Default : (null)
677   NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
678
679      A logon script that will be scheduled to be run after the profile
680      load is complete.  If using the REG_EXPAND_SZ type, you can use
681      any system environment variable as "%varname%" which would be
682      expanded at the time the network provider is run.  Optionally
683      using a "%s" in the value would result in it being expanded into
684      the AFS SMB username for the session.
685
686   Value   : LoginRetryInterval
687   Type    : DWORD
688   Default : 30
689   NSIS/WiX: (not set)
690
691      If the OpenAFS client service has not started yet, the network
692      provider will wait for a maximum of "LoginRetryInterval" seconds
693      while retrying every "LoginSleepInterval" seconds to check if the
694      service is up.
695
696   Value   : LoginSleepInterval
697   Type    : DWORD
698   Default : 5
699   NSIS/WiX: (not set)
700
701      See description of LoginRetryInterval.
702
703   Value   : TheseCells
704   Type    : REG_MULTI_SZ
705   NSIS    : <not set>
706
707     When Kerberos 5 is being used, TheseCells provides a list of additional
708     cells for which tokens should be obtained with the default Kerberos 5 
709     principal.
710
711
712 2.1.2  Selection of effective values for domain specific configuration
713 ----------------------------------------------------------------------
714
715   During login to domain X, where X is the domain passed into
716   NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
717   'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
718   computer, the following keys will be looked up.
719
720     1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
721     2. Domains key. (NP key\"Domain")
722     3. Specific domain key. (Domains key\X)
723
724   If the specific domain key does not exist, then the domains key will
725   be ignored.  All the configuration information in this case will
726   come from the NP key.
727
728   If the specific domain key exists, then for each of the values
729   metioned in (2), they will be looked up in the specific domain key,
730   domains key and the NP key successively until the value is found.
731   The first instance of the value found this way will be the effective
732   for the login session.  If no such instance can be found, the
733   default will be used.  To re-iterate, a value in a more specific key
734   supercedes a value in a less specific key.  The exceptions to this
735   rule are stated below.
736
737 2.1.3  Exceptions to 2.1.2
738 --------------------------
739
740   To retain backwards compatibility, the following exceptions are made
741   to 2.1.2.
742
743 2.1.3.1 'FailLoginsSilently'
744
745   Historically, the 'FailLoginsSilently' value was in
746   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
747   key and not in the NP key.  Therefore, for backwards compatibility,
748   the value in the Parameters key will supercede all instances of this
749   value in other keys.  In the absence of this value in the Parameters
750   key, normal scope rules apply.
751
752 2.1.3.2 'LogonScript'
753
754   If a 'LogonScript' is not specified in the specific domain key nor
755   in the domains key, the value in the NP key will only be checked if
756   the effective 'LogonOptions' specify a high security integrated
757   login.  If a logon script is specified in the specific domain key or
758   the domains key, it will be used regardless of the high security
759   setting.  Please be aware of this when setting this value.
760
761
762 3. AFS Credentials System Tray Tool parameters
763 ----------------------------------------------
764 Affects the behavior of afscreds.exe
765
766 Regkey:
767 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
768
769 Value   : Gateway
770 Type    : REG_SZ
771 Default : ""
772 Function: GetGatewayName()
773
774   If the AFS client is utilizing a gateway to obtain AFS access, 
775   the name of the gateway is specified by this value.
776
777 Value   : Cell
778 Type    : REG_SZ
779 Default : <none>
780 Variable: IsServiceConfigured()
781
782   The value Cell is used to determine if the AFS Client Service has
783   been properly configured or not.
784
785
786 Regkey:
787 [HKLM\SOFTWARE\OpenAFS\Client]
788 [HKCU\SOFTWARE\OpenAFS\Client]
789
790 Value   : ShowTrayIcon
791 Type    : DWORD {0, 1}
792 Default : 1
793 Function: InitApp(), Main_OnCheckTerminate()
794
795   This value is used to determine whether or not a shortcut should be
796   maintained in the user's Start Menu->Programs->Startup folder. 
797
798   This value used to be stored at 
799   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
800
801   The current user value is checked first; if it does not exist the local 
802   machine value is checked.
803
804
805 Value   : EnableKFW
806 Type    : DWORD {0, 1}
807 Default : 1
808 Function: KFW_is_available()
809
810   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
811   to obtain AFS credentials.  By setting this value to 0, the internal
812   Kerberos 4 implementation will be used instead.  The current user value 
813   is checked first; if it does not exist the local machine value is checked.
814
815 Value   : Use524
816 Type    : DWORD {0, 1}
817 Default : 0
818 Function: KFW_use_krb524()
819
820   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
821   to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
822   tickets will be converted to Kerberos 4 tokens via a call to the krb524
823   daemon.  The current user value is checked first; if it does not exist 
824   the local machine value is checked.
825
826 Value   : AfscredsShortcutParams
827 Type    : REG_SZ
828 Default : "-A -M -N -Q"
829 Function: Shortcut_FixStartup
830
831   This value specifies the command line options which should be set
832   as part of the shortcut to afscreds.exe.  afscreds.exe rewrites the 
833   shortcut each time it exits so as to ensure that the shortcut points
834   to the latest version of the program.  This value is used to determine
835   which values should be used for command line parameters.  The current
836   user value is checked first; if it does not exist the local machine
837   value is checked.
838
839   The following subset of the command line options are appropriate for
840   use in this registry setting:
841
842     -A = autoinit 
843     -M = renew drive maps 
844     -N = ip address change detection 
845     -Q = quiet mode.  do not display start service dialog
846          if afsd_service is not already running
847     -S = show tokens dialog on startup
848     -Z = unmap drives
849
850
851 Regkey:
852 [HKCU\SOFTWARE\OpenAFS\Client]
853
854 Value   : Authentication Cell
855 Type    : REG_SZ
856 Default : <none>
857 Function: Afscreds.exe GetDefaultCell()
858
859   This value allows the user to configure a different cell name to
860   be used as the default cell when acquiring tokens in afscreds.exe
861
862
863 Regkey:
864 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
865
866 Value   : "afs cell name"
867 Type    : DWORD {0, 1}
868 Default : <none>
869 Function: LoadRemind(), SaveRemind()
870
871   These values are used to save and restore the state of the reminder
872   flag for each cell for which the user has obtained tokens.
873
874   This value used to be stored at 
875   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
876
877
878 Regkey:
879 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
880
881 Value   : "upper case drive letter"
882 Type    : DWORD {0, 1}
883 Default : <none>
884
885   These values are used to store the persistence state of the AFS 
886   drive mappings as listed in the [...\Client\Mappings] key
887
888   These values used to be stored in the afsdsbmt.ini file
889
890 Regkey:
891 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
892
893 Value   : "upper case drive letter"
894 Type    : REG_SZ
895 Default : <none>
896
897   These values are used to store the AFS path in Unix notation
898   to which the drive letter is to be mapped.
899
900   These values used to be stored in the afsdsbmt.ini file.
901
902
903 ENVIRONMENT VARIABLES:
904
905 Variable: AFS_RPC_ENCRYPT 
906 Values:   "OFF" disables the use of RPC encryption
907           any other value allows RPC encryption to be used
908 Default:  RPC encryption is on
909
910
911 Variable: AFS_RPC_PROTSEQ
912 Values:   "ncalrpc"  - local RPC 
913           "ncacn_np" - named pipes
914           "ncacn_ip_tcp" - tcp/ip
915 Default:  local RPC
916