doc/man/openpam_get_feature.3

   1 .\" Generated from openpam_get_feature.c by gendoc.pl
   2 .\" $OpenPAM: openpam_get_feature.c 938 2017-04-30 21:34:42Z des $
   3 .Dd April 30, 2017
   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 SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .In security/openpam.h
  13 .Ft "int"
  14 .Fn openpam_get_feature "int feature" "int *onoff"
  15 .Sh DESCRIPTION
  16 .Bf Sy
  17 This function is experimental and may be modified or removed in a future release without prior warning.
  18 .Ef
  19 .Pp
  20 The
  21 .Fn openpam_get_feature
  22 function stores the current state of the
  23 specified feature in the variable pointed to by its
  24 .Fa onoff
  25 argument.
  26 .Pp
  27 The following features are recognized:
  28 .Bl -tag -width 18n
  29 .It Dv OPENPAM_RESTRICT_SERVICE_NAME
  30 Disallow path separators in service names.
  31 This feature is enabled by default.
  32 Disabling it allows the application to specify the path to
  33 the desired policy file directly.
  34 .It Dv OPENPAM_VERIFY_POLICY_FILE
  35 Verify the ownership and permissions of the policy file
  36 and the path leading up to it.
  37 This feature is enabled by default.
  38 .It Dv OPENPAM_RESTRICT_MODULE_NAME
  39 Disallow path separators in module names.
  40 This feature is disabled by default.
  41 Enabling it prevents the use of modules in non-standard
  42 locations.
  43 .It Dv OPENPAM_VERIFY_MODULE_FILE
  44 Verify the ownership and permissions of each loadable
  45 module and the path leading up to it.
  46 This feature is enabled by default.
  47 .El
  48 .Sh RETURN VALUES
  49 The
  50 .Fn openpam_get_feature
  51 function returns one of the following values:
  52 .Bl -tag -width 18n
  53 .It Bq Er PAM_SUCCESS
  54 Success.
  55 .It Bq Er PAM_BAD_FEATURE
  56 Unrecognized or restricted feature.
  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 Mt des@des.no .