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