contrib/openpam/doc/man/openpam_get_feature.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4 .\" All rights reserved.
   5 .\"
   6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   7 .\" Network Associates Laboratories, the Security Research Division of
   8 .\" Network 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 .\" $Id$
  36 .\"
  37 .Dd May 26, 2012
  38 .Dt OPENPAM_GET_FEATURE 3
  39 .Os
  40 .Sh NAME
  41 .Nm openpam_get_feature
  42 .Nd query the state of an optional feature
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .In security/openpam.h
  49 .Ft "int"
  50 .Fn openpam_get_feature "int feature" "int *onoff"
  51 .Sh DESCRIPTION
  52 .Bf Sy
  53 This function is experimental and may be modified or removed in a future release without further warning.
  54 .Ef
  55 .Pp
  56 The
  57 .Fn openpam_get_feature
  58 function stores the current state of the
  59 specified feature in the variable pointed to by its
  60 .Fa onoff
  61 argument.
  62 .Pp
  63 The following features are recognized:
  64 .Bl -tag -width 18n
  65 .It Dv OPENPAM_RESTRICT_SERVICE_NAME
  66 Disallow path separators in service names.
  67 This feature is enabled by default.
  68 Disabling it allows the application to specify the path to
  69 the desired policy file directly.
  70 .It Dv OPENPAM_VERIFY_POLICY_FILE
  71 Verify the ownership and permissions of the policy file
  72 and the path leading up to it.
  73 This feature is enabled by default.
  74 .It Dv OPENPAM_RESTRICT_MODULE_NAME
  75 Disallow path separators in module names.
  76 This feature is disabled by default.
  77 Enabling it prevents the use of modules in non-standard
  78 locations.
  79 .It Dv OPENPAM_VERIFY_MODULE_FILE
  80 Verify the ownership and permissions of each loadable
  81 module and the path leading up to it.
  82 This feature is enabled by default.
  83 .El
  84 .Sh RETURN VALUES
  85 The
  86 .Fn openpam_get_feature
  87 function returns one of the following values:
  88 .Bl -tag -width 18n
  89 .It Bq Er PAM_SYMBOL_ERR
  90 Invalid symbol.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr openpam_set_feature 3 ,
  94 .Xr pam 3 ,
  95 .Xr pam_strerror 3
  96 .Sh STANDARDS
  97 The
  98 .Fn openpam_get_feature
  99 function is an OpenPAM extension.
 100 .Sh AUTHORS
 101 The
 102 .Fn openpam_get_feature
 103 function and this manual page were
 104 developed by
 105 .An Dag-Erling Sm\(/orgrav Aq des@des.no .