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 static char *alloc_sub_basic(const char *smb_name
, const char *domain_name
,
30 userdom_struct current_user_info
;
31 fstring remote_proto
="UNKNOWN";
34 * Set the 'local' machine name
35 * @param local_name the name we are being called
36 * @param if this is the 'final' name for us, not be be changed again
39 static char *local_machine
;
41 void free_local_machine_name(void)
43 SAFE_FREE(local_machine
);
46 bool set_local_machine_name(const char *local_name
, bool perm
)
48 static bool already_perm
= false;
49 char *tmp_local_machine
= NULL
;
56 tmp_local_machine
= SMB_STRDUP(local_name
);
57 if (!tmp_local_machine
) {
60 trim_char(tmp_local_machine
,' ',' ');
62 SAFE_FREE(local_machine
);
63 len
= strlen(tmp_local_machine
);
64 local_machine
= SMB_CALLOC_ARRAY(char, len
+1);
66 SAFE_FREE(tmp_local_machine
);
69 /* alpha_strcpy includes the space for the terminating nul. */
70 alpha_strcpy(local_machine
,tmp_local_machine
,
71 SAFE_NETBIOS_CHARS
,len
+1);
72 strlower_m(local_machine
);
73 SAFE_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
= SMB_STRDUP(remote_name
);
108 if (!tmp_remote_machine
) {
111 trim_char(tmp_remote_machine
,' ',' ');
113 SAFE_FREE(remote_machine
);
114 len
= strlen(tmp_remote_machine
);
115 remote_machine
= SMB_CALLOC_ARRAY(char, len
+1);
116 if (!remote_machine
) {
117 SAFE_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 strlower_m(remote_machine
);
125 SAFE_FREE(tmp_remote_machine
);
132 const char *get_remote_machine_name(void)
134 return remote_machine
? remote_machine
: "";
137 /*******************************************************************
138 Setup the string used by %U substitution.
139 ********************************************************************/
141 static char *smb_user_name
;
143 void sub_set_smb_name(const char *name
)
147 bool is_machine_account
= false;
149 /* don't let anonymous logins override the name */
150 if (!name
|| !*name
) {
154 tmp
= SMB_STRDUP(name
);
158 trim_char(tmp
, ' ', ' ');
168 /* long story but here goes....we have to allow usernames
169 ending in '$' as they are valid machine account names.
170 So check for a machine account and re-add the '$'
171 at the end after the call to alpha_strcpy(). --jerry */
173 if (tmp
[len
-1] == '$') {
174 is_machine_account
= True
;
177 SAFE_FREE(smb_user_name
);
178 smb_user_name
= SMB_CALLOC_ARRAY(char, len
+1);
179 if (!smb_user_name
) {
184 /* alpha_strcpy includes the space for the terminating nul. */
185 alpha_strcpy(smb_user_name
, tmp
,
191 if (is_machine_account
) {
192 len
= strlen(smb_user_name
);
193 smb_user_name
[len
-1] = '$';
197 static char sub_peeraddr
[INET6_ADDRSTRLEN
];
198 static const char *sub_peername
= "";
199 static char sub_sockaddr
[INET6_ADDRSTRLEN
];
201 void sub_set_socket_ids(const char *peeraddr
, const char *peername
,
202 const char *sockaddr
)
204 const char *addr
= peeraddr
;
206 if (strnequal(addr
, "::ffff:", 7)) {
209 strlcpy(sub_peeraddr
, addr
, sizeof(sub_peeraddr
));
211 sub_peername
= SMB_STRDUP(peername
);
212 if (sub_peername
== NULL
) {
213 sub_peername
= sub_peeraddr
;
217 * Shouldn't we do the ::ffff: cancellation here as well? The
218 * original code in alloc_sub_basic() did not do it, so I'm
219 * leaving it out here as well for compatibility.
221 strlcpy(sub_sockaddr
, sockaddr
, sizeof(sub_sockaddr
));
224 static const char *get_smb_user_name(void)
226 return smb_user_name
? smb_user_name
: "";
229 /*******************************************************************
230 Setup the strings used by substitutions. Called per packet. Ensure
231 %U name is set correctly also.
233 smb_name must be sanitized by alpha_strcpy
234 ********************************************************************/
236 void set_current_user_info(const char *smb_name
, const char *unix_name
,
239 fstrcpy(current_user_info
.smb_name
, smb_name
);
240 fstrcpy(current_user_info
.unix_name
, unix_name
);
241 fstrcpy(current_user_info
.domain
, domain
);
243 /* The following is safe as current_user_info.smb_name
244 * has already been sanitised in register_existing_vuid. */
246 sub_set_smb_name(current_user_info
.smb_name
);
249 /*******************************************************************
250 Return the current active user name.
251 *******************************************************************/
253 const char *get_current_username(void)
255 if (current_user_info
.smb_name
[0] == '\0' ) {
256 return get_smb_user_name();
259 return current_user_info
.smb_name
;
262 /*******************************************************************
263 Given a pointer to a %$(NAME) in p and the whole string in str
264 expand it as an environment variable.
265 Return a new allocated and expanded string.
266 Based on code by Branko Cibej <branko.cibej@hermes.si>
267 When this is called p points at the '%' character.
268 May substitute multiple occurrencies of the same env var.
269 ********************************************************************/
271 static char * realloc_expand_env_var(char *str
, char *p
)
278 if (p
[0] != '%' || p
[1] != '$' || p
[2] != '(') {
283 * Look for the terminating ')'.
286 if ((q
= strchr_m(p
,')')) == NULL
) {
287 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
292 * Extract the name from within the %$(NAME) string.
298 /* reserve space for use later add %$() chars */
299 if ( (envname
= (char *)SMB_MALLOC(copylen
+ 1 + 4)) == NULL
) {
303 strncpy(envname
,r
,copylen
);
304 envname
[copylen
] = '\0';
306 if ((envval
= getenv(envname
)) == NULL
) {
307 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
313 * Copy the full %$(NAME) into envname so it
318 strncpy(envname
,p
,copylen
);
319 envname
[copylen
] = '\0';
320 r
= realloc_string_sub(str
, envname
, envval
);
326 /*******************************************************************
327 Patch from jkf@soton.ac.uk
328 Added this to implement %p (NIS auto-map version of %H)
329 *******************************************************************/
331 static const char *automount_path(const char *user_name
)
333 TALLOC_CTX
*ctx
= talloc_tos();
334 const char *server_path
;
336 /* use the passwd entry as the default */
337 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
339 server_path
= talloc_strdup(ctx
, get_user_home_dir(ctx
, user_name
));
344 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
346 if (lp_nis_home_map()) {
347 const char *home_path_start
;
348 char *automount_value
= automount_lookup(ctx
, user_name
);
350 if(automount_value
&& strlen(automount_value
) > 0) {
351 home_path_start
= strchr_m(automount_value
,':');
352 if (home_path_start
!= NULL
) {
353 DEBUG(5, ("NIS lookup succeeded. "
354 "Home path is: %s\n",
356 (home_path_start
+1):""));
357 server_path
= talloc_strdup(ctx
,
364 /* NIS key lookup failed: default to
365 * user home directory from password file */
366 DEBUG(5, ("NIS lookup failed. Using Home path from "
367 "passwd file. Home path is: %s\n", server_path
));
372 DEBUG(4,("Home server path: %s\n", server_path
));
376 /*******************************************************************
377 Patch from jkf@soton.ac.uk
378 This is Luke's original function with the NIS lookup code
379 moved out to a separate function.
380 *******************************************************************/
382 static const char *automount_server(const char *user_name
)
384 TALLOC_CTX
*ctx
= talloc_tos();
385 const char *server_name
;
386 const char *local_machine_name
= get_local_machine_name();
388 /* use the local machine name as the default */
389 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
390 if (local_machine_name
&& *local_machine_name
) {
391 server_name
= talloc_strdup(ctx
, local_machine_name
);
393 server_name
= talloc_strdup(ctx
, lp_netbios_name());
400 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
401 if (lp_nis_home_map()) {
404 char *automount_value
= automount_lookup(ctx
, user_name
);
405 if (!automount_value
) {
408 srv
= talloc_strdup(ctx
, automount_value
);
412 p
= strchr_m(srv
, ':');
418 DEBUG(5, ("NIS lookup succeeded. Home server %s\n",
423 DEBUG(4,("Home server: %s\n", server_name
));
427 /****************************************************************************
428 Do some standard substitutions in a string.
429 len is the length in bytes of the space allowed in string str. If zero means
430 don't allow expansions.
431 ****************************************************************************/
433 void standard_sub_basic(const char *smb_name
, const char *domain_name
,
434 char *str
, size_t len
)
438 if ( (s
= alloc_sub_basic( smb_name
, domain_name
, str
)) != NULL
) {
439 strncpy( str
, s
, len
);
445 /****************************************************************************
446 Do some standard substitutions in a string.
447 This function will return an allocated string that have to be freed.
448 ****************************************************************************/
450 char *talloc_sub_basic(TALLOC_CTX
*mem_ctx
, const char *smb_name
,
451 const char *domain_name
, const char *str
)
455 if ( (a
= alloc_sub_basic(smb_name
, domain_name
, str
)) == NULL
) {
458 t
= talloc_strdup(mem_ctx
, a
);
463 /****************************************************************************
464 ****************************************************************************/
466 static char *alloc_sub_basic(const char *smb_name
, const char *domain_name
,
469 char *b
, *p
, *s
, *r
, *a_string
;
470 fstring pidstr
, vnnstr
;
471 const char *local_machine_name
= get_local_machine_name();
472 TALLOC_CTX
*tmp_ctx
= NULL
;
474 /* workaround to prevent a crash while looking at bug #687 */
477 DEBUG(0,("alloc_sub_basic: NULL source string! This should not happen\n"));
481 a_string
= SMB_STRDUP(str
);
482 if (a_string
== NULL
) {
483 DEBUG(0, ("alloc_sub_basic: Out of memory!\n"));
487 tmp_ctx
= talloc_stackframe();
489 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
496 r
= strlower_talloc(tmp_ctx
, smb_name
);
500 a_string
= realloc_string_sub(a_string
, "%U", r
);
504 r
= talloc_strdup(tmp_ctx
, smb_name
);
508 pass
= Get_Pwnam_alloc(tmp_ctx
, r
);
510 a_string
= realloc_string_sub(
512 gidtoname(pass
->pw_gid
));
518 r
= strupper_talloc(tmp_ctx
, domain_name
);
522 a_string
= realloc_string_sub(a_string
, "%D", r
);
525 a_string
= realloc_string_sub(
527 sub_peeraddr
[0] ? sub_peeraddr
: "0.0.0.0");
531 a_string
= realloc_string_sub(
533 sub_sockaddr
[0] ? sub_sockaddr
: "0.0.0.0");
536 if ( strncasecmp_m(p
, "%LOGONSERVER%", strlen("%LOGONSERVER%")) == 0 ) {
539 if (local_machine_name
&& *local_machine_name
) {
540 a_string
= realloc_string_sub(a_string
, "%L", local_machine_name
);
542 a_string
= realloc_string_sub(a_string
, "%L", lp_netbios_name());
546 a_string
= realloc_string_sub(a_string
, "%N", automount_server(smb_name
));
549 a_string
= realloc_string_sub(a_string
, "%M",
553 a_string
= realloc_string_sub(a_string
, "%R", remote_proto
);
556 a_string
= realloc_string_sub(a_string
, "%T", current_timestring(tmp_ctx
, False
));
559 a_string
= realloc_string_sub(a_string
, "%a",
560 get_remote_arch_str());
563 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
564 a_string
= realloc_string_sub(a_string
, "%d", pidstr
);
567 a_string
= realloc_string_sub(a_string
, "%h", myhostname());
570 a_string
= realloc_string_sub(a_string
, "%m",
576 a_string
= realloc_string_sub(a_string
, "%v", samba_version_string());
579 a_string
= realloc_string_sub(a_string
, "%w", lp_winbind_separator());
582 a_string
= realloc_expand_env_var(a_string
, p
); /* Expand environment variables */
585 slprintf(vnnstr
,sizeof(vnnstr
)-1, "%u", get_my_vnn());
586 a_string
= realloc_string_sub(a_string
, "%V", vnnstr
);
595 if (a_string
== NULL
) {
606 TALLOC_FREE(tmp_ctx
);
610 /****************************************************************************
611 Do some specific substitutions in a string.
612 This function will return an allocated string that have to be freed.
613 ****************************************************************************/
615 char *talloc_sub_specified(TALLOC_CTX
*mem_ctx
,
616 const char *input_string
,
617 const char *username
,
623 char *ret_string
= NULL
;
627 if (!(tmp_ctx
= talloc_new(mem_ctx
))) {
628 DEBUG(0, ("talloc_new failed\n"));
632 a_string
= talloc_strdup(tmp_ctx
, input_string
);
633 if (a_string
== NULL
) {
634 DEBUG(0, ("talloc_sub_specified: Out of memory!\n"));
638 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
644 a_string
= talloc_string_sub(
645 tmp_ctx
, a_string
, "%U", username
);
648 a_string
= talloc_string_sub(
649 tmp_ctx
, a_string
, "%u", username
);
653 a_string
= talloc_string_sub(
654 tmp_ctx
, a_string
, "%G",
657 a_string
= talloc_string_sub(
664 a_string
= talloc_string_sub(
665 tmp_ctx
, a_string
, "%g",
668 a_string
= talloc_string_sub(
669 tmp_ctx
, a_string
, "%g", "NO_GROUP");
673 a_string
= talloc_string_sub(tmp_ctx
, a_string
,
677 a_string
= talloc_string_sub(
678 tmp_ctx
, a_string
, "%N",
679 automount_server(username
));
686 if (a_string
== NULL
) {
691 /* Watch out, using "mem_ctx" here, so all intermediate stuff goes
692 * away with the TALLOC_FREE(tmp_ctx) further down. */
694 ret_string
= talloc_sub_basic(mem_ctx
, username
, domain
, a_string
);
697 TALLOC_FREE(tmp_ctx
);
701 /****************************************************************************
702 ****************************************************************************/
704 static char *alloc_sub_advanced(const char *servicename
, const char *user
,
705 const char *connectpath
, gid_t gid
,
706 const char *smb_name
, const char *domain_name
,
709 char *a_string
, *ret_string
;
712 a_string
= SMB_STRDUP(str
);
713 if (a_string
== NULL
) {
714 DEBUG(0, ("alloc_sub_advanced: Out of memory!\n"));
718 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
724 a_string
= realloc_string_sub(a_string
, "%N", automount_server(user
));
728 if ((h
= get_user_home_dir(talloc_tos(), user
)))
729 a_string
= realloc_string_sub(a_string
, "%H", h
);
734 a_string
= realloc_string_sub(a_string
, "%P", connectpath
);
737 a_string
= realloc_string_sub(a_string
, "%S", servicename
);
740 a_string
= realloc_string_sub(a_string
, "%g", gidtoname(gid
));
743 a_string
= realloc_string_sub(a_string
, "%u", user
);
746 /* Patch from jkf@soton.ac.uk Left the %N (NIS
747 * server name) in standard_sub_basic as it is
748 * a feature for logon servers, hence uses the
749 * username. The %p (NIS server path) code is
750 * here as it is used instead of the default
751 * "path =" string in [homes] and so needs the
752 * service name, not the username. */
754 a_string
= realloc_string_sub(a_string
, "%p",
755 automount_path(servicename
));
763 if (a_string
== NULL
) {
768 ret_string
= alloc_sub_basic(smb_name
, domain_name
, a_string
);
774 * This obviously is inefficient and needs to be merged into
775 * alloc_sub_advanced...
778 char *talloc_sub_advanced(TALLOC_CTX
*mem_ctx
,
779 const char *servicename
, const char *user
,
780 const char *connectpath
, gid_t gid
,
781 const char *smb_name
, const char *domain_name
,
786 if (!(a
= alloc_sub_advanced(servicename
, user
, connectpath
, gid
,
787 smb_name
, domain_name
, str
))) {
790 t
= talloc_strdup(mem_ctx
, a
);
796 void standard_sub_advanced(const char *servicename
, const char *user
,
797 const char *connectpath
, gid_t gid
,
798 const char *smb_name
, const char *domain_name
,
799 char *str
, size_t len
)
803 s
= alloc_sub_advanced(servicename
, user
, connectpath
,
804 gid
, smb_name
, domain_name
, str
);
807 strncpy( str
, s
, len
);
812 /****************************************************************************
813 Do some standard substitutions in a string.
814 ****************************************************************************/
816 char *standard_sub_conn(TALLOC_CTX
*ctx
, connection_struct
*conn
, const char *str
)
818 /* Make clear that we require the optional unix_token and unix_info in the source3 code */
819 SMB_ASSERT(conn
->session_info
->unix_token
);
820 SMB_ASSERT(conn
->session_info
->unix_info
);
821 return talloc_sub_advanced(ctx
,
822 lp_servicename(SNUM(conn
)),
823 conn
->session_info
->unix_info
->unix_name
,
825 conn
->session_info
->unix_token
->gid
,
831 /******************************************************************************
832 version of standard_sub_basic() for string lists; uses talloc_sub_basic()
834 *****************************************************************************/
836 bool str_list_sub_basic( char **list
, const char *smb_name
,
837 const char *domain_name
)
839 TALLOC_CTX
*ctx
= list
;
844 tmpstr
= talloc_sub_basic(ctx
, smb_name
, domain_name
, s
);
846 DEBUG(0,("str_list_sub_basic: "
847 "alloc_sub_basic() return NULL!\n"));