[openafs.git] / doc / xml / ReleaseNotesWindows / relnotes.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN"
3         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"[
4 <!ENTITY version SYSTEM "version.xml">
5 ]>
6 <book>
7   <bookinfo>
8     <title>OpenAFS for Windows Release Notes</title>
9     <copyright>
10       <year>2003-2011</year>
11       <holder>Secure Endpoints Inc. and Your File System Inc.</holder>
12     </copyright>
13     <legalnotice>
14       <para>This documentation is covered by the MIT License.</para>
15     </legalnotice>
16     <revhistory>
17     &version;
18     </revhistory>
19     <abstract>
20       <para>This document provides a series of usage notes regarding the OpenAFS for Windows
21       client, supported platforms, contribution information, debugging techniques, and
22       a reference to supported Windows registry values.
23      </para>
24     </abstract>
25   </bookinfo>
26   <preface>
27     <title id="Preface">Preface</title>
28     <para>The Andrew File System (AFS) is a location-independent file system that uses a local cache to increase its performance. An AFS client accesses files anonymously or via a Kerberos authentication. The global AFS is partitioned into cells. The AFS cell is a collection of AFS volumes that are administered by a common entity. AFS cells can be administered by a department even when the Kerberos realm used for local authentication is managed by a much larger organization. AFS clients and servers take advantage of Kerberos cross realm authentication to enable authenticated access by entities located outside the local realm. Authorization is enforced by the use of directory level access control lists which can consist of individual or group identities. </para>
29     <para>The AFS volume is a tree of files and sub-directories. AFS volumes are created by administrators and are joined to an AFS cell via the use of a mount point. Once a volume is created, users can create files and directories as well as mount points and symlinks within the volume without regard for the physical location of the volume. Administrators can move the volume to another server as necessary without the need to notify users. In fact, the volume move can occur while files in the volume are in use. </para>
30     <para>AFS volumes can be replicated to read-only copies. When accessing files from a read-only replica, clients will read all of the data from a single replica. If that replica becomes unavailable, the clients will failover to any replica that is reachable. Users of the data are unaware of where the replicas are stored or which one is being accessed. The contents of the replicas can be updated at any time by
31       <emphasis>releasing</emphasis> the current contents of the source volume.
32     </para>
33     <para>OpenAFS for Windows (OAFW) provides AFS client access Microsoft Windows operating systems. It strives to maintain transparency such that the user is unaware of the distinction between the use of AFS and Microsoft Windows file shares. OAFW can be part of a single sign-on solution by allowing credentials for a Kerberos principal to be obtained at logon and for that principal to be used to obtain AFS tokens for one or more cells. OAFW is implemented as a native installable file system and maintains the portability of file paths by its use of the \\AFS UNC server name.</para>
34     <para>OpenAFS is the product of an open source development effort begun on October 31 2000. OpenAFS is maintained and developed by a group of volunteers with the support of the end user community. When OpenAFS is used as part of your computing infrastructure, please <link linkend="Contributing_to_OpenAFS">contribute</link> to its continued growth.
35   </para>
36   </preface>
37   <chapter id="chap_1">
38     <title id="Installer_Options">Installer Options</title>
39     <para>OpenAFS can be installed either as a new installation or an upgrade from previous versions of either OpenAFS for Windows or the former IBM AFS 3.6 for Windows.
40   Installers are provided as <ulink url="http://msdn.microsoft.com/en-us/library/cc185688%28v=vs.85%29.aspx">Windows Installer packages (.msi)</ulink> that are built using the open source
41   <ulink url="http://wix.sourceforge.net/">WiX Toolkit</ulink>.  The MSI can be customized for organizations via the use of <ulink url="http://msdn.microsoft.com/en-us/library/aa367447%28v=vs.85%29.aspx">MSI Transforms</ulink> (see <link linkend="Introduction_to_MSI_Deployment">MSI Deployment Guide</link>)
42     </para>
43   </chapter>
44   <chapter id="chap_2">
45     <title id="System_Requirements">System Requirements</title>
46     <section>
47       <title id="Supported_Operating_Systems">2.1 Supported Operating Systems</title>
48       <para>
49         <indexterm significance="normal">
50           <primary>operating system versions, supported</primary>
51         </indexterm>
52         <indexterm significance="normal">
53           <primary>system requirements</primary>
54         </indexterm>
55         <itemizedlist>
56           <listitem>
57             <para>Microsoft Windows XP Home SP2 and SP3</para>
58           </listitem>
59           <listitem>
60             <para>Microsoft Windows XP Professional SP2 and SP3</para>
61           </listitem>
62           <listitem>
63             <para>Microsoft Windows XP 64 SP1 and SP2</para>
64           </listitem>
65           <listitem>
66             <para>Microsoft Windows 2003 Server SP1 and SP2 (32-bit and 64-bit Intel)</para>
67           </listitem>
68           <listitem>
69             <para>Microsoft Windows 2003 R2 Server (32-bit and 64-bit Intel)</para>
70           </listitem>
71           <listitem>
72             <para>Microsoft Windows Vista (32-bit and 64-bit Intel)</para>
73           </listitem>
74           <listitem>
75             <para>Microsoft Windows 2008 Server (32-bit and 64-bit Intel)</para>
76           </listitem>
77           <listitem>
78             <para>Microsoft Windows 7 (32-bit and 64-bit Intel)</para>
79           </listitem>
80           <listitem>
81             <para>Microsoft Windows 2008 Server R2 (32-bit and 64-bit Intel)</para>
82           </listitem>
83         </itemizedlist>
84       </para>
85     </section>
86     <section>
87       <title id="Unsupported_Operating_Systems">2.1.1 Unsupported Operating Systems</title>
88       <para>
89         <indexterm significance="normal">
90           <primary>operating system versions, unsupported</primary>
91         </indexterm>
92         <itemizedlist>
93           <listitem>
94             <para> Microsoft Windows 95</para>
95           </listitem>
96           <listitem>
97             <para>Microsoft Windows 98</para>
98           </listitem>
99           <listitem>
100             <para>Microsoft Windows 98 OSR2</para>
101           </listitem>
102           <listitem>
103             <para>Microsoft Windows ME</para>
104           </listitem>
105           <listitem>
106             <para>Microsoft NT</para>
107           </listitem>
108           <listitem>
109             <para>Microsoft Windows 2000 Workstation</para>
110           </listitem>
111           <listitem>
112             <para>Microsoft Windows 2000 Server</para>
113           </listitem>
114           <listitem>
115             <para>Microsoft Windows XP Home (pre-SP2)</para>
116           </listitem>
117           <listitem>
118             <para>Microsoft Windows XP Professional (pre-SP2)</para>
119           </listitem>
120         </itemizedlist>
121       </para>
122       <para>Older releases of OpenAFS are available for download if unsupported operating systems must be used. The last version of OpenAFS with support for Win9x is 1.2.2b. The last version with support for Windows NT 4.0 is 1.2.10.  The last version to support Windows 2000 and XP SP1 is 1.6.x.</para>
123     </section>
124     <section>
125       <title id="Disk_Space">2.2 Disk Space</title>
126       <para>
127         <indexterm significance="normal">
128           <primary>disk space required</primary>
129         </indexterm>
130       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 <link linkend="Regkey_TransarcAFSDaemon_Parameters_CacheSize">the Registry</link> after installation.  The maximum cache size for 32-bit Windows is approximately 1.2GB.  On 64-bit Windows there is no practical limit on the cache size.
131       </para>
132     </section>
133     <section>
134       <title id="Additional_Software_Packages">2.3 Additional Software Packages</title>
135       <indexterm significance="normal">
136         <primary>kerberos for windows</primary>
137       </indexterm>
138       <indexterm significance="normal">
139         <primary>heimdal</primary>
140       </indexterm>
141       <para>
142         <ulink url="https://www.secure-endpoints.com/heimdal">Heimdal</ulink> or <ulink url="http://web.mit.edu/kerberos/dist/index.html">MIT Kerberos for Windows</ulink> 3.2.x if Kerberos v5 authentication support is desired.  Heimdal is preferred over MIT Kerberos as it will provide OpenAFS the ability to offer enhanced capabilities in future releases.  For 64-bit Windows installations, the 64-bit version of Kerberos for Windows is required.  For 32-bit Windows installations, the 32-bit version of Kerberos for Windows is required.
143         See <link linkend="Kerberos_v5_Requirements">3.2 Kerberos v5 Requirements</link> for additional details.
144       </para>
145     </section>
146   </chapter>
147   <chapter id="chap_3">
148     <title id="Operational_Notes">Operational Notes</title>
149     <section>
150       <title id="Unicode_Support">3.1. Unicode Support</title>
151       <indexterm significance="normal">
152         <primary>unicode</primary>
153       </indexterm>
154       <indexterm significance="normal">
155         <primary>character sets</primary>
156       </indexterm>
157       <indexterm significance="normal">
158         <primary>roaming profiles</primary>
159       </indexterm>
160       <indexterm significance="normal">
161         <primary>folder redirection</primary>
162       </indexterm>
163       <para>Starting with the 1.5.50 release of OpenAFS for Windows, each of the AFS Client Service, the AFS Explorer Shell Extension, and the command-line tools are Unicode enabled.  No longer is OpenAFS restricted to accessing file system objects whose names can be represented in the locale specific OEM code page.  This has significant benefits for end users.  Most importantly it permits non-Western languages to now be used for file system object names in AFS from Microsoft Windows operating systems.  Now that Unicode names are supported,
164         <ulink url="http://en.wikipedia.org/wiki/Roaming_user_profile">Roaming User Profiles</ulink> and
165         <ulink url="http://en.wikipedia.org/wiki/Folder_redirection">Folder Redirection</ulink> will no longer fail when a user attempts to store an object with a name that cannot be represented in the OEM code page.
166       </para>
167       <para>Unicode names are stored in AFS using UTF-8 encoding.  UTF-8 is supported as a locale on MacOS X, Linux, Solaris, and most other operating systems.  This permits non-Western object names to be exchanged between Microsoft Windows and other operating systems.  The OpenAFS for Windows client also implements
168         <ulink url="http://en.wikipedia.org/wiki/Unicode_normalization">Unicode Normalization</ulink> as part of the name lookup algorithm.  This is necessary because Unicode does not provide a unique representation for each input string.  The use of normalization permits a file system object name created on MacOS X to be matched with the same string entered on Microsoft Windows even though the operating system's choice of representation may be different.
169       </para>
170       <para>It is important to note that AFS file servers are character-set agnostic.  All file system object names are stored as octet strings without any character set tagging.  If a file system object is created using OEM Code Page 858 and then interpreted as UTF-8 it is likely that the object name will appear to be gibberish.  OpenAFS for Windows goes to great lengths to ensure that the object name is converted to a form that will permit the user to rename the object using Unicode.  Accessing UTF-8 names on UNIX systems that have the locale set to one of the ISO Latin character sets will result in the UTF-8 strings appearing to be gibberish.  </para>
171       <para>UNIX AFS can not perform Unicode Normalization for string comparisons.  Although it is possible to store and read Unicode object names, it is possible that a user may not be able to open an object by typing the name of the object at the keyboard.  GUI point and click operations should permit any object to be accessed.</para>
172     </section>
173     <section id="Kerberos_v5_Requirements">
174       <title>3.2. Requirements for Kerberos v5 Authentication</title>
175       <indexterm significance="normal">
176         <primary>kerberos for windows</primary>
177       </indexterm>
178       <indexterm significance="normal">
179         <primary>heimdal</primary>
180       </indexterm>
181       <para>The OpenAFS distribution ships with its own implementation of Kerberos v4 and although it is Kerberos v5 capable, it relies on third-party Kerberos v5 libraries.  The OpenAFS 1.4 series (and later) integrates with
182         <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> 2.6.5 and above.  OpenAFS Kerberos v5 capable functionality includes integrated logon, the AFS Authentication Tool, the Network Identity Manager AFS provider, and the aklog command.  These tools provide support for Kerberos v5 authentication including acquisition and automatic renewal of AFS tokens as well as support for single sign-on via the Microsoft Windows Kerberos Logon Service.
183       </para>
184       <indexterm significance="normal">
185         <primary>network identity manager</primary>
186       </indexterm>
187       <para>The recommended version of
188         <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> is 3.2.2 as distributed by <ulink url="https://www.secure-endpoints.com/">Secure Endpoints Inc.</ulink>.  As of this writing, the Secure Endpoints Inc. distribution provides 64-bit Windows support which is unavailable from MIT.  KFW 3.2.2 includes Network Identity Manager 1.3.1 which integrates with the
189         <link linkend="Network_Identity_Manager_Provider">AFS Provider</link> installed as part of OpenAFS for Windows.  The most recent version of Network Identity Manager is version 2.1 which is available as an independent upgrade to MIT Kerberos for Windows.
190       </para>
191       <indexterm significance="normal">
192         <primary>transarc afs</primary>
193       </indexterm>
194       <para>With Kerberos for Windows installed, the OpenAFS for Windows client can perform authentication to AFS services using Kerberos v5 service tickets as AFS tokens. When a Kerberos v5 derived AFS token is used, all of the AFS Volume Location and File Servers within the authenticated cell must support Kerberos v5.  If a Kerberos v5 based token is presented to an AFS server that does not support them, the server will be unable to respond to the client.  Attempts to access AFS volumes stored on such a server will fail with the Windows STATUS_NO_KERB_KEY (0xC0000322L) error.  Kerberos v5 based tokens are supported by OpenAFS revisions 1.2.8 or later.  IBM AFS 3.6 servers do not support Kerberos v5.</para>
195       <section>
196         <title id="Active_Directory">3.2.1. Active Directory</title>
197         <indexterm significance="normal">
198           <primary>active directory</primary>
199         </indexterm>
200         <indexterm significance="normal">
201           <primary>des-cbc-crc encryption type</primary>
202         </indexterm>
203         <para>Microsoft Windows Active Directory can be used as a Kerberos v5 KDC in conjunction with OpenAFS.
204           <itemizedlist>
205             <listitem>
206               <para>
207         There are two things to consider when using an Active Directory as the Kerberos realm that issues the AFS service ticket. First, the Kerberos v5 tickets issued by Active Directory can be quite large when compared to tickets issued by traditional UNIX KDCs due to the inclusion of Windows specific authorization data <ulink url="http://msdn.microsoft.com/en-us/library/cc237917%28v=prot.10%29.aspx">(the Microsoft PAC)</ulink>. If the issued tickets are larger than 344 bytes, OpenAFS 1.2.x servers will be unable to process them and will issue a RXKADBADTICKET error.  OpenAFS 1.4 (and beyond) servers can support the largest tickets that Active Directory can issue.
208                </para>
209                </listitem>
210                <listitem>
211                <para>Second, the Kerberos v5 tickets issued by Windows 2003 Active Directory are encrypted with the DES-CBC-MD5 encryption type (enctype). OpenAFS 1.2.x servers only support the DES-CBC-CRC enctype.  As a result, OpenAFS 1.2.x servers cannot process the resulting Kerberos v5 tokens.  Windows 2000 Active Directory issues tickets with the DES-CBC-CRC enctype.  Windows Server 2008 R2 Active Directory domain by default disables use of DES-CBC-MD5 and it must be enabled.
212                </para>
213            <para>Microsoft has documented in
214           <ulink url="http://support.microsoft.com/kb/832572/">Knowledge Base article 832572</ulink> a new NO_AUTH_REQUIRED flag that can be set on the account mapped to the AFS service principal.  When this flag is set, the PAC authorization data will not be included in the ticket.  Setting this flag is recommended for all accounts that are associated with non-Windows services and that do not understand the authorization data stored in the PAC.  This flag cannot be used if AFS service tickets are obtained via cross-realm using an Active Directory user principal.
215         </para>
216         <para>Note that an Active Directory computer object cannot be used for the afs service principal.  A user object must be used.</para>
217         </listitem>
218         </itemizedlist>
219         </para>
220       </section>
221       <section>
222         <title id="Using_krb524_Service">3.2.2. The krb524 Service is no longer supported</title>
223         <indexterm significance="normal">
224           <primary>krb524</primary>
225         </indexterm>
226         <indexterm significance="normal">
227           <primary>port, 4444/udp</primary>
228         </indexterm>
229         <indexterm significance="normal">
230           <primary>registry value, Use524</primary>
231         </indexterm>
232         <para>Before there was native support for Kerberos v5 derived AFS tokens, the krb524 service was used to convert a Kerberos v5 service ticket into a Kerberos v4 service ticket that could in turn be used to construct an AFS authentication token. As of OpenAFS 1.2.8 [14 December 2002], support was added to allow the immediate use of Kerberos v5 tickets as AFS (2b) tokens. This is the first building block necessary to break away from the limitations of Kerberos v4 with AFS. By using Kerberos v5 directly the security holes inherent in Kerberos v4 cross-realm are avoided.  Use of cryptographically stronger algorithms for authentication and encryption become a possibility.</para>
233         <para>Another reason for using Kerberos v5 directly is because the krb524 service runs on port (4444/udp), which has increasingly been blocked by Internet service providers. The port was used to spread a worm which attacked Microsoft Windows in the Summer of 2003. When the port is blocked users find that they are unable to authenticate.</para>
234         <para>Replacing the Kerberos v4 ticket with a Kerberos v5 ticket is a win in all situations except when the cell name does not match the realm name and the principal names placed into the ACL's are not the principal names from the Kerberos v5 ticket.  Unfortunately, some organizations have AFS cell names and Kerberos realm names which differ by more then just typographic case and rely the krb524d service to map the Kerberos v5 client principal name from realm FOO to a Kerberos v4 principal in realm BAR. This allows user@FOO to appear to be user@bar for the purposes of accessing the AFS cell.
235         </para>
236         <para>To support this mode of operation OpenAFS for Windows versions 1.4.x through 1.6.x supported a registry value,
237           <link linkend="Value_Use524">Use524</link>, that forced the use of krb524d within the AFS Authentication Tool and during integrated logon. Previous revisions of this documentation advised that this option should only be used by individuals until such time as their organizations transitioned away from the krb524 service.
238         </para>
239         <para>Over the last few years all Kerberos distributions have removed support for Kerberos v4.  As a result, OpenAFS can no longer support the krb524d service and the functionality has been removed from the source tree for the 1.7.x release.</para>
240         <para>As an alternative, sites should be aware that the OpenAFS 1.4.x servers permit the use of a secondary realm name that can be treated as equivalent to the cell name for authentication.  This functionality can be used to avoid the need for the krb524 service if and only if both realms are managed by the same administrative entity.
241         </para>
242       </section>
243       <section id="Network_Identity_Manager_Provider">
244         <title>3.2.3. Network Identity Manager Provider</title>
245         <indexterm significance="normal">
246           <primary>network identity manager</primary>
247         </indexterm>
248         <para>As of release 1.5.9, OpenAFS for Windows includes a Network Identity Manager Provider for obtaining AFS tokens.  This plug-in is a contribution from
249           <ulink url="https://www.secure-endpoints.com/">Secure Endpoints Inc.</ulink>  Network Identity Manager is a multiple identity credential management tool that ships with
250           <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> version 3.0 and above.  The OpenAFS plug-in requires
251           <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> version 3.1 or above.  Version 3.2.2 is recommended for the best user experience.
252         </para>
253         <para>
254           <inlinemediaobject>
255             <imageobject>
256               <imagedata format="JPG" fileref="relnotes00.jpg" />
257             </imageobject>
258           </inlinemediaobject>
259         </para>
260         <para>The Network Identity Manager replaces the former KFW 2.6.x ticket manager, "Leash", and when combined with the OpenAFS Provider it can be used as a replacement for the AFS Authentication Tool (afscreds.exe).  Unlike both Leash and the AFS Authentication Tool, Network Identity Manager with the OpenAFS Provider can easily acquire and renew AFS tokens for multiple cells from one or more Kerberos v5 identities.</para>
261         <para>
262           <inlinemediaobject>
263             <imageobject>
264               <imagedata format="JPG" fileref="relnotes01.jpg" />
265             </imageobject>
266           </inlinemediaobject>
267         </para>
268         <para>The AFS configuration panel for each Kerberos v5 identity is used to configure which cells credentials should be obtained for and how they should be obtained.  If the cell to realm mapping cannot be automatically determined, it can be explicitly specified.  If the cell does not support Kerberos v5 tickets as tokens, then a krb524 service can be configured.</para>
269         <para>
270           <inlinemediaobject>
271             <imageobject>
272               <imagedata format="JPG" fileref="relnotes02.jpg" />
273             </imageobject>
274           </inlinemediaobject>
275         </para>
276         <para>The OpenAFS Provider configuration panel can be used to check the status of the AFS Client Service and its version.  An optional checkbox is provided that will prevent the AFS Authentication Tool from being started by Windows after login.   A shortcut to the OpenAFS Control Panel is also provided.</para>
277         <para>As of OpenAFS 1.5.66, the Network Identity Manager OpenAFS Provider displays the same AFS Lock notification icon generated by the AFS Authentication Tool.  The AFS Lock can be used to determine if:</para>
278         <itemizedlist>
279           <listitem>
280             <para>one or more AFS tokens are valid</para>
281           </listitem>
282           <listitem>
283             <para>no AFS tokens are present but the AFS service is running</para>
284           </listitem>
285           <listitem>
286             <para>the AFS Service is not running</para>
287           </listitem>
288           <listitem>
289             <para>the AFS Service is running but there is a communication error preventing access to \\AFS</para>
290           </listitem>
291         </itemizedlist>
292       </section>
293     </section>
294     <section>
295       <title id="Use_of_Microsoft_Loopback">3.3. The Former use of the Microsoft Loopback Adapter by the OpenAFS Client Service</title>
296       <indexterm significance="normal">
297         <primary>microsoft loopback adapter</primary>
298       </indexterm>
299       <para>
300                 This section is preserved for those sites that may want to manually configure the OpenAFS Client Service to run as an SMB Gateway to AFS instead of using the native IFS file system redirector driver.  When the IFS driver is in use the Microsoft Loopback Adapter (if installed) is ignored.  The OpenAFS 1.7.x installer will not install a Microsoft Loopback Adapter by default nor will it remove one if already present on the machine.
301           </para>
302       <para>The Microsoft Loopback Adapter (MLA) is installed with a name "AFS" and a pre-assigned IP address of The MLA is bound to the "Client for Microsoft Networks" service and not bound to the "File and Printer Sharing for Microsoft Networks" service. If the MLA is unbound to "Client Microsoft Networks", the OpenAFS Client Service will become inaccessible when the machine is disconnected from the network. If the MLA is bound to "File and Printer Sharing ..." there will be a service type collision between the "AFS" SMB Service and the local machine's File Sharing Service.  This will result in the OpenAFS client service becoming inaccessible and the "NET VIEW \\AFS" command will return a "System Error 52" message. To correct the problem:</para>
303       <itemizedlist>
304         <listitem>
305           <para>stop the AFS Client Service</para>
306         </listitem>
307         <listitem>
308           <para>bind the "Client for Microsoft Networks" to the MLA</para>
309         </listitem>
310         <listitem>
311           <para>unbind "File and Printer Sharing for Microsoft Networks" from the MLA</para>
312         </listitem>
313         <listitem>
314           <para>disable and then re-enable the MLA</para>
315         </listitem>
316         <listitem>
317           <para>start the AFS Client Service</para>
318         </listitem>
319       </itemizedlist>
320       <para>When the MLA is not installed the NETBIOS name published by the OpenAFS SMB server must be unique in order to avoid name conflicts on public network.  The unique name will take the form "<emphasis>MACHINE</emphasis>-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 globally 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.
321       </para>
322     </section>
323     <section>
324       <title id="Using_Freelance_Mode">3.4. Using Freelance (Dynamic Root) Mode to Improve Mobility</title>
325       <indexterm significance="normal">
326         <primary>freelance mode</primary>
327       </indexterm>
328       <indexterm significance="normal">
329         <primary>root.afs volume, fake</primary>
330       </indexterm>
331       <indexterm significance="normal">
332         <primary>mount points</primary>
333       </indexterm>
334       <indexterm significance="normal">
335         <primary>symlinks</primary>
336       </indexterm>
337       <para>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 Virtual Private Network (VPN) connection 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 can not successfully start. </para>
338       <para>To allow the OpenAFS Client Service to operate in these environments, Freelance mode dynamically constructs a fake "root.afs" volume from mount points and symlinks stored in the local registry.</para>
339       <para>The content of the fake "root.afs" volume is dynamically generated as cells are accessed. When the fake "root.afs" volume is initially constructed it will only contain two mount points: a
340         <emphasis>regular path </emphasis>and
341         <emphasis>read-write path </emphasis>mount point used to access the "root.cell" volume of the default AFS cell. Any attempt to access a valid cell name will result in a new mount point being created in the fake "root.afs" volume. If the cellname begins with a "." the mount point will be a
342         <emphasis>read-write path</emphasis>; otherwise the mount point will be a
343         <emphasis>regular path</emphasis>. These mount points are preserved in the registry at key:
344       </para>
345       <para>
346         <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance">HKLM\SOFTWARE\OpenAFS\Client\Freelance</link>
347       </para>
348       <para>Additional mount points may be manually created using the "fs mkmount" command. Mount points may be removed using the "fs rmmount" command.</para>
349       <para>&gt;fs mkmount \\AFS\athena.mit.edu root.cell athena.mit.edu</para>
350       <para>&gt;fs mkmount \\AFS\.athena.mit.edu root.cell athena.mit.edu -rw</para>
351       <para>&gt;fs rmmount \\AFS\athena.mit.edu</para>
352       <para>&gt;fs rmmount \\AFS\.athena.mit.edu</para>
353       <para>Symlinks may also be created within the Freelance "root.afs" volume.</para>
354       <para>&gt;symlink make \\afs\link \\afs\athena.mit.edu\user\j\a\jaltman</para>
355       <para> &gt;symlink list \\afs\link</para>
356       <para> '\\afs\link' is a symlink to 'athena.mit.edu\user\j\a\jaltman'</para>
357       <para>&gt;symlink rm \\afs\link</para>
358       <para>The symlinks are stored in the registry at:</para>
359       <para>
360         <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks">HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks</link>
361       </para>
362       <para><emphasis>NET VIEW \\AFS</emphasis> can be used to browse all of the entries from the command line.</para>
363     </section>
364     <section>
365       <title id="Locating_VLDB_via_DNS">3.5. Locating AFS Volume Database Servers via DNS </title>
366       <indexterm significance="normal">
367         <primary>dns, vldb lookups</primary>
368       </indexterm>
369       <indexterm significance="normal">
370         <primary>afsdb dns records</primary>
371       </indexterm>
372       <para>The OpenAFS for Windows client will use DNS SRV records and AFSDB records to discover the location of AFS Volume Database servers when entries for the cell are not present in either the client's CellServDB registry store or file (\%PROGRAMFILES%\OpenAFS\Client\CellServDB).
373       Also see <link linkend="Registry_VLDB_Configuration">Registry Configuration for AFS Volume Database Servers</link>.</para>
374     </section>
375     <section>
376       <title id="Integrated_Logon">3.6. Obtaining AFS Tokens as a Integrated Part of Windows Logon</title>
377       <indexterm significance="normal">
378         <primary>integrated logon</primary>
379       </indexterm>
380       <indexterm significance="normal">
381         <primary>single sign-on</primary>
382       </indexterm>
383       <indexterm significance="normal">
384         <primary>kerberos for windows</primary>
385       </indexterm>
386       <indexterm significance="normal">
387         <primary>afslogon.dll</primary>
388       </indexterm>
389       <indexterm significance="normal">
390         <primary>EnableKFW</primary>
391       </indexterm>
392       <indexterm significance="normal">
393         <primary>Use524</primary>
394       </indexterm>
395       <indexterm significance="normal">
396         <primary>tokens</primary>
397       </indexterm>
398       <para>OpenAFS for Windows installs a WinLogon Network Provider to provide Single Sign-On functionality (aka Integrated Logon.) Integrated Logon can be used when the Windows username and password match the username and password associated with the default cell's Kerberos realm. For example, if the Windows username is "jaltman" and the default cell is "athena.mit.edu", then Integrated Logon can be successfully used if the windows password matches the password assigned to the Kerberos principal "jaltman@ATHENA.MIT.EDU". The realm "ATHENA.MIT.EDU" is obtained by performing a domain name to realm mapping on the hostname of one of the cell's Volume Database servers.</para>
399       <para>Integrated Logon is required if you desire the ability to store roaming user profiles within the AFS file system. OpenAFS does not provide tools for synchronizing the Windows and Kerberos user accounts and passwords.</para>
400       <para>When KFW is configured, Integrated Logon will use it to obtain tokens. Use of KFW for Integrated Logon can be disabled via the
401         <link linkend="Value_EnableKFW">EnableKFW</link> registry value.
402       </para>
403       <para>Integrated Logon will not transfer Kerberos v5 tickets into the user's logon session credential cache.  This is no longer possible on Vista and Windows 7.</para>
404       <para>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.</para>
405       <para>Integrated Logon supports the ability to obtain tokens for multiple cells. For further information on how to configure this feature, read about the
406         <link linkend="Value_TheseCells">TheseCells</link> value.
407       </para>
408     </section>
409     <section>
410       <title id="AFS_System_Tray">3.7. AFS Authentication Tool Command Line Options</title>
411       <indexterm significance="normal">
412         <primary>afscreds.exe</primary>
413       </indexterm>
414       <indexterm significance="normal">
415         <primary>system tray tool</primary>
416       </indexterm>
417       <indexterm significance="normal">
418         <primary>network identity manager</primary>
419       </indexterm>
420       <para>The AFS Authentication Tool (afscreds.exe) has been deprecated in favor of Network Identity Manager.  afscreds.exe is no longer installed by default in the OpenAFS 1.7 release series.  The following information is for historical reference.</para>
421       <para>The AFS Authentication Tool (afscreds.exe) supports several command line options: </para>
422       <itemizedlist>
423         <listitem>
424           <para>-A = autoinit </para>
425         </listitem>
426         <listitem>
427           <para>-E = force existing afscreds to exit</para>
428         </listitem>
429         <listitem>
430           <para>-I = install startup shortcut</para>
431         </listitem>
432         <listitem>
433           <para>-M = renew drive maps (deprecated)</para>
434         </listitem>
435         <listitem>
436           <para>-N = IP address change detection </para>
437         </listitem>
438         <listitem>
439           <para>-Q = quiet mode.  do not display start service dialog if afsd_service is not already running</para>
440         </listitem>
441         <listitem>
442           <para>-S = show tokens dialog on startup</para>
443         </listitem>
444         <listitem>
445           <para>-U = uninstall startup shortcut</para>
446         </listitem>
447         <listitem>
448           <para>-X = test and do map share (deprecated)</para>
449         </listitem>
450         <listitem>
451           <para> -Z = unmap drives (deprecated)</para>
452         </listitem>
453       </itemizedlist>
454       <para>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.</para>
455       <para>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 each time afscreds.exe is started.</para>
456       <para>By default afscreds.exe is configured by the OpenAFS.org installers to use "-A -N -M -Q" as startup options. Currently, there is no user interface to change this selection after install time although these options may be altered via the registry on either per machine or per user basis. See
457         <link linkend="Value_AfscredsShortcutParams">AfscredsShortcutParams</link> in
458         <link linkend="appendix_a">Appendix A</link>.
459       </para>
460       <para>
461       Due to conflicts with Vista and Windows 7 User Account Control, the Drive Letter Mount and Advanced tabs of the AFS Authentication Tool were disabled beginning with the 1.5.66 release.
462       </para>
463     </section>
464     <section>
465       <title id="AFS_Client_Admin_Group">3.8. The "AFS Client Admins" Authorization Group</title>
466       <indexterm significance="normal">
467         <primary>AFS client administrator authorization group</primary>
468       </indexterm>
469       <indexterm significance="normal">
470         <primary>AFS Client Admins</primary>
471       </indexterm>
472       <indexterm significance="normal">
473         <primary>fs checkservers</primary>
474       </indexterm>
475       <indexterm significance="normal">
476         <primary>fs setcachesize</primary>
477       </indexterm>
478       <indexterm significance="normal">
479         <primary>fs newcell</primary>
480       </indexterm>
481       <indexterm significance="normal">
482         <primary>fs sysname</primary>
483       </indexterm>
484       <indexterm significance="normal">
485         <primary>fs exportafs</primary>
486       </indexterm>
487       <indexterm significance="normal">
488         <primary>fs setcell</primary>
489       </indexterm>
490       <indexterm significance="normal">
491         <primary>fs setserverprefs</primary>
492       </indexterm>
493       <indexterm significance="normal">
494         <primary>fs storebehind</primary>
495       </indexterm>
496       <indexterm significance="normal">
497         <primary>fs setcrypt</primary>
498       </indexterm>
499       <indexterm significance="normal">
500         <primary>fs cscpolicy</primary>
501       </indexterm>
502       <indexterm significance="normal">
503         <primary>fs trace</primary>
504       </indexterm>
505       <indexterm significance="normal">
506         <primary>fs minidump</primary>
507       </indexterm>
508       <indexterm significance="normal">
509         <primary>symlink make</primary>
510       </indexterm>
511       <indexterm significance="normal">
512         <primary>fs makemount</primary>
513       </indexterm>
514       <indexterm significance="normal">
515         <primary>Freelance root.afs volume</primary>
516       </indexterm>
517       <para>The OpenAFS for Windows client supports a local Windows authorization group named "AFS Client Admins". This group is used in place of the "Administrators" group to determine which users are allowed to modify the AFS Client Service configuration via the AFS Control Panel (afs_config.exe) or fs.exe command line tool. The following fs.exe commands are now restricted to members of the "AFS Client Admins" group:</para>
518       <itemizedlist>
519         <listitem>
520           <para>checkservers with a non-zero timer value</para>
521         </listitem>
522         <listitem>
523           <para>setcachesize</para>
524         </listitem>
525         <listitem>
526           <para>newcell</para>
527         </listitem>
528         <listitem>
529           <para>sysname with a new sysname list</para>
530         </listitem>
531         <listitem>
532           <para>exportafs</para>
533         </listitem>
534         <listitem>
535           <para>setcell</para>
536         </listitem>
537         <listitem>
538           <para>setserverprefs</para>
539         </listitem>
540         <listitem>
541           <para>storebehind</para>
542         </listitem>
543         <listitem>
544           <para>setcrypt</para>
545         </listitem>
546         <listitem>
547           <para>cscpolicy</para>
548         </listitem>
549         <listitem>
550           <para>trace</para>
551         </listitem>
552         <listitem>
553           <para>minidump</para>
554         </listitem>
555       </itemizedlist>
556       <para>The creation or removal of mount points and symlinks in the Freelance "root.afs" volume are also restricted to members of the "AFS Client Admins" group.</para>
557       <para>The initial membership of the "AFS Client Admins" group when created by the installer is equivalent to the local "Administrators" group. If a user is added to the "Administrators" group after the creation of the "AFS Client Admin" group, that user will not be an AFS Client Administrator. Only users that are members of the "AFS Client Admins" group are AFS Client Administrators. The local "SYSTEM" account is an implicit member of the "AFS Client Admins" group.</para>
558       <para>Setting the default sysname for a machine should be done via the
559         <link linkend="Value_SysName">SysName registry value</link> and not via "fs sysname".
560       </para>
561     </section>
562     <section>
563       <title id="Support_for_UNC_Paths">3.9. OpenAFS Support for UNC Paths </title>
564       <indexterm significance="normal">
565         <primary>UNC paths</primary>
566       </indexterm>
567       <indexterm significance="normal">
568         <primary>JP Software</primary>
569         <secondary>4NT</secondary>
570       </indexterm>
571       <indexterm significance="normal">
572         <primary>JP Software</primary>
573         <secondary>Take Commands</secondary>
574       </indexterm>
575       <indexterm significance="normal">
576         <primary>PowerShell</primary>
577       </indexterm>
578       <para>The OpenAFS client supports UNC paths everywhere. UNC paths provide a canonical name for resources stored within AFS. UNC paths should be used instead of drive letter mappings whenever possible. This is especially true when specifying the location of roaming profiles and redirected folders.</para>
579       <para>Power users that make extensive use of the command line shell, cmd.exe, should consider using JP Software's 4NT or Take Command command processors. Unlike cmd.exe, the JPSoftware shells fully support UNC paths as the current directory. JPSoftware added special recognition for OpenAFS to its command shells, 4NT 7.0 and Take Command 7.0. 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.  Take Command 13.1 will include support for OpenAFS IFS Reparse Points.</para>
580       <para>JPSoftware's web site is
581         <ulink url="http://www.jpsoft.com/">http://www.jpsoft.com</ulink>.
582       </para>
583       <para>Microsoft PowerShell 1.0 and 2.0 will also support UNC paths as the current directory. </para>
584     </section>
585     <section>
586       <title id="aklog.exe">3.10. aklog.exe</title>
587       <indexterm significance="normal">
588         <primary>aklog.exe</primary>
589       </indexterm>
590       <para>The OpenAFS Client ships with its own version of aklog.exe which should be used in preference to those obtained by other sources. The OpenAFS aklog.exe supports Kerberos v5 as well as the ability to auto-generate AFS IDs within foreign PTS databases.</para>
591       <para>
592         <programlisting format="linespecific">
593     Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]]
594                  [[-p | -path] pathname]
595                  [-noprdb] [-force]
596                  [-5]
598                  -d = output debugging information.
599                  cell = zero or more cells for which tokens will be obtained
600                  krb_realm = the kerberos realm of the cell.
601                  pathname = the directory for which authentication is required
602                  -noprdb = don't try to determine AFS ID.
603                  -5 = use Kerberos v5.
604                       (only Kerberos v5 is available)
605                  No commandline arguments means authenticate to the local cell.
606       </programlisting>
607       </para>
608     </section>
609     <section>
610       <title id="OpenAFS_Servers_on_Windows">3.11. OpenAFS Servers on Windows are Unsupported</title>
611       <indexterm significance="normal">
612         <primary>OpenAFS Servers on Windows</primary>
613       </indexterm>
614       <indexterm significance="normal">
615         <primary>Freelance mode</primary>
616       </indexterm>
617       <indexterm significance="normal">
618         <primary>EnableKFW</primary>
619       </indexterm>
620       <indexterm significance="normal">
621         <primary>power management</primary>
622       </indexterm>
623       <indexterm significance="normal">
624         <primary>kaserver</primary>
625       </indexterm>
626       <para>The AFS Server functionality provided as part of the OpenAFS install package might work but should be considered highly experimental. It has not been thoroughly tested. Any data which would cause pain if lost should not be stored in an OpenAFS Server on Windows.</para>
627       <para>Known issues include lack of support for power management and dynamic network configuration.  Salvager is also known to crash.</para>
628       <section>
629         <title id="OpenAFS_Server_Installation">3.11.1. OpenAFS Server Installation</title>
630         <para>When the OpenAFS Server is installed, the TransarcAFSServer service (bosctlsvc.exe) will be installed and configured.  The TransarcAFSServer service will auto-start the traditional AFS bos server.  The former AFS Server Configuration wizard makes assumptions that no longer hold true and it has therefore been disabled.  However, following the instructions for installing the AFS Servers on UNIX it is possible to properly configure the AFS Servers on Microsoft Windows.  The AFS Server binaries, configuration files, and log files are installed under %Program Files%\OpenAFS\Server.
631           <ulink url="http://www.openafs.org/no-more-des.html">kaserver has been deprecated and its use is strongly discouraged.</ulink>  Instead, Active Directory or some other Kerberos v5 KDC should be used in its place.
632         </para>
633       </section>
634       <section>
635         <title id="Using_the_AFS_Client_Service_with_OpenAFS_Server">3.11.2. Using the AFS Client Service when the Server is installed</title>
636         <para>A few notes on the usage of the AFS Client Service if it is going to be used with the OpenAFS AFS Server:</para>
637         <itemizedlist>
638           <listitem>
639             <para>Freelance mode should be disabled when the AFS Client Service is installed on the same machine as the AFS Server,. Otherwise, it will be impossible to manipulate the contents of the root.afs volume for the hosted cell without constructing an explicit mountpoint to the root.afs volume from another volume.</para>
640           </listitem>
641           <listitem>
642             <para>The AFS Server and related tools only support the built in kaserver (Kerberos IV). If kaserver is being used,
643               <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> should not be installed or must be disabled via the
644               <link linkend="Value_EnableKFW">EnableKFW</link> registry value.
645             </para>
646           </listitem>
647           <listitem>
648             <para>The AFS Servers are not aware of power management events nor are they aware of network configuration changes.  It is strongly advised that the AFS servers be installed only on systems that will not be shutdown or suspended unexpectedly.   An inadvertent shutdown will corrupt volume data.</para>
649           </listitem>
650         </itemizedlist>
651       </section>
652     </section>
653     <section>
654       <title id="OpenAFS_Debug_Symbols">3.12. OpenAFS Debugging Symbols and Checked Builds</title>
655       <indexterm significance="normal">
656         <primary>debug symbols</primary>
657       </indexterm>
658       <indexterm significance="normal">
659         <primary>checked builds</primary>
660       </indexterm>
661       <para>The OpenAFS for Windows installers include Debugging Symbol files which should be installed if you are experiencing problems and need to send crash reports. This is true for both the release and the debug versions of the installers. The difference between the release and debug versions are:</para>
662       <itemizedlist>
663         <listitem>
664           <para>whether or not the binaries were compiled with optimization (release: yes, debug: no)</para>
665         </listitem>
666         <listitem>
667           <para>whether or not the debug symbols are installed by default (release: no, debug: yes)</para>
668         </listitem>
669         <listitem>
670           <para>whether or not
671             <emphasis>fs trace</emphasis> logging is turned on by default (release: no, debug: yes)
672           </para>
673         </listitem>
674         <listitem>
675           <para>whether or not additional debug statements were compiled into the binaries (release: no, debug: yes)</para>
676         </listitem>
677       </itemizedlist>
678     </section>
679     <section>
680       <title id="Large_File_Support">3.13. Large File (64-bit) Support</title>
681       <indexterm significance="normal">
682         <primary>large file support</primary>
683       </indexterm>
684       <indexterm significance="normal">
685         <primary>64-bit file sizes</primary>
686       </indexterm>
687       <para>As of release 1.5.3, OpenAFS for Windows supports files larger than 2GB. The maximum file size is now 16777216 terabytes when the AFS File Server supports large files. If the AFS File Server does not support 64-bit file sizes, then the maximum size of files stored on that server remains 2GB.</para>
688     </section>
689     <section>
690       <title id="Encrypted_AFS_Network_Communication">3.14. Encrypted AFS Network Communication</title>
691       <indexterm significance="normal">
692         <primary>encryption</primary>
693       </indexterm>
694       <indexterm significance="normal">
695         <primary>fs setcrypt</primary>
696       </indexterm>
697       <para>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 "fcrypt" mode. Encrypted data transfer can be turned on or off with the "fs crypt" command. Transitions between "crypt" and "non-crypt" modes are logged to the Windows Application Event Log. </para>
698     </section>
699     <section>
700       <title id="Authenticated_SMB_Access_to_Client_Service">3.15. Authenticated SMB Access to the OpenAFS Client Service</title>
701       <indexterm significance="normal">
702         <primary>SMB authentication</primary>
703       </indexterm>
704       <indexterm significance="normal">
705         <primary>NTLM</primary>
706       </indexterm>
707       <indexterm significance="normal">
708         <primary>GSS SPNEGO</primary>
709       </indexterm>
710       <para><emphasis>This section is maintained for historical reference and those sites that are manually configuring the OpenAFS Service to act as an SMB gateway.  This section does not apply when the OpenAFS IFS redirector driver is in use.</emphasis></para>
711       <para>OpenAFS authenticates SMB connections using either NTLM or GSS SPNEGO (NTLM). In previous versions of OpenAFS, the SMB connections were unauthenticated which opened the door for several attacks which could be used to obtain access to another user's tokens on shared machines. </para>
712       <para>When GSS SPNEGO attempts a Kerberos v5 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.</para>
713       <para>It should also be noted that because Kerberos v5 authentication cannot be used, it is not possible to digitally sign the SMB communications.   On systems that require Digital Signing of SMB Client connections, access to \\AFS will fail with a connection error.</para>
714     </section>
715     <section>
716       <title id="No_More_INI_Files">3.16. IBM AFS INI Files Replaced By Windows Registry Keys</title>
717       <indexterm significance="normal">
718         <primary>INI files</primary>
719       </indexterm>
720       <indexterm significance="normal">
721         <primary>CellServDB</primary>
722       </indexterm>
723       <indexterm significance="normal">
724         <primary>AFSCONF</primary>
725       </indexterm>
726       <para>IBM AFS and OpenAFS 1.2 Windows clients stored configuration data in Windows .INI files. This OpenAFS client does not use Windows .INI files for the storage of configuration data. All settings are stored in the registry (see
727         <link linkend="appendix_a">Appendix A</link>). The CellServDB file is now stored in either the %ALLUSERSPROFILE%\Application Data\OpenAFS\Client directory (aka \ProgramData\OpenAFS\Client on Vista\Win7\2008) or the %PROGRAMFILES%\OpenAFS\Client directory. The
728         <link linkend="Value_CellServDBDir">CellServDBDir</link> registry value or the AFSCONF environment variable can be used to specify an alternative location.
729       </para>
730       <para>For users converting from IBM AFS clients, during installation OpenAFS will relocate the contents of the "afsdcell.ini" file to the new CellServDB file. OpenAFS will also import the contents of the "afs_freelance.ini" file to the Windows registry. OpenAFS will not process the contents of the "afsddbmt.ini".</para>
731     </section>
732     <section>
733       <title id="Windows_Internet_Connection_Firewall">3.17. Microsoft Windows Internet Connection Firewall</title>
734       <indexterm significance="normal">
735         <primary>Windows Internet Connection Firewall</primary>
736       </indexterm>
737       <indexterm significance="normal">
738         <primary>firewall</primary>
739       </indexterm>
740       <indexterm significance="normal">
741         <primary>Back Connection</primary>
742       </indexterm>
743       <para>The OpenAFS Client is compatible with the Internet Connection Firewall that debuted with Windows XP SP2 and Windows 2003 SP1. The Internet Connection Firewall will be automatically configured to allow the receipt of incoming callback messages from the AFS file server. In addition, if the OpenAFS Service is manually configured to behave as an SMB Gateway, the appropriate
744         <emphasis>Back Connection</emphasis> registry entries are added to allow SMB authentication to be performed across the Microsoft Loopback Adapter.
745       </para>
746       <para>
747       On Windows Vista, Windows 7 and Server 2008 the OpenAFS Service can only modify the local machine firewall policy.  The domain firewall policy must be manually configured by the Domain Administrator.
748       </para>
749     </section>
750     <section>
751       <title id="Browsing_AFS_from_Explorer_Shell">3.18. Browsing AFS from the Explorer Shell and Office</title>
752       <indexterm significance="normal">
753         <primary>Explorer Shell</primary>
754       </indexterm>
755       <indexterm significance="normal">
756         <primary>Microsoft Office</primary>
757       </indexterm>
758       <para>The OpenAFS Client Service implements the CIFS Remote Admin Protocol and the Microsoft RPC SVRSVC and WKSSVC services which allows Explorer to browse server and share information. This significantly enhances the interoperability of AFS volumes within the Explorer Shell and Microsoft Office applications.</para>
759     </section>
760     <section>
761       <title id="Byte_Range_Locking">3.19. Byte Range Locking</title>
762       <indexterm significance="normal">
763         <primary>byte range locking</primary>
764       </indexterm>
765       <indexterm significance="normal">
766         <primary>Microsoft Office</primary>
767       </indexterm>
768       <indexterm significance="normal">
769         <primary>EnableServerLocks</primary>
770       </indexterm>
771       <para>Many applications on Windows (e.g. Microsoft Office) require the use of byte range locks applied to a file either to protect against simultaneous file access or as a signaling mechanism. OpenAFS for Windows release 1.5 (or greater) implements byte range locking within the CIFS-AFS gateway server. This support for byte range locking obtains AFS' advisory file server locks to simulate Microsoft Windows mandatory locks. When an application opens a file, a lock will be obtained from AFS indicating that the file is in use. If the lock is a write lock, access to the file will be restricted to other applications running on the same machine as the first application to request the lock. Applications running on other machines will see the AFS full file lock and will be unable to access the file.</para>
772       <para>Most Windows applications and Windows itself opens files in shared read mode. When this is done, a read lock is applied to the file. This does not prevent shared read access across multiple machines but is used to ensure that no one writes to the file while it is in use.</para>
773       <para>As the CIFS-AFS gateway server attempts to implement Windows lock semantics on top of AFS lock semantics it is important to understand how AFS file locks work. In Windows there are no special privileges associated with obtaining file locks. If you can read or execute a file, then you can obtain shared and exclusive locks. In general, a Windows shared lock equates to an AFS read lock and a Windows exclusive lock equates to an AFS write lock. In AFS if you can write to a file, then you can obtain a write lock. However, in AFS if you can read a file it does not mean that you can obtain a read lock on it. The ability to obtain read locks is granted only if you have the lock (or ‘k') privilege. This behavior is required in order to allow anonymous users to read files while preventing them from being able to deny access to the files to other users.
774         <emphasis>OpenAFS 1.4.0 and earlier as well as all IBM AFS file servers have an implementation bug that prevents users with write privileges from being able to obtain locks without the lock privilege.</emphasis> When AFS serves data out of read-only volumes the file server will deny all requests for read and write locks because the contents of the volume cannot be changed by the client.
775       </para>
776       <para>Since Microsoft Windows applications almost always attempt to obtain a temporary exclusive lock when accessing files the OpenAFS Client's CIFS-AFS gateway implements the following semantics in order to reduce the inconvenience on end users. </para>
777       <itemizedlist mark="bullet">
778         <listitem>
779           <para>If the file is located on a read-only volume and the application requests a shared lock, the CIFS-AFS server will grant the lock request without asking the AFS file server.</para>
780         </listitem>
781         <listitem>
782           <para>If the file is located on a read-only volume and the application opens the file with write access and requests an exclusive lock, the CIFS-AFS server will refuse the lock request and return a read only error.</para>
783         </listitem>
784         <listitem>
785           <para>If the file is located on a read-only volume and the application opens the file with only read access and requests an exclusive lock, the CIFS-AFS server will fulfill the lock request with a read lock.</para>
786         </listitem>
787         <listitem>
788           <para>If the file is located on a read-write volume and the application requests an exclusive lock, the CIFS-AFS server will request a write lock from the AFS file server. If granted by the file server, then the CIFS-AFS server will grant the lock request. If the request is denied due to an access denied error and the user has the lookup, read and lock privileges and the file was opened for read only access, then the CIFS-AFS server will request a read lock from the file server. If the request is denied due to an access denied error and the user has the lookup and read privileges but not the lock privilege, then the CIFS-AFS server will grant the request even though the AFS file server said ‘no'. If the user does not have at least those permissions, the CIFS-AFS server will deny the request.</para>
789         </listitem>
790         <listitem>
791           <para>If the file is located on a read-write volume and the application requests a shared lock, the CIFS-AFS server will request a read lock from the AFS file server. If granted by the file server, then the CIFS-AFS server grants the lock request. If the request is denied due to an access denied error and the user has the lookup and read privileges but not the lock privilege, then the CIFS-AFS server will grant the request even though the AFS file server said ‘no'. If the user does not have at least those permissions, the CIFS-AFS server will deny the request.</para>
792         </listitem>
793         <listitem>
794           <para>If multiple processes on the same machine attempt to access the same file simultaneously, the CIFS-AFS server will locally manage the granted locks and all processes will share a single lock on the AFS file server.</para>
795         </listitem>
796         <listitem>
797           <para>If the CIFS-AFS server is unable to renew the AFS file server locks, then it will invalidate the associated file handles. This is the same behavior that an application will experience if it was using a Windows File Share and the connection was broken. Invalidating the file handles prevents subsequent data corruption from taking place.</para>
798         </listitem>
799       </itemizedlist>
800       <para>If you wish to disable the acquisition of locks from the file server, this can be performed using the
801         <link linkend="Value_EnableServerLocks">EnableServerLocks</link> registry value.
802       </para>
803     </section>
804     <section>
805       <title id="Automatic_Discarding_of_Tokens_at_Logoff">3.20. Automatic Discarding of AFS Tokens at Logoff</title>
806       <indexterm significance="normal">
807         <primary>tokens</primary>
808       </indexterm>
809       <indexterm significance="normal">
810         <primary>LogoffPreserveTokens</primary>
811       </indexterm>
812       <para><emphasis>This section does not apply unless the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
813       <para>The OpenAFS Client 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.</para>
814       <para>If there is a need to disable this functionality, the
815         <link linkend="Value_LogoffPreserveTokens">LogoffPreserveTokens</link> registry value can be used. (see
816         <link linkend="appendix_a">Appendix A</link>.)
817       </para>
818     </section>
819     <section>
820       <title id="Windows_Terminal_Server_Installs">3.21. Windows Terminal Server installations</title>
821       <indexterm significance="normal">
822         <primary>Terminal Server</primary>
823       </indexterm>
824       <indexterm significance="normal">
825         <primary>Installation</primary>
826       </indexterm>
827       <para>The OpenAFS Servers should not be installed on a machine with Terminal Server installed.</para>
828     </section>
829     <section>
830       <title id="Hidden_Dot_Files">3.22. Hidden Dot Files</title>
831       <indexterm significance="normal">
832         <primary>HideDotFiles</primary>
833       </indexterm>
834       <para>AFS is a UNIX native file system. The OpenAFS client attempts to treat the files stored in AFS as they would be on UNIX. File and directory names beginning with a "." are automatically given the Hidden attribute so they will not normally be displayed.  This behavior can be altered via the
835         <link linkend="Value_HideDotFiles">HideDotFiles</link> registry value.
836       </para>
837     </section>
838     <section>
839       <title id="Status_Cache_Limits">3.23. Status Cache Limits</title>
840       <indexterm significance="normal">
841         <primary>afs_config.exe</primary>
842       </indexterm>
843       <indexterm significance="normal">
844         <primary>AFS Configuration Control Panel</primary>
845       </indexterm>
846       <indexterm significance="normal">
847         <primary>cache limits</primary>
848       </indexterm>
849       <indexterm significance="normal">
850         <primary>Stats</primary>
851       </indexterm>
852       <para>The Status Cache (AFS Configuration Control Panel: Advanced Page) is defined to have a maximum number of entries. Each entry represents a single file or directory entry accessed within the AFS file system. When the maximum number of entries are allocated, entries will begin to be reused according to a least recently used (LRU) algorithm. If the number of files or directories being accessed repeatedly by your applications is greater then the maximum number of entries, your host will begin to experience thrashing of the Status Cache and all requests will result in network operations.</para>
853       <para>If you are experiencing poor performance try increasing the maximum number of Status Cache entries. Each entry requires approximately 1.2K. The default number of Status Cache entries is 10,000.  This can be adjusted using the
854         <link linkend="Value_Stats">Stats</link> registry value.
855       </para>
856     </section>
857     <section>
858       <title id="NETBIOS_over_TCP">3.24. NETBIOS over TCP/IP must be enabled</title>
859       <indexterm significance="normal">
860         <primary>NETBIOS over TCP</primary>
861       </indexterm>
862       <para>"Netbios over TCP/IP" must be active on the machine in order for communication with the AFS Client Service to succeed. If "Netbios over TCP/IP" is disabled on the machine, then communication with the AFS Client Service will be impossible.  If you are using the Microsoft Loopback Adapter, configure the "Netbios over TCP/IP" setting for the adapter.</para>
863     </section>
864     <section>
865       <title id="OpenAFS_binaries_digital_signatures">3.25. OpenAFS binaries are digitally signed</title>
866       <indexterm significance="normal">
867         <primary>digital signatures</primary>
868       </indexterm>
869       <indexterm significance="normal">
870         <primary>Your File System Inc.</primary>
871       </indexterm>
872       <indexterm significance="normal">
873         <primary>Secure Endpoints Inc.</primary>
874       </indexterm>
875       <indexterm significance="normal">
876         <primary>VerifyServiceSignature</primary>
877       </indexterm>
878       <para>The OpenAFS Client Service and related binaries distributed by OpenAFS.org are digitally signed by "Secure Endpoints Inc." or "Your File System Inc.". The OpenAFS Client Service will perform a run-time verification check to ensure that all OpenAFS related DLLs loaded by the service match the same file version number and were signed by the same entity. This check has been added to prevent the stability problems caused when more than one AFS installation is present on a machine simultaneously. Many hours of support time have been wasted tracking down problems caused by the mixture of files from different releases. </para>
879       <para>
880         <link linkend="appendix_a">Appendix A</link> documents the "
881         <link linkend="Value_VerifyServiceSignature">VerifyServiceSignature</link>" registry value which can be used to disable the signature check. The file version check cannot be disabled.
882       </para>
883     </section>
884     <section>
885       <title id="Maximum_Cache_Size">3.26. Maximum Size of the AFSCache File</title>
886       <indexterm significance="normal">
887         <primary>cache size</primary>
888       </indexterm>
889       <para>The maximum cache size on 32-bit Windows is approximately 1.2GB. This is the largest contiguous block of memory in the 2GB process address space which can be used for constructing a memory mapped file. Due to fragmentation of the process space caused by the loading of libraries required by the digital signature verification code, any attempt to specify a cache size greater then 700MB will result in the automatic disabling of the signature check.  Significantly larger cache sizes can be used on 64-bit Windows.</para>
890       <para>On 32-bit systems that have Apple Bonjour 1.0.6 installed, the maximum cache size is further constrained due design flaw in the Apple mdnsNSP.dll which is injected into all processes that use network services.  On these systems the maximum is approximately 512MB.</para>
891     </section>
892     <section>
893       <title id="Filename_Character_Sets">3.27. Filename Character Sets</title>
894       <indexterm significance="normal">
895         <primary>character sets</primary>
896       </indexterm>
897       <indexterm significance="normal">
898         <primary>StoreAnsiFilenames</primary>
899       </indexterm>
900       <para><emphasis>This section describes functionality and concerns related to pre-1.5.50 releases of OpenAFS for Windows.   This release stores all file names on the file servers as Unicode encoded using UTF-8.</emphasis></para>
901       <para>OpenAFS for Windows implements an SMB server which is used as a gateway to the AFS filesystem. Because of limitations of the SMB implementation in pre-1.5.50 releases, Windows stored all files into AFS using OEM code pages such as CP437 (United States) or CP850 (Western Europe). These code pages are incompatible with the ISO Latin-1 or Unicode (UTF-8) character sets typically used as the default on UNIX systems in both the United States and Western Europe. Filenames stored by OpenAFS for Windows were therefore unreadable on UNIX systems if they include any of the following characters:</para>
902       <informaltable frame="all">
903         <tgroup rowsep="1" align="left" colsep="1" cols="1">
904           <colspec colwidth="442pt" colname="c1" />
905           <tbody>
906             <row>
907               <entry>
908                 <para> [Ç] 128 08/00 200 80 C cedilla</para>
909                 <para> [ü] 129 08/01 201 81 u diaeresis</para>
910                 <para> [é] 130 08/02 202 82 e acute</para>
911                 <para> [â] 131 08/03 203 83 a circumflex</para>
912                 <para> [ä] 132 08/04 204 84 a diaeresis</para>
913                 <para> [à] 133 08/05 205 85 a grave</para>
914                 <para> [å] 134 08/06 206 86 a ring</para>
915                 <para> [ç] 135 08/07 207 87 c cedilla</para>
916                 <para> [ê] 136 08/08 210 88 e circumflex</para>
917                 <para> [ë] 137 08/09 211 89 e diaeresis</para>
918                 <para> [è] 138 08/10 212 8A e grave</para>
919                 <para> [ï] 139 08/11 213 8B i diaeresis</para>
920                 <para> [î] 140 08/12 214 8C i circumflex</para>
921                 <para> [ì] 141 08/13 215 8D i grave</para>
922                 <para> [Ä] 142 08/14 216 8E A diaeresis</para>
923                 <para> [Å] 143 08/15 217 8F A ring</para>
924                 <para> [É] 144 09/00 220 90 E acute</para>
925                 <para> [æ] 145 09/01 221 91 ae diphthong</para>
926                 <para> [Æ] 146 09/02 222 92 AE diphthong</para>
927                 <para> [ô] 147 09/03 223 93 o circumflex</para>
928                 <para> [ö] 148 09/04 224 94 o diaeresis</para>
929                 <para> [ò] 149 09/05 225 95 o grave</para>
930                 <para> [û] 150 09/06 226 96 u circumflex</para>
931                 <para> [ù] 151 09/07 227 97 u grave</para>
932                 <para> [ÿ] 152 09/08 230 98 y diaeresis</para>
933                 <para> [Ö] 153 09/09 231 99 O diaeresis</para>
934                 <para> [Ü] 154 09/10 232 9A U diaeresis</para>
935                 <para> [ø] 155 09/11 233 9B o slash</para>
936                 <para> [£] 156 09/12 234 9C Pound sterling sign</para>
937                 <para> [Ø] 157 09/13 235 9D O slash</para>
938                 <para> [×] 158 09/14 236 9E Multiplication sign</para>
939                 <para> [ƒ] 159 09/15 237 9F Florin sign</para>
940               </entry>
941             </row>
942           </tbody>
943         </tgroup>
944       </informaltable>
945       <para></para>
946       <para>The pre-1.5.50 OpenAFS Client provided an optional registry value,
947         <link linkend="Value_StoreAnsiFilenames">StoreAnsiFilenames</link>, that could be set to instruct OpenAFS to store filenames using the ANSI Code Page instead of the OEM Code Page. The ANSI Code Page is a compatible superset of Latin-1. This 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.
948       </para>
949       <para>All versions of OpenAFS for Windows 1.5.50 and above exchange file names with Microsoft Windows using the Unicode character set. All file names are read from and stored to AFS file servers using the UTF-8 encoding of Unicode. As a result the
950         <link linkend="Value_StoreAnsiFilenames">StoreAnsiFilenames</link> option is no longer supported.
951       </para>
952     </section>
953     <section>
954       <title id="Character_Set_Issues_Roaming_Profiles">3.28. Character Set Issues with Roaming Profiles</title>
955       <indexterm significance="normal">
956         <primary>character sets</primary>
957       </indexterm>
958       <indexterm significance="normal">
959         <primary>roaming profiles</primary>
960       </indexterm>
961       <para><emphasis>This section describes functionality and concerns related to pre-1.5.50 releases of OpenAFS for Windows.   This release stores all file names on the file servers as Unicode encoded using UTF-8.</emphasis></para>
962       <para>There is a known issue with storing Windows Roaming Profiles when the profile contains either directories or files with names which cannot be represented in the local OEM character set. In this case, attempts to write the profile back to AFS will fail during the character set conversion. The pre-1.5.50 OpenAFS Client's CIFS gateway did not support UNICODE. To avoid this problem some sites run custom logoff scripts (assigned by group policy) which rename all files to use only the supported characters for the locale.</para>
963       <para>Versions of OpenAFS for Windows 1.5.50 and above do not suffer from these issues.</para>
964     </section>
965     <section>
966       <title id="AFSCache_File">3.29. The AFSCache File</title>
967       <indexterm significance="normal">
968         <primary>AFSCache</primary>
969       </indexterm>
970       <indexterm significance="normal">
971         <primary>cache file</primary>
972       </indexterm>
973       <indexterm significance="normal">
974         <primary>SysInternals</primary>
975       </indexterm>
976       <para>The AFS Cache file is stored by default at %TEMP%\AFSCache in a persistent file marked with the Hidden and System attributes. The persistent nature of the data stored in the cache file improves the performance of OpenAFS by reducing the number of times data must be read from the AFS file servers. </para>
977       <para>The performance of the AFS Client Service is significantly affected by the access times associated with the AFSCache paging file. When given the choice, the AFSCache file should be placed on a fast disk, preferably formatted NTFS and using a Solid State Disk, the file should not be 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 while the AFS Client Service is stopped.</para>
978     </section>
979     <section>
980       <title id="Restricting_OpenAFS_Service_Start_and_Stop">3.30. Restricting OpenAFS Client Service Start and Stop</title>
981       <indexterm significance="normal">
982         <primary>service start restrictions</primary>
983       </indexterm>
984       <indexterm significance="normal">
985         <primary>TransarcAFSDaemon</primary>
986       </indexterm>
987       <indexterm significance="normal">
988         <primary>afsdacl.exe</primary>
989       </indexterm>
990       <para>A command line tool, afsdacl.exe, can be used to restrict the ability to start and stop the OpenAFS Client Service.</para>
991       <para>
992         <programlisting format="linespecific">
993     afsdacl : Set or reset the DACL to allow starting or stopping
994               the afsd service by any ordinary user.
996     Usage: afsdacl [-set | -reset] [-show]
997            -set   : Sets the DACL
998            -reset : Reset the DACL
999            -show  : Show current DACL (SDSF)
1000     </programlisting>
1001       </para>
1002     </section>
1003     <section>
1004       <title id="SysName_List">3.31. The @sys Name List</title>
1005       <indexterm significance="normal">
1006         <primary>@sys</primary>
1007       </indexterm>
1008       <indexterm significance="normal">
1009         <primary>fs sysname</primary>
1010       </indexterm>
1011       <indexterm significance="normal">
1012         <primary>SysName</primary>
1013       </indexterm>
1014       <para>The default @sys name list in the OpenAFS Client is set to "x86_win32 i386_w2k i386_nt40" for 32-bit x86 systems. The default is "amd64_win64" for amd 64-bit versions of Windows.</para>
1015       <para>The IFS redirector driver is aware of the process type.  On 64-bit systems, there are two @sys name lists "SysName" which is used for the WOW64 environment and "SysName64" which is used for the 64-bit environment.</para>
1016     </section>
1017     <section>
1018       <title id="Symlinks_to_AFS_UNC_Paths">3.32. Symlinks to AFS UNC Paths</title>
1019       <indexterm significance="normal">
1020         <primary>UNC paths</primary>
1021       </indexterm>
1022       <indexterm significance="normal">
1023         <primary>symlinks</primary>
1024       </indexterm>
1025       <indexterm significance="normal">
1026         <primary>path separators</primary>
1027       </indexterm>
1028       <indexterm significance="normal">
1029         <primary>symlink.exe</primary>
1030       </indexterm>
1031       <indexterm significance="normal">
1032         <primary>symlink make</primary>
1033       </indexterm>
1034       <para>In OpenAFS, symlinks to AFS UNC paths, \\AFS[\all]\..., are treated the same as symlinks to /afs/... However, please use /afs/... as the Windows UNC form will not work on UNIX client.</para>
1035       <para>The <emphasis>symlink make</emphasis> command will automatically translate \\AFS\... to /afs/... for you.</para>
1036     </section>
1037     <section>
1038       <title id="Cache_Manager_Debugging">3.33. Cache Manager Debugging</title>
1039       <indexterm significance="normal">
1040         <primary>debugging the cache manager</primary>
1041       </indexterm>
1042       <indexterm significance="normal">
1043         <primary>cmdebug.exe</primary>
1044       </indexterm>
1045       <para>The OpenAFS Client implements the Cache Manager Debugging RPC Interface. The CM debugger can be queried with <ulink url="http://docs.openafs.org/Reference/1/cmdebug.html">cmdebug.exe</ulink>.  </para>
1046       <para>
1047         <programlisting format="linespecific">
1048     Usage: cmdebug -servers &lt;server machine&gt; [-port &lt;IP port&gt;] [-long] [-refcounts]
1049                     [-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
1050     Where: -long        print all info
1051            -refcounts   print only cache entries with positive reference counts
1052            -callbacks   print only cache entries with callbacks
1053            -ctime       print human readable expiration time
1054            -addrs       print only host interfaces
1055            -cache       print only cache configuration
1056            -cellservdb  print only cellservdb info
1057     </programlisting>
1058       </para>
1059     </section>
1060     <section>
1061       <title id="Windows_Logon_Caching_vs_Kerberos_Logons">3.34. Windows Logon Caching vs. Kerberos Logons</title>
1062       <indexterm significance="normal">
1063         <primary>windows logon caching</primary>
1064       </indexterm>
1065       <indexterm significance="normal">
1066         <primary>kerberos</primary>
1067       </indexterm>
1068       <para>If you are a site which utilizes MIT/Heimdal Kerberos 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 or Windows 7.</para>
1069     </section>
1070     <section>
1071       <title id="Initial_Server_Preferences">3.35. Initial Server Preferences</title>
1072       <indexterm significance="normal">
1073         <primary>server preferences</primary>
1074       </indexterm>
1075       <indexterm significance="normal">
1076         <primary>fs setserverprefs</primary>
1077       </indexterm>
1078       <indexterm significance="normal">
1079         <primary>setting server preferences</primary>
1080       </indexterm>
1081       <para>VLDB and File Server Preferences can now be provided initial values using registry keys. This is useful for managed machines in a Windows domain which are centrally located (e.g., in a computing lab.) See
1082         <link linkend="appendix_a">Appendix A</link> for details on the "
1083         <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB">Server Preferences</link>" keys.
1084       </para>
1085     </section>
1086     <section>
1087       <title id="File_Timestamps_and_DST">3.36. File Timestamps and Daylight Saving Time</title>
1088       <indexterm significance="normal">
1089         <primary>timestamps</primary>
1090       </indexterm>
1091       <indexterm significance="normal">
1092         <primary>DST</primary>
1093       </indexterm>
1094       <indexterm significance="normal">
1095         <primary>UTC</primary>
1096       </indexterm>
1097       <para>The OpenAFS Client reports timestamps on files stored in AFS in UTC all year round. In locales with daylight savings time, previous versions of AFS for Windows reported the time when DST is active as UTC+1. This was done to preserve the relative local time for the user. A file stored at 11:00am EST in January would be reported as having been stored at 11:00am EDT in June. Unfortunately, this has the negative side effect of changing the reported timestamp from 16:00UTC to 15:00UTC. Since Windows treats all file times in UTC, data synchronization applications which rely on the timestamp would believe that all files stored in AFS had changed.</para>
1098       <para>It should be noted that UNIX based operating systems (such as Solaris) do not appear to report file times to applications in UTC. They do preserve the relative local time. This may confuse some users who are used to being able to compare the timestamp in an UNIX shell with the 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.</para>
1099     </section>
1100     <section>
1101       <title id="Windows_RPC_client_support">3.37. Windows RPC client support must be installed </title>
1102       <indexterm significance="normal">
1103         <primary>RPC client support</primary>
1104       </indexterm>
1105       <para>If the installer refuses to install and complains about an RPC configuration error, check to ensure that the following registry entries are present and that they refer to the dll "rpcrt4.dll":</para>
1106       <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_np"</para>
1107       <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_ip_tcp"</para>
1108       <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncadg_ip_udp"</para>
1109       <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_http"</para>
1110     </section>
1111     <section>
1112       <title id="Generating_Minidumps">3.38. Generating Minidumps of the OpenAFS Client Service</title>
1113       <indexterm significance="normal">
1114         <primary>minidumps</primary>
1115       </indexterm>
1116       <indexterm significance="normal">
1117         <primary>fs minidump</primary>
1118       </indexterm>
1119       <para>OpenAFS 1.4 added a new command, "fs minidump". This command can be used at any time to generate a mini dump file containing the current stack of the afsd_service.exe process. This output can be very helpful when debugging the AFS Client Service when it is unresponsive to SMB/CIFS requests.</para>
1120     </section>
1121     <section>
1122       <title id="AFS_UUIDs_vs_System_Cloning">3.39. AFS Client Universally Unique Identifiers (UUIDs) vs. System Cloning or Virtual Machine Cloning</title>
1123       <indexterm significance="normal">
1124         <primary>UUIDs</primary>
1125       </indexterm>
1126       <indexterm significance="normal">
1127         <primary>system cloning</primary>
1128       </indexterm>
1129       <indexterm significance="normal">
1130         <primary>vm cloning</primary>
1131       </indexterm>
1132       <indexterm significance="normal">
1133         <primary>NonPersistentCaching</primary>
1134       </indexterm>
1135       <indexterm significance="normal">
1136         <primary>instloop.exe</primary>
1137       </indexterm>
1138       <indexterm significance="normal">
1139         <primary>msiexec.exe</primary>
1140       </indexterm>
1141       <para>The OpenAFS Client implements Universally Unique Identifiers (UUIDs). They are used to provide the AFS file server with a method of identifying the client that is independent of IP address. This permits the AFS file server to track mobile clients or those behind Network Address Translators when they move from address to address or port to port. Tracking the client improves client performance by permitting callback state to be maintained across location changes. The UUID is generated when the AFSCache file is created and is maintained as long as the contents of the AFSCache file are valid. The UUID is stored in the AFSCache file.</para>
1142       <para>When cloning machines that have Windows AFS client installed it is necessary to generate a new UUID for each client. This will be done automatically if the Windows Machine SID is re-generated using Microsoft SysPrep. If the SID is not being re-generated either the AFSCache file should be deleted or the command
1143         <emphasis>fs uuid -generate</emphasis> must be executed after the the clone is created.
1144         <emphasis role="bold">Multiple AFS clients reporting the same UUID will not only result in horrible AFS client performance and cache inconsistencies, but they will also put a tremendous strain on the AFS file servers.</emphasis></para>
1145       <para>For lab environments that wish to erase all cached data on each restart, the
1146         <link linkend="Value_NonPersistentCaching">NonPersistentCaching</link> option will disable the use of the persistent cache file. As a side effect, a new UUID will be generated for the AFS client service on each restart.
1147       </para>
1148       <para>When a Windows system is cloned, the Microsoft Loopback Adapter will be disabled in the cloned system.  Administrators must re-install the Microsoft Loopback Adapter within the cloned environment.  This can be automated by using the OpenAFS "
1149         <emphasis>instloop.exe</emphasis> –
1150         <emphasis>i</emphasis>" command.  Instloop.exe can be extracted from the MSI installer by performing an administrative install via
1151         <emphasis>msiexec.exe /a</emphasis>.
1152       </para>
1153     </section>
1154     <section>
1155       <title id="Delayed_Write_Errors">3.40. Delayed Write Errors with Microsoft Office Applications</title>
1156       <indexterm significance="normal">
1157         <primary>delayed write errors</primary>
1158       </indexterm>
1159       <indexterm significance="normal">
1160         <primary>ConnDeadTimeout</primary>
1161       </indexterm>
1162       <indexterm significance="normal">
1163         <primary>SMBAsyncStoreSize</primary>
1164       </indexterm>
1165       <indexterm significance="normal">
1166         <primary>EnableSMBAsyncStore</primary>
1167       </indexterm>
1168       <indexterm significance="normal">
1169         <primary>SMB timeouts</primary>
1170       </indexterm>
1171       <para><emphasis>This section does not apply unless the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
1172       <para>Microsoft Office makes heavy use of asynchronous input/output methods for reading and writing to file streams. This can result in hundreds of requests being simultaneously queued for service by the CIFS client with a fixed timeout period. As the AFS CIFS server is local to the machine the Windows CIFS client believes that it can respond almost instantaneously to write requests as the actual writing to the AFS file server is performed by a background daemon thread. When the actual network bandwidth to the AFS file server is slow and the file size is large it is possible for the CIFS client to time out the connection. When this happens a "delayed write error" will be reported to the user and the application may crash. The only workaround at the current time is to save first to a local disk and subsequently copy the file to AFS as copying a file with the explorer shell does not use asynchronous i/o. </para>
1173       <para>The CIFS session timeout defaults to 45 seconds and can be increased by modifying the
1174         <link linkend="Value_ConnDeadTimeout">ConnDeadTimeout registry value</link>.
1175       </para>
1176       <para>Beginning with the 1.5.33 release, the performance characteristics of SMB Write Data operations can be adjusted.  In prior releases all writes were performed using a restricted asynchronous store model in which only one asynchronous store operation per file can be performed at a time.  The reason for this restriction is limit the amount of data the cache manager will accept without it having been written to the file server.  If too much unwritten data is accepted, the file close operation will block until all of the unwritten data is output and this could trigger a CIFS client disconnect.  </para>
1177       <para>Prior to 1.5.33 the size of the asynchronous store was always equal to the chunk size which was often too large for low bandwidth connections.  The asynchronous store size now defaults to 32KB and is configurable using the
1178         <link linkend="Value_SMBAsyncStoreSize">SMBAsyncStoreSize</link> registry value.  Asynchronous store operations can also be disabled using the
1179         <link linkend="Value_EnableSMBAsyncStore">EnableSMBAsyncStore</link> registry value in which case all writes received by the cache manager block until the Rx StoreData operation completes.
1180       </para>
1181       <para>During the first quarter of 2009 Microsoft added new functionality to the SMB Redirector which permits an extended timeout period to be used
1182             for an enumerated list of Netbios server names.  This functionality was distributed in Service Pack 2 for Vista and 2008 and is incorporated
1183             into the RTM releases of Windows 7 and Server 2008 R2.  Updates to Windows XP (KB916204), XP64 (KB969289), and Server 2003 (KB969289) were
1184             made available as hot fixes.  When this support is available, the OpenAFS for Windows client 1.5.61 and above will raise the timeout period
1185             from 45 seconds to 10 minutes.</para>
1186     </section>
1187     <section>
1188       <title id="Global_Drives">3.41. Global Drives (aka Service Drive Letters) are no longer supported by Microsoft</title>
1189       <indexterm significance="normal">
1190         <primary>global drives</primary>
1191       </indexterm>
1192       <indexterm significance="normal">
1193         <primary>service drive letters</primary>
1194       </indexterm>
1195       <indexterm significance="normal">
1196         <primary>path ioctl failures</primary>
1197       </indexterm>
1198       <para>The Global DriveAuto-mount feature has been deprecated due to the following Microsoft KB article.</para>
1199       <para>
1200         <ulink url="http://msdn.microsoft.com/library/en-us/dllproc/base/services_and_redirected_drives.asp">http://msdn.microsoft.com/library/en-us/dllproc/base/services_and_redirected_drives.asp</ulink>
1201       </para>
1202       <para>The article says that services mounting drive letters are no longer supported by Microsoft and may act unpredictably.
1203             The experience other users have had is that if the connection to the OpenAFS CIFS/SMB server is terminated by the
1204             Windows CIFS client, the drive mapping may not be re-established until the machine is rebooted.</para>
1205       <para>OpenAFS supports UNC paths and whenever possible applications should be modified to use UNC form
1206             \\AFS\&lt;cellname&gt;\&lt;path&gt; instead of drive letters.</para>
1207       <para>Another problem with service mounted drive letters is that the drives are reported as local disk devices
1208             and cannot be resolved as being mapped to the \\AFS name space.  As a result, AFS path ioctl operations will
1209             fail.  The fs.exe and symlink.exe command line tools and the AFS Explorer Shell extension will not operate
1210             on service mounted drive letters.</para>
1211     </section>
1212     <section>
1213       <title id="SixtyFour-bit_Windows">3.42. 64-bit Microsoft Windows Installations</title>
1214       <indexterm significance="normal">
1215         <primary>64-bit Windows</primary>
1216       </indexterm>
1217       <para>Although 64-bit Windows platforms support both 64-bit and 32-bit applications, the OpenAFS Service installed on the machine must be 64-bit. The 64-bit installer contains only 64-bit executables. In order to support 32-bit applications it is required that a separate 32-bit OpenAFS Tools set be installed.  This is especially true when the IFS redirector is in use as the 32-bit Network Provider DLL must be installed in order for 32-bit applications to access drive letters mapped to \\AFS.</para>
1218       <para>OpenAFS on 64-bit Windows benefits from the lifting of the 2GB process memory restriction that is present in 32-bit Windows. Without this restriction the AFS Cache File can become arbitrarily large limited only by available disk space.</para>
1219     </section>
1220     <section>
1221       <title id="Windows_Vista_Known_Issues">3.43. Known Issues with Microsoft Windows Vista, Windows 7, and Server 2008 [R2]</title>
1222       <indexterm significance="normal">
1223         <primary>windows vista</primary>
1224       </indexterm>
1225       <indexterm significance="normal">
1226         <primary>windows 2008</primary>
1227       </indexterm>
1228       <indexterm significance="normal">
1229         <primary>windows 7</primary>
1230       </indexterm>
1231       <para>Windows Vista, Windows 7, and Server 2008 [R2] implement
1232         <ulink url="http://www.microsoft.com/technet/windowsvista/library/0d75f774-8514-4c9e-ac08-4c21f5c6c2d9.mspx">User Account Control</ulink> (UAC), a new security feature that implements least user privilege.  With UAC, applications only run with the minimum required privileges.  Even Administrator accounts run applications without the "Administrator" access control credentials.  One side effect of this is that existing applications that mix user and system configuration capabilities must be re-written to separate those functions that require "Administrator" privileges into a separate process space.  Future updates to OpenAFS will incorporate the necessary privilege separation, until that time some functions such as the Start and Stop Service features of the AFS Authentication Tool and the AFS Control Panel will not work unless they are "Run as Administrator".  When a Vista user account that is a member of the "Administrators" group is used to access the AFS Control Panel (afs_config.exe), the process must be "Run as Administrator".   Otherwise, attempts to modify the OpenAFS configuration will appear to succeed but in reality will have failed due to Vista's system file and registry virtualization feature.
1233       </para>
1234       <para>The help files provided with OpenAFS are in .HLP format.
1235         <ulink url="http://support.microsoft.com/kb/917607">Windows Vista, Windows 7, and Server 2008 [R2] do not include a help engine for this format.</ulink>
1236       </para>
1237       <para><emphasis>The following items only apply when the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
1238       <para>OpenAFS for Windows works with Microsoft Windows Vista, Windows 7 and Server 2008 [R2] from both the command prompt and the Explorer Shell.
1239             When performing an upgrade from earlier versions of Microsoft Windows the Microsoft Loopback Adapter (MSLA) will be uninstalled.
1240             OpenAFS should be re-installed after the Windows Upgrade installation to restore the MSLA configuration.</para>
1241       <para>Due to a feature change in Windows Vista's Plug-n-Play network stack, during a standby/hibernate operation the
1242             MSLA is disabled just as any other hardware device would be.  This causes the OpenAFS Client's network binding to be lost.
1243             As a result, it takes anywhere from 30 to 90 seconds after the operating system is resumed for access to the OpenAFS Client
1244             and the AFS file name space to be restored.  Until the network bindings have been re-established, ticket managers and other
1245             tools will report that the "AFS Client Service may not have been started".</para>
1246     </section>
1247     <section>
1248       <title id="AFS_Share_Direct_Access_to_Volumes">3.44. AFS Share Name Syntax Provides Direct Access to Volumes</title>
1249       <indexterm significance="normal">
1250         <primary>share names</primary>
1251       </indexterm>
1252       <indexterm significance="normal">
1253         <primary>afs volumes - direct access</primary>
1254       </indexterm>
1255       <para>Starting with the 1.5.21 release of OpenAFS for Windows, the following syntax can be used to access any volume in any cell without requiring the creation of a mount point.</para>
1256       <para>\\AFS\&lt;cell&gt;&lt;mount point type&gt;&lt;volume&gt;\</para>
1257       <para>Where &lt;cell&gt; can be either a full cell name or an unambiguous prefix, the &lt;mount point type&gt; is '#' for a normal mount point or '%' to force the use of a read-write volume, and &lt;volume&gt; is either a volume name or its ID number.</para>
1258       <para>Examples include:</para>
1259       <para>    \\AFS\athena.mit.edu#user.jaltman\</para>
1260       <para>    \\AFS\athena%user.jaltman\</para>
1261       <para>    \\AFS\athena.mit.edu# 537235559\</para>
1262     </section>
1263     <section>
1264       <title id="Differences_between_Windows_and_Unix">3.45. Differences between Windows and UNIX <emphasis>fs examine</emphasis></title>
1265       <indexterm significance="normal">
1266         <primary>fs examine</primary>
1267       </indexterm>
1268       <indexterm significance="normal">
1269         <primary>fs chown</primary>
1270       </indexterm>
1271       <indexterm significance="normal">
1272         <primary>fs chgrp</primary>
1273       </indexterm>
1274       <indexterm significance="normal">
1275         <primary>fs chmod</primary>
1276       </indexterm>
1277       <indexterm significance="normal">
1278         <primary>owner information</primary>
1279       </indexterm>
1280       <indexterm significance="normal">
1281         <primary>group information</primary>
1282       </indexterm>
1283       <para>The OpenAFS for Windows version of "fs examine" provide two additional lines of output when compared to the
1284         UNIX implementation.  These lines include the owner and group information for the file as well as the volume status.
1285         The Windows output will also indicate the type of object {File, Directory, Mountpoint, Symlink, ...} that was examined.</para>
1286       <para>[C:\]fs examine \\afs\athena#user.jaltman</para>
1287       <para>Directory \\afs\athena#user.jaltman (537235559.1.1) contained in cell athena.mit.edu</para>
1288       <para>
1289         <emphasis role="bold">Owner jaltman (28180) Group jaltman (28180)</emphasis>
1290       </para>
1291       <para>Volume status for vid = 537235559 named user.jaltman is</para>
1292       <para>Current disk quota is 1500000</para>
1293       <para>Current blocks used are 1244184</para>
1294       <para>The partition has 151945877 blocks available out of 511163724</para>
1295       <para>
1296         <emphasis role="bold">Volume is online</emphasis>
1297       </para>
1298       <para>
1299       </para>
1300       <para>The object owner and group and UNIX mode information is not available on Microsoft Windows via any other method.</para>
1301       <para>To set the owner use <emphasis>fs chown -owner &lt;user name or id&gt; [-path &lt;dir/file path&gt;+] [-literal]</emphasis></para>
1302       <para>To set the group use <emphasis>fs chgrp -group &lt;user name or id&gt; [-path &lt;dir/file path&gt;+] [-literal]</emphasis></para>
1303       <para>To set the UNIX mode use <emphasis>fs chmod -mode &lt;UNIX mode bits&gt; [-path &lt;dir/file path&gt;+] [-literal]</emphasis></para>
1304     </section>
1305     <section>
1306       <title id="fs_Command_Literal_Option">3.46. Literal evaluation of AFS Symlink and MountPoint objects via fs commands</title>
1307       <indexterm significance="normal">
1308         <primary>-literal</primary>
1309       </indexterm>
1310       <indexterm significance="normal">
1311         <primary>fs examine</primary>
1312       </indexterm>
1313       <indexterm significance="normal">
1314         <primary>fs flush</primary>
1315       </indexterm>
1316       <indexterm significance="normal">
1317         <primary>fs whereis</primary>
1318       </indexterm>
1319       <indexterm significance="normal">
1320         <primary>fs whichcell</primary>
1321       </indexterm>
1322       <para>Beginning with the 1.5.31 release, the fs commands
1323         <emphasis>examine</emphasis>,
1324         <emphasis>flush</emphasis>,
1325         <emphasis>whereis</emphasis>, and
1326         <emphasis>whichcell</emphasis> provide a new command-line parameter,
1327         <emphasis>-literal</emphasis>.  When specified, if the evaluated object is a symlink or a mountpoint the resulting output will describe the specified object and not the target of the symlink or mountpoint.
1328       </para>
1329     </section>
1330     <section>
1331       <title id="Out_of_Quota_Errors">3.47. Out of Quota errors</title>
1332       <indexterm significance="normal">
1333         <primary>out of quota</primary>
1334       </indexterm>
1335       <indexterm significance="normal">
1336         <primary>quotas</primary>
1337       </indexterm>
1338       <para>Prior to the 1.5.31 release, out of quota errors were reported to the calling application as an out of space error.  As of 1.5.31, an out of space error will indicate that the partition on which the volume is located is in fact out of space.  Whereas an out of quota error indicates that the user does not have permission to allocate additional space.</para>
1339     </section>
1340     <section id="Linked_Cells">
1341       <title>3.48. Linked Cells</title>
1342       <indexterm significance="normal">
1343         <primary>linked cells</primary>
1344       </indexterm>
1345       <indexterm significance="normal">
1346         <primary>cell renaming</primary>
1347       </indexterm>
1348       <indexterm significance="normal">
1349         <primary>cell splitting</primary>
1350       </indexterm>
1351       <indexterm significance="normal">
1352         <primary>cell merging</primary>
1353       </indexterm>
1354       <indexterm significance="normal">
1355         <primary>CellServDB</primary>
1356       </indexterm>
1357       <para>The 1.5.55 release adds support for linked cells as implemented in the Unix OpenAFS client.  When two cells are linked, a volume lookup in one cell that fails is retried in the linked cell.  This functionality can be used to implement:</para>
1358       <itemizedlist mark="bullet">
1359         <listitem>
1360           <para>a test cell which provides substitutes for a subset of the volumes in the linked production cell</para>
1361         </listitem>
1362         <listitem>
1363           <para>a cell renaming</para>
1364         </listitem>
1365         <listitem>
1366           <para>a cell splitting</para>
1367         </listitem>
1368         <listitem>
1369           <para>a cell merger</para>
1370         </listitem>
1371       </itemizedlist>
1372       <para>Two cells are linked in the CellServDB file:</para>
1373       <para>
1374         <programlisting format="linespecific">
1375        &gt;cell-one     cell-two        #Description
1376        ...
1377        &gt;cell-two     cell-one        #Description
1378        ...
1379        </programlisting>
1380       </para>
1381       <para>aklog and Network Identity Manager will automatically obtain tokens for the linked cell when tokens for the other cell is specified.
1382       </para>
1383     </section>
1384     <section id="Registry_VLDB_Configuration">
1385       <title>3.49 Registry Configuration for AFS Volume Database Servers</title>
1386       <indexterm significance="normal">
1387         <primary>vldb server locations</primary>
1388       </indexterm>
1389       <indexterm significance="normal">
1390         <primary>CellServDB</primary>
1391       </indexterm>
1392       <para>Beginning with the 1.5.60 release, the <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB">[HKLM\SOFTWARE\OpenAFS\Client\CellServDB]</link>
1393     registry key can be used to distribute Volume Database Server location information either as a supplement to the <emphasis>CellServDB file</emphasis> or
1394     as a substitute for it.  The precedence order for lookups is: Registry, File, and then DNS.</para>
1395     </section>
1396     <section>
1397       <title id="HTMLHelp_Documentation">3.50 Documentation Converted to Windows HTML Help</title>
1398       <indexterm significance="normal">
1399         <primary>HTMLHelp</primary>
1400       </indexterm>
1401       <para>Starting with the 1.5.60 release, this document, the OpenAFS Administrator Guide and the OpenAFS User Guide are provided in HTML Help format instead
1402     of raw HTML pages.</para>
1403     </section>
1404     <section>
1405       <title id="MSRPC_Services">3.51. Support for Microsoft RPC Services: WKSSVC and SRVSVC</title>
1406       <indexterm significance="normal">
1407         <primary>Explorer Shell</primary>
1408       </indexterm>
1409       <indexterm significance="normal">
1410         <primary>Microsoft Office</primary>
1411       </indexterm>
1412       <para>Beginning with the 1.5.62 release, the OpenAFS SMB Server supports named pipes and the Microsoft RPC Services
1413         WKSSVC and SRVSVC.  This permits a significantly improved Netbios Server browsing experience with both the
1414         <emphasis>NET VIEW \\AFS</emphasis> command and the Explorer Shell.  No longer will Windows display truncated
1415         cell names as available network shares.  The network share properties will also include the object type and
1416         and the target of symlinks and mount points.</para>
1417     </section>
1418     <section>
1419       <title id="fs_newcell_differences">3.52. Differences between Windows and UNIX <emphasis>fs newcell</emphasis></title>
1420       <indexterm significance="normal">
1421         <primary>fs newcell</primary>
1422       </indexterm>
1423       <para>
1424         The OpenAFS for Windows version of "fs newcell" prior to 1.5.74 behaved quite differently than its UNIX counterpart.
1425         Instead of adding cell server information for a new cell, the command simply caused the cache manager to destroy all of its
1426         cell server information and then reload it the next time the server list for a cell is needed.  The UNIX version explicitly
1427         replaces the server list for a cell with a new list.
1428       </para>
1429       <para>
1430         Beginning with the 1.5.75 release, the Windows version will continue to behave as prior versions did when no parameters
1431         are specified but will accept an extended UNIX command-line syntax as well.  In addition to the UNIX parameters,
1432         the Windows "fs newcell" command accepts four new ones:
1433       </para>
1434       <itemizedlist>
1435         <listitem>
1436           <para>[-fsport &lt;cell's fileserver port&gt;]</para>
1437           <para>Specifies an alternate port number at which the cell's file servers are listening</para>
1438         </listitem>
1439         <listitem>
1440           <para>[-vlport &lt;cell's vldb server port&gt;]</para>
1441           <para>Specifies an alternate port number at which the cell's volume location database servers are listening</para>
1442         </listitem>
1443         <listitem>
1444           <para>[-registry]</para>
1445           <para>Instructs the cache manager to save the cell server information to the registry database</para>
1446         </listitem>
1447         <listitem>
1448           <para>[-dns]</para>
1449           <para>Indicates that the cell server information should be obtained via DNS SRV or DNS AFSDB records</para>
1450         </listitem>
1451       </itemizedlist>
1452     </section>
1454     <section>
1455       <title id="openafs_reparse_points">3.53. AFS Mount Points and Symlinks are Reparse Points</title>
1456       <indexterm significance="normal">
1457         <primary>reparse points</primary>
1458       </indexterm>
1459       <indexterm significance="normal">
1460         <primary>mount points</primary>
1461       </indexterm>
1462       <indexterm significance="normal">
1463         <primary>symlinks</primary>
1464       </indexterm>
1465       <para>
1466                 The IFS redirector driver represents all AFS mount points and AFS symlinks as reparse points within the file system name space
1467                 using a Microsoft assigned tag value. Tools that are OpenAFS reparse point aware can create, query
1468                 and remove AFS symlinks and mount points without requiring knowledge
1469                 of AFS pioctls.  The explorer shell will be able to delete a mount
1470                 point or symlink as part of a recursive directory tree removal without
1471                 crossing into the reparse point target.
1472       </para>
1473     </section>
1475     <section>
1476       <title id="authentication_groups">3.54. AFS Authentication Groups</title>
1477       <indexterm significance="normal">
1478         <primary>authentication groups</primary>
1479       </indexterm>
1480       <indexterm significance="normal">
1481         <primary>PAG</primary>
1482       </indexterm>
1483       <indexterm significance="normal">
1484         <primary>tokens</primary>
1485       </indexterm>
1486       <para>
1487                 When the OpenAFS Service is configured as an SMB Gateway, all AFS Tokens are associated with Windows user names.
1488                 With the IFS redirector driver, tokens are associated with Authentication Groups.
1489                 By default, an authentication group is allocated for each User SID
1490                 and Logon Session Id combination.  In addition, it is possible for
1491                 processes to create additional Authentication Groups.  Each thread in
1492                 a process can select an Authentication Group within the process as the
1493                 active Authentication Group.
1494                 </para>
1495           <para>
1496                 One of the significant benefits of Authentication Groups within the
1497                 Windows environment is that Windows services (svchost.exe, csrss.exe,
1498                 etc.) which impersonate user processes will seamlessly gain access
1499                 to the user's AFS credentials for the lifetime of the impersonation.
1500       </para>
1501     </section>
1503     <section>
1504       <title id="ifs_known_issues">3.55. Known IFS redirector driver limitations</title>
1505       <indexterm significance="normal">
1506         <primary>IFS redirector</primary>
1507       </indexterm>
1508       <indexterm significance="normal">
1509         <primary>known issues</primary>
1510       </indexterm>
1511       <para>
1512       The following is a list of known issues when using the IFS redirector driver:
1513       <itemizedlist>
1514       <listitem>
1515                 <para>It is not possible to execute an application out of AFS under
1516    the following conditions:
1517       <itemizedlist>
1518       <listitem><para>The path is a drive letter mapping</para></listitem>
1519       <listitem><para>The application requires elevated privileges</para></listitem>
1520       </itemizedlist>
1521    Workaround: use SUBST instead of NET USE to assign drive
1522    letters to UNC paths.
1523       </para>
1524       </listitem>
1525       <listitem>
1526       <para>The Windows File System <ulink url="http://msdn.microsoft.com/en-us/library/ff549293%28v=vs.85%29.aspx">Volume Query Quota Interface</ulink> is not implemented.  As a result, AFS quota information is not available to application processes or end users via Windows dialogs.</para>
1527       </listitem>
1528       <listitem>
1529       <para>The Windows <ulink url="https://secure.wikimedia.org/wikipedia/en/wiki/Shadow_Copy">Volume Shadow Copy Service</ulink> is not implemented.  As a result, AFS backup volumes are not accessible via the Explorer Shell.</para>
1530       </listitem>
1531       <listitem>
1532       <para>
1533       There is no support for storing DOS attributes such as Hidden, System, or Archive.
1534       </para>
1535       </listitem>
1536       <listitem>
1537       <para>
1538       There is no support for Alternate Data Streams as required by Windows User Account Control to store Zone Identity data.
1539       </para>
1540       </listitem>
1541       <listitem>
1542       <para>
1543       There is no support for Extended Attributes.
1544       </para>
1545       </listitem>
1546       <listitem>
1547       <para>
1548       There is no support for <ulink url="https://blogs.technet.com/b/hugofe/archive/2010/06/21/windows-2008-access-based-enumeration-abe.aspx">Access Based Enumeration</ulink>.
1549       </para>
1550       </listitem>
1551       <listitem>
1552       <para>
1553       There is no support for <ulink url="https://secure.wikimedia.org/wikipedia/en/wiki/Windows_Management_Instrumentation">Windows Management Instrumentation</ulink>
1554       </para>
1555       </listitem>
1556       <listitem>
1557       <para>
1558       There is no support for <ulink url="http://msdn.microsoft.com/en-us/library/aa363997%28v=vs.85%29.aspx">Distributed Link Tracking and Object Identifiers</ulink>
1559       </para>
1560       </listitem>
1561       <listitem>
1562       <para>
1563       There is no support for storing <ulink url="http://msdn.microsoft.com/en-us/magazine/cc982153.aspx">Windows Access Control Lists</ulink>.  Only the AFS ACLs are enforced.
1564       </para>
1565       </listitem>
1566       </itemizedlist>
1567       </para>
1568     </section>
1570   </chapter>
1571   <chapter id="chap_4">
1572     <title id="How_to_Debug_Problems">How to Troubleshoot Problems with OpenAFS for Windows</title>
1573     <para>
1574     <indexterm significance="normal">
1575       <primary>debugging</primary>
1576     </indexterm>
1577     <indexterm significance="normal">
1578       <primary>troubleshooting</primary>
1579     </indexterm>
1580     OpenAFS for Windows provides a wide range of tools to assist you in debugging problems. The techniques available to you are varied because of the wide range of issues that have been discovered over the years.</para>
1581     <section>
1582       <title id="pioctl_debugging">4.1. pioctl debugging (
1583         <link linkend="Value_IoctlDebug">IoctlDebug</link> registry key)
1584       </title>
1585       <indexterm significance="normal">
1586         <primary>IoctlDebug</primary>
1587       </indexterm>
1588       <indexterm significance="normal">
1589         <primary>tokens.exe</primary>
1590       </indexterm>
1591       <indexterm significance="normal">
1592         <primary>aklog.exe</primary>
1593       </indexterm>
1594       <indexterm significance="normal">
1595         <primary>afscreds.exe</primary>
1596       </indexterm>
1597       <para>pioctl (path-based ioctl) calls are used by various tools to communicate with the AFS Client Service. Some of the operations performed include:</para>
1598       <itemizedlist>
1599         <listitem>
1600           <para>setting/querying tokens (tokens.exe, aklog.exe, afscreds.exe)</para>
1601         </listitem>
1602         <listitem>
1603           <para>setting/querying ACLs </para>
1604         </listitem>
1605         <listitem>
1606           <para>setting/querying cache parameters</para>
1607         </listitem>
1608         <listitem>
1609           <para>flushing files or volumes</para>
1610         </listitem>
1611         <listitem>
1612           <para>setting/querying server preferences</para>
1613         </listitem>
1614         <listitem>
1615           <para>querying path location</para>
1616         </listitem>
1617         <listitem>
1618           <para>checking the status of servers and volumes</para>
1619         </listitem>
1620         <listitem>
1621           <para>setting/querying the sysname list</para>
1622         </listitem>
1623       </itemizedlist>
1624       <para>pioctl calls are implemented by writing to a special UNC path that is processed by the AFS Client Service. If there is a failure to communicate with the AFS Client Service via SMB/CIFS, it will be impossible to perform any of the above operations. </para>
1625       <para>To assist in debugging these problems, the registry value:</para>
1626       <para> [HKLM\SOFTWARE\OpenAFS\Client]</para>
1627       <para> REG_DWORD: IoctlDebug = 0x01</para>
1628       <para>should be set. Then any of the commands that perform pioctl calls should be executed from the command prompt. With this key set the pioctl library will generate debugging output to stderr. The output will contain the Win32 API calls executed along with their most important parameters and their return code. The MSDN Library and the Microsoft KnowledgeBase can be used as a reference to help you determine the configuration probem with your system.</para>
1629     </section>
1630     <section>
1631       <title id="afsd_service_init_log">4.2. afsd_service initialization log (%WinDir%\TEMP\afsd_init.log)</title>
1632       <indexterm significance="normal">
1633         <primary>afsd_init.log</primary>
1634       </indexterm>
1635       <indexterm significance="normal">
1636         <primary>MaxLogSize</primary>
1637       </indexterm>
1638       <para>Every time the AFS Client Service starts it appends data about its progress and configuration to a file. This file provides information crucial to determining why the service cannot start when there are problems. When the process terminates due to a panic condition it will write to this file the source code file and line number of the error. In many cases the panic condition is due to a misconfiguration of the machine. In other cases it might be due to a programming error in the software. A quick review of the location in the source code will quickly reveal the reason for the termination.</para>
1639       <para>The
1640         <link linkend="Value_MaxLogSize">MaxLogSize</link> 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.
1641       </para>
1642     </section>
1643     <section>
1644       <title id="afsd_service_debug_log">4.3. afsd_service debug logs (fs trace {-on, -off, -dump} -&gt;%WinDir%\TEMP\afsd.log)</title>
1645       <indexterm significance="normal">
1646         <primary>afsd.log</primary>
1647       </indexterm>
1648       <indexterm significance="normal">
1649         <primary>fs trace</primary>
1650       </indexterm>
1651       <indexterm significance="normal">
1652         <primary>TraceBufferSize</primary>
1653       </indexterm>
1654       <para>When attempting to debug the behavior of the SMB/CIFS Server and the Cache Manager it is often useful to examine a log of the operations being performed. While running the AFS Client Service keeps an in memory log of many of its actions. The default number of actions preserved at any one time is 5000. This can be adjusted with the
1655         <link linkend="Value_TraceBufferSize">TraceBufferSize registry value</link>:
1656       </para>
1657       <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1658       <para> REG_DWORD TraceBufferSize </para>
1659       <para>A restart of the service is necessary when adjusting this value. Execute "fs trace -on -reset" to begin the logging and "fs trace -dump" to output the contents of the log to the file.</para>
1660     </section>
1661     <section>
1662       <title id="Using_Sysinternals_Tools">4.4. Using SysInternal's Debug Viewer, Process Monitor and Process Explorer Tools</title>
1663       <indexterm significance="normal">
1664         <primary>SysInternals</primary>
1665       </indexterm>
1666       <indexterm significance="normal">
1667         <primary>dbgview.exe</primary>
1668       </indexterm>
1669       <indexterm significance="normal">
1670         <primary>procmon.exe</primary>
1671       </indexterm>
1672       <indexterm significance="normal">
1673         <primary>TraceOption</primary>
1674       </indexterm>
1675       <para>An alternatve option to the use of "fs trace -dump" to capture internal OpenAFS Client Service events is to use a tool such as Sysinternal's
1676         <ulink url="http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx">Debug Viewer</ulink> to capture real-time debugging output. When the OpenAFS Client Service starts and Bit 2 of the
1677         <link linkend="Value_TraceOption">TraceOption</link> value in the registry is set, all trace log events are output using the Windows Debug Monitor interface (OutputDebugString).
1678       </para>
1679       <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1680       <para>REG_DWORD TraceOption = 0x04</para>
1681       <para>Use "fs trace –on" and "fs trace –off" to toggle the generation of log messages. </para>
1682       <para>Sysinternal's
1683         <ulink url="http://technet.microsoft.com/en-us/sysinternals/bb896645.aspx">Process Monitor</ulink> can be use to monitor the file operations requested by applications and their success or failure.
1684       </para>
1685       <para>In Process Monitor, set a filter to include only events on file paths that refer to the AFS name space. Be sure to include both the UNC path as well as any drive letters mapped to AFS. </para>
1686       <para>Turn on the
1687         <emphasis>Clock Time</emphasis> and
1688         <emphasis>Show Milliseconds</emphasis> options in both tools to make it easier to synchronize the application requests and the resulting OpenAFS Client Service operations. The captured data can be stored to files for inclusion in
1689         <link linkend="Reporting_Bugs">bug reports</link>.
1690       </para>
1691       <para>Sysinternal's
1692         <ulink url="http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx">Process Explorer</ulink> is a replacement for the Windows Task Manager and so much more. Process Explorer can be configured to use the DbgHelp.dll from "
1693         <ulink url="http://www.microsoft.com/whdc/devtools/debugging/default.mspx">Microsoft Debugging Tools for Windows</ulink>" as well as the debug symbols shipped as an optional component of the OpenAFS for Windows installer. (Options-&gt;Configure Symbols) Once configured the "Threads" tab of the process properties dialog will permit the viewing of a fully documented stack for each displayed thread. Hint: If there is a deadlock in the cache manager, two or more of the threads will be stuck in a call to osi_TWait().
1694       </para>
1695     </section>
1696     <section>
1697       <title id="Creating_Microsoft_Minidumps">4.5. Creating Microsoft MiniDumps
1698 (fs minidump -&gt; %WinDir%\TEMP\afsd.dmp)</title>
1699       <indexterm significance="normal">
1700         <primary>minidumps</primary>
1701       </indexterm>
1702       <indexterm significance="normal">
1703         <primary>fs minidump</primary>
1704       </indexterm>
1705       <indexterm significance="normal">
1706         <primary>MiniDumpType</primary>
1707       </indexterm>
1708       <indexterm significance="normal">
1709         <primary>afsd.dmp</primary>
1710       </indexterm>
1711       <para>If the AFS Client Service become unresponsive to any form of communication there may be a serious error that can only be debugged by someone with access to the source code and a debugger. The "fs minidump" command can be used to force the generation of a MiniDump file containing the state of all of the threads in the AFS Client Service process. The most accurate MiniDump files will be produced after installing "
1712         <ulink url="http://www.microsoft.com/whdc/devtools/debugging/default.mspx">Microsoft Debugging Tools for Windows</ulink>".
1713       </para>
1714       <para>The
1715         <link linkend="Value_MiniDumpType">MiniDumpType</link> registry value can be used to adjust the scope of the process information included within the dump file. By default the MiniDump only contains the stacks of all threads and the values of all global variables. A much more useful MiniDump is one that contains the contents of the heap. Be warned, a MiniDump with heap will be as large as the cache file. In addition, it will include all of the data stored within the cache. If there are privacy concerns, do not produce a MiniDump with heap.
1716       </para>
1717     </section>
1718     <section>
1719       <title id="Integrated_Logon_Debugging">4.6. Single Sign-on (Integrated Logon) debugging</title>
1720       <indexterm significance="normal">
1721         <primary>integrated logon</primary>
1722       </indexterm>
1723       <indexterm significance="normal">
1724         <primary>TraceOption</primary>
1725       </indexterm>
1726       <para>If you are having trouble with the Integrated Logon operations it is often useful to be able to obtain a log of what it is attempting to do. Setting Bit 0 of the
1727         <link linkend="Value_TraceOption">TraceOption</link> registry value:
1728       </para>
1729       <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1730       <para> REG_DWORD TraceOption = 0x01</para>
1731       <para>will instruct the Integrated Logon Network Provider and Event Handlers to log information to the Windows Event Log: Application under the name "AFS Logon".</para>
1732     </section>
1733     <section>
1734       <title id="rxdebug_usage">4.7. RX (AFS RPC) debugging (rxdebug)</title>
1735       <indexterm significance="normal">
1736         <primary>rxdebug.exe</primary>
1737       </indexterm>
1738       <para>The rxdebug.exe tool can be used to query a variety of information about the AFS services installed on a given machine. The port for the AFS Cache Manager is 7001. </para>
1739       <para>
1740         <programlisting format="linespecific">
1741     Usage: rxdebug -servers &lt;server machine&gt; [-port &lt;IP port&gt;] [-nodally]
1742            [-allconnections] [-rxstats] [-onlyserver] [-onlyclient]
1743            [-onlyport &lt;show only &lt;port&gt;&gt;]
1744            [-onlyhost &lt;show only &lt;host&gt;&gt;]
1745            [-onlyauth &lt;show only &lt;auth level&gt;&gt;] [-version]
1746            [-noconns] [-peers] [-help]
1747     Where: -nodally         don't show dallying conns
1748            -allconnections  don't filter out uninteresting connections
1749            -rxstats         show Rx statistics
1750            -onlyserver      only show server conns
1751            -onlyclient      only show client conns
1752            -version         show AFS version id
1753            -noconns         show no connections
1754            -peers           show peers
1755       </programlisting>
1756       </para>
1757     </section>
1758     <section>
1759       <title id="cmdebug_usage">4.8. Cache Manager RPC debugging (cmdebug)</title>
1760       <indexterm significance="normal">
1761         <primary>cmdebug.exe</primary>
1762       </indexterm>
1763       <para>The cmdebug.exe tool can be used to query the state of the AFS Cache Manager over the network.</para>
1764       <para>
1765         <programlisting format="linespecific">
1766     Usage: cmdebug -servers &lt;server machine&gt; [-port &lt;IP port&gt;] [-long] [-refcounts]
1767            [-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
1768     Where: -long        print all info
1769            -refcounts   print only cache entries with positive reference counts
1770            -callbacks   print only cache entries with callbacks
1771            -ctime       print human readable expiration time
1772            -addrs       print only host interfaces
1773            -cache       print only cache configuration
1774            -cellservdb  print only cellservdb info
1775       </programlisting>
1776       </para>
1777     </section>
1778     <section>
1779       <title id="Persistent_Cache_Consistency_Check">4.9. Persistent Cache consistency check</title>
1780       <indexterm significance="normal">
1781         <primary>AFSCache</primary>
1782       </indexterm>
1783       <indexterm significance="normal">
1784         <primary>validate cache file</primary>
1785       </indexterm>
1786       <para>The persistent cache is stored in a Hidden System file at %WinDir%\TEMP\AFSCache. If there is a problem with the persistent cache that prevent the AFS Client Service from being able to start a validation check on the file can be performed.</para>
1787       <para> afsd_service.exe --validate-cache &lt;cache-path&gt;</para>
1788     </section>
1789     <section>
1790       <title id="Token_Acquisition_Debugging">4.10. Token Acquisition Debugging</title>
1791       <indexterm significance="normal">
1792         <primary>tokens</primary>
1793       </indexterm>
1794       <indexterm significance="normal">
1795         <primary>klog.exe</primary>
1796       </indexterm>
1797       <indexterm significance="normal">
1798         <primary>kinit.exe</primary>
1799       </indexterm>
1800       <indexterm significance="normal">
1801         <primary>aklog.exe</primary>
1802       </indexterm>
1803       <para>If you are having trouble obtaining tokens with the Network Identity Manager AFS credential provider, it is recommended that you verify your ability to obtain tokens using the command-line tools
1804         <emphasis>klog.exe</emphasis> (if you are using kaserver) or
1805         <emphasis>kinit.exe</emphasis> and
1806         <emphasis>aklog.exe</emphasis> (if you are using Kerberos v5.)  The aklog.exe
1807         <emphasis>–d</emphasis> option will be quite helpful in diagnosing Kerberos v5 related problems.
1808       </para>
1809     </section>
1810   </chapter>
1811   <chapter id="Reporting_Bugs">
1812     <title>Reporting Bugs</title>
1813     <para>
1814     <indexterm significance="normal">
1815       <primary>bug reports</primary>
1816     </indexterm>
1817     Bug reports should be sent to
1818       <ulink url="mailto:openafs-bugs@openafs.org?subject=Bug%20Report">openafs-bugs@openafs.org</ulink>. Please include as much information as possible about the issue. If you are reporting a crash, please install the debugging symbols by re-running the installer. If a dump file is available for the problem, %WINDIR%\TEMP\afsd.dmp, include it along with the AFS Client Trace file %WINDIR%\TEMP\afsd.log. The AFS Client startup log is %WINDIR%\TEMP\afsd_init.log. Send the last continuous block of log information from this file.
1819     </para>
1820     <para>Configuring DrWatson to generate dump files for crashes:</para>
1821     <orderedlist inheritnum="ignore" continuation="restarts">
1822       <listitem>
1823         <para>Run drwtsn32.exe to configure or to identify where the log and the crash dump files are created: </para>
1824       </listitem>
1825       <listitem>
1826         <para>click Start &gt; Run... </para>
1827       </listitem>
1828       <listitem>
1829         <para>type drwtsn32 &lt;enter&gt;. </para>
1830       </listitem>
1831       <listitem>
1832         <para>Select either a Crash Dump Type: Mini or Full. </para>
1833       </listitem>
1834       <listitem>
1835         <para>Clear Dump Symbol Table</para>
1836       </listitem>
1837       <listitem>
1838         <para>Clear Append to Existing Log file. </para>
1839       </listitem>
1840       <listitem>
1841         <para>Check Dump All Thread Contexts.</para>
1842       </listitem>
1843       <listitem>
1844         <para>Check Create Crash Dump File</para>
1845       </listitem>
1846       <listitem>
1847         <para>Next run the monitoring module of Dr. Watson: </para>
1848       </listitem>
1849       <listitem>
1850         <para>click Start &gt; Run...</para>
1851       </listitem>
1852       <listitem>
1853         <para>type drwatson &lt;enter&gt;. </para>
1854       </listitem>
1855       <listitem>
1856         <para>Once a crash happens, Dr. Watson generates a dump file and a report in the log file, including the address of the crash and the stack dump.</para>
1857       </listitem>
1858     </orderedlist>
1859     <para>Once you have the Dr. Watson's logfile and minidump, zip them and attach them to your e-mail.</para>
1860     <para>When reporting a error, please be sure to include the version of OpenAFS.
1861     </para>
1862   </chapter>
1863   <chapter id="chap_6">
1864     <title id="Contributing_to_OpenAFS">How to Contribute to the Development of OpenAFS for Windows</title>
1865     <para>
1866     <indexterm significance="normal">
1867       <primary>contributing to OpenAFS</primary>
1868     </indexterm>
1869     Contributions to the development of OpenAFS for Windows are continuously needed. Contributions may take many forms including cash donations, support contracts, donated developer time, and even donated tech writer time.</para>
1870     <section>
1871       <title id="USENIX_OpenAFS_Fund">6.1. The USENIX OpenAFS Fund </title>
1872       <para>
1873       <indexterm significance="normal">
1874         <primary>USENIX OpenAFS Fund</primary>
1875       </indexterm>
1876         <ulink url="http://www.usenix.org/">USENIX</ulink>, a 501c3 non-profit corporation, has formed the USENIX OpenAFS Fund in order to accept tax deductible donations on behalf of the OpenAFS Elders. The donated funds will be allocated by the OpenAFS Elders to fund OpenAFS development, documentation, project management, and maintaining openafs.org.
1877       </para>
1878       <informaltable frame="none">
1879         <tgroup rowsep="1" align="left" colsep="1" cols="1">
1880           <colspec colwidth="405pt" colname="c1" />
1881           <tbody>
1882             <row>
1883               <entry>
1884                 <para>
1885                   <programlisting format="linespecific">
1886     USENIX OpenAFS Fund
1887     USENIX Association
1888     2560 Ninth St., Suite 215
1889     Berkeley, CA 94710
1890                   </programlisting>
1891                 </para>
1892               </entry>
1893             </row>
1894           </tbody>
1895         </tgroup>
1896       </informaltable>
1897       <para>Donations can be made by sending a check, drawn on a U.S. bank, made out to the USENIX OpenAFS Fund or by making a
1898         <ulink url="https://db.usenix.org/cgi-bin/openafs/openafs.cgi">donation online</ulink>.
1899       </para>
1900     </section>
1901     <section>
1902       <title id="Secure_Endpoints_Inc">6.2. Secure Endpoints Inc. </title>
1903       <para>
1904       <indexterm significance="normal">
1905         <primary>Secure Endpoints Inc.</primary>
1906       </indexterm>
1907         <ulink url="http://www.secure-endpoints.com/">Secure Endpoints Inc.</ulink> provides development and support services for OpenAFS for Windows and
1908         <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink>. Donations provided to Secure Endpoints Inc. for the development of OpenAFS are used to cover the OpenAFS gatekeeper responsibilities; providing support to the OpenAFS community via the OpenAFS mailing lists; and furthering development of desired features that are either too small to be financed by development contracts.
1909       </para>
1910       <para>Secure Endpoints Inc. accepts software development agreements from organizations who wish to fund a well-defined set of bug fixes or new features. </para>
1911       <para>Secure Endpoints Inc. provides contract based support for the OpenAFS for Windows and the
1912         <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> products.
1913       </para>
1914     </section>
1915     <section>
1916       <title id="Your_File_System_Inc">6.3. Your File System Inc. </title>
1917       <para>
1918       <indexterm significance="normal">
1919         <primary>Your File System Inc.</primary>
1920       </indexterm>
1921         <ulink url="http://www.your-file-system.com/">Your File System Inc.</ulink> provides development and support services for OpenAFS for Windows.
1922         Donations provided to Your File System Inc. for the development of OpenAFS are used to cover the OpenAFS gatekeeper responsibilities;
1923         providing support to the OpenAFS community via the OpenAFS mailing lists;
1924         and furthering development of desired features that are either too small to be financed by development contracts.
1925       </para>
1926       <para>Your File System Inc. accepts software development agreements from organizations who wish to fund a well-defined set of bug fixes or new features. </para>
1927       <para>Your File System Inc. provides contract based support for OpenAFS on all platforms.
1928       </para>
1929     </section>
1930     <section>
1931       <title id="Direct_Code_Contributions">6.4. Direct contributions of code and/or documentation </title>
1932       <para>Organizations that use OpenAFS in house and have development staffs are encouraged to contribute any code modifications they make to OpenAFS.org via openafs-bugs@openafs.org. Contributions of documentation are highly desired. </para>
1933     </section>
1934     <section>
1935       <title id="OAFW_Mailing_Lists">6.5. OpenAFS for Windows Mailing Lists</title>
1936       <indexterm significance="normal">
1937         <primary>mailing lists</primary>
1938       </indexterm>
1939       <indexterm significance="normal">
1940         <primary>openafs-win32-devel</primary>
1941       </indexterm>
1942       <indexterm significance="normal">
1943         <primary>openafs-info</primary>
1944       </indexterm>
1945       <para>If you wish to participate in OpenAFS for Windows development please join the
1946         <ulink url="mailto:openafs-win32-devel@openafs.org?subject=OpenAFS%20for%20Windows%20Development%20Contribution">openafs-win32-devel@openafs.org</ulink> mailing list.
1947       </para>
1948       <para>
1949         <emphasis role="bold">https://lists.openafs.org/mailman/listinfo/openafs-win32-devel</emphasis>
1950       </para>
1951       <para>User questions should be sent to the
1952         <ulink url="mailto:openafs-info@openafs.org?subject=OpenAFS%20for%20Windows%20User%20Question">openafs-info@openafs.org</ulink> mailing list.
1953       </para>
1954       <para>
1955         <emphasis role="bold">https://lists.openafs.org/mailman/listinfo/openafs-info</emphasis>
1956       </para>
1957       <para>You must join the mailing lists if you wish to post to the list without incurring a moderation delay.</para>
1958     </section>
1959   </chapter>
1960   <chapter id="chap_7">
1961     <title id="MSI_Deployment_Guide">MSI Deployment Guide</title>
1962     <section>
1963       <title>7.1. Introduction</title>
1964       <indexterm significance="normal">
1965         <primary>msi deployment</primary>
1966       </indexterm>
1967       <indexterm significance="normal">
1968         <primary>msi transforms</primary>
1969       </indexterm>
1970       <para id="Introduction_to_MSI_Deployment">A MSI installer option is available for those who wish to use Windows Installer for installing OpenAFS and for organizations that wish to deploy OpenAFS through Group Policy. The first version of OpenAFS for Windows available as an MSI was 1.3.65.</para>
1971       <para>This document provides a guide for authoring transforms used to customize the MSI package for a particular organization. Although many settings can be deployed via transforms, in an Active Directory environment it is advisable to deploy registry settings and configuration files through group policy and/or startup scripts so that machines where OpenAFS for Windows is already installed will pick up these customizations.</para>
1972       <section>
1973         <title id="MSI_Deployment_Requirements">7.1.1 Requirements</title>
1974         <para>The information in this document applies to MSI packages distributed with OpenAFS for Windows releases from 1.3.65 and onwards or MSI packages built from corresponding source releases. Not all releases support all the configuration options documented here.</para>
1975         <para>Authoring a "Windows Installer" transform requires additional software for editing the MSI database tables and generating the transform from the modified MSI package. ORCA.EXE and MSITRAN.EXE which are included in the Windows Platform SDK ("Windows Installer" SDK) can be used for this purpose.</para>
1976         <para>For reference, the schema for the MSI package is based on SCHEMA.MSI distributed with the Platform SDK.</para>
1977         <para>For general information about "Windows Installer", refer to:</para>
1978         <para>
1979           <ulink url="http://msdn.microsoft.com/library/en-us/msi/setup/windows_installer_start_page.asp">http://msdn.microsoft.com/library/en-us/msi/setup/windows_installer_start_page.asp</ulink></para>
1980         <para>For general information about authoring MSI transforms, refer to:</para>
1981         <para>
1982           <ulink url="http://msdn.microsoft.com/library/en-us/msi/setup/transforms.asp">http://msdn.microsoft.com/library/en-us/msi/setup/transforms.asp</ulink></para>
1983         <para>The remainder of this document assumes some familiarity with authoring transforms. While the MSDN documentation for Windows Installer is a bit dense, the guide on MSI transforms found at the second link above is recommended reading. MSDN also includes a step-by-step example for creating a transform at:</para>
1984         <para>
1985           <ulink url="http://msdn.microsoft.com/library/en-us/msi/setup/a_customization_transform_example.asp">http://msdn.microsoft.com/library/en-us/msi/setup/a_customization_transform_example.asp</ulink></para>
1986       </section>
1987       <section>
1988         <title id="MSI_Authoring_Transforms">7.1.2 Authoring a Transform</title>
1989         <para>Transforms describe a set of modifications to be performed on an existing MSI for the purpose of customizing it. This is ordinarily done by making a copy of the MSI to be customized, modifying the copy and then using the old and the new MSI to generate a transform. For example:</para>
1990         <orderedlist inheritnum="ignore" continuation="restarts">
1991           <listitem>
1992             <para>copy openafs.msi openafs-modified.msi</para>
1993           </listitem>
1994           <listitem>
1995             <para>(edit the openafs-modified.msi to include the necessary changes)</para>
1996           </listitem>
1997           <listitem>
1998             <para>msitran -g openafs.msi openafs-modified.msi openafs-transform.mst</para>
1999           </listitem>
2000           <listitem>
2001             <para>(generates openafs-transform.mst, which is the transform)</para>
2002           </listitem>
2003         </orderedlist>
2004         <para>Transforms have an extension of .mst. 'msitran' is a tool distributed as part of the "Windows Installer" SDK (part of the Windows Platform SDK).</para>
2005         <para>You can test a transform by:</para>
2006         <orderedlist inheritnum="ignore" continuation="restarts">
2007           <listitem>
2008             <para>copy openafs.msi openafs-test.msi</para>
2009           </listitem>
2010           <listitem>
2011             <para>msitran -a openafs-transform.mst openafs-test.msi</para>
2012           </listitem>
2013         </orderedlist>
2014         <para>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.</para>
2015         <para>As mentioned above, you can use a tool like ORCA.EXE to edit the MSI databases directly when editing openafs-modified.msi. More details are given below.</para>
2016       </section>
2017     </section>
2018     <section>
2019       <title id="MSI_Configuration_Options">7.2. Configuration Options</title>
2020       <para>The logic necessary to implement many of the settings described in
2021         <link linkend="appendix_a">Appendix A</link> are present in the MSI. Most of these can be controlled by setting the corresponding properties to the desired value. Some settings may require modifying existing registry entries (though not recommended) or adding new resources (like files or registry keys). Instructions for performing these tasks are below.
2022       </para>
2023       <section>
2024         <title id="MSI_Configurable_Properties">7.2.1 Configurable Properties</title>
2025         <para>Most configurable properties correspond to registry keys or values. Due to the logic invoked based on the existence of these registry keys or values, they are only set if the associated property is defined to have a non null value. If the associated property is not defined in the MSI, the registry key or value will not be touched. By default, the MSI does not contain these properties and hence will not set the registry keys. You will need to add properties as needed to the MSI.</para>
2026         <para>When one of the configurable properties is set, the installer will use the property value to set the corresponding setting in the HKEY_LOCAL_MACHINE registry hive. The HKEY_CURRENT_USER hive is not touched by the installer.</para>
2027         <para>For each property, the associated registry setting is referenced by the same text used in
2028           <link linkend="appendix_a">Appendix A</link>.
2029         </para>
2030         <para>Strings are quoted using single quotes (e.g. 'a string'). An empty string is denoted as ''. Note that you can't author null values into the 'Property' table.</para>
2031         <para>Numeric values should be authored as decimal strings.</para>
2032         <section>
2033           <title id="MSI_Setting_Properties"> Setting Properties</title>
2034           <para>In order to set a property,</para>
2035           <orderedlist inheritnum="ignore" continuation="restarts">
2036             <listitem>
2037               <para>Open the MSI in ORCA.EXE</para>
2038             </listitem>
2039             <listitem>
2040               <para>Select the 'Property' table from the list of tables on the left.</para>
2041             </listitem>
2042             <listitem>
2043               <para>Find the property in the list of properties on the right, double click the value and type the new value.</para>
2044             </listitem>
2045             <listitem>
2046               <para>If the property does not exist in the property list, right click the list and select 'Add Row', type the property name and the desired value.</para>
2047             </listitem>
2048           </orderedlist>
2049         </section>
2050         <section>
2051           <title id="MSI_OAFW_Properties"> OpenAFS for Windows Properties</title>
2052           <informaltable frame="all">
2053             <tgroup rowsep="1" align="left" colsep="1" cols="1">
2054               <colspec colwidth="447pt" colname="c1" />
2055               <tbody>
2056                 <row>
2057                   <entry>
2058                     <para>
2059                       <emphasis>(Service parameters):</emphasis>
2060                     </para>
2061                     <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2062                   </entry>
2063                 </row>
2064                 <row>
2065                   <entry>
2066                     <para>
2067                       <emphasis>(Network provider):</emphasis>
2068                     </para>
2069                     <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
2070                   </entry>
2071                 </row>
2072                 <row>
2073                   <entry>
2074                     <para>
2075                       <emphasis>(OpenAFS Client):</emphasis>
2076                     </para>
2077                     <para>[HKLM\SOFTWARE\OpenAFS\Client]</para>
2078                   </entry>
2079                 </row>
2080               </tbody>
2081             </tgroup>
2082           </informaltable>
2083           <section>
2084             <title id="MSI_OAFW_Registry_Properties"> Registry Properties</title>
2085             <para>These properties are used to set the values of registry entries associated with OpenAFS for Windows.</para>
2086             <informaltable frame="all">
2087               <tgroup rowsep="1" align="left" colsep="1" cols="1">
2088                 <colspec colwidth="447pt" colname="c1" />
2089                 <tbody>
2090                   <row>
2091                     <entry>
2092                       <para>
2093                         <emphasis role="bold">AFSCACHEPATH</emphasis>
2094                       </para>
2095                       <para>Registry key :
2096                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2097                       <para>Registry value :
2098                         <link linkend="Value_CachePath">CachePath</link></para>
2099                       <para>Valid values : string .</para>
2100                     </entry>
2101                   </row>
2102                   <row>
2103                     <entry>
2104                       <para>
2105                         <emphasis role="bold">AFSCACHESIZE</emphasis>
2106                       </para>
2107                       <para>Registry key :
2108                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2109                       <para>Registry value :
2110                         <link linkend="Value_CacheSize">CacheSize</link></para>
2111                       <para>Valid values : numeric</para>
2112                     </entry>
2113                   </row>
2114                   <row>
2115                     <entry>
2116                       <para>
2117                         <emphasis role="bold">AFSCELLNAME</emphasis>
2118                       </para>
2119                       <para>Registry key :
2120                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2121                       <para>Registry value :
2122                         <link linkend="Value_Cell">Cell</link></para>
2123                       <para>Valid values : string</para>
2124                     </entry>
2125                   </row>
2126                   <row>
2127                     <entry>
2128                       <para>
2129                         <emphasis role="bold">FREELANCEMODE</emphasis>
2130                       </para>
2131                       <para>Registry key :
2132                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2133                       <para>Registry value :
2134                         <link linkend="Value_FreelanceClient">FreelanceClient</link></para>
2135                       <para>Valid values : '1' or '0'</para>
2136                     </entry>
2137                   </row>
2138                   <row>
2139                     <entry>
2140                       <para>
2141                         <emphasis role="bold">HIDEDOTFILES</emphasis>
2142                       </para>
2143                       <para>Registry key :
2144                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2145                       <para>Registry value :
2146                         <link linkend="Value_HideDotFiles">HideDotFiles</link></para>
2147                       <para>Valid values : '1' or '0'</para>
2148                     </entry>
2149                   </row>
2150                   <row>
2151                     <entry>
2152                       <para>
2153                         <emphasis role="bold">LOGONOPTIONS</emphasis>
2154                       </para>
2155                       <para>Registry key :
2156                         <link linkend="Domain_Specific_Regkeys">(Network Provider)</link></para>
2157                       <para>Registry value :
2158                         <link linkend="Value_LogonOptions">LogonOptions</link></para>
2159                       <para>Valid values : '0', '1' or '3'</para>
2160                       <para>See
2161                         <link linkend="appendix_a">Appendix A</link><link linkend="Domain_Specific_Configuration">section 2.1 (Domain Specific Configuration keys for Network Provider)</link> for more details.
2165                       </para>
2166                     </entry>
2167                   </row>
2168                   <row>
2169                     <entry>
2170                       <para>
2171                         <emphasis role="bold">MOUNTROOT</emphasis>
2172                       </para>
2173                       <para>Registry key :
2174                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2175                       <para>Registry value :
2176                         <link linkend="Value_Mountroot">Mountroot</link></para>
2177                       <para>Valid values : string</para>
2178                     </entry>
2179                   </row>
2180                   <row>
2181                     <entry>
2182                       <para>
2183                         <emphasis role="bold">NETBIOSNAME</emphasis>
2184                       </para>
2185                       <para>Registry key :
2186                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2187                       <para>Registry value :
2188                         <link linkend="Value_NetbiosName">NetbiosName</link></para>
2189                       <para>Valid values : string (at most 15 characters)</para>
2190                     </entry>
2191                   </row>
2192                   <row>
2193                     <entry>
2194                       <para>
2195                         <emphasis role="bold">NOFINDLANABYNAME</emphasis>
2196                       </para>
2197                       <para>Registry key :
2198                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2199                       <para>Registry value :
2200                         <link linkend="Value_NoFindLanaByName">NoFindLanaByName</link></para>
2201                       <para>Valid values : '1' or '0'</para>
2202                     </entry>
2203                   </row>
2204                   <row>
2205                     <entry>
2206                       <para>
2207                         <emphasis role="bold">RXMAXMTU</emphasis>
2208                       </para>
2209                       <para>Registry key :
2210                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2211                       <para>Registry value :
2212                         <link linkend="Value_RxMaxMTU">RxMaxMTU</link></para>
2213                       <para>Valid values : numeric</para>
2214                     </entry>
2215                   </row>
2216                   <row>
2217                     <entry>
2218                       <para>
2219                         <emphasis role="bold">SECURITYLEVEL</emphasis>
2220                       </para>
2221                       <para>Registry key :
2222                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2223                       <para>Registry value :
2224                         <link linkend="Value_SecurityLevel">SecurityLevel</link></para>
2225                       <para>Valid values : '1' or '0'</para>
2226                     </entry>
2227                   </row>
2228                   <row>
2229                     <entry>
2230                       <para>
2231                         <emphasis role="bold">SMBAUTHTYPE</emphasis>
2232                       </para>
2233                       <para>Registry key :
2234                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2235                       <para>Registry value :
2236                         <link linkend="Value_smbAuthType">SMBAuthType</link></para>
2237                       <para>Valid values : '0','1' or '2'</para>
2238                     </entry>
2239                   </row>
2240                   <row>
2241                     <entry>
2242                       <para>
2243                         <emphasis role="bold">STOREANSIFILENAMES</emphasis>
2244                       </para>
2245                       <para>Registry key :
2246                         <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client">(OpenAFS Client)</link></para>
2247                       <para>Registry value :
2248                         <link linkend="Value_StoreAnsiFilenames">StoreAnsiFilenames</link></para>
2249                       <para>Valid values : '0' or '1'</para>
2250                       <para>This option is no longer supported as of 1.5.50 now that all file names are stored to AFS file servers using the UTF-8 encoding of Unicode.</para>
2251                     </entry>
2252                   </row>
2253                   <row>
2254                     <entry>
2255                       <para>
2256                         <emphasis role="bold">USEDNS</emphasis>
2257                       </para>
2258                       <para>Registry key :
2259                         <link linkend="Service_Parameters">(Service Parameters)</link></para>
2260                       <para>Registry value :
2261                         <link linkend="Value_UseDNS">UseDNS</link></para>
2262                       <para>Valid values : '1' or '0'</para>
2263                     </entry>
2264                   </row>
2265                 </tbody>
2266               </tgroup>
2267             </informaltable>
2268           </section>
2269           <section>
2270             <title id="MSI_OAFW_AFSCreds_Properties">
2271       AFSCreds.exe Properties
2272             </title>
2273             <para>These properties are combined to add a command line option to the shortcut that will be created in the Start:Programs:OpenAFS and Start:Programs:Startup folders (see CREDSSTARTUP). The method of specifying the option was chosen for easy integration with the Windows Installer user interface. Although other methods can be used to specify options to AFSCREDS.EXE, it is advised that they be avoided as transforms including such options may not apply to future releases of OpenAFS.</para>
2274             <informaltable frame="all">
2275               <tgroup rowsep="1" align="left" colsep="1" cols="1">
2276                 <colspec colwidth="447pt" colname="c1" />
2277                 <tbody>
2278                   <row>
2279                     <entry>
2280                       <para>
2281                         <emphasis role="bold">CREDSSTARTUP</emphasis>
2282                       </para>
2283                       <para>Valid values : '1' or '0'</para>
2284                       <para>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 determined by the other CREDS* properties.</para>
2285                     </entry>
2286                   </row>
2287                   <row>
2288                     <entry>
2289                       <para>
2290                         <emphasis role="bold">CREDSAUTOINIT</emphasis>
2291                       </para>
2292                       <para>Valid values : '-a' or ''</para>
2293                       <para>Enables automatic initialization.</para>
2294                     </entry>
2295                   </row>
2296                   <row>
2297                     <entry>
2298                       <para>
2299                         <emphasis role="bold">CREDSIPCHDET</emphasis>
2300                       </para>
2301                       <para>Valid values : '-n' or ''</para>
2302                       <para>Enables IP address change detection.</para>
2303                     </entry>
2304                   </row>
2305                   <row>
2306                     <entry>
2307                       <para>
2308                         <emphasis role="bold">CREDSQUIET</emphasis>
2309                       </para>
2310                       <para>Valid values : '-q' or ''</para>
2311                       <para>Enables quiet mode.</para>
2312                     </entry>
2313                   </row>
2314                   <row>
2315                     <entry>
2316                       <para>
2317                         <emphasis role="bold">CREDSRENEWDRMAP</emphasis>
2318                       </para>
2319                       <para>Valid values : '-m' or ''</para>
2320                       <para>Enables renewing drive map at startup.</para>
2321                     </entry>
2322                   </row>
2323                   <row>
2324                     <entry>
2325                       <para>
2326                         <emphasis role="bold">CREDSSHOW</emphasis>
2327                       </para>
2328                       <para>Valid values : '-s' or ''</para>
2329                       <para>Enables displaying the credential manager window when AFSCREDS starts up.</para>
2330                     </entry>
2331                   </row>
2332                 </tbody>
2333               </tgroup>
2334             </informaltable>
2335           </section>
2336         </section>
2337       </section>
2338       <section>
2339         <title id="MSI_Existing_Registry_Entries">7.2.2 Existing Registry Entries</title>
2340         <para>You can change existing registry values subject to the restrictions mentioned in the Windows Platform SDK. Pay special attention to component key paths and try to only change the 'Value' column in the 'Registry' table. If you want to add additional registry keys please refer to section 3 (Additional resources).</para>
2341       </section>
2342       <section>
2343         <title id="MSI_Replacing_Configuration_Files">7.2.3 Replacing Configuration Files</title>
2344         <para>The OpenAFS configuration files (CellServDB) can be replaced by your own configuration files. These files are contained in separate MSI components so that you can disable them individually.</para>
2345         <para>The recommended method for replacing these files is to first disable the components containing the configuration files that you want to replace, and then add new components for the replacement files. This is outlined below (assuming you are using ORCA.EXE to author the transform).</para>
2346         <para>Note that transforms are not a good way to add a new file as an embedded stream. The method outlined here places the file in the same directory as the MSI for deployment.</para>
2347         <para>The walkthrough below is to add a custom 'CellServDB' file.</para>
2348         <orderedlist inheritnum="ignore" continuation="restarts">
2349           <listitem>
2350             <para>Disable the component that contains the configuration file that you want to replace.</para>
2351             <orderedlist inheritnum="ignore" continuation="restarts">
2352               <listitem>
2353                 <para>Locate and select the 'Component' table in the 'Tables' list.</para>
2354               </listitem>
2355               <listitem>
2356                 <para>In the Component table, locate the component you need to change ( Ctrl-F invokes the 'Find' dialog). The component names are listed below in section
2357                   <link linkend="MSI_Configuration_File_Components"></link>. For this example, the component name is 'elf_CellServDB'.
2358                 </para>
2359               </listitem>
2360               <listitem>
2361                 <para>Go to the 'Condition' column of the component.</para>
2362               </listitem>
2363               <listitem>
2364                 <para>Enter a condition that evaluates to false. I.e. 'DONOTINSTALL'. (Note that an undefined property always evaluates to false).</para>
2365                 <para>Note that you can also use this step to disable other configuration files without providing replacements.</para>
2366               </listitem>
2367             </orderedlist>
2368           </listitem>
2369           <listitem>
2370             <para>Add a new component containing the new configuration file.</para>
2371             <orderedlist inheritnum="ignore" continuation="restarts">
2372               <listitem>
2373                 <para>Select the 'Component' table in the 'Tables' list.</para>
2374               </listitem>
2375               <listitem>
2376                 <para>Select 'Tables'-&gt;'Add Row' (Ctrl-R).</para>
2377               </listitem>
2378               <listitem>
2379                 <para>Enter the following :</para>
2380                 <informaltable frame="all">
2381                   <tgroup rowsep="1" align="left" colsep="1" cols="2">
2382                     <colspec colwidth="84pt" colname="c1" />
2383                     <colspec colwidth="318pt" colname="c2" />
2384                     <tbody>
2385                       <row>
2386                         <entry>
2387                           <para>Component</para>
2388                         </entry>
2389                         <entry>
2390                           <para>cmf_my_CellServDB</para>
2391                         </entry>
2392                       </row>
2393                       <row>
2394                         <entry>
2395                           <para>ComponentID</para>
2396                         </entry>
2397                         <entry>
2398                           <para>{7019836F-BB2C-4AF6-9463-0D6EC9035CF1}</para>
2399                         </entry>
2400                       </row>
2401                       <row>
2402                         <entry>
2403                           <para>Directory_</para>
2404                         </entry>
2405                         <entry>
2406                           <para>dirClient</para>
2407                         </entry>
2408                       </row>
2409                       <row>
2410                         <entry>
2411                           <para>Attributes</para>
2412                         </entry>
2413                         <entry>
2414                           <para>144</para>
2415                         </entry>
2416                       </row>
2417                       <row>
2418                         <entry>
2419                           <para>Condition</para>
2420                         </entry>
2421                         <entry>
2422                           <para></para>
2423                         </entry>
2424                       </row>
2425                       <row>
2426                         <entry>
2427                           <para>KeyPath</para>
2428                         </entry>
2429                         <entry>
2430                           <para>fil_my_CellServDB</para>
2431                         </entry>
2432                       </row>
2433                     </tbody>
2434                   </tgroup>
2435                 </informaltable>
2436                 <para>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.</para>
2437                 <para>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.</para>
2438                 <para> 'fil_my_CellServDB' is a key into the 'File' table which we will fill later.</para>
2439               </listitem>
2440             </orderedlist>
2441           </listitem>
2442           <listitem>
2443             <para>Add a new feature to hold the new component.</para>
2444             <orderedlist inheritnum="ignore" continuation="restarts">
2445               <listitem>
2446                 <para>Select the 'Feature' table.</para>
2447               </listitem>
2448               <listitem>
2449                 <para>Add a new row (Ctrl-R or 'Tables'-&gt;'Add Row') with the following values:</para>
2450                 <informaltable frame="all">
2451                   <tgroup rowsep="1" align="left" colsep="1" cols="2">
2452                     <colspec colwidth="94pt" colname="c1" />
2453                     <colspec colwidth="307pt" colname="c2" />
2454                     <tbody>
2455                       <row>
2456                         <entry>
2457                           <para>Feature</para>
2458                         </entry>
2459                         <entry>
2460                           <para>fea_my_CellServDB</para>
2461                         </entry>
2462                       </row>
2463                       <row>
2464                         <entry>
2465                           <para>Feature_Parent</para>
2466                         </entry>
2467                         <entry>
2468                           <para>feaClient</para>
2469                         </entry>
2470                       </row>
2471                       <row>
2472                         <entry>
2473                           <para>Title</para>
2474                         </entry>
2475                         <entry>
2476                           <para></para>
2477                         </entry>
2478                       </row>
2479                       <row>
2480                         <entry>
2481                           <para>Description</para>
2482                         </entry>
2483                         <entry>
2484                           <para></para>
2485                         </entry>
2486                       </row>
2487                       <row>
2488                         <entry>
2489                           <para>Display</para>
2490                         </entry>
2491                         <entry>
2492                           <para>0</para>
2493                         </entry>
2494                       </row>
2495                       <row>
2496                         <entry>
2497                           <para>Level</para>
2498                         </entry>
2499                         <entry>
2500                           <para>30</para>
2501                         </entry>
2502                       </row>
2503                       <row>
2504                         <entry>
2505                           <para>Directory_</para>
2506                         </entry>
2507                         <entry>
2508                           <para></para>
2509                         </entry>
2510                       </row>
2511                       <row>
2512                         <entry>
2513                           <para>Attributes</para>
2514                         </entry>
2515                         <entry>
2516                           <para>8</para>
2517                         </entry>
2518                       </row>
2519                     </tbody>
2520                   </tgroup>
2521                 </informaltable>
2522                 <para>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.</para>
2523                 <para>Setting 'Display' to 0 will hide this feature from the feature selection dialog during an interactive installation. A value of 30 for 'Level' allows this feature to be installed by default (on a 'Typical' installation).</para>
2524                 <para>The 'Attributes' value is msidbFeatureAttributesDisallowAdvertise (8), which is set on all features in the OpenAFS MSI. The OpenAFS MSI is not designed for an advertised installation.</para>
2525               </listitem>
2526             </orderedlist>
2527           </listitem>
2528           <listitem>
2529             <para>Join the component and the feature.</para>
2530             <orderedlist inheritnum="ignore" continuation="restarts">
2531               <listitem>
2532                 <para>Select the 'FeatureComponents' table.</para>
2533               </listitem>
2534               <listitem>
2535                 <para>Add a new row with the following values:</para>
2536                 <informaltable frame="all">
2537                   <tgroup rowsep="1" align="left" colsep="1" cols="2">
2538                     <colspec colwidth="90pt" colname="c1" />
2539                     <colspec colwidth="312pt" colname="c2" />
2540                     <tbody>
2541                       <row>
2542                         <entry>
2543                           <para>Feature</para>
2544                         </entry>
2545                         <entry>
2546                           <para>fea_my_CellServDB</para>
2547                         </entry>
2548                       </row>
2549                       <row>
2550                         <entry>
2551                           <para>Component</para>
2552                         </entry>
2553                         <entry>
2554                           <para>cmf_my_CellServDB</para>
2555                         </entry>
2556                       </row>
2557                     </tbody>
2558                   </tgroup>
2559                 </informaltable>
2560               </listitem>
2561             </orderedlist>
2562           </listitem>
2563           <listitem>
2564             <para>Add an entry to the 'File' table.</para>
2565             <orderedlist inheritnum="ignore" continuation="restarts">
2566               <listitem>
2567                 <para>Select the 'File' table.</para>
2568               </listitem>
2569               <listitem>
2570                 <para>Add a new row with the following values:</para>
2571                 <informaltable frame="all">
2572                   <tgroup rowsep="1" align="left" colsep="1" cols="2">
2573                     <colspec colwidth="91pt" colname="c1" />
2574                     <colspec colwidth="311pt" colname="c2" />
2575                     <tbody>
2576                       <row>
2577                         <entry>
2578                           <para>File</para>
2579                         </entry>
2580                         <entry>
2581                           <para>fil_my_CellServDB</para>
2582                         </entry>
2583                       </row>
2584                       <row>
2585                         <entry>
2586                           <para>Component_</para>
2587                         </entry>
2588                         <entry>
2589                           <para>cmf_my_CellServDB</para>
2590                         </entry>
2591                       </row>
2592                       <row>
2593                         <entry>
2594                           <para>FileName</para>
2595                         </entry>
2596                         <entry>
2597                           <para>CellServDB</para>
2598                         </entry>
2599                       </row>
2600                       <row>
2601                         <entry>
2602                           <para>FileSize</para>
2603                         </entry>
2604                         <entry>
2605                           <para>(enter file size here)</para>
2606                         </entry>
2607                       </row>
2608                       <row>
2609                         <entry>
2610                           <para>Attributes</para>
2611                         </entry>
2612                         <entry>
2613                           <para>8192</para>
2614                         </entry>
2615                       </row>
2616                       <row>
2617                         <entry>
2618                           <para>Sequence</para>
2619                         </entry>
2620                         <entry>
2621                           <para>1000</para>
2622                         </entry>
2623                       </row>
2624                     </tbody>
2625                   </tgroup>
2626                 </informaltable>
2627                 <para>  (leave other fields blank)</para>
2628                 <para>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.</para>
2629                 <para>Finally, the 'Sequence' value of 1000 will be used later to distinguish the file as being in a separate source location than the other files in the MSI.</para>
2630               </listitem>
2631             </orderedlist>
2632           </listitem>
2633           <listitem>
2634             <para>Set a media source for the file.</para>
2635             <orderedlist inheritnum="ignore" continuation="restarts">
2636               <listitem>
2637                 <para>Select the 'Media' table.</para>
2638               </listitem>
2639               <listitem>
2640                 <para>Add a row with the following values :</para>
2641                 <informaltable frame="all">
2642                   <tgroup rowsep="1" align="left" colsep="1" cols="2">
2643                     <colspec colwidth="93pt" colname="c1" />
2644                     <colspec colwidth="309pt" colname="c2" />
2645                     <tbody>
2646                       <row>
2647                         <entry>
2648                           <para>DiskId</para>
2649                         </entry>
2650                         <entry>
2651                           <para>2</para>
2652                         </entry>
2653                       </row>
2654                       <row>
2655                         <entry>
2656                           <para>LastSequence</para>
2657                         </entry>
2658                         <entry>
2659                           <para>1000</para>
2660                         </entry>
2661                       </row>
2662                     </tbody>
2663                   </tgroup>
2664                 </informaltable>
2665                 <para>  (leave other fields blank)</para>
2666                 <para>The sequence number of 1000 designates this as the media source for the newly added file.
2667         </para>
2668               </listitem>
2669             </orderedlist>
2670           </listitem>
2671         </orderedlist>
2672         <section id="MSI_Configuration_File_Components">
2673           <title> Components for Configuration Files</title>
2674           <para>CellServDB: 'cpf_CellServDB' (ID {D5BA4C15-DBEC-4292-91FC-B54C30F24F2A})</para>
2675         </section>
2676       </section>
2677       <section>
2678         <title id="MSI_Adding_Domain_Specific_Registry_Keys">7.2.4 Adding Domain Specific Registry Keys</title>
2679         <para>Following is an example for adding domain specific registry keys.</para>
2680         <para> Refer to
2681           <link linkend="appendix_a">Appendix A</link> section 2.1 for more information.
2685         </para>
2686         <para> Columns that are unspecified should be left empty.</para>
2687         <para> We create a new feature and component to hold the new registry keys.</para>
2688         <informaltable frame="all">
2689           <tgroup rowsep="1" align="left" colsep="1" cols="1">
2690             <colspec colwidth="448pt" colname="c1" />
2691             <tbody>
2692               <row>
2693                 <entry>
2694                   <para> 'Feature' table:</para>
2695                 </entry>
2696               </row>
2697               <row>
2698                 <entry>
2699                   <para>  (new row)
2700  Feature : 'feaDomainKeys'
2701  Feature Parent : 'feaClient'
2702  Display : 0
2703  Level : 30
2704  Attributes : 10</para>
2705                 </entry>
2706               </row>
2707               <row>
2708                 <entry>
2709                   <para> 'Component' table:</para>
2710                 </entry>
2711               </row>
2712               <row>
2713                 <entry>
2714                   <para>  (new row)
2715   Component : 'rcm_DomainKeys'
2716  ComponentId : '{4E3FCBF4-8BE7-40B2-A108-C47CF743C627}'
2717  Directory : 'TARGETDIR'
2718  Attributes : 4
2719  KeyPath : 'reg_domkey0'</para>
2720                 </entry>
2721               </row>
2722               <row>
2723                 <entry>
2724                   <para> 'FeatureComponents' table:</para>
2725                 </entry>
2726               </row>
2727               <row>
2728                 <entry>
2729                   <para>  (new row)
2730  Feature : 'feaDomainKeys'
2731  Component : 'rcm_DomainKeys'</para>
2732                 </entry>
2733               </row>
2734               <row>
2735                 <entry>
2736                   <para> 'Registry' table:</para>
2737                 </entry>
2738               </row>
2739               <row>
2740                 <entry>
2741                   <para> (new row)
2742  Registry : 'reg_domkey0'
2743  Root : 2
2744  Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'
2745  Component : 'rcm_DomainKeys'</para>
2746                 </entry>
2747               </row>
2748               <row>
2749                 <entry>
2750                   <para> (new row)
2751  Registry : 'reg_domkey1'
2752  Root : 2
2753  Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'