lib/pam_module/pam_opie/pam_opie.8

   1 .\" Copyright (c) 2001 Mark R V Murray
   2 .\" All rights reserved.
   3 .\" Copyright (c) 2002 Networks Associates Technology, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Portions of this software were developed for the FreeBSD Project by
   7 .\" ThinkSec AS and NAI Labs, the Security Research Division of Network
   8 .\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The name of the author may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $FreeBSD: src/lib/libpam/modules/pam_opie/pam_opie.8,v 1.9 2002/12/27 12:15:31 schweikh Exp $
  36 .\" $DragonFly: src/lib/pam_module/pam_opie/pam_opie.8,v 1.1 2005/07/12 22:53:20 joerg Exp $
  37 .\"
  38 .Dd July 7, 2001
  39 .Dt PAM_OPIE 8
  40 .Os
  41 .Sh NAME
  42 .Nm pam_opie
  43 .Nd OPIE PAM module
  44 .Sh SYNOPSIS
  45 .Op Ar service-name
  46 .Ar module-type
  47 .Ar control-flag
  48 .Pa pam_opie
  49 .Op Ar options
  50 .Sh DESCRIPTION
  51 The OPIE authentication service module for PAM,
  52 .Nm
  53 provides functionality for only one PAM category:
  54 that of authentication.
  55 In terms of the
  56 .Ar module-type
  57 parameter, this is the
  58 .Dq Li auth
  59 feature.
  60 It also provides a null function for session management.
  61 .Pp
  62 Note that this module does not enforce
  63 .Xr opieaccess 5
  64 checks.
  65 There is a separate module,
  66 .Xr pam_opieaccess 8 ,
  67 for this purpose.
  68 .Ss OPIE Authentication Module
  69 The OPIE authentication component
  70 provides functions to verify the identity of a user
  71 .Pq Fn pam_sm_authenticate ,
  72 which obtains the relevant
  73 .Xr opie 4
  74 credentials.
  75 It provides the user with an OPIE challenge,
  76 and verifies that this is correct with
  77 .Xr opiechallenge 3 .
  78 .Pp
  79 The following options may be passed to the authentication module:
  80 .Bl -tag -width ".Cm auth_as_self"
  81 .It Cm debug
  82 .Xr syslog 3
  83 debugging information at
  84 .Dv LOG_DEBUG
  85 level.
  86 .It Cm auth_as_self
  87 This option will require the user
  88 to authenticate himself as the user
  89 given by
  90 .Xr getlogin 2 ,
  91 not as the account they are attempting to access.
  92 This is primarily for services like
  93 .Xr su 1 ,
  94 where the user's ability to retype
  95 their own password
  96 might be deemed sufficient.
  97 .It Cm no_fake_prompts
  98 Do not generate fake challenges for users who do not have an OPIE key.
  99 Note that this can leak information to a hypothetical attacker about
 100 who uses OPIE and who does not, but it can be useful on systems where
 101 some users want to use OPIE but most do not.
 102 .El
 103 .Pp
 104 Note that
 105 .Nm
 106 ignores the standard options
 107 .Cm try_first_pass
 108 and
 109 .Cm use_first_pass ,
 110 since a challenge must be generated before the user can submit a valid
 111 response.
 112 .Sh FILES
 113 .Bl -tag -width ".Pa /etc/opiekeys" -compact
 114 .It Pa /etc/opiekeys
 115 default OPIE password database.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr passwd 1 ,
 119 .Xr getlogin 2 ,
 120 .Xr opiechallenge 3 ,
 121 .Xr syslog 3 ,
 122 .Xr opie 4 ,
 123 .Xr pam.conf 5 ,
 124 .Xr pam 8