lib/libpam/modules/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$
  36 .\"
  37 .Dd September 15, 2022
  38 .Dt PAM_OPIE 8
  39 .Os
  40 .Sh NAME
  41 .Nm pam_opie
  42 .Nd OPIE PAM module
  43 .Sh SYNOPSIS
  44 .Op Ar service-name
  45 .Ar module-type
  46 .Ar control-flag
  47 .Pa pam_opie
  48 .Op Ar options
  49 .Sh DEPRECATION NOTICE
  50 OPIE is deprecated, and may not be available in
  51 .Fx 14.0
  52 and later.
  53 .Sh DESCRIPTION
  54 The OPIE authentication service module for PAM,
  55 .Nm
  56 provides functionality for only one PAM category:
  57 that of authentication.
  58 In terms of the
  59 .Ar module-type
  60 parameter, this is the
  61 .Dq Li auth
  62 feature.
  63 It also provides a null function for session management.
  64 .Pp
  65 Note that this module does not enforce
  66 .Xr opieaccess 5
  67 checks.
  68 There is a separate module,
  69 .Xr pam_opieaccess 8 ,
  70 for this purpose.
  71 .Ss OPIE Authentication Module
  72 The OPIE authentication component
  73 provides functions to verify the identity of a user
  74 .Pq Fn pam_sm_authenticate ,
  75 which obtains the relevant
  76 .Xr opie 4
  77 credentials.
  78 It provides the user with an OPIE challenge,
  79 and verifies that this is correct with
  80 .Xr opiechallenge 3 .
  81 .Pp
  82 The following options may be passed to the authentication module:
  83 .Bl -tag -width ".Cm auth_as_self"
  84 .It Cm debug
  85 .Xr syslog 3
  86 debugging information at
  87 .Dv LOG_DEBUG
  88 level.
  89 .It Cm auth_as_self
  90 This option will require the user
  91 to authenticate himself as the user
  92 given by
  93 .Xr getlogin 2 ,
  94 not as the account they are attempting to access.
  95 This is primarily for services like
  96 .Xr su 1 ,
  97 where the user's ability to retype
  98 their own password
  99 might be deemed sufficient.
 100 .It Cm no_fake_prompts
 101 Do not generate fake challenges for users who do not have an OPIE key.
 102 Note that this can leak information to a hypothetical attacker about
 103 who uses OPIE and who does not, but it can be useful on systems where
 104 some users want to use OPIE but most do not.
 105 .El
 106 .Pp
 107 Note that
 108 .Nm
 109 ignores the standard options
 110 .Cm try_first_pass
 111 and
 112 .Cm use_first_pass ,
 113 since a challenge must be generated before the user can submit a valid
 114 response.
 115 .Sh FILES
 116 .Bl -tag -width ".Pa /etc/opiekeys" -compact
 117 .It Pa /etc/opiekeys
 118 default OPIE password database.
 119 .El
 120 .Sh SEE ALSO
 121 .Xr passwd 1 ,
 122 .Xr getlogin 2 ,
 123 .Xr opiechallenge 3 ,
 124 .Xr syslog 3 ,
 125 .Xr opie 4 ,
 126 .Xr pam.conf 5 ,
 127 .Xr pam 3