1f7e6344dSDag-Erling Smørgrav /*-
2f7e6344dSDag-Erling Smørgrav * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3*f3b0ac34SDag-Erling Smørgrav * Copyright (c) 2004-2017 Dag-Erling Smørgrav
4f7e6344dSDag-Erling Smørgrav * All rights reserved.
5f7e6344dSDag-Erling Smørgrav *
6f7e6344dSDag-Erling Smørgrav * This software was developed for the FreeBSD Project by ThinkSec AS and
7f7e6344dSDag-Erling Smørgrav * Network Associates Laboratories, the Security Research Division of
8f7e6344dSDag-Erling Smørgrav * Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9f7e6344dSDag-Erling Smørgrav * ("CBOSS"), as part of the DARPA CHATS research program.
10f7e6344dSDag-Erling Smørgrav *
11f7e6344dSDag-Erling Smørgrav * Redistribution and use in source and binary forms, with or without
12f7e6344dSDag-Erling Smørgrav * modification, are permitted provided that the following conditions
13f7e6344dSDag-Erling Smørgrav * are met:
14f7e6344dSDag-Erling Smørgrav * 1. Redistributions of source code must retain the above copyright
15f7e6344dSDag-Erling Smørgrav * notice, this list of conditions and the following disclaimer.
16f7e6344dSDag-Erling Smørgrav * 2. Redistributions in binary form must reproduce the above copyright
17f7e6344dSDag-Erling Smørgrav * notice, this list of conditions and the following disclaimer in the
18f7e6344dSDag-Erling Smørgrav * documentation and/or other materials provided with the distribution.
19f7e6344dSDag-Erling Smørgrav * 3. The name of the author may not be used to endorse or promote
20f7e6344dSDag-Erling Smørgrav * products derived from this software without specific prior written
21f7e6344dSDag-Erling Smørgrav * permission.
22f7e6344dSDag-Erling Smørgrav *
23f7e6344dSDag-Erling Smørgrav * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24f7e6344dSDag-Erling Smørgrav * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25f7e6344dSDag-Erling Smørgrav * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26f7e6344dSDag-Erling Smørgrav * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27f7e6344dSDag-Erling Smørgrav * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28f7e6344dSDag-Erling Smørgrav * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29f7e6344dSDag-Erling Smørgrav * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30f7e6344dSDag-Erling Smørgrav * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31f7e6344dSDag-Erling Smørgrav * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32f7e6344dSDag-Erling Smørgrav * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33f7e6344dSDag-Erling Smørgrav * SUCH DAMAGE.
34f7e6344dSDag-Erling Smørgrav */
35f7e6344dSDag-Erling Smørgrav
36f7e6344dSDag-Erling Smørgrav #ifdef HAVE_CONFIG_H
37f7e6344dSDag-Erling Smørgrav # include "config.h"
38f7e6344dSDag-Erling Smørgrav #endif
39f7e6344dSDag-Erling Smørgrav
40f7e6344dSDag-Erling Smørgrav #include <sys/param.h>
41f7e6344dSDag-Erling Smørgrav
42f7e6344dSDag-Erling Smørgrav #include <stdlib.h>
43f7e6344dSDag-Erling Smørgrav
44f7e6344dSDag-Erling Smørgrav #include <security/pam_appl.h>
45f7e6344dSDag-Erling Smørgrav #include <security/openpam.h>
46f7e6344dSDag-Erling Smørgrav
47f7e6344dSDag-Erling Smørgrav #include "openpam_impl.h"
48f7e6344dSDag-Erling Smørgrav
49f7e6344dSDag-Erling Smørgrav static const char user_prompt[] = "Login:";
50f7e6344dSDag-Erling Smørgrav
51f7e6344dSDag-Erling Smørgrav /*
52f7e6344dSDag-Erling Smørgrav * XSSO 4.2.1
53f7e6344dSDag-Erling Smørgrav * XSSO 6 page 52
54f7e6344dSDag-Erling Smørgrav *
55f7e6344dSDag-Erling Smørgrav * Retrieve user name
56f7e6344dSDag-Erling Smørgrav */
57f7e6344dSDag-Erling Smørgrav
58f7e6344dSDag-Erling Smørgrav int
pam_get_user(pam_handle_t * pamh,const char ** user,const char * prompt)59f7e6344dSDag-Erling Smørgrav pam_get_user(pam_handle_t *pamh,
60f7e6344dSDag-Erling Smørgrav const char **user,
61f7e6344dSDag-Erling Smørgrav const char *prompt)
62f7e6344dSDag-Erling Smørgrav {
63f7e6344dSDag-Erling Smørgrav char prompt_buf[1024];
64f7e6344dSDag-Erling Smørgrav size_t prompt_size;
65f7e6344dSDag-Erling Smørgrav const void *promptp;
66f7e6344dSDag-Erling Smørgrav char *resp;
67f7e6344dSDag-Erling Smørgrav int r;
68f7e6344dSDag-Erling Smørgrav
69f7e6344dSDag-Erling Smørgrav ENTER();
70f7e6344dSDag-Erling Smørgrav r = pam_get_item(pamh, PAM_USER, (const void **)user);
71f7e6344dSDag-Erling Smørgrav if (r == PAM_SUCCESS && *user != NULL)
72f7e6344dSDag-Erling Smørgrav RETURNC(PAM_SUCCESS);
73f7e6344dSDag-Erling Smørgrav /* pam policy overrides the module's choice */
74f7e6344dSDag-Erling Smørgrav if ((promptp = openpam_get_option(pamh, "user_prompt")) != NULL)
75f7e6344dSDag-Erling Smørgrav prompt = promptp;
76f7e6344dSDag-Erling Smørgrav /* no prompt provided, see if there is one tucked away somewhere */
77*f3b0ac34SDag-Erling Smørgrav if (prompt == NULL) {
78*f3b0ac34SDag-Erling Smørgrav r = pam_get_item(pamh, PAM_USER_PROMPT, &promptp);
79*f3b0ac34SDag-Erling Smørgrav if (r == PAM_SUCCESS && promptp != NULL)
80f7e6344dSDag-Erling Smørgrav prompt = promptp;
81*f3b0ac34SDag-Erling Smørgrav }
82f7e6344dSDag-Erling Smørgrav /* fall back to hardcoded default */
83f7e6344dSDag-Erling Smørgrav if (prompt == NULL)
84f7e6344dSDag-Erling Smørgrav prompt = user_prompt;
85f7e6344dSDag-Erling Smørgrav /* expand */
86f7e6344dSDag-Erling Smørgrav prompt_size = sizeof prompt_buf;
87f7e6344dSDag-Erling Smørgrav r = openpam_subst(pamh, prompt_buf, &prompt_size, prompt);
88f7e6344dSDag-Erling Smørgrav if (r == PAM_SUCCESS && prompt_size <= sizeof prompt_buf)
89f7e6344dSDag-Erling Smørgrav prompt = prompt_buf;
90f7e6344dSDag-Erling Smørgrav r = pam_prompt(pamh, PAM_PROMPT_ECHO_ON, &resp, "%s", prompt);
91f7e6344dSDag-Erling Smørgrav if (r != PAM_SUCCESS)
92f7e6344dSDag-Erling Smørgrav RETURNC(r);
93f7e6344dSDag-Erling Smørgrav r = pam_set_item(pamh, PAM_USER, resp);
94f7e6344dSDag-Erling Smørgrav FREE(resp);
95f7e6344dSDag-Erling Smørgrav if (r != PAM_SUCCESS)
96f7e6344dSDag-Erling Smørgrav RETURNC(r);
97f7e6344dSDag-Erling Smørgrav r = pam_get_item(pamh, PAM_USER, (const void **)user);
98f7e6344dSDag-Erling Smørgrav RETURNC(r);
99f7e6344dSDag-Erling Smørgrav }
100f7e6344dSDag-Erling Smørgrav
101f7e6344dSDag-Erling Smørgrav /*
102f7e6344dSDag-Erling Smørgrav * Error codes:
103f7e6344dSDag-Erling Smørgrav *
104f7e6344dSDag-Erling Smørgrav * =pam_get_item
105f7e6344dSDag-Erling Smørgrav * =pam_prompt
106f7e6344dSDag-Erling Smørgrav * =pam_set_item
107f7e6344dSDag-Erling Smørgrav * !PAM_SYMBOL_ERR
108f7e6344dSDag-Erling Smørgrav */
109f7e6344dSDag-Erling Smørgrav
110f7e6344dSDag-Erling Smørgrav /**
111f7e6344dSDag-Erling Smørgrav * The =pam_get_user function returns the name of the target user, as
112f7e6344dSDag-Erling Smørgrav * specified to =pam_start.
113f7e6344dSDag-Erling Smørgrav * If no user was specified, nor set using =pam_set_item, =pam_get_user
114f7e6344dSDag-Erling Smørgrav * will prompt for a user name.
115f7e6344dSDag-Erling Smørgrav * Either way, a pointer to the user name is stored in the location
116ce77a8d6SDag-Erling Smørgrav * pointed to by the =user argument, and the corresponding PAM item is
117ce77a8d6SDag-Erling Smørgrav * updated.
118f7e6344dSDag-Erling Smørgrav *
119f7e6344dSDag-Erling Smørgrav * The =prompt argument specifies a prompt to use if no user name is
120f7e6344dSDag-Erling Smørgrav * cached.
121f7e6344dSDag-Erling Smørgrav * If it is =NULL, the =PAM_USER_PROMPT item will be used.
122f7e6344dSDag-Erling Smørgrav * If that item is also =NULL, a hardcoded default prompt will be used.
123ce77a8d6SDag-Erling Smørgrav * Additionally, when =pam_get_user is called from a service module, the
124ce77a8d6SDag-Erling Smørgrav * prompt may be affected by module options as described below.
125ce77a8d6SDag-Erling Smørgrav * The prompt is then expanded using =openpam_subst before it is passed to
126ce77a8d6SDag-Erling Smørgrav * the conversation function.
127f7e6344dSDag-Erling Smørgrav *
128ce77a8d6SDag-Erling Smørgrav * MODULE OPTIONS
129f7e6344dSDag-Erling Smørgrav *
130ce77a8d6SDag-Erling Smørgrav * When called by a service module, =pam_get_user will recognize the
131ce77a8d6SDag-Erling Smørgrav * following module options:
132ce77a8d6SDag-Erling Smørgrav *
133ce77a8d6SDag-Erling Smørgrav * ;user_prompt:
134ce77a8d6SDag-Erling Smørgrav * Prompt to use when asking for the user name.
135ce77a8d6SDag-Erling Smørgrav * This option overrides both the =prompt argument and the
136ce77a8d6SDag-Erling Smørgrav * =PAM_USER_PROMPT item.
137ce77a8d6SDag-Erling Smørgrav *
138ce77a8d6SDag-Erling Smørgrav * >pam_conv
139f7e6344dSDag-Erling Smørgrav * >pam_get_item
140f7e6344dSDag-Erling Smørgrav * >pam_get_authtok
141ce77a8d6SDag-Erling Smørgrav * >openpam_get_option
142f7e6344dSDag-Erling Smørgrav * >openpam_subst
143f7e6344dSDag-Erling Smørgrav */
144