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

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

Plug memory leak, reduce differences between these very similar
functions, and {add,tweak} documentation.

Sponsored by: DARPA, NAI Labs

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