xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_authenticate.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: pam_authenticate.c,v 1.3 2017/05/06 19:50:09 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
5  * Copyright (c) 2004-2017 Dag-Erling Smørgrav
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by ThinkSec AS and
9  * Network Associates Laboratories, the Security Research Division of
10  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11  * ("CBOSS"), as part of the DARPA CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * $OpenPAM: pam_authenticate.c 938 2017-04-30 21:34:42Z des $
38  */
39 
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43 
44 #include <sys/cdefs.h>
45 __RCSID("$NetBSD: pam_authenticate.c,v 1.3 2017/05/06 19:50:09 christos Exp $");
46 
47 #include <sys/param.h>
48 
49 #include <security/pam_appl.h>
50 
51 #include "openpam_impl.h"
52 
53 /*
54  * XSSO 4.2.1
55  * XSSO 6 page 34
56  *
57  * Perform authentication within the PAM framework
58  */
59 
60 int
61 pam_authenticate(pam_handle_t *pamh,
62 	int flags)
63 {
64 	int r;
65 
66 	ENTER();
67 	if (flags & ~(PAM_SILENT|PAM_DISALLOW_NULL_AUTHTOK))
68 		RETURNC(PAM_BAD_CONSTANT);
69 	r = openpam_dispatch(pamh, PAM_SM_AUTHENTICATE, flags);
70 	pam_set_item(pamh, PAM_AUTHTOK, NULL);
71 	RETURNC(r);
72 }
73 
74 /*
75  * Error codes:
76  *
77  *	=openpam_dispatch
78  *	=pam_sm_authenticate
79  *	!PAM_IGNORE
80  *	PAM_BAD_CONSTANT
81  */
82 
83 /**
84  * The =pam_authenticate function attempts to authenticate the user
85  * associated with the pam context specified by the =pamh argument.
86  *
87  * The application is free to call =pam_authenticate as many times as it
88  * wishes, but some modules may maintain an internal retry counter and
89  * return =PAM_MAXTRIES when it exceeds some preset or hardcoded limit.
90  *
91  * The =flags argument is the binary or of zero or more of the following
92  * values:
93  *
94  *	=PAM_SILENT:
95  *		Do not emit any messages.
96  *	=PAM_DISALLOW_NULL_AUTHTOK:
97  *		Fail if the user's authentication token is null.
98  *
99  * If any other bits are set, =pam_authenticate will return
100  * =PAM_BAD_CONSTANT.
101  */
102