1/*	$NetBSD: pam_authenticate.c,v 1.2 2011/12/25 22:27:55 christos Exp $	*/
2
3/*-
4 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
5 * Copyright (c) 2004-2011 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 * Id: pam_authenticate.c 437 2011-09-13 12:00:13Z des
38 */
39
40#ifdef HAVE_CONFIG_H
41# include "config.h"
42#endif
43
44#include <sys/param.h>
45
46#include <security/pam_appl.h>
47
48#include "openpam_impl.h"
49
50/*
51 * XSSO 4.2.1
52 * XSSO 6 page 34
53 *
54 * Perform authentication within the PAM framework
55 */
56
57int
58pam_authenticate(pam_handle_t *pamh,
59	int flags)
60{
61	int r;
62
63	ENTER();
64	if (flags & ~(PAM_SILENT|PAM_DISALLOW_NULL_AUTHTOK))
65		RETURNC(PAM_SYMBOL_ERR);
66	r = openpam_dispatch(pamh, PAM_SM_AUTHENTICATE, flags);
67	pam_set_item(pamh, PAM_AUTHTOK, NULL);
68	RETURNC(r);
69	/*NOTREACHED*/
70}
71
72/*
73 * Error codes:
74 *
75 *	=openpam_dispatch
76 *	=pam_sm_authenticate
77 *	!PAM_IGNORE
78 *	PAM_SYMBOL_ERR
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_SYMBOL_ERR.
99 */
100