xref: /freebsd/contrib/openpam/lib/libpam/openpam_get_feature.c (revision d4ae33f0721c1b170fe37d97e395228ffcfb3f80)
1 /*-
2  * Copyright (c) 2012 Dag-Erling Smørgrav
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote
14  *    products derived from this software without specific prior written
15  *    permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $Id: openpam_get_feature.c 648 2013-03-05 17:54:27Z des $
30  */
31 
32 #ifdef HAVE_CONFIG_H
33 # include "config.h"
34 #endif
35 
36 #include <security/pam_appl.h>
37 #include <security/openpam.h>
38 
39 #include "openpam_impl.h"
40 
41 /*
42  * OpenPAM extension
43  *
44  * Query the state of an optional feature.
45  */
46 
47 int
48 openpam_get_feature(int feature, int *onoff)
49 {
50 
51 	ENTERF(feature);
52 	if (feature < 0 || feature >= OPENPAM_NUM_FEATURES)
53 		RETURNC(PAM_SYMBOL_ERR);
54 	*onoff = openpam_features[feature].onoff;
55 	RETURNC(PAM_SUCCESS);
56 }
57 
58 /*
59  * Error codes:
60  *
61  *	PAM_SYMBOL_ERR
62  */
63 
64 /**
65  * EXPERIMENTAL
66  *
67  * The =openpam_get_feature function stores the current state of the
68  * specified feature in the variable pointed to by its =onoff argument.
69  *
70  * The following features are recognized:
71  *
72  *	=OPENPAM_RESTRICT_SERVICE_NAME:
73  *		Disallow path separators in service names.
74  *		This feature is enabled by default.
75  *		Disabling it allows the application to specify the path to
76  *		the desired policy file directly.
77  *
78  *	=OPENPAM_VERIFY_POLICY_FILE:
79  *		Verify the ownership and permissions of the policy file
80  *		and the path leading up to it.
81  *		This feature is enabled by default.
82  *
83  *	=OPENPAM_RESTRICT_MODULE_NAME:
84  *		Disallow path separators in module names.
85  *		This feature is disabled by default.
86  *		Enabling it prevents the use of modules in non-standard
87  *		locations.
88  *
89  *	=OPENPAM_VERIFY_MODULE_FILE:
90  *		Verify the ownership and permissions of each loadable
91  *		module and the path leading up to it.
92  *		This feature is enabled by default.
93  *
94  *
95  * >openpam_set_feature
96  *
97  * AUTHOR DES
98  */
99