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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 extern struct current_user current_user
;
27 fstring local_machine
="";
28 fstring remote_arch
="UNKNOWN";
29 userdom_struct current_user_info
;
30 fstring remote_proto
="UNKNOWN";
32 static fstring remote_machine
;
33 static fstring smb_user_name
;
36 * Set the 'local' machine name
37 * @param local_name the name we are being called
38 * @param if this is the 'final' name for us, not be be changed again
41 void set_local_machine_name(const char* local_name
, BOOL perm
)
43 static BOOL already_perm
= False
;
44 fstring tmp_local_machine
;
46 fstrcpy(tmp_local_machine
,local_name
);
47 trim_char(tmp_local_machine
,' ',' ');
50 * Windows NT/2k uses "*SMBSERVER" and XP uses "*SMBSERV"
54 if ( strequal(tmp_local_machine
, "*SMBSERVER") || strequal(tmp_local_machine
, "*SMBSERV") ) {
55 fstrcpy( local_machine
, client_socket_addr() );
64 alpha_strcpy(local_machine
,tmp_local_machine
,SAFE_NETBIOS_CHARS
,sizeof(local_machine
)-1);
65 strlower_m(local_machine
);
69 * Set the 'remote' machine name
70 * @param remote_name the name our client wants to be called by
71 * @param if this is the 'final' name for them, not be be changed again
74 void set_remote_machine_name(const char* remote_name
, BOOL perm
)
76 static BOOL already_perm
= False
;
77 fstring tmp_remote_machine
;
84 fstrcpy(tmp_remote_machine
,remote_name
);
85 trim_char(tmp_remote_machine
,' ',' ');
86 alpha_strcpy(remote_machine
,tmp_remote_machine
,SAFE_NETBIOS_CHARS
,sizeof(remote_machine
)-1);
87 strlower_m(remote_machine
);
90 const char* get_remote_machine_name(void)
92 return remote_machine
;
95 const char* get_local_machine_name(void)
97 if (!*local_machine
) {
98 return global_myname();
101 return local_machine
;
104 /*******************************************************************
105 Setup the string used by %U substitution.
106 ********************************************************************/
108 void sub_set_smb_name(const char *name
)
112 BOOL is_machine_account
= False
;
114 /* don't let anonymous logins override the name */
119 fstrcpy( tmp
, name
);
120 trim_char( tmp
, ' ', ' ' );
128 /* long story but here goes....we have to allow usernames
129 ending in '$' as they are valid machine account names.
130 So check for a machine account and re-add the '$'
131 at the end after the call to alpha_strcpy(). --jerry */
133 if ( tmp
[len
-1] == '$' )
134 is_machine_account
= True
;
136 alpha_strcpy( smb_user_name
, tmp
, SAFE_NETBIOS_CHARS
, sizeof(smb_user_name
)-1 );
138 if ( is_machine_account
) {
139 len
= strlen( smb_user_name
);
140 smb_user_name
[len
-1] = '$';
144 char* sub_get_smb_name( void )
146 return smb_user_name
;
149 /*******************************************************************
150 Setup the strings used by substitutions. Called per packet. Ensure
151 %U name is set correctly also.
152 ********************************************************************/
154 void set_current_user_info(const userdom_struct
*pcui
)
156 current_user_info
= *pcui
;
157 /* The following is safe as current_user_info.smb_name
158 * has already been sanitised in register_vuid. */
159 fstrcpy(smb_user_name
, current_user_info
.smb_name
);
162 /*******************************************************************
163 return the current active user name
164 *******************************************************************/
166 const char* get_current_username( void )
168 if ( current_user_info
.smb_name
[0] == '\0' )
169 return smb_user_name
;
171 return current_user_info
.smb_name
;
174 /*******************************************************************
175 Given a pointer to a %$(NAME) in p and the whole string in str
176 expand it as an environment variable.
177 Return a new allocated and expanded string.
178 Based on code by Branko Cibej <branko.cibej@hermes.si>
179 When this is called p points at the '%' character.
180 May substitute multiple occurrencies of the same env var.
181 ********************************************************************/
183 static char * realloc_expand_env_var(char *str
, char *p
)
190 if (p
[0] != '%' || p
[1] != '$' || p
[2] != '(') {
195 * Look for the terminating ')'.
198 if ((q
= strchr_m(p
,')')) == NULL
) {
199 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
204 * Extract the name from within the %$(NAME) string.
210 /* reserve space for use later add %$() chars */
211 if ( (envname
= (char *)SMB_MALLOC(copylen
+ 1 + 4)) == NULL
) {
215 strncpy(envname
,r
,copylen
);
216 envname
[copylen
] = '\0';
218 if ((envval
= getenv(envname
)) == NULL
) {
219 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
225 * Copy the full %$(NAME) into envname so it
230 strncpy(envname
,p
,copylen
);
231 envname
[copylen
] = '\0';
232 r
= realloc_string_sub(str
, envname
, envval
);
238 /*******************************************************************
239 *******************************************************************/
241 static char *longvar_domainsid( void )
246 if ( !secrets_fetch_domain_sid( lp_workgroup(), &sid
) ) {
250 sid_string
= SMB_STRDUP( sid_string_static( &sid
) );
253 DEBUG(0,("longvar_domainsid: failed to dup SID string!\n"));
259 /*******************************************************************
260 *******************************************************************/
267 struct api_longvar longvar_table
[] = {
268 { "DomainSID", longvar_domainsid
},
272 static char *get_longvar_val( const char *varname
)
276 DEBUG(7,("get_longvar_val: expanding variable [%s]\n", varname
));
278 for ( i
=0; longvar_table
[i
].name
; i
++ ) {
279 if ( strequal( longvar_table
[i
].name
, varname
) ) {
280 return longvar_table
[i
].fn();
287 /*******************************************************************
288 Expand the long smb.conf variable names given a pointer to a %(NAME).
289 Return the number of characters by which the pointer should be advanced.
290 When this is called p points at the '%' character.
291 ********************************************************************/
293 static char *realloc_expand_longvar(char *str
, char *p
)
300 if ( p
[0] != '%' || p
[1] != '(' ) {
304 /* Look for the terminating ')'.*/
306 if ((q
= strchr_m(p
,')')) == NULL
) {
307 DEBUG(0,("realloc_expand_longvar: Unterminated environment variable [%s]\n", p
));
311 /* Extract the name from within the %(NAME) string.*/
314 copylen
= MIN( (q
-r
), (sizeof(varname
)-1) );
315 strncpy(varname
, r
, copylen
);
316 varname
[copylen
] = '\0';
318 if ((value
= get_longvar_val(varname
)) == NULL
) {
319 DEBUG(0,("realloc_expand_longvar: Variable [%s] not set. Skipping\n", varname
));
323 /* Copy the full %(NAME) into envname so it can be replaced.*/
325 copylen
= MIN( (q
+1-p
),(sizeof(varname
)-1) );
326 strncpy( varname
, p
, copylen
);
327 varname
[copylen
] = '\0';
328 r
= realloc_string_sub(str
, varname
, value
);
331 /* skip over the %(varname) */
336 /*******************************************************************
337 Patch from jkf@soton.ac.uk
338 Added this to implement %p (NIS auto-map version of %H)
339 *******************************************************************/
341 static char *automount_path(const char *user_name
)
343 static pstring server_path
;
345 /* use the passwd entry as the default */
346 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
348 pstrcpy(server_path
, get_user_home_dir(user_name
));
350 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
352 if (lp_nis_home_map()) {
353 const char *home_path_start
;
354 const char *automount_value
= automount_lookup(user_name
);
356 if(strlen(automount_value
) > 0) {
357 home_path_start
= strchr_m(automount_value
,':');
358 if (home_path_start
!= NULL
) {
359 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
360 home_path_start
?(home_path_start
+1):""));
361 pstrcpy(server_path
, home_path_start
+1);
364 /* NIS key lookup failed: default to user home directory from password file */
365 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path
));
370 DEBUG(4,("Home server path: %s\n", server_path
));
375 /*******************************************************************
376 Patch from jkf@soton.ac.uk
377 This is Luke's original function with the NIS lookup code
378 moved out to a separate function.
379 *******************************************************************/
381 static const char *automount_server(const char *user_name
)
383 static pstring server_name
;
384 const char *local_machine_name
= get_local_machine_name();
386 /* use the local machine name as the default */
387 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
388 if (local_machine_name
&& *local_machine_name
)
389 pstrcpy(server_name
, local_machine_name
);
391 pstrcpy(server_name
, global_myname());
393 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
395 if (lp_nis_home_map()) {
397 char *automount_value
= automount_lookup(user_name
);
398 home_server_len
= strcspn(automount_value
,":");
399 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len
));
400 if (home_server_len
> sizeof(pstring
))
401 home_server_len
= sizeof(pstring
);
402 strncpy(server_name
, automount_value
, home_server_len
);
403 server_name
[home_server_len
] = '\0';
407 DEBUG(4,("Home server: %s\n", server_name
));
412 /****************************************************************************
413 Do some standard substitutions in a string.
414 len is the length in bytes of the space allowed in string str. If zero means
415 don't allow expansions.
416 ****************************************************************************/
418 void standard_sub_basic(const char *smb_name
, char *str
, size_t len
)
422 if ( (s
= alloc_sub_basic( smb_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
, const char *str
)
439 if ( (a
= alloc_sub_basic(smb_name
, str
)) == NULL
) {
442 t
= talloc_strdup(mem_ctx
, a
);
447 /****************************************************************************
448 ****************************************************************************/
450 char *alloc_sub_basic(const char *smb_name
, const char *str
)
452 char *b
, *p
, *s
, *r
, *a_string
;
455 const char *local_machine_name
= get_local_machine_name();
457 /* workaround to prevent a crash while looking at bug #687 */
460 DEBUG(0,("alloc_sub_basic: NULL source string! This should not happen\n"));
464 a_string
= SMB_STRDUP(str
);
465 if (a_string
== NULL
) {
466 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
470 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
477 r
= strdup_lower(smb_name
);
481 a_string
= realloc_string_sub(a_string
, "%U", r
);
484 r
= SMB_STRDUP(smb_name
);
488 if ((pass
= Get_Pwnam(r
))!=NULL
) {
489 a_string
= realloc_string_sub(a_string
, "%G", gidtoname(pass
->pw_gid
));
493 r
= strdup_upper(current_user_info
.domain
);
497 a_string
= realloc_string_sub(a_string
, "%D", r
);
500 a_string
= realloc_string_sub(a_string
, "%I", client_addr());
503 a_string
= realloc_string_sub( a_string
, "%i", client_socket_addr() );
506 if ( StrnCaseCmp(p
, "%LOGONSERVER%", strlen("%LOGONSERVER%")) == 0 ) {
509 if (local_machine_name
&& *local_machine_name
) {
510 a_string
= realloc_string_sub(a_string
, "%L", local_machine_name
);
512 a_string
= realloc_string_sub(a_string
, "%L", global_myname());
516 a_string
= realloc_string_sub(a_string
, "%N", automount_server(smb_name
));
519 a_string
= realloc_string_sub(a_string
, "%M", client_name());
522 a_string
= realloc_string_sub(a_string
, "%R", remote_proto
);
525 a_string
= realloc_string_sub(a_string
, "%T", timestring(False
));
528 a_string
= realloc_string_sub(a_string
, "%a", remote_arch
);
531 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
532 a_string
= realloc_string_sub(a_string
, "%d", pidstr
);
535 a_string
= realloc_string_sub(a_string
, "%h", myhostname());
538 a_string
= realloc_string_sub(a_string
, "%m", remote_machine
);
541 a_string
= realloc_string_sub(a_string
, "%v", SAMBA_VERSION_STRING
);
544 a_string
= realloc_string_sub(a_string
, "%w", lp_winbind_separator());
547 a_string
= realloc_expand_env_var(a_string
, p
); /* Expand environment variables */
550 a_string
= realloc_expand_longvar( a_string
, p
);
571 /****************************************************************************
572 Do some specific substitutions in a string.
573 This function will return an allocated string that have to be freed.
574 ****************************************************************************/
576 char *talloc_sub_specified(TALLOC_CTX
*mem_ctx
,
577 const char *input_string
,
578 const char *username
,
584 a
= alloc_sub_specified(input_string
, username
, domain
, uid
, gid
);
588 t
= talloc_strdup(mem_ctx
, a
);
593 /****************************************************************************
594 ****************************************************************************/
596 char *alloc_sub_specified(const char *input_string
,
597 const char *username
,
602 char *a_string
, *ret_string
;
605 a_string
= SMB_STRDUP(input_string
);
606 if (a_string
== NULL
) {
607 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
611 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
617 a_string
= realloc_string_sub(a_string
, "%U", username
);
620 a_string
= realloc_string_sub(a_string
, "%u", username
);
624 a_string
= realloc_string_sub(a_string
, "%G", gidtoname(gid
));
626 a_string
= realloc_string_sub(a_string
, "%G", "NO_GROUP");
631 a_string
= realloc_string_sub(a_string
, "%g", gidtoname(gid
));
633 a_string
= realloc_string_sub(a_string
, "%g", "NO_GROUP");
637 a_string
= realloc_string_sub(a_string
, "%D", domain
);
640 a_string
= realloc_string_sub(a_string
, "%N", automount_server(username
));
647 if (a_string
== NULL
) {
652 ret_string
= alloc_sub_basic(username
, a_string
);
657 /****************************************************************************
658 ****************************************************************************/
660 char *talloc_sub_advanced(TALLOC_CTX
*mem_ctx
,
663 const char *connectpath
,
665 const char *smb_name
,
669 a
= alloc_sub_advanced(snum
, user
, connectpath
, gid
, smb_name
, str
);
673 t
= talloc_strdup(mem_ctx
, a
);
678 /****************************************************************************
679 ****************************************************************************/
681 char *alloc_sub_advanced(int snum
, const char *user
,
682 const char *connectpath
, gid_t gid
,
683 const char *smb_name
, const char *str
)
685 char *a_string
, *ret_string
;
688 a_string
= SMB_STRDUP(str
);
689 if (a_string
== NULL
) {
690 DEBUG(0, ("alloc_sub_advanced: Out of memory!\n"));
694 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
700 a_string
= realloc_string_sub(a_string
, "%N", automount_server(user
));
703 if ((h
= get_user_home_dir(user
)))
704 a_string
= realloc_string_sub(a_string
, "%H", h
);
707 a_string
= realloc_string_sub(a_string
, "%P", connectpath
);
710 a_string
= realloc_string_sub(a_string
, "%S", lp_servicename(snum
));
713 a_string
= realloc_string_sub(a_string
, "%g", gidtoname(gid
));
716 a_string
= realloc_string_sub(a_string
, "%u", user
);
719 /* Patch from jkf@soton.ac.uk Left the %N (NIS
720 * server name) in standard_sub_basic as it is
721 * a feature for logon servers, hence uses the
722 * username. The %p (NIS server path) code is
723 * here as it is used instead of the default
724 * "path =" string in [homes] and so needs the
725 * service name, not the username. */
727 a_string
= realloc_string_sub(a_string
, "%p", automount_path(lp_servicename(snum
)));
735 if (a_string
== NULL
) {
740 ret_string
= alloc_sub_basic(smb_name
, a_string
);
745 /****************************************************************************
746 Do some standard substitutions in a string.
747 ****************************************************************************/
749 void standard_sub_conn(connection_struct
*conn
, char *str
, size_t len
)
753 s
= alloc_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
754 conn
->gid
, smb_user_name
, str
);
757 strncpy( str
, s
, len
);
762 /****************************************************************************
763 ****************************************************************************/
765 char *talloc_sub_conn(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
, const char *str
)
767 return talloc_sub_advanced(mem_ctx
, SNUM(conn
), conn
->user
,
768 conn
->connectpath
, conn
->gid
,
772 /****************************************************************************
773 ****************************************************************************/
775 char *alloc_sub_conn(connection_struct
*conn
, const char *str
)
777 return alloc_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
778 conn
->gid
, smb_user_name
, str
);
781 /****************************************************************************
782 Like standard_sub but by snum.
783 ****************************************************************************/
785 void standard_sub_snum(int snum
, char *str
, size_t len
)
787 static uid_t cached_uid
= -1;
788 static fstring cached_user
;
791 /* calling uidtoname() on every substitute would be too expensive, so
792 we cache the result here as nearly every call is for the same uid */
794 if (cached_uid
!= current_user
.ut
.uid
) {
795 fstrcpy(cached_user
, uidtoname(current_user
.ut
.uid
));
796 cached_uid
= current_user
.ut
.uid
;
799 s
= alloc_sub_advanced(snum
, cached_user
, "", current_user
.ut
.gid
,
803 strncpy( str
, s
, len
);