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