2 Unix SMB/CIFS implementation.
3 string substitution functions
4 Copyright (C) Andrew Tridgell 1992-2000
5 Copyright (C) Gerald Carter 2006
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "system/passwd.h"
27 userdom_struct current_user_info;
28 fstring remote_proto="UNKNOWN";
31 * Set the 'local' machine name
32 * @param local_name the name we are being called
33 * @param if this is the 'final' name for us, not be be changed again
36 static char *local_machine;
38 void free_local_machine_name(void)
40 TALLOC_FREE(local_machine);
43 bool set_local_machine_name(const char *local_name, bool perm)
45 static bool already_perm = false;
46 char *tmp_local_machine = NULL;
53 tmp_local_machine = talloc_strdup(NULL, local_name);
54 if (!tmp_local_machine) {
57 trim_char(tmp_local_machine,' ',' ');
59 TALLOC_FREE(local_machine);
60 len = strlen(tmp_local_machine);
61 local_machine = (char *)TALLOC_ZERO(NULL, len+1);
63 TALLOC_FREE(tmp_local_machine);
66 /* alpha_strcpy includes the space for the terminating nul. */
67 alpha_strcpy(local_machine,tmp_local_machine,
68 SAFE_NETBIOS_CHARS,len+1);
69 if (!strlower_m(local_machine)) {
70 TALLOC_FREE(tmp_local_machine);
73 TALLOC_FREE(tmp_local_machine);
80 const char *get_local_machine_name(void)
82 if (!local_machine || !*local_machine) {
83 return lp_netbios_name();
90 * Set the 'remote' machine name
91 * @param remote_name the name our client wants to be called by
92 * @param if this is the 'final' name for them, not be be changed again
95 static char *remote_machine;
97 bool set_remote_machine_name(const char *remote_name, bool perm)
99 static bool already_perm = False;
100 char *tmp_remote_machine;
107 tmp_remote_machine = talloc_strdup(NULL, remote_name);
108 if (!tmp_remote_machine) {
111 trim_char(tmp_remote_machine,' ',' ');
113 TALLOC_FREE(remote_machine);
114 len = strlen(tmp_remote_machine);
115 remote_machine = (char *)TALLOC_ZERO(NULL, len+1);
116 if (!remote_machine) {
117 TALLOC_FREE(tmp_remote_machine);
121 /* alpha_strcpy includes the space for the terminating nul. */
122 alpha_strcpy(remote_machine,tmp_remote_machine,
123 SAFE_NETBIOS_CHARS,len+1);
124 if (!strlower_m(remote_machine)) {
125 TALLOC_FREE(tmp_remote_machine);
128 TALLOC_FREE(tmp_remote_machine);
135 const char *get_remote_machine_name(void)
137 return remote_machine ? remote_machine : "";
140 /*******************************************************************
141 Setup the string used by %U substitution.
142 ********************************************************************/
144 static char *smb_user_name;
146 void sub_set_smb_name(const char *name)
150 bool is_machine_account = false;
152 /* don't let anonymous logins override the name */
153 if (!name || !*name) {
157 tmp = talloc_strdup(NULL, name);
161 trim_char(tmp, ' ', ' ');
162 if (!strlower_m(tmp)) {
174 /* long story but here goes....we have to allow usernames
175 ending in '$' as they are valid machine account names.
176 So check for a machine account and re-add the '$'
177 at the end after the call to alpha_strcpy(). --jerry */
179 if (tmp[len-1] == '$') {
180 is_machine_account = True;
183 TALLOC_FREE(smb_user_name);
184 smb_user_name = (char *)TALLOC_ZERO(NULL, len+1);
185 if (!smb_user_name) {
190 /* alpha_strcpy includes the space for the terminating nul. */
191 alpha_strcpy(smb_user_name, tmp,
197 if (is_machine_account) {
198 len = strlen(smb_user_name);
199 smb_user_name[len-1] = '$';
203 static char sub_peeraddr[INET6_ADDRSTRLEN];
204 static const char *sub_peername = NULL;
205 static char sub_sockaddr[INET6_ADDRSTRLEN];
207 void sub_set_socket_ids(const char *peeraddr, const char *peername,
208 const char *sockaddr)
210 const char *addr = peeraddr;
212 if (strnequal(addr, "::ffff:", 7)) {
215 strlcpy(sub_peeraddr, addr, sizeof(sub_peeraddr));
217 if (sub_peername != NULL &&
218 sub_peername != sub_peeraddr) {
219 talloc_free(discard_const_p(char,sub_peername));
222 sub_peername = talloc_strdup(NULL, peername);
223 if (sub_peername == NULL) {
224 sub_peername = sub_peeraddr;
228 * Shouldn't we do the ::ffff: cancellation here as well? The
229 * original code in talloc_sub_basic() did not do it, so I'm
230 * leaving it out here as well for compatibility.
232 strlcpy(sub_sockaddr, sockaddr, sizeof(sub_sockaddr));
235 static const char *get_smb_user_name(void)
237 return smb_user_name ? smb_user_name : "";
240 /*******************************************************************
241 Setup the strings used by substitutions. Called per packet. Ensure
242 %U name is set correctly also.
244 smb_name must be sanitized by alpha_strcpy
245 ********************************************************************/
247 void set_current_user_info(const char *smb_name, const char *unix_name,
250 static const void *last_smb_name;
251 static const void *last_unix_name;
252 static const void *last_domain;
254 if (likely(last_smb_name == smb_name &&
255 last_unix_name == unix_name &&
256 last_domain == domain))
261 fstrcpy(current_user_info.smb_name, smb_name);
262 fstrcpy(current_user_info.unix_name, unix_name);
263 fstrcpy(current_user_info.domain, domain);
265 /* The following is safe as current_user_info.smb_name
266 * has already been sanitised in register_existing_vuid. */
268 sub_set_smb_name(current_user_info.smb_name);
270 last_smb_name = smb_name;
271 last_unix_name = unix_name;
272 last_domain = domain;
275 /*******************************************************************
276 Return the current active user name.
277 *******************************************************************/
279 const char *get_current_username(void)
281 if (current_user_info.smb_name[0] == '\0' ) {
282 return get_smb_user_name();
285 return current_user_info.smb_name;
288 /*******************************************************************
289 Given a pointer to a %$(NAME) in p and the whole string in str
290 expand it as an environment variable.
291 str must be a talloced string.
292 Return a new allocated and expanded string.
293 Based on code by Branko Cibej <branko.cibej@hermes.si>
294 When this is called p points at the '%' character.
295 May substitute multiple occurrencies of the same env var.
296 ********************************************************************/
298 static char *realloc_expand_env_var(char *str, char *p)
305 if (p[0] != '%' || p[1] != '$' || p[2] != '(') {
310 * Look for the terminating ')'.
313 if ((q = strchr_m(p,')')) == NULL) {
314 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
319 * Extract the name from within the %$(NAME) string.
325 /* reserve space for use later add %$() chars */
326 if ( (envname = talloc_array(talloc_tos(), char, copylen + 1 + 4)) == NULL ) {
330 strncpy(envname,r,copylen);
331 envname[copylen] = '\0';
333 if ((envval = getenv(envname)) == NULL) {
334 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
335 TALLOC_FREE(envname);
340 * Copy the full %$(NAME) into envname so it
345 strncpy(envname,p,copylen);
346 envname[copylen] = '\0';
347 r = realloc_string_sub(str, envname, envval);
348 TALLOC_FREE(envname);
353 /*******************************************************************
354 Patch from jkf@soton.ac.uk
355 Added this to implement %p (NIS auto-map version of %H)
356 *******************************************************************/
358 static const char *automount_path(const char *user_name)
360 TALLOC_CTX *ctx = talloc_tos();
361 const char *server_path;
363 /* use the passwd entry as the default */
364 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
366 server_path = talloc_strdup(ctx, get_user_home_dir(ctx, user_name));
371 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
373 if (lp_nis_homedir()) {
374 const char *home_path_start;
375 char *automount_value = automount_lookup(ctx, user_name);
377 if(automount_value && strlen(automount_value) > 0) {
378 home_path_start = strchr_m(automount_value,':');
379 if (home_path_start != NULL) {
380 DEBUG(5, ("NIS lookup succeeded. "
381 "Home path is: %s\n",
383 (home_path_start+1):""));
384 server_path = talloc_strdup(ctx,
391 /* NIS key lookup failed: default to
392 * user home directory from password file */
393 DEBUG(5, ("NIS lookup failed. Using Home path from "
394 "passwd file. Home path is: %s\n", server_path ));
399 DEBUG(4,("Home server path: %s\n", server_path));
403 /*******************************************************************
404 Patch from jkf@soton.ac.uk
405 This is Luke's original function with the NIS lookup code
406 moved out to a separate function.
407 *******************************************************************/
409 static const char *automount_server(const char *user_name)
411 TALLOC_CTX *ctx = talloc_tos();
412 const char *server_name;
413 const char *local_machine_name = get_local_machine_name();
415 /* use the local machine name as the default */
416 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
417 if (local_machine_name && *local_machine_name) {
418 server_name = talloc_strdup(ctx, local_machine_name);
420 server_name = talloc_strdup(ctx, lp_netbios_name());
427 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
428 if (lp_nis_homedir()) {
431 char *automount_value = automount_lookup(ctx, user_name);
432 if (!automount_value) {
435 srv = talloc_strdup(ctx, automount_value);
439 p = strchr_m(srv, ':');
445 DEBUG(5, ("NIS lookup succeeded. Home server %s\n",
450 DEBUG(4,("Home server: %s\n", server_name));
454 /****************************************************************************
455 Do some standard substitutions in a string.
456 len is the length in bytes of the space allowed in string str. If zero means
457 don't allow expansions.
458 ****************************************************************************/
460 void standard_sub_basic(const char *smb_name, const char *domain_name,
461 char *str, size_t len)
465 if ( (s = talloc_sub_basic(talloc_tos(), smb_name, domain_name, str )) != NULL ) {
466 strncpy( str, s, len );
473 * Limit addresses to hexalpha charactes and underscore, safe for path
474 * components for Windows clients.
476 static void make_address_pathsafe(char *addr)
478 while(addr && *addr) {
479 if(!isxdigit(*addr)) {
486 /****************************************************************************
487 Do some standard substitutions in a string.
488 This function will return a talloced string that has to be freed.
489 ****************************************************************************/
491 char *talloc_sub_basic(TALLOC_CTX *mem_ctx,
492 const char *smb_name,
493 const char *domain_name,
496 char *b, *p, *s, *r, *a_string;
497 fstring pidstr, vnnstr;
498 const char *local_machine_name = get_local_machine_name();
499 TALLOC_CTX *tmp_ctx = NULL;
501 /* workaround to prevent a crash while looking at bug #687 */
504 DEBUG(0,("talloc_sub_basic: NULL source string! This should not happen\n"));
508 a_string = talloc_strdup(mem_ctx, str);
509 if (a_string == NULL) {
510 DEBUG(0, ("talloc_sub_basic: Out of memory!\n"));
514 tmp_ctx = talloc_stackframe();
516 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
523 r = strlower_talloc(tmp_ctx, smb_name);
527 a_string = realloc_string_sub(a_string, "%U", r);
531 bool is_domain_name = false;
532 const char *sep = lp_winbind_separator();
534 if (domain_name != NULL && domain_name[0] != '\0' &&
535 (lp_security() == SEC_ADS ||
536 lp_security() == SEC_DOMAIN)) {
537 r = talloc_asprintf(tmp_ctx,
542 is_domain_name = true;
544 r = talloc_strdup(tmp_ctx, smb_name);
550 pass = Get_Pwnam_alloc(tmp_ctx, r);
554 group_name = gidtoname(pass->pw_gid);
555 if (is_domain_name) {
557 group_sep = strchr_m(group_name, *sep);
558 if (group_sep != NULL) {
559 group_name = group_sep + 1;
562 a_string = realloc_string_sub(a_string,
570 r = strupper_talloc(tmp_ctx, domain_name);
574 a_string = realloc_string_sub(a_string, "%D", r);
577 a_string = realloc_string_sub(
579 sub_peeraddr[0] ? sub_peeraddr : "0.0.0.0");
583 r = talloc_strdup(tmp_ctx,
584 sub_peeraddr[0] ? sub_peeraddr : "0.0.0.0");
585 make_address_pathsafe(r);
586 a_string = realloc_string_sub(a_string, "%J", r);
590 a_string = realloc_string_sub(
592 sub_sockaddr[0] ? sub_sockaddr : "0.0.0.0");
595 r = talloc_strdup(tmp_ctx,
596 sub_sockaddr[0] ? sub_sockaddr : "0.0.0.0");
597 make_address_pathsafe(r);
598 a_string = realloc_string_sub(a_string, "%j", r);
602 if ( strncasecmp_m(p, "%LOGONSERVER%", strlen("%LOGONSERVER%")) == 0 ) {
605 if (local_machine_name && *local_machine_name) {
606 a_string = realloc_string_sub(a_string, "%L", local_machine_name);
608 a_string = realloc_string_sub(a_string, "%L", lp_netbios_name());
612 a_string = realloc_string_sub(a_string, "%N", automount_server(smb_name));
615 a_string = realloc_string_sub(a_string, "%M",
616 sub_peername ? sub_peername : "");
619 a_string = realloc_string_sub(a_string, "%R", remote_proto);
622 a_string = realloc_string_sub(a_string, "%T", current_timestring(tmp_ctx, False));
625 a_string = realloc_string_sub(a_string, "%t",
626 current_minimal_timestring(tmp_ctx, False));
629 a_string = realloc_string_sub(a_string, "%a",
630 get_remote_arch_str());
633 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)getpid());
634 a_string = realloc_string_sub(a_string, "%d", pidstr);
637 a_string = realloc_string_sub(a_string, "%h", myhostname());
640 a_string = realloc_string_sub(a_string, "%m",
646 a_string = realloc_string_sub(a_string, "%v", samba_version_string());
649 a_string = realloc_string_sub(a_string, "%w", lp_winbind_separator());
652 a_string = realloc_expand_env_var(a_string, p); /* Expand environment variables */
655 slprintf(vnnstr,sizeof(vnnstr)-1, "%u", get_my_vnn());
656 a_string = realloc_string_sub(a_string, "%V", vnnstr);
665 if (a_string == NULL) {
673 TALLOC_FREE(a_string);
676 TALLOC_FREE(tmp_ctx);
680 /****************************************************************************
681 Do some specific substitutions in a string.
682 This function will return an allocated string that have to be freed.
683 ****************************************************************************/
685 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
686 const char *input_string,
687 const char *username,
694 char *ret_string = NULL;
698 if (!(tmp_ctx = talloc_new(mem_ctx))) {
699 DEBUG(0, ("talloc_new failed\n"));
703 a_string = talloc_strdup(tmp_ctx, input_string);
704 if (a_string == NULL) {
705 DEBUG(0, ("talloc_sub_specified: Out of memory!\n"));
709 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
715 a_string = talloc_string_sub(
716 tmp_ctx, a_string, "%U", username);
719 a_string = talloc_string_sub(
720 tmp_ctx, a_string, "%u", username);
726 if (grpname != NULL) {
729 name = gidtoname(gid);
732 a_string = talloc_string_sub(tmp_ctx,
737 a_string = talloc_string_sub(
746 if (grpname != NULL) {
749 name = gidtoname(gid);
752 a_string = talloc_string_sub(tmp_ctx,
757 a_string = talloc_string_sub(
758 tmp_ctx, a_string, "%g", "NO_GROUP");
762 a_string = talloc_string_sub(tmp_ctx, a_string,
766 a_string = talloc_string_sub(
767 tmp_ctx, a_string, "%N",
768 automount_server(username));
775 if (a_string == NULL) {
780 /* Watch out, using "mem_ctx" here, so all intermediate stuff goes
781 * away with the TALLOC_FREE(tmp_ctx) further down. */
783 ret_string = talloc_sub_basic(mem_ctx, username, domain, a_string);
786 TALLOC_FREE(tmp_ctx);
790 /****************************************************************************
791 ****************************************************************************/
793 char *talloc_sub_advanced(TALLOC_CTX *ctx,
794 const char *servicename,
796 const char *connectpath,
798 const char *smb_name,
799 const char *domain_name,
802 char *a_string, *ret_string;
805 a_string = talloc_strdup(talloc_tos(), str);
806 if (a_string == NULL) {
807 DEBUG(0, ("talloc_sub_advanced: Out of memory!\n"));
811 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
817 a_string = realloc_string_sub(a_string, "%N", automount_server(user));
821 if ((h = get_user_home_dir(talloc_tos(), user)))
822 a_string = realloc_string_sub(a_string, "%H", h);
827 a_string = realloc_string_sub(a_string, "%P", connectpath);
830 a_string = realloc_string_sub(a_string, "%S", servicename);
833 a_string = realloc_string_sub(a_string, "%g", gidtoname(gid));
836 a_string = realloc_string_sub(a_string, "%u", user);
839 /* Patch from jkf@soton.ac.uk Left the %N (NIS
840 * server name) in standard_sub_basic as it is
841 * a feature for logon servers, hence uses the
842 * username. The %p (NIS server path) code is
843 * here as it is used instead of the default
844 * "path =" string in [homes] and so needs the
845 * service name, not the username. */
847 a_string = realloc_string_sub(a_string, "%p",
848 automount_path(servicename));
856 if (a_string == NULL) {
861 ret_string = talloc_sub_basic(ctx, smb_name, domain_name, a_string);
862 TALLOC_FREE(a_string);
866 void standard_sub_advanced(const char *servicename, const char *user,
867 const char *connectpath, gid_t gid,
868 const char *smb_name, const char *domain_name,
869 char *str, size_t len)
871 char *s = talloc_sub_advanced(talloc_tos(),
872 servicename, user, connectpath,
873 gid, smb_name, domain_name, str);
878 strlcpy( str, s, len );
882 /******************************************************************************
883 version of standard_sub_basic() for string lists; uses talloc_sub_basic()
885 *****************************************************************************/
887 bool str_list_sub_basic( char **list, const char *smb_name,
888 const char *domain_name )
890 TALLOC_CTX *ctx = list;
895 tmpstr = talloc_sub_basic(ctx, smb_name, domain_name, s);
897 DEBUG(0,("str_list_sub_basic: "
898 "talloc_sub_basic() return NULL!\n"));