xref: /freebsd/contrib/openpam/doc/man/openpam_get_feature.3 (revision 7d8f797b725e3efc0a4256554654780df83c456c)
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 12, 2014
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
19This function is experimental and may be modified or removed in a future release without prior warning.
20.Ef
21.Pp
22The
23.Fn openpam_get_feature
24function stores the current state of the
25specified feature in the variable pointed to by its
26.Fa onoff
27argument.
28.Pp
29The following features are recognized:
30.Bl -tag -width 18n
31.It Dv OPENPAM_RESTRICT_SERVICE_NAME
32Disallow path separators in service names.
33This feature is enabled by default.
34Disabling it allows the application to specify the path to
35the desired policy file directly.
36.It Dv OPENPAM_VERIFY_POLICY_FILE
37Verify the ownership and permissions of the policy file
38and the path leading up to it.
39This feature is enabled by default.
40.It Dv OPENPAM_RESTRICT_MODULE_NAME
41Disallow path separators in module names.
42This feature is disabled by default.
43Enabling it prevents the use of modules in non-standard
44locations.
45.It Dv OPENPAM_VERIFY_MODULE_FILE
46Verify the ownership and permissions of each loadable
47module and the path leading up to it.
48This feature is enabled by default.
49.El
50.Sh RETURN VALUES
51The
52.Fn openpam_get_feature
53function returns one of the following values:
54.Bl -tag -width 18n
55.It Bq Er PAM_SYMBOL_ERR
56Invalid 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
63The
64.Fn openpam_get_feature
65function is an OpenPAM extension.
66.Sh AUTHORS
67The
68.Fn openpam_get_feature
69function and this manual page were
70developed by
71.An Dag-Erling Sm\(/orgrav Aq des@des.no .
72