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/>.
24 extern struct current_user current_user;
26 fstring local_machine="";
27 fstring remote_arch="UNKNOWN";
28 userdom_struct current_user_info;
29 fstring remote_proto="UNKNOWN";
31 static fstring remote_machine;
32 static fstring smb_user_name;
35 * Set the 'local' machine name
36 * @param local_name the name we are being called
37 * @param if this is the 'final' name for us, not be be changed again
40 void set_local_machine_name(const char* local_name, BOOL perm)
42 static BOOL already_perm = False;
43 fstring tmp_local_machine;
45 fstrcpy(tmp_local_machine,local_name);
46 trim_char(tmp_local_machine,' ',' ');
49 * Windows NT/2k uses "*SMBSERVER" and XP uses "*SMBSERV"
53 if ( strequal(tmp_local_machine, "*SMBSERVER") || strequal(tmp_local_machine, "*SMBSERV") ) {
54 fstrcpy( local_machine, client_socket_addr() );
63 alpha_strcpy(local_machine,tmp_local_machine,SAFE_NETBIOS_CHARS,sizeof(local_machine)-1);
64 strlower_m(local_machine);
68 * Set the 'remote' machine name
69 * @param remote_name the name our client wants to be called by
70 * @param if this is the 'final' name for them, not be be changed again
73 void set_remote_machine_name(const char* remote_name, BOOL perm)
75 static BOOL already_perm = False;
76 fstring tmp_remote_machine;
83 fstrcpy(tmp_remote_machine,remote_name);
84 trim_char(tmp_remote_machine,' ',' ');
85 alpha_strcpy(remote_machine,tmp_remote_machine,SAFE_NETBIOS_CHARS,sizeof(remote_machine)-1);
86 strlower_m(remote_machine);
89 const char* get_remote_machine_name(void)
91 return remote_machine;
94 const char* get_local_machine_name(void)
96 if (!*local_machine) {
97 return global_myname();
100 return local_machine;
103 /*******************************************************************
104 Setup the string used by %U substitution.
105 ********************************************************************/
107 void sub_set_smb_name(const char *name)
111 BOOL is_machine_account = False;
113 /* don't let anonymous logins override the name */
118 fstrcpy( tmp, name );
119 trim_char( tmp, ' ', ' ' );
127 /* long story but here goes....we have to allow usernames
128 ending in '$' as they are valid machine account names.
129 So check for a machine account and re-add the '$'
130 at the end after the call to alpha_strcpy(). --jerry */
132 if ( tmp[len-1] == '$' )
133 is_machine_account = True;
135 alpha_strcpy( smb_user_name, tmp, SAFE_NETBIOS_CHARS, sizeof(smb_user_name)-1 );
137 if ( is_machine_account ) {
138 len = strlen( smb_user_name );
139 smb_user_name[len-1] = '$';
143 char* sub_get_smb_name( void )
145 return smb_user_name;
148 /*******************************************************************
149 Setup the strings used by substitutions. Called per packet. Ensure
150 %U name is set correctly also.
151 ********************************************************************/
153 void set_current_user_info(const userdom_struct *pcui)
155 current_user_info = *pcui;
156 /* The following is safe as current_user_info.smb_name
157 * has already been sanitised in register_vuid. */
158 fstrcpy(smb_user_name, current_user_info.smb_name);
161 /*******************************************************************
162 return the current active user name
163 *******************************************************************/
165 const char* get_current_username( void )
167 if ( current_user_info.smb_name[0] == '\0' )
168 return smb_user_name;
170 return current_user_info.smb_name;
173 /*******************************************************************
174 Given a pointer to a %$(NAME) in p and the whole string in str
175 expand it as an environment variable.
176 Return a new allocated and expanded string.
177 Based on code by Branko Cibej <branko.cibej@hermes.si>
178 When this is called p points at the '%' character.
179 May substitute multiple occurrencies of the same env var.
180 ********************************************************************/
182 static char * realloc_expand_env_var(char *str, char *p)
189 if (p[0] != '%' || p[1] != '$' || p[2] != '(') {
194 * Look for the terminating ')'.
197 if ((q = strchr_m(p,')')) == NULL) {
198 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
203 * Extract the name from within the %$(NAME) string.
209 /* reserve space for use later add %$() chars */
210 if ( (envname = (char *)SMB_MALLOC(copylen + 1 + 4)) == NULL ) {
214 strncpy(envname,r,copylen);
215 envname[copylen] = '\0';
217 if ((envval = getenv(envname)) == NULL) {
218 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
224 * Copy the full %$(NAME) into envname so it
229 strncpy(envname,p,copylen);
230 envname[copylen] = '\0';
231 r = realloc_string_sub(str, envname, envval);
237 /*******************************************************************
238 *******************************************************************/
240 static char *longvar_domainsid( void )
245 if ( !secrets_fetch_domain_sid( lp_workgroup(), &sid ) ) {
249 sid_string = SMB_STRDUP( sid_string_static( &sid ) );
252 DEBUG(0,("longvar_domainsid: failed to dup SID string!\n"));
258 /*******************************************************************
259 *******************************************************************/
266 struct api_longvar longvar_table[] = {
267 { "DomainSID", longvar_domainsid },
271 static char *get_longvar_val( const char *varname )
275 DEBUG(7,("get_longvar_val: expanding variable [%s]\n", varname));
277 for ( i=0; longvar_table[i].name; i++ ) {
278 if ( strequal( longvar_table[i].name, varname ) ) {
279 return longvar_table[i].fn();
286 /*******************************************************************
287 Expand the long smb.conf variable names given a pointer to a %(NAME).
288 Return the number of characters by which the pointer should be advanced.
289 When this is called p points at the '%' character.
290 ********************************************************************/
292 static char *realloc_expand_longvar(char *str, char *p)
299 if ( p[0] != '%' || p[1] != '(' ) {
303 /* Look for the terminating ')'.*/
305 if ((q = strchr_m(p,')')) == NULL) {
306 DEBUG(0,("realloc_expand_longvar: Unterminated environment variable [%s]\n", p));
310 /* Extract the name from within the %(NAME) string.*/
313 copylen = MIN( (q-r), (sizeof(varname)-1) );
314 strncpy(varname, r, copylen);
315 varname[copylen] = '\0';
317 if ((value = get_longvar_val(varname)) == NULL) {
318 DEBUG(0,("realloc_expand_longvar: Variable [%s] not set. Skipping\n", varname));
322 /* Copy the full %(NAME) into envname so it can be replaced.*/
324 copylen = MIN( (q+1-p),(sizeof(varname)-1) );
325 strncpy( varname, p, copylen );
326 varname[copylen] = '\0';
327 r = realloc_string_sub(str, varname, value);
330 /* skip over the %(varname) */
335 /*******************************************************************
336 Patch from jkf@soton.ac.uk
337 Added this to implement %p (NIS auto-map version of %H)
338 *******************************************************************/
340 static char *automount_path(const char *user_name)
342 static pstring server_path;
344 /* use the passwd entry as the default */
345 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
347 pstrcpy(server_path, get_user_home_dir(user_name));
349 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
351 if (lp_nis_home_map()) {
352 const char *home_path_start;
353 const char *automount_value = automount_lookup(user_name);
355 if(strlen(automount_value) > 0) {
356 home_path_start = strchr_m(automount_value,':');
357 if (home_path_start != NULL) {
358 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
359 home_path_start?(home_path_start+1):""));
360 pstrcpy(server_path, home_path_start+1);
363 /* NIS key lookup failed: default to user home directory from password file */
364 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path ));
369 DEBUG(4,("Home server path: %s\n", server_path));
374 /*******************************************************************
375 Patch from jkf@soton.ac.uk
376 This is Luke's original function with the NIS lookup code
377 moved out to a separate function.
378 *******************************************************************/
380 static const char *automount_server(const char *user_name)
382 static pstring server_name;
383 const char *local_machine_name = get_local_machine_name();
385 /* use the local machine name as the default */
386 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
387 if (local_machine_name && *local_machine_name)
388 pstrcpy(server_name, local_machine_name);
390 pstrcpy(server_name, global_myname());
392 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
394 if (lp_nis_home_map()) {
396 char *automount_value = automount_lookup(user_name);
397 home_server_len = strcspn(automount_value,":");
398 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len));
399 if (home_server_len > sizeof(pstring))
400 home_server_len = sizeof(pstring);
401 strncpy(server_name, automount_value, home_server_len);
402 server_name[home_server_len] = '\0';
406 DEBUG(4,("Home server: %s\n", server_name));
411 /****************************************************************************
412 Do some standard substitutions in a string.
413 len is the length in bytes of the space allowed in string str. If zero means
414 don't allow expansions.
415 ****************************************************************************/
417 void standard_sub_basic(const char *smb_name, const char *domain_name,
418 char *str, size_t len)
422 if ( (s = alloc_sub_basic( smb_name, domain_name, str )) != NULL ) {
423 strncpy( str, s, len );
430 /****************************************************************************
431 Do some standard substitutions in a string.
432 This function will return an allocated string that have to be freed.
433 ****************************************************************************/
435 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name,
436 const char *domain_name, const char *str)
440 if ( (a = alloc_sub_basic(smb_name, domain_name, str)) == NULL ) {
443 t = talloc_strdup(mem_ctx, a);
448 /****************************************************************************
449 ****************************************************************************/
451 char *alloc_sub_basic(const char *smb_name, const char *domain_name,
454 char *b, *p, *s, *r, *a_string;
455 fstring pidstr, vnnstr;
457 const char *local_machine_name = get_local_machine_name();
459 /* workaround to prevent a crash while looking at bug #687 */
462 DEBUG(0,("alloc_sub_basic: NULL source string! This should not happen\n"));
466 a_string = SMB_STRDUP(str);
467 if (a_string == NULL) {
468 DEBUG(0, ("alloc_sub_basic: Out of memory!\n"));
472 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
479 r = strdup_lower(smb_name);
483 a_string = realloc_string_sub(a_string, "%U", r);
486 r = SMB_STRDUP(smb_name);
490 if ((pass = Get_Pwnam(r))!=NULL) {
491 a_string = realloc_string_sub(a_string, "%G", gidtoname(pass->pw_gid));
495 r = strdup_upper(domain_name);
499 a_string = realloc_string_sub(a_string, "%D", r);
502 a_string = realloc_string_sub(a_string, "%I", client_addr());
505 a_string = realloc_string_sub( a_string, "%i", client_socket_addr() );
508 if ( StrnCaseCmp(p, "%LOGONSERVER%", strlen("%LOGONSERVER%")) == 0 ) {
511 if (local_machine_name && *local_machine_name) {
512 a_string = realloc_string_sub(a_string, "%L", local_machine_name);
514 a_string = realloc_string_sub(a_string, "%L", global_myname());
518 a_string = realloc_string_sub(a_string, "%N", automount_server(smb_name));
521 a_string = realloc_string_sub(a_string, "%M", client_name());
524 a_string = realloc_string_sub(a_string, "%R", remote_proto);
527 a_string = realloc_string_sub(a_string, "%T", current_timestring(False));
530 a_string = realloc_string_sub(a_string, "%a", remote_arch);
533 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
534 a_string = realloc_string_sub(a_string, "%d", pidstr);
537 a_string = realloc_string_sub(a_string, "%h", myhostname());
540 a_string = realloc_string_sub(a_string, "%m", remote_machine);
543 a_string = realloc_string_sub(a_string, "%v", SAMBA_VERSION_STRING);
546 a_string = realloc_string_sub(a_string, "%w", lp_winbind_separator());
549 a_string = realloc_expand_env_var(a_string, p); /* Expand environment variables */
552 a_string = realloc_expand_longvar( a_string, p );
555 slprintf(vnnstr,sizeof(vnnstr)-1, "%u", get_my_vnn());
556 a_string = realloc_string_sub(a_string, "%V", vnnstr);
577 /****************************************************************************
578 Do some specific substitutions in a string.
579 This function will return an allocated string that have to be freed.
580 ****************************************************************************/
582 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
583 const char *input_string,
584 const char *username,
590 char *ret_string = NULL;
594 if (!(tmp_ctx = talloc_new(mem_ctx))) {
595 DEBUG(0, ("talloc_new failed\n"));
599 a_string = talloc_strdup(tmp_ctx, input_string);
600 if (a_string == NULL) {
601 DEBUG(0, ("talloc_sub_specified: Out of memory!\n"));
605 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
611 a_string = talloc_string_sub(
612 tmp_ctx, a_string, "%U", username);
615 a_string = talloc_string_sub(
616 tmp_ctx, a_string, "%u", username);
620 a_string = talloc_string_sub(
621 tmp_ctx, a_string, "%G",
624 a_string = talloc_string_sub(
631 a_string = talloc_string_sub(
632 tmp_ctx, a_string, "%g",
635 a_string = talloc_string_sub(
636 tmp_ctx, a_string, "%g", "NO_GROUP");
640 a_string = talloc_string_sub(tmp_ctx, a_string,
644 a_string = talloc_string_sub(
645 tmp_ctx, a_string, "%N",
646 automount_server(username));
653 if (a_string == NULL) {
658 /* Watch out, using "mem_ctx" here, so all intermediate stuff goes
659 * away with the TALLOC_FREE(tmp_ctx) further down. */
661 ret_string = talloc_sub_basic(mem_ctx, username, domain, a_string);
664 TALLOC_FREE(tmp_ctx);
668 /****************************************************************************
669 ****************************************************************************/
671 static char *alloc_sub_advanced(const char *servicename, const char *user,
672 const char *connectpath, gid_t gid,
673 const char *smb_name, const char *domain_name,
676 char *a_string, *ret_string;
679 a_string = SMB_STRDUP(str);
680 if (a_string == NULL) {
681 DEBUG(0, ("alloc_sub_advanced: Out of memory!\n"));
685 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
691 a_string = realloc_string_sub(a_string, "%N", automount_server(user));
694 if ((h = get_user_home_dir(user)))
695 a_string = realloc_string_sub(a_string, "%H", h);
698 a_string = realloc_string_sub(a_string, "%P", connectpath);
701 a_string = realloc_string_sub(a_string, "%S", servicename);
704 a_string = realloc_string_sub(a_string, "%g", gidtoname(gid));
707 a_string = realloc_string_sub(a_string, "%u", user);
710 /* Patch from jkf@soton.ac.uk Left the %N (NIS
711 * server name) in standard_sub_basic as it is
712 * a feature for logon servers, hence uses the
713 * username. The %p (NIS server path) code is
714 * here as it is used instead of the default
715 * "path =" string in [homes] and so needs the
716 * service name, not the username. */
718 a_string = realloc_string_sub(a_string, "%p",
719 automount_path(servicename));
727 if (a_string == NULL) {
732 ret_string = alloc_sub_basic(smb_name, domain_name, a_string);
738 * This obviously is inefficient and needs to be merged into
739 * alloc_sub_advanced...
742 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
743 const char *servicename, const char *user,
744 const char *connectpath, gid_t gid,
745 const char *smb_name, const char *domain_name,
750 if (!(a = alloc_sub_advanced(servicename, user, connectpath, gid,
751 smb_name, domain_name, str))) {
754 t = talloc_strdup(mem_ctx, a);
760 void standard_sub_advanced(const char *servicename, const char *user,
761 const char *connectpath, gid_t gid,
762 const char *smb_name, const char *domain_name,
763 char *str, size_t len)
767 s = alloc_sub_advanced(servicename, user, connectpath,
768 gid, smb_name, domain_name, str);
771 strncpy( str, s, len );