Deleted Added
full compact
pam_get_authtok.c (302408) pam_get_authtok.c (91094)
1/*-
1/*-
2 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3 * Copyright (c) 2004-2011 Dag-Erling Sm��rgrav
2 * Copyright (c) 2002 Networks Associates Technologies, Inc.
4 * All rights reserved.
5 *
6 * This software was developed for the FreeBSD Project by ThinkSec AS and
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
7 * Network Associates Laboratories, the Security Research Division of
8 * Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9 * ("CBOSS"), as part of the DARPA CHATS research program.
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.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the

--- 9 unchanged lines hidden (view full) ---

27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
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

--- 9 unchanged lines hidden (view full) ---

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 *
35 * $Id: pam_get_authtok.c 807 2014-09-09 09:41:32Z des $
34 * $Id$
36 */
37
35 */
36
38#ifdef HAVE_CONFIG_H
39# include "config.h"
40#endif
41
42#include <sys/param.h>
43
37#include <sys/param.h>
38
44#include <stdlib.h>
45#include <string.h>
46
47#include <security/pam_appl.h>
48#include <security/openpam.h>
49
50#include "openpam_impl.h"
39#include <security/pam_appl.h>
40#include <security/openpam.h>
41
42#include "openpam_impl.h"
51#include "openpam_strlset.h"
52
43
53static const char authtok_prompt[] = "Password:";
54static const char authtok_prompt_remote[] = "Password for %u@%h:";
55static const char oldauthtok_prompt[] = "Old Password:";
56static const char newauthtok_prompt[] = "New Password:";
57
58/*
59 * OpenPAM extension
60 *
61 * Retrieve authentication token
62 */
63
64int
65pam_get_authtok(pam_handle_t *pamh,
44/*
45 * OpenPAM extension
46 *
47 * Retrieve authentication token
48 */
49
50int
51pam_get_authtok(pam_handle_t *pamh,
66 int item,
67 const char **authtok,
68 const char *prompt)
69{
52 const char **authtok,
53 const char *prompt)
54{
70 char prompt_buf[1024];
71 size_t prompt_size;
72 const void *oldauthtok, *prevauthtok, *promptp;
73 const char *prompt_option, *default_prompt;
74 const void *lhost, *rhost;
75 char *resp, *resp2;
76 int pitem, r, style, twice;
55 char *p, *resp;
56 int r;
77
57
78 ENTER();
79 if (pamh == NULL || authtok == NULL)
58 if (pamh == NULL || authtok == NULL)
80 RETURNC(PAM_SYSTEM_ERR);
81 *authtok = NULL;
82 twice = 0;
83 switch (item) {
84 case PAM_AUTHTOK:
85 pitem = PAM_AUTHTOK_PROMPT;
86 prompt_option = "authtok_prompt";
87 default_prompt = authtok_prompt;
88 r = pam_get_item(pamh, PAM_RHOST, &rhost);
89 if (r == PAM_SUCCESS && rhost != NULL) {
90 r = pam_get_item(pamh, PAM_HOST, &lhost);
91 if (r == PAM_SUCCESS && lhost != NULL) {
92 if (strcmp(rhost, lhost) != 0)
93 default_prompt = authtok_prompt_remote;
94 }
95 }
96 r = pam_get_item(pamh, PAM_OLDAUTHTOK, &oldauthtok);
97 if (r == PAM_SUCCESS && oldauthtok != NULL) {
98 default_prompt = newauthtok_prompt;
99 twice = 1;
100 }
101 break;
102 case PAM_OLDAUTHTOK:
103 pitem = PAM_OLDAUTHTOK_PROMPT;
104 prompt_option = "oldauthtok_prompt";
105 default_prompt = oldauthtok_prompt;
106 twice = 0;
107 break;
108 default:
109 RETURNC(PAM_SYMBOL_ERR);
59 return (PAM_SYSTEM_ERR);
60
61 r = pam_get_item(pamh, PAM_AUTHTOK, (const void **)authtok);
62 if (r == PAM_SUCCESS)
63 return (PAM_SUCCESS);
64 if (prompt == NULL) {
65 if (pam_get_item(pamh, PAM_AUTHTOK_PROMPT,
66 (const void **)&p) != PAM_SUCCESS || p == NULL)
67 prompt = "Password:";
110 }
68 }
111 if (openpam_get_option(pamh, "try_first_pass") ||
112 openpam_get_option(pamh, "use_first_pass")) {
113 r = pam_get_item(pamh, item, &prevauthtok);
114 if (r == PAM_SUCCESS && prevauthtok != NULL) {
115 *authtok = prevauthtok;
116 RETURNC(PAM_SUCCESS);
117 } else if (openpam_get_option(pamh, "use_first_pass")) {
118 RETURNC(r == PAM_SUCCESS ? PAM_AUTH_ERR : r);
119 }
120 }
121 /* pam policy overrides the module's choice */
122 if ((promptp = openpam_get_option(pamh, prompt_option)) != NULL)
123 prompt = promptp;
124 /* no prompt provided, see if there is one tucked away somewhere */
125 if (prompt == NULL)
126 if (pam_get_item(pamh, pitem, &promptp) && promptp != NULL)
127 prompt = promptp;
128 /* fall back to hardcoded default */
129 if (prompt == NULL)
130 prompt = default_prompt;
131 /* expand */
132 prompt_size = sizeof prompt_buf;
133 r = openpam_subst(pamh, prompt_buf, &prompt_size, prompt);
134 if (r == PAM_SUCCESS && prompt_size <= sizeof prompt_buf)
135 prompt = prompt_buf;
136 style = openpam_get_option(pamh, "echo_pass") ?
137 PAM_PROMPT_ECHO_ON : PAM_PROMPT_ECHO_OFF;
138 r = pam_prompt(pamh, style, &resp, "%s", prompt);
69 r = pam_prompt(pamh, PAM_PROMPT_ECHO_OFF, &resp,
70 "%s", prompt ? prompt : p);
139 if (r != PAM_SUCCESS)
71 if (r != PAM_SUCCESS)
140 RETURNC(r);
141 if (twice) {
142 r = pam_prompt(pamh, style, &resp2, "Retype %s", prompt);
143 if (r != PAM_SUCCESS) {
144 strlset(resp, 0, PAM_MAX_RESP_SIZE);
145 FREE(resp);
146 RETURNC(r);
147 }
148 if (strcmp(resp, resp2) != 0) {
149 strlset(resp, 0, PAM_MAX_RESP_SIZE);
150 FREE(resp);
151 }
152 strlset(resp2, 0, PAM_MAX_RESP_SIZE);
153 FREE(resp2);
154 }
155 if (resp == NULL)
156 RETURNC(PAM_TRY_AGAIN);
157 r = pam_set_item(pamh, item, resp);
158 strlset(resp, 0, PAM_MAX_RESP_SIZE);
159 FREE(resp);
160 if (r != PAM_SUCCESS)
161 RETURNC(r);
162 r = pam_get_item(pamh, item, (const void **)authtok);
163 RETURNC(r);
72 return (r);
73 *authtok = resp;
74 return (pam_set_item(pamh, PAM_AUTHTOK, *authtok));
164}
75}
165
166/*
167 * Error codes:
168 *
169 * =pam_get_item
170 * =pam_prompt
171 * =pam_set_item
172 * !PAM_SYMBOL_ERR
173 * PAM_TRY_AGAIN
174 */
175
176/**
177 * The =pam_get_authtok function either prompts the user for an
178 * authentication token or retrieves a cached authentication token,
179 * depending on circumstances.
180 * Either way, a pointer to the authentication token is stored in the
181 * location pointed to by the =authtok argument, and the corresponding PAM
182 * item is updated.
183 *
184 * The =item argument must have one of the following values:
185 *
186 * =PAM_AUTHTOK:
187 * Returns the current authentication token, or the new token
188 * when changing authentication tokens.
189 * =PAM_OLDAUTHTOK:
190 * Returns the previous authentication token when changing
191 * authentication tokens.
192 *
193 * The =prompt argument specifies a prompt to use if no token is cached.
194 * If it is =NULL, the =PAM_AUTHTOK_PROMPT or =PAM_OLDAUTHTOK_PROMPT item,
195 * as appropriate, will be used.
196 * If that item is also =NULL, a hardcoded default prompt will be used.
197 * Additionally, when =pam_get_authtok is called from a service module,
198 * the prompt may be affected by module options as described below.
199 * The prompt is then expanded using =openpam_subst before it is passed to
200 * the conversation function.
201 *
202 * If =item is set to =PAM_AUTHTOK and there is a non-null =PAM_OLDAUTHTOK
203 * item, =pam_get_authtok will ask the user to confirm the new token by
204 * retyping it.
205 * If there is a mismatch, =pam_get_authtok will return =PAM_TRY_AGAIN.
206 *
207 * MODULE OPTIONS
208 *
209 * When called by a service module, =pam_get_authtok will recognize the
210 * following module options:
211 *
212 * ;authtok_prompt:
213 * Prompt to use when =item is set to =PAM_AUTHTOK.
214 * This option overrides both the =prompt argument and the
215 * =PAM_AUTHTOK_PROMPT item.
216 * ;echo_pass:
217 * If the application's conversation function allows it, this
218 * lets the user see what they are typing.
219 * This should only be used for non-reusable authentication
220 * tokens.
221 * ;oldauthtok_prompt:
222 * Prompt to use when =item is set to =PAM_OLDAUTHTOK.
223 * This option overrides both the =prompt argument and the
224 * =PAM_OLDAUTHTOK_PROMPT item.
225 * ;try_first_pass:
226 * If the requested item is non-null, return it without
227 * prompting the user.
228 * Typically, the service module will verify the token, and
229 * if it does not match, clear the item before calling
230 * =pam_get_authtok a second time.
231 * ;use_first_pass:
232 * Do not prompt the user at all; just return the cached
233 * value, or =PAM_AUTH_ERR if there is none.
234 *
235 * >pam_conv
236 * >pam_get_item
237 * >pam_get_user
238 * >openpam_get_option
239 * >openpam_subst
240 */