contrib/openpam/doc/man/openpam_get_feature.3

   1 .\" Generated from openpam_get_feature.c by gendoc.pl
   2 .\" $Id: openpam_get_feature.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt OPENPAM_GET_FEATURE 3
   5 .Os
   6 .Sh NAME
   7 .Nm openpam_get_feature
   8 .Nd query the state of an optional feature
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .In security/openpam.h
  15 .Ft "int"
  16 .Fn openpam_get_feature "int feature" "int *onoff"
  17 .Sh DESCRIPTION
  18 .Bf Sy
  19 This function is experimental and may be modified or removed in a future release without prior warning.
  20 .Ef
  21 .Pp
  22 The
  23 .Fn openpam_get_feature
  24 function stores the current state of the
  25 specified feature in the variable pointed to by its
  26 .Fa onoff
  27 argument.
  28 .Pp
  29 The following features are recognized:
  30 .Bl -tag -width 18n
  31 .It Dv OPENPAM_RESTRICT_SERVICE_NAME
  32 Disallow path separators in service names.
  33 This feature is enabled by default.
  34 Disabling it allows the application to specify the path to
  35 the desired policy file directly.
  36 .It Dv OPENPAM_VERIFY_POLICY_FILE
  37 Verify the ownership and permissions of the policy file
  38 and the path leading up to it.
  39 This feature is enabled by default.
  40 .It Dv OPENPAM_RESTRICT_MODULE_NAME
  41 Disallow path separators in module names.
  42 This feature is disabled by default.
  43 Enabling it prevents the use of modules in non-standard
  44 locations.
  45 .It Dv OPENPAM_VERIFY_MODULE_FILE
  46 Verify the ownership and permissions of each loadable
  47 module and the path leading up to it.
  48 This feature is enabled by default.
  49 .El
  50 .Sh RETURN VALUES
  51 The
  52 .Fn openpam_get_feature
  53 function returns one of the following values:
  54 .Bl -tag -width 18n
  55 .It Bq Er PAM_SYMBOL_ERR
  56 Invalid symbol.
  57 .El
  58 .Sh SEE ALSO
  59 .Xr openpam_set_feature 3 ,
  60 .Xr pam 3 ,
  61 .Xr pam_strerror 3
  62 .Sh STANDARDS
  63 The
  64 .Fn openpam_get_feature
  65 function is an OpenPAM extension.
  66 .Sh AUTHORS
  67 The
  68 .Fn openpam_get_feature
  69 function and this manual page were
  70 developed by
  71 .An Dag-Erling Sm\(/orgrav Aq des@des.no .