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