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 = NULL;
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 if (sub_peername != NULL &&
212 sub_peername != sub_peeraddr) {
213 free(discard_const_p(char,sub_peername));
216 sub_peername = SMB_STRDUP(peername);
217 if (sub_peername == NULL) {
218 sub_peername = sub_peeraddr;
222 * Shouldn't we do the ::ffff: cancellation here as well? The
223 * original code in alloc_sub_basic() did not do it, so I'm
224 * leaving it out here as well for compatibility.
226 strlcpy(sub_sockaddr, sockaddr, sizeof(sub_sockaddr));
229 static const char *get_smb_user_name(void)
231 return smb_user_name ? smb_user_name : "";
234 /*******************************************************************
235 Setup the strings used by substitutions. Called per packet. Ensure
236 %U name is set correctly also.
238 smb_name must be sanitized by alpha_strcpy
239 ********************************************************************/
241 void set_current_user_info(const char *smb_name, const char *unix_name,
244 fstrcpy(current_user_info.smb_name, smb_name);
245 fstrcpy(current_user_info.unix_name, unix_name);
246 fstrcpy(current_user_info.domain, domain);
248 /* The following is safe as current_user_info.smb_name
249 * has already been sanitised in register_existing_vuid. */
251 sub_set_smb_name(current_user_info.smb_name);
254 /*******************************************************************
255 Return the current active user name.
256 *******************************************************************/
258 const char *get_current_username(void)
260 if (current_user_info.smb_name[0] == '\0' ) {
261 return get_smb_user_name();
264 return current_user_info.smb_name;
267 /*******************************************************************
268 Given a pointer to a %$(NAME) in p and the whole string in str
269 expand it as an environment variable.
270 Return a new allocated and expanded string.
271 Based on code by Branko Cibej <branko.cibej@hermes.si>
272 When this is called p points at the '%' character.
273 May substitute multiple occurrencies of the same env var.
274 ********************************************************************/
276 static char * realloc_expand_env_var(char *str, char *p)
283 if (p[0] != '%' || p[1] != '$' || p[2] != '(') {
288 * Look for the terminating ')'.
291 if ((q = strchr_m(p,')')) == NULL) {
292 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
297 * Extract the name from within the %$(NAME) string.
303 /* reserve space for use later add %$() chars */
304 if ( (envname = (char *)SMB_MALLOC(copylen + 1 + 4)) == NULL ) {
308 strncpy(envname,r,copylen);
309 envname[copylen] = '\0';
311 if ((envval = getenv(envname)) == NULL) {
312 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
318 * Copy the full %$(NAME) into envname so it
323 strncpy(envname,p,copylen);
324 envname[copylen] = '\0';
325 r = realloc_string_sub(str, envname, envval);
331 /*******************************************************************
332 Patch from jkf@soton.ac.uk
333 Added this to implement %p (NIS auto-map version of %H)
334 *******************************************************************/
336 static const char *automount_path(const char *user_name)
338 TALLOC_CTX *ctx = talloc_tos();
339 const char *server_path;
341 /* use the passwd entry as the default */
342 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
344 server_path = talloc_strdup(ctx, get_user_home_dir(ctx, user_name));
349 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
351 if (lp_nis_home_map()) {
352 const char *home_path_start;
353 char *automount_value = automount_lookup(ctx, user_name);
355 if(automount_value && strlen(automount_value) > 0) {
356 home_path_start = strchr_m(automount_value,':');
357 if (home_path_start != NULL) {
358 DEBUG(5, ("NIS lookup succeeded. "
359 "Home path is: %s\n",
361 (home_path_start+1):""));
362 server_path = talloc_strdup(ctx,
369 /* NIS key lookup failed: default to
370 * user home directory from password file */
371 DEBUG(5, ("NIS lookup failed. Using Home path from "
372 "passwd file. Home path is: %s\n", server_path ));
377 DEBUG(4,("Home server path: %s\n", server_path));
381 /*******************************************************************
382 Patch from jkf@soton.ac.uk
383 This is Luke's original function with the NIS lookup code
384 moved out to a separate function.
385 *******************************************************************/
387 static const char *automount_server(const char *user_name)
389 TALLOC_CTX *ctx = talloc_tos();
390 const char *server_name;
391 const char *local_machine_name = get_local_machine_name();
393 /* use the local machine name as the default */
394 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
395 if (local_machine_name && *local_machine_name) {
396 server_name = talloc_strdup(ctx, local_machine_name);
398 server_name = talloc_strdup(ctx, lp_netbios_name());
405 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
406 if (lp_nis_home_map()) {
409 char *automount_value = automount_lookup(ctx, user_name);
410 if (!automount_value) {
413 srv = talloc_strdup(ctx, automount_value);
417 p = strchr_m(srv, ':');
423 DEBUG(5, ("NIS lookup succeeded. Home server %s\n",
428 DEBUG(4,("Home server: %s\n", server_name));
432 /****************************************************************************
433 Do some standard substitutions in a string.
434 len is the length in bytes of the space allowed in string str. If zero means
435 don't allow expansions.
436 ****************************************************************************/
438 void standard_sub_basic(const char *smb_name, const char *domain_name,
439 char *str, size_t len)
443 if ( (s = alloc_sub_basic( smb_name, domain_name, str )) != NULL ) {
444 strncpy( str, s, len );
450 /****************************************************************************
451 Do some standard substitutions in a string.
452 This function will return an allocated string that have to be freed.
453 ****************************************************************************/
455 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name,
456 const char *domain_name, const char *str)
460 if ( (a = alloc_sub_basic(smb_name, domain_name, str)) == NULL ) {
463 t = talloc_strdup(mem_ctx, a);
468 /****************************************************************************
469 ****************************************************************************/
471 static char *alloc_sub_basic(const char *smb_name, const char *domain_name,
474 char *b, *p, *s, *r, *a_string;
475 fstring pidstr, vnnstr;
476 const char *local_machine_name = get_local_machine_name();
477 TALLOC_CTX *tmp_ctx = NULL;
479 /* workaround to prevent a crash while looking at bug #687 */
482 DEBUG(0,("alloc_sub_basic: NULL source string! This should not happen\n"));
486 a_string = SMB_STRDUP(str);
487 if (a_string == NULL) {
488 DEBUG(0, ("alloc_sub_basic: Out of memory!\n"));
492 tmp_ctx = talloc_stackframe();
494 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
501 r = strlower_talloc(tmp_ctx, smb_name);
505 a_string = realloc_string_sub(a_string, "%U", r);
509 r = talloc_strdup(tmp_ctx, smb_name);
513 pass = Get_Pwnam_alloc(tmp_ctx, r);
515 a_string = realloc_string_sub(
517 gidtoname(pass->pw_gid));
523 r = strupper_talloc(tmp_ctx, domain_name);
527 a_string = realloc_string_sub(a_string, "%D", r);
530 a_string = realloc_string_sub(
532 sub_peeraddr[0] ? sub_peeraddr : "0.0.0.0");
536 a_string = realloc_string_sub(
538 sub_sockaddr[0] ? sub_sockaddr : "0.0.0.0");
541 if ( strncasecmp_m(p, "%LOGONSERVER%", strlen("%LOGONSERVER%")) == 0 ) {
544 if (local_machine_name && *local_machine_name) {
545 a_string = realloc_string_sub(a_string, "%L", local_machine_name);
547 a_string = realloc_string_sub(a_string, "%L", lp_netbios_name());
551 a_string = realloc_string_sub(a_string, "%N", automount_server(smb_name));
554 a_string = realloc_string_sub(a_string, "%M",
555 sub_peername ? sub_peername : "");
558 a_string = realloc_string_sub(a_string, "%R", remote_proto);
561 a_string = realloc_string_sub(a_string, "%T", current_timestring(tmp_ctx, False));
564 a_string = realloc_string_sub(a_string, "%a",
565 get_remote_arch_str());
568 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
569 a_string = realloc_string_sub(a_string, "%d", pidstr);
572 a_string = realloc_string_sub(a_string, "%h", myhostname());
575 a_string = realloc_string_sub(a_string, "%m",
581 a_string = realloc_string_sub(a_string, "%v", samba_version_string());
584 a_string = realloc_string_sub(a_string, "%w", lp_winbind_separator());
587 a_string = realloc_expand_env_var(a_string, p); /* Expand environment variables */
590 slprintf(vnnstr,sizeof(vnnstr)-1, "%u", get_my_vnn());
591 a_string = realloc_string_sub(a_string, "%V", vnnstr);
600 if (a_string == NULL) {
611 TALLOC_FREE(tmp_ctx);
615 /****************************************************************************
616 Do some specific substitutions in a string.
617 This function will return an allocated string that have to be freed.
618 ****************************************************************************/
620 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
621 const char *input_string,
622 const char *username,
628 char *ret_string = NULL;
632 if (!(tmp_ctx = talloc_new(mem_ctx))) {
633 DEBUG(0, ("talloc_new failed\n"));
637 a_string = talloc_strdup(tmp_ctx, input_string);
638 if (a_string == NULL) {
639 DEBUG(0, ("talloc_sub_specified: Out of memory!\n"));
643 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
649 a_string = talloc_string_sub(
650 tmp_ctx, a_string, "%U", username);
653 a_string = talloc_string_sub(
654 tmp_ctx, a_string, "%u", username);
658 a_string = talloc_string_sub(
659 tmp_ctx, a_string, "%G",
662 a_string = talloc_string_sub(
669 a_string = talloc_string_sub(
670 tmp_ctx, a_string, "%g",
673 a_string = talloc_string_sub(
674 tmp_ctx, a_string, "%g", "NO_GROUP");
678 a_string = talloc_string_sub(tmp_ctx, a_string,
682 a_string = talloc_string_sub(
683 tmp_ctx, a_string, "%N",
684 automount_server(username));
691 if (a_string == NULL) {
696 /* Watch out, using "mem_ctx" here, so all intermediate stuff goes
697 * away with the TALLOC_FREE(tmp_ctx) further down. */
699 ret_string = talloc_sub_basic(mem_ctx, username, domain, a_string);
702 TALLOC_FREE(tmp_ctx);
706 /****************************************************************************
707 ****************************************************************************/
709 static char *alloc_sub_advanced(const char *servicename, const char *user,
710 const char *connectpath, gid_t gid,
711 const char *smb_name, const char *domain_name,
714 char *a_string, *ret_string;
717 a_string = SMB_STRDUP(str);
718 if (a_string == NULL) {
719 DEBUG(0, ("alloc_sub_advanced: Out of memory!\n"));
723 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
729 a_string = realloc_string_sub(a_string, "%N", automount_server(user));
733 if ((h = get_user_home_dir(talloc_tos(), user)))
734 a_string = realloc_string_sub(a_string, "%H", h);
739 a_string = realloc_string_sub(a_string, "%P", connectpath);
742 a_string = realloc_string_sub(a_string, "%S", servicename);
745 a_string = realloc_string_sub(a_string, "%g", gidtoname(gid));
748 a_string = realloc_string_sub(a_string, "%u", user);
751 /* Patch from jkf@soton.ac.uk Left the %N (NIS
752 * server name) in standard_sub_basic as it is
753 * a feature for logon servers, hence uses the
754 * username. The %p (NIS server path) code is
755 * here as it is used instead of the default
756 * "path =" string in [homes] and so needs the
757 * service name, not the username. */
759 a_string = realloc_string_sub(a_string, "%p",
760 automount_path(servicename));
768 if (a_string == NULL) {
773 ret_string = alloc_sub_basic(smb_name, domain_name, a_string);
779 * This obviously is inefficient and needs to be merged into
780 * alloc_sub_advanced...
783 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
784 const char *servicename, const char *user,
785 const char *connectpath, gid_t gid,
786 const char *smb_name, const char *domain_name,
791 if (!(a = alloc_sub_advanced(servicename, user, connectpath, gid,
792 smb_name, domain_name, str))) {
795 t = talloc_strdup(mem_ctx, a);
801 void standard_sub_advanced(const char *servicename, const char *user,
802 const char *connectpath, gid_t gid,
803 const char *smb_name, const char *domain_name,
804 char *str, size_t len)
808 s = alloc_sub_advanced(servicename, user, connectpath,
809 gid, smb_name, domain_name, str);
812 strncpy( str, s, len );
817 /****************************************************************************
818 Do some standard substitutions in a string.
819 ****************************************************************************/
821 char *standard_sub_conn(TALLOC_CTX *ctx, connection_struct *conn, const char *str)
823 /* Make clear that we require the optional unix_token and unix_info in the source3 code */
824 SMB_ASSERT(conn->session_info->unix_token);
825 SMB_ASSERT(conn->session_info->unix_info);
826 return talloc_sub_advanced(ctx,
827 lp_servicename(SNUM(conn)),
828 conn->session_info->unix_info->unix_name,
830 conn->session_info->unix_token->gid,
836 /******************************************************************************
837 version of standard_sub_basic() for string lists; uses talloc_sub_basic()
839 *****************************************************************************/
841 bool str_list_sub_basic( char **list, const char *smb_name,
842 const char *domain_name )
844 TALLOC_CTX *ctx = list;
849 tmpstr = talloc_sub_basic(ctx, smb_name, domain_name, s);
851 DEBUG(0,("str_list_sub_basic: "
852 "alloc_sub_basic() return NULL!\n"));