source: openpam/trunk/lib/pam_get_authtok.c @ 100

Last change on this file since 100 was 100, checked in by Dag-Erling Smørgrav, 19 years ago

Change pam_get_authtok()'s prototype so the caller can specify
what token it wants. Also introduce PAM_OLDAUTHTOK_PROMPT.

Sponsored by: DARPA, NAI Labs

File size: 4.2 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 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * 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_get_authtok.c#13 $
35 */
36
37#include <sys/param.h>
38
39#include <security/pam_appl.h>
40#include <security/openpam.h>
41
42#include "openpam_impl.h"
43
44const char authtok_prompt[] = "Password:";
45const char oldauthtok_prompt[] = "Old Password:";
46
47/*
48 * OpenPAM extension
49 *
50 * Retrieve authentication token
51 */
52
53int
54pam_get_authtok(pam_handle_t *pamh,
55        int item,
56        const char **authtok,
57        const char *prompt)
58{
59        const char *default_prompt;
60        char *resp;
61        int pitem, r, style;
62
63        if (pamh == NULL || authtok == NULL)
64                return (PAM_SYSTEM_ERR);
65
66        *authtok = NULL;
67        switch (item) {
68        case PAM_AUTHTOK:
69                pitem = PAM_AUTHTOK_PROMPT;
70                default_prompt = authtok_prompt;
71                break;
72        case PAM_OLDAUTHTOK:
73                pitem = PAM_OLDAUTHTOK_PROMPT;
74                default_prompt = oldauthtok_prompt;
75                break;
76        default:
77                return (PAM_SYMBOL_ERR);
78        }
79
80        if (openpam_get_option(pamh, "try_first_pass") ||
81            openpam_get_option(pamh, "use_first_pass")) {
82                r = pam_get_item(pamh, item, (const void **)authtok);
83                if (r == PAM_SUCCESS && *authtok != NULL)
84                        return (PAM_SUCCESS);
85                else if (openpam_get_option(pamh, "use_first_pass"))
86                        return (r == PAM_SUCCESS ? PAM_AUTH_ERR : r);
87        }
88        if (prompt == NULL) {
89                r = pam_get_item(pamh, pitem, (const void **)&prompt);
90                if (r != PAM_SUCCESS || prompt == NULL)
91                        prompt = default_prompt;
92        }
93        style = openpam_get_option(pamh, "echo_pass") ?
94            PAM_PROMPT_ECHO_ON : PAM_PROMPT_ECHO_OFF;
95        r = pam_prompt(pamh, style, &resp, "%s", prompt);
96        if (r != PAM_SUCCESS)
97                return (r);
98        *authtok = resp;
99        return (pam_set_item(pamh, item, *authtok));
100}
101
102/*
103 * Error codes:
104 *
105 *      =pam_get_item
106 *      =pam_prompt
107 *      =pam_set_item
108 *      !PAM_SYMBOL_ERR
109 */
110
111/**
112 * The =pam_get_authtok function returns the cached authentication token,
113 * or prompts the user if no token is currently cached.  Either way, a
114 * pointer to the authentication token is stored in the location pointed
115 * to by the =authtok argument.
116 *
117 * The =item argument must have one of the following values:
118 *
119 *      =PAM_AUTHTOK
120 *              Returns the current authentication token, or the new token
121 *              when changing authentication tokens.
122 *      =PAM_OLDAUTHTOK
123 *              Returns the previous authentication token when changing
124 *              authentication tokens.
125 *
126 * The =prompt argument specifies a prompt to use if no token is cached.
127 * If =NULL, the =PAM_AUTHTOK_PROMPT or =PAM_OLDAUTHTOK_PROMPT item, as
128 * appropriate, will be used.  If that item is also =NULL, a hardcoded
129 * default prompt will be used.
130 *
131 * >pam_get_item
132 */
Note: See TracBrowser for help on using the repository browser.