contrib/libpam/doc/modules/pam_ftp.sgml

   1 <!--
   2    $Id: pam_ftp.sgml,v 1.1 1996/11/30 20:59:32 morgan Exp $
   3
   4    This file was written by Andrew G. Morgan <morgan@parc.power.net>
   5 -->
   6
   7 <sect1>Anonymous access module
   8
   9 <sect2>Synopsis
  10
  11 <p>
  12 <descrip>
  13
  14 <tag><bf>Module Name:</bf></tag>
  15 <tt/pam_ftp.so/
  16
  17 <tag><bf>Author:</bf></tag>
  18 Andrew G. Morgan &lt;morgan@parc.power.net&gt;
  19
  20 <tag><bf>Maintainer:</bf></tag>
  21 Author.
  22
  23 <tag><bf>Management groups provided:</bf></tag>
  24 authentication
  25
  26 <tag><bf>Cryptographically sensitive:</bf></tag>
  27
  28 <tag><bf>Security rating:</bf></tag>
  29
  30 <tag><bf>Clean code base:</bf></tag>
  31
  32 <tag><bf>System dependencies:</bf></tag>
  33
  34 <tag><bf>Network aware:</bf></tag>
  35 prompts for email address of user; easily spoofed (XXX - needs work)
  36
  37 </descrip>
  38
  39 <sect2>Overview of module
  40
  41 <p>
  42 The purpose of this module is to provide a pluggable anonymous ftp
  43 mode of access.
  44
  45 <sect2>Authentication component
  46
  47 <p>
  48 <descrip>
  49
  50 <tag><bf>Recognized arguments:</bf></tag>
  51 <tt/debug/;
  52 <tt/users=XXX,YYY,.../;
  53 <tt/ignore/
  54
  55 <tag><bf>Description:</bf></tag>
  56
  57 This module intercepts the user's name and password. If the name is
  58 ``<tt/ftp/'' or ``<tt/anonymous/'', the user's password is broken up
  59 at the `<tt/@/' delimiter into a <tt/PAM_RUSER/ and a <tt/PAM_RHOST/
  60 part; these pam-items being set accordingly. The username is set to
  61 ``<tt/ftp/''.  In this case the module succeeds.  Alternatively, the
  62 module sets the <tt/PAM_AUTHTOK/ item with the entered password and
  63 fails.
  64
  65 <p>
  66 The behavior of the module can be modified with the following flags:
  67 <itemize>
  68 <item><tt/debug/ -
  69 log more information to with <tt/syslog(3)/.
  70
  71 <item><tt/users=XXX,YYY,.../ -
  72 instead of ``<tt/ftp/'' or ``<tt/anonymous/'', provide anonymous login
  73 to the comma separated list of users; ``<tt/XXX,YYY,.../''. Should the
  74 applicant enter one of these usernames the returned username is set to
  75 the first in the list; ``<tt/XXX/''.
  76
  77 <item><tt/ignore/ -
  78 pay no attention to the email address of the user (if supplied).
  79
  80 </itemize>
  81
  82 <tag><bf>Examples/suggested usage:</bf></tag>
  83
  84 An example of the use of this module is provided in the configuration
  85 file section <ref id="configuration" name="above">. With care, this
  86 module could be used to provide new/temporary account anonymous
  87 login.
  88
  89 </descrip>
  90
  91 <!--
  92 End of sgml insert for this module.
  93 -->