1 /* $NetBSD: pam_authenticate.c,v 1.4 2023/06/30 21:46:21 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
38 #ifdef HAVE_CONFIG_H
39 # include "config.h"
40 #endif
41
42 #include <sys/cdefs.h>
43 __RCSID("$NetBSD: pam_authenticate.c,v 1.4 2023/06/30 21:46:21 christos Exp $");
44
45 #include <sys/param.h>
46
47 #include <security/pam_appl.h>
48
49 #include "openpam_impl.h"
50
51 /*
52 * XSSO 4.2.1
53 * XSSO 6 page 34
54 *
55 * Perform authentication within the PAM framework
56 */
57
58 int
pam_authenticate(pam_handle_t * pamh,int flags)59 pam_authenticate(pam_handle_t *pamh,
60 int flags)
61 {
62 int r;
63
64 ENTER();
65 if (flags & ~(PAM_SILENT|PAM_DISALLOW_NULL_AUTHTOK))
66 RETURNC(PAM_BAD_CONSTANT);
67 r = openpam_dispatch(pamh, PAM_SM_AUTHENTICATE, flags);
68 pam_set_item(pamh, PAM_AUTHTOK, NULL);
69 RETURNC(r);
70 }
71
72 /*
73 * Error codes:
74 *
75 * =openpam_dispatch
76 * =pam_sm_authenticate
77 * !PAM_IGNORE
78 * PAM_BAD_CONSTANT
79 */
80
81 /**
82 * The =pam_authenticate function attempts to authenticate the user
83 * associated with the pam context specified by the =pamh argument.
84 *
85 * The application is free to call =pam_authenticate as many times as it
86 * wishes, but some modules may maintain an internal retry counter and
87 * return =PAM_MAXTRIES when it exceeds some preset or hardcoded limit.
88 *
89 * The =flags argument is the binary or of zero or more of the following
90 * values:
91 *
92 * =PAM_SILENT:
93 * Do not emit any messages.
94 * =PAM_DISALLOW_NULL_AUTHTOK:
95 * Fail if the user's authentication token is null.
96 *
97 * If any other bits are set, =pam_authenticate will return
98 * =PAM_BAD_CONSTANT.
99 */
100