libsmbconf: Document smbconf_shutdown().
[Samba.git] / source3 / auth / user_util.c
blobd982c746c6bf4b0beeca6bbd6ab2a5fdb67e9083
1 /*
2 Unix SMB/CIFS implementation.
3 Username handling
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 1997-2001.
6 Copyright (C) Volker Lendecke 2006
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
23 #include "system/filesys.h"
24 #include "auth.h"
26 /*******************************************************************
27 Map a username from a dos name to a unix name by looking in the username
28 map. Note that this modifies the name in place.
29 This is the main function that should be called *once* on
30 any incoming or new username - in order to canonicalize the name.
31 This is being done to de-couple the case conversions from the user mapping
32 function. Previously, the map_username was being called
33 every time Get_Pwnam_alloc was called.
34 Returns True if username was changed, false otherwise.
35 ********************************************************************/
37 static char *last_from = NULL;
38 static char *last_to = NULL;
40 static const char *get_last_from(void)
42 if (!last_from) {
43 return "";
45 return last_from;
48 static const char *get_last_to(void)
50 if (!last_to) {
51 return "";
53 return last_to;
56 static bool set_last_from_to(const char *from, const char *to)
58 char *orig_from = last_from;
59 char *orig_to = last_to;
61 last_from = SMB_STRDUP(from);
62 last_to = SMB_STRDUP(to);
64 SAFE_FREE(orig_from);
65 SAFE_FREE(orig_to);
67 if (!last_from || !last_to) {
68 SAFE_FREE(last_from);
69 SAFE_FREE(last_to);
70 return false;
72 return true;
75 static char *skip_space(char *s)
77 while (isspace((int)(*s))) {
78 s += 1;
80 return s;
83 static bool fetch_map_from_gencache(TALLOC_CTX *ctx,
84 const char *user_in,
85 char **p_user_out)
87 char *key, *value;
88 bool found;
90 if (lp_username_map_cache_time() == 0) {
91 return false;
94 key = talloc_asprintf_strupper_m(ctx, "USERNAME_MAP/%s",
95 user_in);
96 if (key == NULL) {
97 return false;
99 found = gencache_get(key, &value, NULL);
100 TALLOC_FREE(key);
101 if (!found) {
102 return false;
104 TALLOC_FREE(*p_user_out);
105 *p_user_out = talloc_strdup(ctx, value);
106 SAFE_FREE(value);
107 if (!*p_user_out) {
108 return false;
110 return true;
113 static void store_map_in_gencache(TALLOC_CTX *ctx, const char *from, const char *to)
115 char *key;
116 int cache_time = lp_username_map_cache_time();
118 if (cache_time == 0) {
119 return;
122 key = talloc_asprintf_strupper_m(ctx, "USERNAME_MAP/%s",
123 from);
124 if (key == NULL) {
125 return;
127 gencache_set(key, to, cache_time + time(NULL));
128 TALLOC_FREE(key);
131 /****************************************************************************
132 Check if a user is in a netgroup user list. If at first we don't succeed,
133 try lower case.
134 ****************************************************************************/
136 bool user_in_netgroup(TALLOC_CTX *ctx, const char *user, const char *ngname)
138 #ifdef HAVE_NETGROUP
139 static char *my_yp_domain = NULL;
140 char *lowercase_user = NULL;
142 if (my_yp_domain == NULL) {
143 yp_get_default_domain(&my_yp_domain);
146 if (my_yp_domain == NULL) {
147 DEBUG(5,("Unable to get default yp domain, "
148 "let's try without specifying it\n"));
151 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
152 user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
154 if (innetgr(ngname, NULL, user, my_yp_domain)) {
155 DEBUG(5,("user_in_netgroup: Found\n"));
156 return true;
160 * Ok, innetgr is case sensitive. Try once more with lowercase
161 * just in case. Attempt to fix #703. JRA.
163 lowercase_user = talloc_strdup(ctx, user);
164 if (!lowercase_user) {
165 return false;
167 strlower_m(lowercase_user);
169 if (strcmp(user,lowercase_user) == 0) {
170 /* user name was already lower case! */
171 return false;
174 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
175 lowercase_user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
177 if (innetgr(ngname, NULL, lowercase_user, my_yp_domain)) {
178 DEBUG(5,("user_in_netgroup: Found\n"));
179 return true;
181 #endif /* HAVE_NETGROUP */
182 return false;
185 /****************************************************************************
186 Check if a user is in a user list - can check combinations of UNIX
187 and netgroup lists.
188 ****************************************************************************/
190 bool user_in_list(TALLOC_CTX *ctx, const char *user,const char **list)
192 if (!list || !*list)
193 return False;
195 DEBUG(10,("user_in_list: checking user %s in list\n", user));
197 while (*list) {
199 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
200 user, *list));
203 * Check raw username.
205 if (strequal(user, *list))
206 return(True);
209 * Now check to see if any combination
210 * of UNIX and netgroups has been specified.
213 if(**list == '@') {
215 * Old behaviour. Check netgroup list
216 * followed by UNIX list.
218 if(user_in_netgroup(ctx, user, *list +1))
219 return True;
220 if(user_in_group(user, *list +1))
221 return True;
222 } else if (**list == '+') {
224 if((*(*list +1)) == '&') {
226 * Search UNIX list followed by netgroup.
228 if(user_in_group(user, *list +2))
229 return True;
230 if(user_in_netgroup(ctx, user, *list +2))
231 return True;
233 } else {
236 * Just search UNIX list.
239 if(user_in_group(user, *list +1))
240 return True;
243 } else if (**list == '&') {
245 if(*(*list +1) == '+') {
247 * Search netgroup list followed by UNIX list.
249 if(user_in_netgroup(ctx, user, *list +2))
250 return True;
251 if(user_in_group(user, *list +2))
252 return True;
253 } else {
255 * Just search netgroup list.
257 if(user_in_netgroup(ctx, user, *list +1))
258 return True;
262 list++;
264 return(False);
267 bool map_username(TALLOC_CTX *ctx, const char *user_in, char **p_user_out)
269 XFILE *f;
270 char *mapfile = lp_username_map();
271 char *s;
272 char buf[512];
273 bool mapped_user = False;
274 char *cmd = lp_username_map_script();
276 *p_user_out = NULL;
278 if (!user_in)
279 return false;
281 /* Initially make a copy of the incoming name. */
282 *p_user_out = talloc_strdup(ctx, user_in);
283 if (!*p_user_out) {
284 return false;
287 if (strequal(user_in,get_last_to()))
288 return false;
290 if (strequal(user_in,get_last_from())) {
291 DEBUG(3,("Mapped user %s to %s\n",user_in,get_last_to()));
292 TALLOC_FREE(*p_user_out);
293 *p_user_out = talloc_strdup(ctx, get_last_to());
294 return true;
297 if (fetch_map_from_gencache(ctx, user_in, p_user_out)) {
298 return true;
301 /* first try the username map script */
303 if ( *cmd ) {
304 char **qlines;
305 char *command = NULL;
306 int numlines, ret, fd;
308 command = talloc_asprintf(ctx,
309 "%s \"%s\"",
310 cmd,
311 user_in);
312 if (!command) {
313 return false;
316 DEBUG(10,("Running [%s]\n", command));
317 ret = smbrun(command, &fd);
318 DEBUGADD(10,("returned [%d]\n", ret));
320 TALLOC_FREE(command);
322 if ( ret != 0 ) {
323 if (fd != -1)
324 close(fd);
325 return False;
328 numlines = 0;
329 qlines = fd_lines_load(fd, &numlines, 0, ctx);
330 DEBUGADD(10,("Lines returned = [%d]\n", numlines));
331 close(fd);
333 /* should be either no lines or a single line with the mapped username */
335 if (numlines && qlines) {
336 DEBUG(3,("Mapped user %s to %s\n", user_in, qlines[0] ));
337 set_last_from_to(user_in, qlines[0]);
338 store_map_in_gencache(ctx, user_in, qlines[0]);
339 TALLOC_FREE(*p_user_out);
340 *p_user_out = talloc_strdup(ctx, qlines[0]);
341 if (!*p_user_out) {
342 return false;
346 TALLOC_FREE(qlines);
348 return numlines != 0;
351 /* ok. let's try the mapfile */
352 if (!*mapfile)
353 return False;
355 f = x_fopen(mapfile,O_RDONLY, 0);
356 if (!f) {
357 DEBUG(0,("can't open username map %s. Error %s\n",mapfile, strerror(errno) ));
358 return False;
361 DEBUG(4,("Scanning username map %s\n",mapfile));
363 while((s=fgets_slash(buf,sizeof(buf),f))!=NULL) {
364 char *unixname = s;
365 char *dosname = strchr_m(unixname,'=');
366 char **dosuserlist;
367 bool return_if_mapped = False;
369 if (!dosname)
370 continue;
372 *dosname++ = 0;
374 unixname = skip_space(unixname);
376 if ('!' == *unixname) {
377 return_if_mapped = True;
378 unixname = skip_space(unixname+1);
381 if (!*unixname || strchr_m("#;",*unixname))
382 continue;
385 int l = strlen(unixname);
386 while (l && isspace((int)unixname[l-1])) {
387 unixname[l-1] = 0;
388 l--;
392 /* skip lines like 'user = ' */
394 dosuserlist = str_list_make_v3(ctx, dosname, NULL);
395 if (!dosuserlist) {
396 DEBUG(0,("Bad username map entry. Unable to build user list. Ignoring.\n"));
397 continue;
400 if (strchr_m(dosname,'*') ||
401 user_in_list(ctx, user_in, (const char **)dosuserlist)) {
402 DEBUG(3,("Mapped user %s to %s\n",user_in,unixname));
403 mapped_user = True;
405 set_last_from_to(user_in, unixname);
406 store_map_in_gencache(ctx, user_in, unixname);
407 TALLOC_FREE(*p_user_out);
408 *p_user_out = talloc_strdup(ctx, unixname);
409 if (!*p_user_out) {
410 TALLOC_FREE(dosuserlist);
411 x_fclose(f);
412 return false;
415 if ( return_if_mapped ) {
416 TALLOC_FREE(dosuserlist);
417 x_fclose(f);
418 return True;
422 TALLOC_FREE(dosuserlist);
425 x_fclose(f);
428 * Setup the last_from and last_to as an optimization so
429 * that we don't scan the file again for the same user.
432 set_last_from_to(user_in, user_in);
433 store_map_in_gencache(ctx, user_in, user_in);
435 return mapped_user;