lib/libpam/modules/pam_opieaccess/pam_opieaccess.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 October 26, 2007
  38 .Dt PAM_OPIEACCESS 8
  39 .Os
  40 .Sh NAME
  41 .Nm pam_opieaccess
  42 .Nd OPIEAccess PAM module
  43 .Sh SYNOPSIS
  44 .Op Ar service-name
  45 .Ar module-type
  46 .Ar control-flag
  47 .Pa pam_opieaccess
  48 .Op Ar options
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 module is used in conjunction with the
  53 .Xr pam_opie 8
  54 PAM module to ascertain that authentication can proceed by other means
  55 (such as the
  56 .Xr pam_unix 8
  57 module) even if OPIE authentication failed.
  58 To properly use this module,
  59 .Xr pam_opie 8
  60 should be marked
  61 .Dq Li sufficient ,
  62 and
  63 .Nm
  64 should be listed right below it and marked
  65 .Dq Li requisite .
  66 .Pp
  67 The
  68 .Nm
  69 module provides functionality for only one PAM category:
  70 authentication.
  71 In terms of the
  72 .Ar module-type
  73 parameter, this is the
  74 .Dq Li auth
  75 feature.
  76 It also provides null functions for the remaining module types.
  77 .Ss OPIEAccess Authentication Module
  78 The authentication component
  79 .Pq Fn pam_sm_authenticate ,
  80 returns
  81 .Dv PAM_SUCCESS
  82 in two cases:
  83 .Bl -enum
  84 .It
  85 The user does not have OPIE enabled.
  86 .It
  87 The user has OPIE enabled, and the remote host is listed as a trusted
  88 host in
  89 .Pa /etc/opieaccess ,
  90 and the user does not have a file named
  91 .Pa \&.opiealways
  92 in his home directory.
  93 .El
  94 .Pp
  95 Otherwise, it returns
  96 .Dv PAM_AUTH_ERR .
  97 .Pp
  98 The following options may be passed to the authentication module:
  99 .Bl -tag -width ".Cm allow_local"
 100 .It Cm allow_local
 101 Normally, local logins are subjected to the same restrictions as
 102 remote logins from
 103 .Dq localhost .
 104 This option causes
 105 .Nm
 106 to always allow local logins.
 107 .It Cm debug
 108 .Xr syslog 3
 109 debugging information at
 110 .Dv LOG_DEBUG
 111 level.
 112 .It Cm no_warn
 113 suppress warning messages to the user.
 114 These messages include reasons why the user's authentication attempt
 115 was declined.
 116 .El
 117 .Sh FILES
 118 .Bl -tag -width ".Pa $HOME/.opiealways"
 119 .It Pa /etc/opieaccess
 120 List of trusted hosts or networks.
 121 See
 122 .Xr opieaccess 5
 123 for a description of its syntax.
 124 .It Pa $HOME/.opiealways
 125 The presence of this file makes OPIE mandatory for the user.
 126 .El
 127 .Sh SEE ALSO
 128 .Xr opie 4 ,
 129 .Xr opieaccess 5 ,
 130 .Xr pam.conf 5 ,
 131 .Xr pam 8 ,
 132 .Xr pam_opie 8
 133 .Sh AUTHORS
 134 The
 135 .Nm
 136 module and this manual page were developed for the
 137 .Fx
 138 Project by
 139 ThinkSec AS and NAI Labs, the Security Research Division of Network
 140 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
 141 .Pq Dq CBOSS ,
 142 as part of the DARPA CHATS research program.