doc/xml/QuickStartUnix/appendix.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <appendix id="Legacy">
   3   <title>Appendix B. Configuring Legacy Components</title>
   4
   5   <para>This chapter describes how to configure a number of deprecated
   6   components in OpenAFS. Whilst these components are not recommended for sites
   7   performing new installations, it is recognised that there are a number of
   8   installations which have not yet transitioned from using these, for whom
   9   continued provision of installation instructions my be useful</para>
  10
  11   <sect1 id="KAS001">
  12     <title>kaserver and Legacy Kerberos 4 Authentication</title>
  13
  14     <para>This section contains instructions for installing server and client
  15     machines in sites which use either the deprecated AFS
  16     <emphasis role="bold">kaserver</emphasis> or legacy Kerberos 4
  17     authentication systems</para>
  18
  19     <para>This should be used in conjuction with the installation instructures
  20     in earlier chapters, whose format it mirrors.</para>
  21
  22     <sect2 id="KAS002">
  23       <title>Background</title>
  24
  25       <para>As detailed in the OpenAFS "No more DES" roadmap, OpenAFS is moving
  26       away from the single DES based security models of both
  27       <emphasis role="bold">kaserver</emphasis> and external Kerberos 4 KDCs,
  28       in favour of using external, Kerberos 5 KDCs for authentication.</para>
  29
  30       <para>AFS version 3 was designed and implemented during the late 80s and
  31       early 90s when the state of the art in distributed computer
  32       authentication and data security was Kerberos 4 and single DES. The
  33       RXKAD security class was specified to use a single DES key and the kauth
  34       authentication protocol is a derivative of MIT's Kerberos 4 protocol.
  35       </para>
  36
  37       <para>For the better part of the last decade there has been concern
  38       regarding the cryptographic strength of the DES cipher when used as a
  39       building block within systems intended to prove authentication and/or
  40       data integrity and privacy. Kerberos 4 and RXKAD are not extensible and
  41       cannot negotiate non-DES key types. As a result efforts to migrate away
  42       from Kerberos 4 based authentication at higher risk organizations have
  43       been underway since the mid to late 90s. Ken Hornstein issued the first
  44       of his Kerberos 5 migration kits for AFS in May 1999. </para>
  45
  46       <para>In March 2003, the continued use of single DES and kauth as the
  47       basis for OpenAFS security became a real-world threat when a significant
  48       Kerberos 4 crossrealm vulnerability was published. The OpenAFS community
  49       was notified in security advisory OPENAFS-SA-2003-001 which can be
  50       found at http://www.openafs.org/security.</para>
  51
  52       <para>As a result of the mounting concerns regarding the strength of
  53       DES, NIST announced in May 2003 the withdrawal of FIPS 43-3
  54       "Data Encryption Standard (DES)" as well as the associated FIPS 74 and
  55       FIPS 81. In other words, NIST announced that DES and its derivatives
  56       could no longer be used by the United States Government and should no
  57       longer by those that trust its lead.</para>
  58
  59       <para>In July 2003 MIT announced the end of life of the Kerberos 4
  60       protocol which is distributed for backward compatibility as part of the
  61       MIT Kerberos 5 distribution.</para>
  62     </sect2>
  63     <sect2 id="KAS003">
  64       <title>Using this Appendix</title>
  65
  66       <para>This appendix should be read in conjunction with the instructions
  67       contained in the earlier chapters. It contains additions and in some
  68       cases, modifications, to the directions contained in those
  69       chapters. It is organised into 3 main sections, corresponding to the
  70       topics of the earlier chapters.
  71       <orderedlist>
  72         <listitem>
  73           <para>Installing the First AFS Machine</para>
  74         </listitem>
  75         <listitem>
  76           <para>Installing Additional Server Machines</para>
  77         </listitem>
  78         <listitem>
  79           <para>Installing Additonal Client Machines</para>
  80         </listitem>
  81       </orderedlist></para>
  82
  83       <para>There is an additional section on installing AFS login
  84       functionality, which is relevant to all machines which are operating as
  85       AFS clients</para>
  86
  87       <para>In addition, some general substitions should be made
  88       <itemizedlist>
  89         <listitem>
  90           <para>References to <emphasis role="bold">kinit</emphasis>and
  91           <emphasis role="bold">aklog</emphasis> should be replaced with
  92           a single call to <emphasis role="bold">klog</emphasis></para>
  93           <para>For example
  94 <programlisting>
  95    # <emphasis role="bold">kinit admin</emphasis>
  96    Password:  <replaceable>admin_passwd</replaceable>
  97    # <emphasis role="bold">aklog</emphasis>
  98 </programlisting>
  99           becomes
 100 <programlisting>
 101    # <emphasis role="bold">kinit admin</emphasis>
 102    Password:  <replaceable>admin_passwd</replaceable>
 103 </programlisting></para>
 104         </listitem>
 105       </itemizedlist></para>
 106     </sect2>
 107     <sect2 id="KAS003a">
 108       <title>Installing the First AFS machine</title>
 109
 110       <para>This section details changes to the installation procedure for the
 111       first AFS machine which are required in order to use
 112       <emphasis role="bold">kaserver</emphasis> for authentication. As
 113       detailed above, new sites are strongly discouraged from deploying
 114       kaserver.</para>
 115
 116       <para>The structure of this section follows the structure of the
 117       earlier chapter.</para>
 118
 119       <sect3 id="F">
 120         <title>Overview: Installing Server Functionality</title>
 121
 122         <para>In adddition to the items described, you must also create
 123         the Authentication Server as a database server process. The procedure
 124         for creating the initial security mechanisms is also changed.</para>
 125       </sect3>
 126
 127       <sect3 id="KAS006">
 128         <title>Starting the kaserver Database Server Process</title>
 129         <indexterm>
 130           <primary>Authentication Server</primary>
 131           <secondary>starting</secondary>
 132           <tertiary>first AFS machine</tertiary>
 133         </indexterm>
 134         <indexterm>
 135           <primary>first AFS machine</primary>
 136           <secondary>Authentication Server</secondary>
 137         </indexterm>
 138         <indexterm>
 139           <primary>kaserver process</primary>
 140           <see>Authentication Server</see>
 141         </indexterm>
 142         <indexterm>
 143           <primary>starting</primary>
 144           <secondary>Authentication Server</secondary>
 145           <tertiary>first AFS machine</tertiary>
 146         </indexterm>
 147
 148         <para>In addition to the database server processes described, you
 149         must also use the <emphasis role="bold">bos create</emphasis> command
 150         to create an entry for the following process, which runs on database
 151         server machines only:
 152         <itemizedlist>
 153           <listitem>
 154             <para>The Authentication Server
 155             (the <emphasis role="bold">kaserver</emphasis> process) maintains
 156             the Authentication Database</para>
 157           </listitem>
 158         </itemizedlist></para>
 159
 160         <para>The following instructions include the
 161         <emphasis role="bold">-cell</emphasis> argument on all applicable
 162         commands. Provide the cell name you assigned in
 163         <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
 164         Processes</link>. If a command appears on multiple lines, it is
 165         only for legibility. The following commands should run before any of
 166         the <emphasis role="bold">bos create</emphasis> commands detailed in
 167         <link linkend="HDRWQ52">Starting the Database Server Processes</link>.
 168         </para>
 169
 170         <orderedlist>
 171           <listitem>
 172             <para>
 173             <indexterm>
 174               <primary>commands</primary>
 175               <secondary>bos create</secondary>
 176             </indexterm>
 177             <indexterm>
 178               <primary>bos commands</primary>
 179               <secondary>create</secondary>
 180             </indexterm>
 181             Issue the <emphasis role="bold">bos create</emphasis>
 182             command to start the Authentication Server. The current
 183             working directory is still
 184             <emphasis role="bold">/usr/afs/bin</emphasis>.
 185 <programlisting>
 186    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">kaserver simple /usr/afs/bin/kaserver</emphasis>  \
 187  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
 188 </programlisting>
 189             </para>
 190
 191             <para>You can safely ignore the messages that tell you to add
 192             Kerberos to the <emphasis role="bold">/etc/services</emphasis>
 193             file; AFS uses a default value that makes the addition
 194             unnecessary. You can also ignore messages about the failure of
 195             authentication.</para>
 196           </listitem>
 197           <listitem>
 198             <para>Return to <link linkend="HDRWQ52">Starting the Database Server
 199             Processes</link> and follow the remaining instructions</para>
 200            </listitem>
 201         </orderedlist>
 202       </sect3>
 203       <sect3 id="KAS007">
 204         <title>Initialising Cell Security with kaserver </title>
 205
 206         <note>
 207           <para>The following instructions should be followed in place of
 208           those in <link linkend="HDRWQ53">Initializing Cell Security</link>
 209           </para>
 210         </note>
 211
 212         <para>Begin by creating the following two initial entries in the
 213         Authentication Database:
 214         <itemizedlist>
 215           <listitem>
 216             <para>A generic administrative account, called
 217             <emphasis role="bold">admin</emphasis> by convention. If you
 218             choose to assign a different name, substitute it throughout the
 219             remainder of this document.</para>
 220
 221             <para>After you complete the installation of the first machine,
 222             you can continue to have all administrators use the
 223             <emphasis role="bold">admin</emphasis> account, or you can create
 224             a separate administrative account for each of them. The latter
 225             scheme implies somewhat more overhead, but provides a more
 226             informative audit trail for administrative operations.</para>
 227           </listitem>
 228
 229           <listitem>
 230             <para>The entry for AFS server processes, called
 231             <emphasis role="bold">afs</emphasis>. No user logs in under this
 232             identity, but the Authentication Server's Ticket Granting Service
 233             (TGS) module uses the associated key to encrypt the server
 234             tickets that it grants to AFS clients for presentation to server
 235             processes during mutual authentication. (The chapter in the
 236             <emphasis>OpenAFS Administration Guide</emphasis> about cell
 237             configuration and administration describes the role of server
 238             encryption keys in mutual authentication.)</para>
 239
 240             <para>In Step <link linkend="AppendixLIWQ58">7</link>, you also
 241             place the initial AFS server encryption key into the <emphasis
 242             role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server
 243             processes refer to this file to learn the server
 244             encryption key when they need to decrypt server tickets.</para>
 245           </listitem>
 246         </itemizedlist>
 247         </para>
 248
 249           <para>You also issue several commands that enable the new
 250           <emphasis role="bold">admin</emphasis> user to issue privileged
 251           commands in all of the AFS suites.</para>
 252
 253           <para>The following instructions do not configure all of the security
 254           mechanisms related to the AFS Backup System. See the chapter in the
 255           <emphasis>OpenAFS Administration Guide</emphasis> about configuring
 256           the Backup System.
 257           <orderedlist>
 258             <indexterm>
 259               <primary>commands</primary>
 260               <secondary>kas (interactive)</secondary>
 261             </indexterm>
 262
 263             <indexterm>
 264               <primary>kas commands</primary>
 265               <secondary>interactive mode, entering</secondary>
 266             </indexterm>
 267
 268             <indexterm>
 269               <primary>interactive mode for kas</primary>
 270               <secondary>entering</secondary>
 271             </indexterm>
 272
 273             <listitem>
 274               <para>Enter <emphasis role="bold">kas</emphasis> interactive
 275               mode. Because the machine is in no-authorization checking
 276               mode, include the <emphasis role="bold">-noauth</emphasis> flag
 277               to suppress the Authentication Server's usual prompt for a
 278               password.
 279 <programlisting>
 280    # <emphasis role="bold">kas  -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
 281    ka&gt;
 282 </programlisting>
 283               <indexterm>
 284                 <primary>commands</primary>
 285                 <secondary>kas create</secondary>
 286               </indexterm>
 287               <indexterm>
 288                 <primary>kas commands</primary>
 289                 <secondary>create</secondary>
 290               </indexterm>
 291               <indexterm>
 292                 <primary>server encryption key</primary>
 293                 <secondary>in Authentication Database</secondary>
 294               </indexterm>
 295               <indexterm>
 296                 <primary>creating</primary>
 297                 <secondary>server encryption key</secondary>
 298                 <tertiary>Authentication Database</tertiary>
 299               </indexterm>
 300               </para>
 301             </listitem>
 302
 303             <listitem id="AppendixLIWQ54">
 304               <para>Issue the
 305               <emphasis role="bold">kas create</emphasis> command to create
 306               Authentication Database entries called
 307               <emphasis role="bold">admin</emphasis> and
 308               <emphasis role="bold">afs</emphasis>.</para>
 309
 310               <para>Do not provide passwords on the command line. Instead
 311               provide them as <replaceable>afs_passwd</replaceable> and
 312               <replaceable>admin_passwd</replaceable> in response to the
 313               <emphasis role="bold">kas</emphasis> command interpreter's
 314               prompts as shown, so that they do not appear on the standard
 315               output stream.</para>
 316
 317               <para>You need to enter the <replaceable>afs_passwd</replaceable>
 318               string only in this step and in Step
 319               <link linkend="AppendixLIWQ58">7</link>, so provide a value that
 320               is as long and complex as possible, preferably including numerals,
 321               punctuation characters, and both uppercase and lowercase letters.
 322               Also make the <replaceable>admin_passwd</replaceable> as
 323               long and complex as possible, but keep in mind that
 324               administrators need to enter it often. Both passwords must be
 325               at least six characters long.</para>
 326
 327 <programlisting>
 328    ka&gt; <emphasis role="bold">create afs</emphasis>
 329    initial_password:  <replaceable>afs_passwd</replaceable>
 330    Verifying, please re-enter initial_password: <replaceable>afs_passwd</replaceable>
 331    ka&gt; <emphasis role="bold">create admin</emphasis>
 332    initial_password: <replaceable>admin_passwd</replaceable>
 333    Verifying, please re-enter initial_password: <replaceable>admin_passwd</replaceable>
 334 </programlisting>
 335
 336               <indexterm>
 337                 <primary>commands</primary>
 338                 <secondary>kas examine</secondary>
 339               </indexterm>
 340
 341               <indexterm>
 342                 <primary>kas commands</primary>
 343                 <secondary>examine</secondary>
 344               </indexterm>
 345
 346               <indexterm>
 347                 <primary>displaying</primary>
 348                 <secondary>server encryption key</secondary>
 349                 <tertiary>Authentication Database</tertiary>
 350               </indexterm>
 351             </listitem>
 352
 353             <listitem id="AppendixLIWQ55">
 354               <para>Issue the
 355               <emphasis role="bold">kas examine</emphasis> command to display
 356               the <emphasis role="bold">afs</emphasis> entry. The output
 357               includes a checksum generated by encrypting a constant with the
 358               server encryption key derived from the
 359               <replaceable>afs_passwd</replaceable> string. In
 360               Step <link linkend="AppendixLIWQ59">8</link> you issue the
 361               <emphasis role="bold">bos listkeys</emphasis> command to verify
 362               that the checksum in its output matches the checksum in this
 363               output.
 364 <programlisting>
 365    ka&gt; <emphasis role="bold">examine afs</emphasis>
 366    User data for afs
 367     key (0) cksum is <replaceable>checksum</replaceable> . . .
 368 </programlisting>
 369               <indexterm>
 370                 <primary>commands</primary>
 371                 <secondary>kas setfields</secondary>
 372               </indexterm>
 373               <indexterm>
 374                 <primary>kas commands</primary>
 375                 <secondary>setfields</secondary>
 376               </indexterm>
 377               <indexterm>
 378                 <primary>admin account</primary>
 379                 <secondary>setting ADMIN flag on Auth. DB entry</secondary>
 380               </indexterm>
 381               </para>
 382             </listitem>
 383
 384             <listitem id="LIWQ56">
 385               <para>Issue the
 386               <emphasis role="bold">kas setfields</emphasis> command to turn
 387               on the <computeroutput>ADMIN</computeroutput> flag in the
 388               <emphasis role="bold">admin</emphasis> entry. This enables the
 389               <emphasis role="bold">admin</emphasis> user to issue privileged
 390               <emphasis role="bold">kas</emphasis> commands. Then issue
 391               the <emphasis role="bold">kas examine</emphasis> command to verify
 392               that the <computeroutput>ADMIN</computeroutput> flag
 393               appears in parentheses on the first line of the output, as shown
 394               in the example.
 395 <programlisting>
 396    ka&gt; <emphasis role="bold">setfields admin -flags admin</emphasis>
 397    ka&gt; <emphasis role="bold">examine admin</emphasis>
 398    User data for admin (ADMIN) . . .
 399 </programlisting>
 400               <indexterm>
 401                 <primary>commands</primary>
 402                 <secondary>kas quit</secondary>
 403               </indexterm>
 404               <indexterm>
 405                 <primary>kas commands</primary>
 406                 <secondary>quit</secondary>
 407               </indexterm>
 408               <indexterm>
 409                 <primary>interactive mode for kas</primary>
 410                 <secondary>quitting</secondary>
 411               </indexterm>
 412               </para>
 413             </listitem>
 414
 415             <listitem>
 416               <para>Issue the <emphasis role="bold">kas quit</emphasis>
 417               command to leave <emphasis role="bold">kas</emphasis>
 418               interactive mode.
 419 <programlisting>
 420    ka&gt; <emphasis role="bold">quit</emphasis>
 421 </programlisting>
 422               <indexterm>
 423                 <primary>commands</primary>
 424                 <secondary>bos adduser</secondary>
 425               </indexterm>
 426               <indexterm>
 427                 <primary>bos commands</primary>
 428                 <secondary>adduser</secondary>
 429               </indexterm>
 430               <indexterm>
 431                 <primary>usr/afs/etc/UserList</primary>
 432                 <see>UserList file</see>
 433               </indexterm>
 434               <indexterm>
 435                 <primary>UserList file</primary>
 436                 <secondary>first AFS machine</secondary>
 437               </indexterm>
 438               <indexterm>
 439                 <primary>files</primary>
 440                 <secondary>UserList</secondary>
 441               </indexterm>
 442               <indexterm>
 443                 <primary>creating</primary>
 444                 <secondary>UserList file entry</secondary>
 445               </indexterm>
 446               <indexterm>
 447                 <primary>admin account</primary>
 448                 <secondary>adding</secondary>
 449                 <tertiary>to UserList file</tertiary>
 450               </indexterm>
 451               </para>
 452             </listitem>
 453
 454             <listitem id="AppendixLIWQ57">
 455               <para>Issue the
 456               <emphasis role="bold">bos adduser</emphasis> command to add the
 457               <emphasis role="bold">admin</emphasis> user to the
 458               <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file.
 459               This enables the <emphasis role="bold">admin</emphasis> user to
 460               issue privileged <emphasis role="bold">bos</emphasis> and
 461               <emphasis role="bold">vos</emphasis> commands.
 462 <programlisting>
 463    # <emphasis role="bold">./bos adduser</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">admin -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
 464                 role="bold">-noauth</emphasis>
 465 </programlisting>
 466               <indexterm>
 467                 <primary>commands</primary>
 468                 <secondary>bos addkey</secondary>
 469               </indexterm>
 470               <indexterm>
 471                 <primary>bos commands</primary>
 472                 <secondary>addkey</secondary>
 473               </indexterm>
 474               <indexterm>
 475                 <primary>creating</primary>
 476                 <secondary>server encryption key</secondary>
 477                 <tertiary>KeyFile file</tertiary>
 478               </indexterm>
 479               <indexterm>
 480                 <primary>server encryption key</primary>
 481                 <secondary>in KeyFile file</secondary>
 482               </indexterm>
 483               </para>
 484             </listitem>
 485
 486             <listitem id="AppendixLIWQ58">
 487               <para>Issue the
 488               <emphasis role="bold">bos addkey</emphasis> command to define
 489               the AFS server encryption key in the
 490               <emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file.
 491               </para>
 492
 493               <para>Do not provide the password on the command line. Instead
 494               provide it as <replaceable>afs_passwd</replaceable> in
 495               response to the <emphasis role="bold">bos</emphasis> command
 496               interpreter's prompts, as shown. Provide the same string as
 497               in Step <link linkend="AppendixLIWQ54">2</link>.</para>
 498
 499 <programlisting>
 500    # <emphasis role="bold">./bos addkey</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-kvno 0 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis
 501               role="bold">-noauth</emphasis>
 502    Input key: <replaceable>afs_passwd</replaceable>
 503    Retype input key: <replaceable>afs_passwd</replaceable>
 504 </programlisting>
 505
 506               <indexterm>
 507                 <primary>commands</primary>
 508                 <secondary>bos listkeys</secondary>
 509               </indexterm>
 510
 511               <indexterm>
 512                 <primary>bos commands</primary>
 513                 <secondary>listkeys</secondary>
 514               </indexterm>
 515
 516               <indexterm>
 517                 <primary>displaying</primary>
 518                 <secondary>server encryption key</secondary>
 519                 <tertiary>KeyFile file</tertiary>
 520               </indexterm>
 521             </listitem>
 522
 523             <listitem id="AppendixLIWQ59">
 524               <para>Issue the
 525               <emphasis role="bold">bos listkeys</emphasis> command to verify
 526               that the checksum for the new key in the
 527               <emphasis role="bold">KeyFile</emphasis> file is the same as the
 528               checksum for the key in the Authentication Database's
 529               <emphasis role="bold">afs</emphasis> entry, which you displayed
 530               in Step <link linkend="AppendixLIWQ55">3</link>.
 531 <programlisting>
 532    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-cell</emphasis> &lt;<replaceable>ce
 533 ll name</replaceable>&gt; <emphasis
 534                 role="bold">-noauth</emphasis>
 535    key 0 has cksum <replaceable>checksum</replaceable>
 536 </programlisting></para>
 537
 538               <para>You can safely ignore any error messages indicating that
 539               <emphasis role="bold">bos</emphasis> failed to get tickets
 540               or that authentication failed.</para>
 541
 542               <para>If the keys are different, issue the following commands,
 543               making sure that the <replaceable>afs_passwd</replaceable>
 544               string is the same in each case. The
 545               <replaceable>checksum</replaceable> strings reported by the
 546               <emphasis role="bold">kas examine</emphasis> and
 547               <emphasis role="bold">bos listkeys</emphasis> commands must
 548               match; if they do not, repeat these instructions until they do,
 549               using the <emphasis role="bold">-kvno</emphasis> argument to
 550               increment the key version number each time.</para>
 551
 552 <programlisting>
 553    # <emphasis role="bold">./kas  -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
 554    ka&gt; <emphasis role="bold">setpassword afs -kvno 1</emphasis>
 555    new_password: <replaceable>afs_passwd</replaceable>
 556    Verifying, please re-enter initial_password: <replaceable>afs_passwd</replaceable>
 557    ka&gt; <emphasis role="bold">examine afs</emphasis>
 558    User data for afs
 559     key (1) cksum is <replaceable>checksum</replaceable> . . .
 560    ka&gt; <emphasis role="bold">quit</emphasis>
 561    # <emphasis role="bold">./bos addkey</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-kvno 1 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
 562               role="bold">-noauth</emphasis>
 563    Input key: <replaceable>afs_passwd</replaceable>
 564    Retype input key: <replaceable>afs_passwd</replaceable>
 565    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
 566               role="bold">-noauth</emphasis>
 567    key 1 has cksum <replaceable>checksum</replaceable>
 568 </programlisting>
 569             </listitem>
 570             <listitem>
 571               <para>Proceed to
 572               <link linkend="HDRWQ53a">Initializing the Protection Database</link>
 573               to continue with the installation process</para>
 574             </listitem>
 575           </orderedlist></para>
 576         </sect3>
 577       </sect2>
 578       <sect2 id="KAS009">
 579         <title>Installing Additional Server Machines</title>
 580
 581         <sect3 id="KAS010">
 582           <title>Starting the Authenticxation Service</title>
 583           <indexterm>
 584             <primary>Authentication Server</primary>
 585             <secondary>starting</secondary>
 586             <tertiary>new db-server machine</tertiary>
 587           </indexterm>
 588           <indexterm>
 589             <primary>starting</primary>
 590             <secondary>Authentication Server</secondary>
 591             <tertiary>new db-server machine</tertiary>
 592           </indexterm>
 593           <para>In addition to the instructions in the main guide, you must
 594           also start the Authentication Server on the new database machine,
 595           as detailed below</para>
 596
 597           <orderedlist>
 598             <listitem id="LIWQ118">
 599               <para>Start the Authentication Server
 600               (the <emphasis role="bold">kaserver</emphasis> process).
 601 <programlisting>
 602    % <emphasis role="bold">bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">kaserver simple /usr/afs/bin/kaserver</emphasis>
 603 </programlisting> </para>
 604            </listitem>
 605
 606            <listitem>
 607              <para>Return to <link linkend="LIWQ119">starting the backup server</link></para>
 608            </listitem>
 609           </orderedlist>
 610         </sect3>
 611       </sect2>
 612
 613       <sect2 id="KAS011">
 614         <title>Enabling AFS login with kaserver</title>
 615         <para>The authentication system of every machine should be modified so
 616         that users obtain an AFS token as they log into the local file system.
 617         Using AFS is simpler and more convenient for your users if you make the
 618         modifications on all client machines. Otherwise users must perform a two
 619         step login procedure (login to the local system, and then issue the
 620         <emphasis role="bold">klog</emphasis> command.</para>
 621
 622         <para>For convenience, the following sections group this procedure by
 623         system type. Proceed to the appropriate section.
 624           <itemizedlist>
 625             <listitem>
 626               <para>
 627                 <link linkend="KAS012">Enabling AFS Login on AIX Systems</link>
 628               </para>
 629             </listitem>
 630             <listitem>
 631               <para>
 632                 <link linkend="KAS015">Enabling AFS Login on Linux Systems</link>
 633               </para>
 634             </listitem>
 635             <listitem>
 636               <para>
 637                 <link linkend="KAS016">Enabling AFS login on Solaris Systems</link>
 638               </para>
 639             </listitem>
 640           </itemizedlist>
 641         </para>
 642       </sect2>
 643       <sect2 id="KAS012">
 644         <title>Enabling kaserver based AFS login</title>
 645
 646         <para>Now incorporate AFS into the AIX secondary authentication system.
 647           <orderedlist>
 648             <listitem>
 649               <para>Issue the <emphasis role="bold">ls</emphasis> command to
 650               verify that the <emphasis role="bold">afs_dynamic_auth</emphasis>
 651               and <emphasis role="bold">afs_dynamic_kerbauth</emphasis>
 652               programs are installed in the local
 653               <emphasis role="bold">/usr/vice/etc</emphasis> directory.
 654 <programlisting>
 655    # <emphasis role="bold">ls /usr/vice/etc</emphasis>
 656 </programlisting>
 657               </para>
 658
 659               <para>If the files do not exist, unpack the
 660               OpenAFS Binary Distribution for AIX (if it is not already),
 661               change directory as indicated, and copy them.</para>
 662
 663 <programlisting>
 664    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/dest/root.client/usr/vice/etc</emphasis>
 665    # <emphasis role="bold">cp  -p  afs_dynamic*  /usr/vice/etc</emphasis>
 666 </programlisting>
 667             </listitem>
 668
 669             <listitem>
 670               <para>Edit the local
 671               <emphasis role="bold">/etc/security/user</emphasis> file, making
 672               changes to the indicated stanzas:
 673                 <itemizedlist>
 674                   <listitem>
 675                     <para>In the default stanza, set the
 676                     <computeroutput>registry</computeroutput> attribute to
 677                     <emphasis role="bold">DCE</emphasis> (not to
 678                     <emphasis role="bold">AFS</emphasis>), as follows:
 679 <programlisting>
 680    registry = DCE
 681 </programlisting>
 682                     </para>
 683                   </listitem>
 684
 685                   <listitem>
 686                     <para>In the default stanza, set the
 687                     <computeroutput>SYSTEM</computeroutput> attribute as
 688                     indicated.</para>
 689
 690                     <para>If the machine is an AFS client only, set the
 691                     following value:</para>
 692 <programlisting>
 693    SYSTEM = "AFS OR (AFS[UNAVAIL] AND compat[SUCCESS])"
 694 </programlisting>
 695
 696                     <para>If the machine is both an AFS and a DCE client,
 697                     set the following value (it must appear on a single line in
 698                     the file):</para>
 699 <programlisting>
 700    SYSTEM = "DCE OR DCE[UNAVAIL] OR AFS OR (AFS[UNAVAIL]  \
 701        AND compat[SUCCESS])"
 702 </programlisting>
 703                   </listitem>
 704
 705                   <listitem>
 706                     <para>In the <computeroutput>root</computeroutput>
 707                     stanza, set the <computeroutput>registry</computeroutput>
 708                     attribute as follows. It enables the local superuser
 709                     <emphasis role="bold">root</emphasis> to log into the local
 710                     file system only, based on the password listed in the
 711                     local password file.
 712 <programlisting>
 713    root:
 714          registry = files
 715 </programlisting>
 716                     </para>
 717                   </listitem>
 718                 </itemizedlist>
 719               </para>
 720             </listitem>
 721
 722             <listitem>
 723               <para>Edit the local
 724               <emphasis role="bold">/etc/security/login.cfg</emphasis> file,
 725               creating or editing the indicated stanzas:
 726                 <itemizedlist>
 727                   <listitem>
 728                     <para>In the <computeroutput>DCE</computeroutput> stanza,
 729                     set the <computeroutput>program</computeroutput>
 730                     attribute as follows.</para>
 731
 732                     <para>If you use the AFS Authentication Server
 733                     (<emphasis role="bold">kaserver</emphasis> process):</para>
 734 <programlisting>
 735    DCE:
 736         program = /usr/vice/etc/afs_dynamic_auth
 737 </programlisting>
 738
 739                     <para>If you use a Kerberos v4 implementation of AFS
 740                     authentication:</para>
 741
 742 <programlisting>
 743    DCE:
 744         program = /usr/vice/etc/afs_dynamic_kerbauth
 745 </programlisting>
 746                   </listitem>
 747
 748                   <listitem>
 749                     <para>In the <computeroutput>AFS</computeroutput> stanza,
 750                     set the <computeroutput>program</computeroutput>
 751                     attribute as follows.</para>
 752
 753                     <para>If you use the AFS Authentication Server
 754                     (<emphasis role="bold">kaserver</emphasis> process):</para>
 755 <programlisting>
 756    AFS:
 757         program = /usr/vice/etc/afs_dynamic_auth
 758 </programlisting>
 759
 760                     <para>If you use a Kerberos v4 implementation of AFS
 761                     authentication:</para>
 762 <programlisting>
 763    AFS:
 764         program = /usr/vice/etc/afs_dynamic_kerbauth
 765 </programlisting>
 766                 </listitem>
 767                 </itemizedlist>
 768               </para>
 769             </listitem>
 770             <listitem>
 771               <para>Proceed to
 772               <link linkend="HDRWQ50">Starting the BOS Server</link>,
 773               if you are installing your first file server machine;
 774               <link linkend="HDRWQ108">Starting Server Programs</link>,
 775               if you are installing an additional file server machine; or
 776               <link linkend="HDRWQ145">Loading and Creating Client Files</link>
 777               if you are installating a client</para>
 778             </listitem>
 779           </orderedlist>
 780         </para>
 781       </sect2>
 782       <sect2 id="KAS015">
 783         <title>Enabling kaserver based AFS Login on Linux Systems</title>
 784
 785         <para>At this point you incorporate AFS into the operating system's
 786         Pluggable Authentication Module (PAM) scheme. PAM integrates all
 787         authentication mechanisms on the machine, including login, to provide
 788         the security infrastructure for authenticated access to and from the
 789         machine.</para>
 790
 791         <para>Explaining PAM is beyond the scope of this document. It is
 792         assumed that you understand the syntax and meanings of settings in the
 793         PAM configuration file (for example, how the
 794         <computeroutput>other</computeroutput> entry works, the effect of
 795         marking an entry as <computeroutput>required</computeroutput>,
 796         <computeroutput>optional</computeroutput>, or
 797         <computeroutput>sufficient</computeroutput>, and so on).</para>
 798
 799         <para>The following instructions explain how to alter the entries in
 800         the PAM configuration file for each service for which you
 801         wish to use AFS authentication. Other configurations possibly also
 802         work, but the instructions specify the recommended and
 803         tested configuration.</para>
 804
 805         <para>The recommended AFS-related entries in the PAM configuration
 806         file make use of one or more of the following three
 807         attributes.
 808         <variablelist>
 809           <title>Authentication Management</title>
 810
 811           <varlistentry>
 812             <term><emphasis role="bold"><computeroutput>try_first_pass</computeroutput></emphasis></term>
 813
 814             <listitem>
 815               <para>This is a standard PAM attribute that can be included on
 816               entries after the first one for a service; it directs
 817               the module to use the password that was provided to the first
 818               module. For the AFS module, it means that AFS
 819               authentication succeeds if the password provided to the module
 820               listed first is the user's correct AFS password. For
 821               further discussion of this attribute and its alternatives, see
 822               the operating system's PAM documentation.</para>
 823             </listitem>
 824           </varlistentry>
 825
 826           <varlistentry>
 827             <term><emphasis role="bold"><computeroutput>ignore_root</computeroutput></emphasis></term>
 828
 829             <listitem>
 830               <para>This attribute, specific to the AFS PAM module, directs it
 831               to ignore not only the local superuser <emphasis
 832               role="bold">root</emphasis>, but also any user with UID
 833               0 (zero).</para>
 834             </listitem>
 835           </varlistentry>
 836
 837           <varlistentry>
 838             <term><emphasis role="bold"><computeroutput>ignore_uid </computeroutput><emphasis>uid</emphasis></emphasis></term>
 839
 840             <listitem>
 841               <para>This option is an extension of the "ignore_root" switch.
 842               The additional parameter is a limit. Users with a uid
 843               up to the given parameter are ignored by
 844               <emphasis>pam_afs.so</emphasis>. Thus, a system administrator
 845               still has the
 846               opportunity to add local user accounts to his system by choosing
 847               between "low" and "high" user ids. An example
 848               /etc/passwd file for "ignore_uid 100" may have entries like these:
 849 <programlisting>
 850         .
 851         .
 852 afsuserone:x:99:100::/afs/afscell/u/afsuserone:/bin/bash
 853 afsusertwo:x:100:100::/afs/afscell/u/afsusertwo:/bin/bash
 854 localuserone:x:101:100::/home/localuserone:/bin/bash
 855 localusertwo:x:102:100::/home/localusertwo:/bin/bash
 856         .
 857         .
 858 </programlisting>
 859               AFS accounts should be locked in the file /etc/shadow like this:
 860 <programlisting>
 861         .
 862         .
 863 afsuserone:!!:11500:0:99999:7:::
 864 afsusertwo:!!:11500:0:99999:7:::
 865 localuserone:&lt;thelocaluserone'skey&gt;:11500:0:99999:7:::
 866 localusertwo:&lt;thelocalusertwo'skey&gt;:11500:0:99999:7:::
 867         .
 868         .
 869 </programlisting>
 870               There is no need to store a local key in this file since the AFS
 871               password is sent and verfied at the AFS cell server!</para>
 872             </listitem>
 873           </varlistentry>
 874
 875           <varlistentry>
 876             <term><emphasis role="bold"><computeroutput>setenv_password_expires</computeroutput></emphasis></term>
 877
 878             <listitem>
 879               <para>This attribute, specific to the AFS PAM module, sets the
 880               environment variable PASSWORD_EXPIRES to the expiration
 881               date of the user's AFS password, which is recorded in the
 882               Authentication Database.</para>
 883             </listitem>
 884           </varlistentry>
 885
 886           <varlistentry>
 887             <term><emphasis role="bold"><computeroutput>set_token</computeroutput></emphasis></term>
 888
 889             <listitem>
 890               <para>Some applications don't call
 891               <emphasis>pam_setcred()</emphasis> in order to retrieve the
 892               appropriate credentials (here the AFS token) for their session.
 893               This switch sets the credentials already in
 894               <emphasis>pam_sm_authenticate()</emphasis> obsoleting a call to
 895               <emphasis>pam_setcred()</emphasis>. <emphasis
 896               role="bold">Caution: Don't use this switch for applications which
 897               do call <emphasis>pam_setcred()</emphasis>!</emphasis> One
 898               example for an application not calling
 899               <emphasis>pam_setcred()</emphasis> are older versions of the
 900               samba server. Nevertheless, using applications with
 901               working pam session management is recommended as this setup
 902               conforms better with the PAM definitions.</para>
 903             </listitem>
 904           </varlistentry>
 905
 906           <varlistentry>
 907             <term><emphasis role="bold"><computeroutput>refresh_token</computeroutput></emphasis></term>
 908
 909             <listitem>
 910               <para>This options is identical to "set_token" except that no
 911               new PAG is generated. This is necessary to handle
 912               processes like xlock or xscreensaver. It is not enough to just
 913               unlock the screen for a user who
 914               reactivated his session by typing in the correct AFS password, but
 915               one may also need fresh tokens with a full lifetime in
 916               order to work on, and the new token must be refreshed in the
 917               already existing PAG for the processes that have been
 918               started. This is achieved using this option.</para>
 919             </listitem>
 920           </varlistentry>
 921
 922           <varlistentry>
 923             <term><emphasis role="bold"><computeroutput>use_klog</computeroutput></emphasis></term>
 924
 925             <listitem>
 926               <para>Activating this switch causes authentication to be done by
 927               calling the external program "klog". One program requiring
 928               this is for example <emphasis>kdm</emphasis> of KDE 2.x.</para>
 929             </listitem>
 930           </varlistentry>
 931
 932           <varlistentry>
 933             <term><emphasis role="bold"><computeroutput>dont_fork</computeroutput></emphasis></term>
 934
 935             <listitem>
 936               <para>Usually, the password verification and token establishment
 937               is performed in a sub process. Using this option pam_afs does not
 938               fork and performs all actions in a single process.
 939               <emphasis role="bold">Only use this option in cases where you
 940               notice serious problems caused by the sub process.</emphasis>
 941               This option has been developed in respect to
 942               the "mod_auth_pam"-project (see also
 943               <ulink url="http://pam.sourceforge.net/mod_auth_pam/">mod_auth_pam</ulink>).
 944               The mod_auth_pam module enables PAM authentication for the apache
 945               http server package.</para>
 946             </listitem>
 947           </varlistentry>
 948         </variablelist>
 949         <variablelist>
 950           <title>Session Management</title>
 951
 952           <varlistentry>
 953             <term><emphasis role="bold"><computeroutput>no_unlog</computeroutput></emphasis></term>
 954
 955             <listitem>
 956               <para>Normally the tokens are deleted (in memory) after the
 957               session ends. Using this option causes the tokens to be left
 958               untouched. <emphasis role="bold">This behaviour was the default
 959               in pam_afs until openafs-1.1.1!</emphasis></para>
 960             </listitem>
 961           </varlistentry>
 962
 963           <varlistentry>
 964             <term><emphasis role="bold"><computeroutput>remainlifetime</computeroutput> <emphasis>sec</emphasis></emphasis></term>
 965
 966             <listitem>
 967               <para>The tokens are kept active for <emphasis>sec</emphasis>
 968               seconds before they are deleted. X display managers i.e.
 969               are used to inform the applications started in the X session
 970               before the logout and then end themselves. If the token
 971               was deleted immediately the applications would have no chance
 972               to write back their settings to i.e. the user's AFS home
 973               space. This option may help to avoid the problem.</para>
 974             </listitem>
 975           </varlistentry>
 976         </variablelist></para>
 977
 978       <para>Perform the following steps to enable AFS login.
 979         <orderedlist>
 980           <listitem>
 981             <para>Unpack the OpenAFS Binary Distribution for Linux into the
 982             <emphasis role="bold">/tmp/afsdist/</emphasis> directory, if it is
 983             not already.
 984             Then change to the directory for PAM modules, which depends on which Linux distribution you are using.</para>
 985
 986             <para>If you are using a Linux distribution from Red Hat Software:</para>
 987
 988             <programlisting>
 989    # <emphasis role="bold">cd /lib/security</emphasis>
 990 </programlisting>
 991
 992             <para>If you are using another Linux distribution:</para>
 993
 994             <programlisting>
 995    # <emphasis role="bold">cd /usr/lib/security</emphasis>
 996 </programlisting>
 997           </listitem>
 998
 999           <listitem>
1000             <para>Copy the appropriate AFS authentication library file to the
1001             directory to which you changed in the previous step.
1002             Create a symbolic link whose name does not mention the version.
1003             Omitting the version eliminates the need to edit the PAM
1004             configuration file if you later update the library file.</para>
1005
1006             <para>If you use the AFS Authentication Server
1007             (<emphasis role="bold">kaserver</emphasis> process):</para>
1008 <programlisting>
1009    # <emphasis role="bold">cp /cdrom/i386_linux22/lib/pam_afs.so.1  .</emphasis>
1010    # <emphasis role="bold">ln -s pam_afs.so.1 pam_afs.so</emphasis>
1011 </programlisting>
1012
1013             <para>If you use a Kerberos implementation of AFS
1014             authentication:</para>
1015 <programlisting>
1016    # <emphasis role="bold">cp /cdrom/i386_linux22/lib/pam_afs.krb.so.1   .</emphasis>
1017    # <emphasis role="bold">ln -s pam_afs.krb.so.1 pam_afs.so</emphasis>
1018 </programlisting>
1019           </listitem>
1020
1021           <listitem>
1022             <para>For each service with which you want to use AFS
1023             authentication, insert an entry for the AFS PAM module into the
1024             <computeroutput>auth</computeroutput> section of the service's
1025             PAM configuration file. (Linux uses a separate
1026             configuration file for each service, unlike some other operating
1027             systems which list all services in a single file.) Mark
1028             the entry as <computeroutput>sufficient</computeroutput> in the
1029             second field.</para>
1030
1031             <para>Place the AFS entry below any entries that impose conditions
1032             under which you want the service to fail for a user
1033             who does not meet the entry's requirements. Mark these entries
1034             <computeroutput>required</computeroutput>. Place the AFS
1035             entry above any entries that need to execute only if AFS
1036             authentication fails.</para>
1037
1038             <para>Insert the following AFS entry if using the Red Hat
1039             distribution:</para>
1040 <programlisting>
1041    auth  sufficient  /lib/security/pam_afs.so   try_first_pass  ignore_root
1042 </programlisting>
1043
1044             <para>Insert the following AFS entry if using another
1045             distribution:</para>
1046
1047 <programlisting>
1048    auth  sufficient  /usr/lib/security/pam_afs.so  try_first_pass  ignore_root
1049 </programlisting>
1050
1051             <para>Check the PAM config files also for "session" entries. If
1052             there are lines beginning with "session" then please
1053             insert this line too:</para>
1054
1055 <programlisting>
1056    session  optional  /lib/security/pam_afs.so
1057 </programlisting>
1058
1059             <para>or</para>
1060
1061 <programlisting>
1062    session  optional  /usr/lib/security/pam_afs.so
1063 </programlisting>
1064
1065             <para>This guarantees that the user's tokens are deleted from
1066             memory after his session ends so that no other user
1067             coincidently gets those tokens without authorization! The
1068             following examples illustrate the recommended configuration of
1069             the configuration file for several services:
1070               <variablelist>
1071                 <title>Authentication Management</title>
1072
1073                 <varlistentry>
1074                   <term>(<emphasis role="bold">/etc/pam.d/login</emphasis>)</term>
1075
1076                   <listitem>
1077                     <para>
1078 <programlisting>
1079    #%PAM-1.0
1080    auth      required   /lib/security/pam_securetty.so
1081    auth      required   /lib/security/pam_nologin.so
1082    auth      sufficient /lib/security/pam_afs.so try_first_pass ignore_root
1083    #                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1084    #This enables AFS authentication for every user but root
1085    auth      required   /lib/security/pam_pwdb.so shadow nullok
1086    account   required   /lib/security/pam_pwdb.so
1087    password  required   /lib/security/pam_cracklib.so
1088    password  required   /lib/security/pam_pwdb.so shadow nullok use_authtok
1089    session   optional   /lib/security/pam_afs.so
1090    #Make sure tokens are deleted after the user logs out
1091    session   required   /lib/security/pam_pwdb.so
1092 </programlisting>
1093                     </para>
1094                   </listitem>
1095                 </varlistentry>
1096
1097                 <varlistentry>
1098                   <term>(<emphasis role="bold">/etc/pam.d/samba</emphasis>)</term>
1099
1100                   <listitem>
1101                     <para>
1102 <programlisting>
1103    auth       required     /lib/security/pam_afs.so ignore_uid 100 set_token
1104    #                                                ^^^^^^^^^^^^^^^^^^^^^^^^
1105    #Here, users with uid&gt;100 are considered to belong to the AFS and users
1106    #with uid&lt;=100 are ignored by pam_afs. The token is retrieved already in
1107    #pam_sm_authenticate() (this is an example pam config for a samba version
1108    #that does not call pam_setcred(), it also does no sense to include session
1109    #entries here since they would be ignored by this version of samba ).
1110    account    required     /lib/security/pam_pwdb.so
1111 </programlisting>
1112                     </para>
1113                   </listitem>
1114                 </varlistentry>
1115
1116                 <varlistentry>
1117                   <term>(<emphasis role="bold">/etc/pam.d/xscreensaver</emphasis>)</term>
1118
1119                   <listitem>
1120                     <para>
1121 <programlisting>
1122    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100 refresh_token
1123    #                                                               ^^^^^^^^^^^^^
1124    #Avoid generating a new PAG for the new tokens, use the already existing PAG and
1125    #establish a fresh token in it.
1126    auth       required     /lib/security/pam_pwdb.so try_first_pass
1127 </programlisting>
1128                     </para>
1129                   </listitem>
1130                 </varlistentry>
1131
1132                 <varlistentry>
1133                   <term>(<emphasis role="bold">/etc/pam.d/httpd</emphasis>)</term>
1134
1135                   <listitem>
1136                     <para>
1137 <programlisting>
1138    auth       required   /lib/security/pam_afs.so ignore_uid 100 dont_fork
1139    #                                                             ^^^^^^^^^
1140    #Don't fork for the verification of the password.
1141 </programlisting>
1142                     </para>
1143                   </listitem>
1144                 </varlistentry>
1145               </variablelist>
1146               <variablelist>
1147                 <title>Session Management</title>
1148
1149                 <varlistentry>
1150                   <term>(<emphasis role="bold">/etc/pam.d/su</emphasis>)</term>
1151
1152                   <listitem>
1153                     <para>
1154 <programlisting>
1155    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100
1156    auth       required     /lib/security/pam_pwdb.so try_first_pass
1157    account    required     /lib/security/pam_pwdb.so
1158    password   required     /lib/security/pam_cracklib.so
1159    password   required     /lib/security/pam_pwdb.so use_authtok
1160    session    required     /lib/security/pam_pwdb.so
1161    session    optional     /lib/security/pam_afs.so no_unlog
1162    #                                                ^^^^^^^^
1163    #Don't delete the token in this case, since the user may still
1164    #need it (for example if somebody logs in and changes to root
1165    #afterwards he may still want to access his home space in AFS).
1166    session    required     /lib/security/pam_login_access.so
1167    session    optional     /lib/security/pam_xauth.so
1168 </programlisting>
1169                     </para>
1170                   </listitem>
1171                 </varlistentry>
1172
1173                 <varlistentry>
1174                   <term>(<emphasis role="bold">/etc/pam.d/xdm</emphasis>)</term>
1175
1176                   <listitem>
1177                     <para>
1178 <programlisting>
1179    auth       required     /lib/security/pam_nologin.so
1180    auth       required     /lib/security/pam_login_access.so
1181    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100 use_klog
1182    auth       required     /lib/security/pam_pwdb.so try_first_pass
1183    account    required     /lib/security/pam_pwdb.so
1184    password   required     /lib/security/pam_cracklib.so
1185    password   required     /lib/security/pam_pwdb.so shadow nullok use_authtok
1186    session    optional     /lib/security/pam_afs.so remainlifetime 10
1187    #                                                ^^^^^^^^^^^^^^^^^
1188    #Wait 10 seconds before deleting the AFS tokens in order to give
1189    #the programs of the X session some time to save their settings
1190    #to AFS.
1191    session    required     /lib/security/pam_pwdb.so
1192 </programlisting>
1193                      </para>
1194                   </listitem>
1195                 </varlistentry>
1196               </variablelist></para>
1197           </listitem>
1198           <listitem>
1199             <para>After taking any necessary action, proceed to
1200             <link linkend="HDRWQ50">Starting the BOS Server</link> if you
1201             are installing your first file server;
1202             <link linkend="HDRWQ108">Starting Server Programs</link> if you
1203             are installing an additional file server machine; or
1204             <link linkend="HDRWQ145">Loading and Creating Client Files</link> if you are installing a client.
1205             </para>
1206           </listitem>
1207         </orderedlist>
1208       </para>
1209     </sect2>
1210     <sect2 id="KAS016">
1211       <title>Enabling kaserver based AFS Login on Solaris Systems</title>
1212
1213       <para>At this point you incorporate AFS into the operating system's
1214       Pluggable Authentication Module (PAM) scheme. PAM
1215       integrates all authentication mechanisms on the machine, including
1216       login, to provide the security infrastructure for
1217       authenticated access to and from the machine.</para>
1218
1219       <para>Explaining PAM is beyond the scope of this document. It is
1220       assumed that you understand the syntax and meanings of
1221       settings in the PAM configuration file (for example, how the
1222       <computeroutput>other</computeroutput> entry works, the effect of
1223       marking an entry as <computeroutput>required</computeroutput>,
1224       <computeroutput>optional</computeroutput>, or
1225       <computeroutput>sufficient</computeroutput>, and so on).</para>
1226
1227       <para>The following instructions explain how to alter the entries in the
1228       PAM configuration file for each service for which you
1229       wish to use AFS authentication. Other configurations possibly also
1230       work, but the instructions specify the recommended and
1231       tested configuration.</para>
1232
1233       <note>
1234         <para>The instructions specify that you mark each entry as
1235         <computeroutput>optional</computeroutput>. However, marking some
1236         modules as optional can mean that they grant access to the
1237         corresponding service even when the user does not meet all of the
1238         module's requirements. In some operating system revisions,
1239         for example, if you mark as optional the module that controls
1240         login via a dial-up connection, it allows users to login without
1241         providing a password. See the <emphasis>OpenAFS Release
1242         Notes</emphasis> for a discussion of any limitations that apply to
1243         this operating system.</para>
1244
1245         <para>Also, with some operating system versions you must install
1246         patches for PAM to interact correctly with certain
1247         authentication programs. For details, see the
1248         <emphasis>OpenAFS Release Notes</emphasis>.</para>
1249       </note>
1250
1251       <para>The recommended AFS-related entries in the PAM configuration file
1252       make use of one or more of the following three
1253       attributes.
1254         <variablelist>
1255           <title>Authentication Management</title>
1256
1257           <varlistentry>
1258             <term><emphasis role="bold"><computeroutput>try_first_pass</computeroutput></emphasis></term>
1259
1260             <listitem>
1261               <para>This is a standard PAM attribute that can be included on
1262               entries after the first one for a service; it directs
1263               the module to use the password that was provided to the first
1264               module. For the AFS module, it means that AFS
1265               authentication succeeds if the password provided to the module
1266               listed first is the user's correct AFS password. For
1267               further discussion of this attribute and its alternatives, see
1268               the operating system's PAM documentation.</para>
1269             </listitem>
1270           </varlistentry>
1271
1272           <varlistentry>
1273             <term><emphasis role="bold"><computeroutput>ignore_root</computeroutput></emphasis></term>
1274
1275             <listitem>
1276               <para>This attribute, specific to the AFS PAM module, directs it
1277               to ignore not only the local superuser <emphasis
1278               role="bold">root</emphasis>, but also any user with UID 0
1279               (zero).</para>
1280             </listitem>
1281           </varlistentry>
1282
1283           <varlistentry>
1284             <term><emphasis role="bold"><computeroutput>setenv_password_expires</computeroutput></emphasis></term>
1285
1286             <listitem>
1287               <para>This attribute, specific to the AFS PAM module, sets the
1288               environment variable PASSWORD_EXPIRES to the expiration
1289               date of the user's AFS password, which is recorded in the
1290               Authentication Database.</para>
1291             </listitem>
1292           </varlistentry>
1293         </variablelist></para>
1294
1295       <para>Perform the following steps to enable AFS login. <orderedlist>
1296           <listitem>
1297             <para>Unpack the OpenAFS Binary Distribution for Solaris into the
1298             <emphasis role="bold">/cdrom</emphasis> directory, if it is not
1299             already.
1300             Then change directory as indicated.
1301 <programlisting>
1302    # <emphasis role="bold">cd /usr/lib/security</emphasis>
1303 </programlisting></para>
1304           </listitem>
1305
1306           <listitem>
1307             <para>Copy the AFS authentication library file to the
1308             <emphasis role="bold">/usr/lib/security</emphasis> directory. Then
1309             create a symbolic link to it whose name does not mention the
1310             version. Omitting the version eliminates the need to edit
1311             the PAM configuration file if you later update the library
1312             file.</para>
1313
1314             <para>If you use the AFS Authentication Server
1315             (<emphasis role="bold">kaserver</emphasis> process):</para>
1316
1317 <programlisting>
1318    # <emphasis role="bold">cp /tmp/afsdist/sun4x_56/dest/lib/pam_afs.so.1 .</emphasis>
1319    # <emphasis role="bold">ln -s pam_afs.so.1 pam_afs.so</emphasis>
1320 </programlisting>
1321
1322             <para>If you use a Kerberos implementation of AFS authentication:</para>
1323
1324 <programlisting>
1325    # <emphasis role="bold">cp /tmp/afsdist/sun4x_56/dest/lib/pam_afs.krb.so.1 .</emphasis>
1326    # <emphasis role="bold">ln -s pam_afs.krb.so.1 pam_afs.so</emphasis>
1327 </programlisting>
1328           </listitem>
1329
1330           <listitem>
1331             <para>Edit the
1332             <computeroutput>Authentication management</computeroutput> section
1333             of the Solaris PAM configuration file,
1334             <emphasis role="bold">/etc/pam.conf</emphasis> by convention.
1335             The entries in this section have the value
1336             <computeroutput>auth</computeroutput> in their second field.</para>
1337
1338             <para>First edit the standard entries, which refer to the
1339             Solaris PAM module (usually, the file <emphasis
1340             role="bold">/usr/lib/security/pam_unix.so.1</emphasis>) in their
1341             fourth field. For each service for which you want to
1342             use AFS authentication, edit the third field of its entry to read
1343             <computeroutput>optional</computeroutput>. The
1344             <emphasis role="bold">pam.conf</emphasis> file in the Solaris
1345             distribution usually includes standard entries for the
1346             <emphasis role="bold">login</emphasis>,
1347             <emphasis role="bold">rlogin</emphasis>, and <emphasis
1348             role="bold">rsh</emphasis> services, for instance.</para>
1349
1350             <para>If there are services for which you want to use AFS
1351             authentication, but for which the <emphasis
1352             role="bold">pam.conf</emphasis> file does not already include a
1353             standard entry, you must create that entry and place the
1354             value <computeroutput>optional</computeroutput> in its third field.
1355             For instance, the Solaris
1356             <emphasis role="bold">pam.conf</emphasis> file does not usually
1357             include standard entries for the
1358             <emphasis role="bold">ftp</emphasis> or
1359             <emphasis role="bold">telnet</emphasis> services.</para>
1360
1361             <para>Then create an AFS-related entry for each service, placing it
1362             immediately below the standard entry. The following
1363             example shows what the
1364             <computeroutput>Authentication Management</computeroutput>
1365             section looks like after you have you edited or created entries
1366             for the services mentioned previously. Note that the example AFS
1367             entries appear on two lines
1368             only for legibility.</para>
1369
1370 <programlisting>
1371    login   auth  optional  /usr/lib/security/pam_unix.so.1
1372    login   auth  optional  /usr/lib/security/pam_afs.so       \
1373          try_first_pass  ignore_root  setenv_password_expires
1374    rlogin  auth  optional  /usr/lib/security/pam_unix.so.1
1375    rlogin  auth  optional  /usr/lib/security/pam_afs.so       \
1376          try_first_pass  ignore_root  setenv_password_expires
1377    rsh     auth  optional  /usr/lib/security/pam_unix.so.1
1378    rsh     auth  optional  /usr/lib/security/pam_afs.so       \
1379          try_first_pass  ignore_root
1380    ftp     auth  optional  /usr/lib/security/pam_unix.so.1
1381    ftp     auth  optional  /usr/lib/security/pam_afs.so       \
1382          try_first_pass  ignore_root
1383    telnet  auth  optional  /usr/lib/security/pam_unix.so.1
1384    telnet  auth  optional  /usr/lib/security/pam_afs.so       \
1385          try_first_pass  ignore_root  setenv_password_expires
1386 </programlisting>
1387           </listitem>
1388
1389           <listitem>
1390             <para>If you use the Common Desktop Environment (CDE) on the
1391             machine and want users to obtain an AFS token as they log
1392             in, also add or edit the following four entries in the
1393             <computeroutput>Authentication management</computeroutput>
1394             section. Note that the AFS-related entries appear on two lines
1395             here only for legibility.
1396 <programlisting>
1397    dtlogin   auth  optional  /usr/lib/security/pam_unix.so.1
1398    dtlogin   auth  optional  /usr/lib/security/pam_afs.so     \
1399          try_first_pass  ignore_root
1400    dtsession  auth  optional /usr/lib/security/pam_unix.so.1
1401    dtsession  auth  optional /usr/lib/security/pam_afs.so     \
1402          try_first_pass  ignore_root
1403 </programlisting>
1404             </para>
1405           </listitem>
1406           <listitem>
1407             <para>Proceed to
1408             <link linkend="HDRWQ49a">Editing the File Systems Clean-up Script
1409             on Solaris Systems in the server instructions </link> if you are
1410             installing your first file server;
1411             <link linkend="HDRWQ108">Starting Server Programs</link> if you
1412             are installing an additional file server machine; or
1413             <link linkend="Header_137a">Editing the File Systems Clean-up Script
1414             on Solaris Systems in the client instructions</link> if you are
1415             installing a client.</para>
1416           </listitem>
1417         </orderedlist>
1418       </para>
1419     </sect2>
1420   </sect1>
1421 </appendix>