source: openpam/trunk/lib/pam_authenticate.c @ 157

Last change on this file since 157 was 157, checked in by des, 12 years ago

DBA update and minor whitespace fixes.

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