2 Unix SMB/Netbios implementation.
4 MSDfs services for Samba
5 Copyright (C) Shirish Kalele 2000
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 fstring local_machine;
26 extern uint32 global_client_caps;
28 /**********************************************************************
29 Parse the pathname of the form \hostname\service\reqpath
30 into the dfs_path structure
31 **********************************************************************/
33 static BOOL parse_dfs_path(char* pathname, struct dfs_path* pdp)
35 pstring pathname_local;
38 pstrcpy(pathname_local,pathname);
39 p = temp = pathname_local;
43 trim_string(temp,"\\","\\");
44 DEBUG(10,("temp in parse_dfs_path: .%s. after trimming \\'s\n",temp));
47 /* parse out hostname */
48 p = strchr(temp,'\\');
52 pstrcpy(pdp->hostname,temp);
53 DEBUG(10,("hostname: %s\n",pdp->hostname));
55 /* parse out servicename */
57 p = strchr(temp,'\\');
59 pstrcpy(pdp->servicename,temp);
60 pdp->reqpath[0] = '\0';
64 pstrcpy(pdp->servicename,temp);
65 DEBUG(10,("servicename: %s\n",pdp->servicename));
68 pstrcpy(pdp->reqpath, p+1);
71 if (*p == '\\') *p = '/';
75 DEBUG(10,("rest of the path: %s\n",pdp->reqpath));
79 /********************************************************
80 Fake up a connection struct for the VFS layer.
81 *********************************************************/
83 static BOOL create_conn_struct( connection_struct *conn, int snum, char *path)
87 conn->connectpath = path;
88 pstring_sub(conn->connectpath , "%S", lp_servicename(snum));
90 if (!smbd_vfs_init(conn)) {
91 DEBUG(0,("create_conn_struct: smbd_vfs_init failed.\n"));
98 /**********************************************************************
99 Parse the contents of a symlink to verify if it is an msdfs referral
100 A valid referral is of the form: msdfs:server1\share1,server2\share2
101 **********************************************************************/
102 static BOOL parse_symlink(char* buf,struct referral** preflist,
107 char* alt_path[MAX_REFERRAL_COUNT];
109 struct referral* reflist;
113 prot = strtok(temp,":");
115 if (!strequal(prot, "msdfs"))
118 /* No referral list requested. Just yes/no. */
122 /* parse out the alternate paths */
123 while(((alt_path[count] = strtok(NULL,",")) != NULL) && count<MAX_REFERRAL_COUNT)
126 DEBUG(10,("parse_symlink: count=%d\n", count));
128 reflist = *preflist = (struct referral*) malloc(count * sizeof(struct referral));
129 if(reflist == NULL) {
130 DEBUG(0,("parse_symlink: Malloc failed!\n"));
134 for(i=0;i<count;i++) {
135 /* replace / in the alternate path by a \ */
136 char* p = strchr(alt_path[i],'/');
140 pstrcpy(reflist[i].alternate_path, "\\");
141 pstrcat(reflist[i].alternate_path, alt_path[i]);
142 reflist[i].proximity = 0;
143 reflist[i].ttl = REFERRAL_TTL;
144 DEBUG(10, ("parse_symlink: Created alt path: %s\n", reflist[i].alternate_path));
153 /**********************************************************************
154 Returns true if the unix path is a valid msdfs symlink
155 **********************************************************************/
156 BOOL is_msdfs_link(connection_struct* conn, char* path,
157 struct referral** reflistp, int* refcnt,
158 SMB_STRUCT_STAT *sbufp)
162 int referral_len = 0;
172 if (conn->vfs_ops.lstat(conn, path, sbufp) != 0) {
173 DEBUG(5,("is_msdfs_link: %s does not exist.\n",path));
177 if (S_ISLNK(sbufp->st_mode)) {
178 /* open the link and read it */
179 referral_len = conn->vfs_ops.readlink(conn, path, referral,
181 if (referral_len == -1) {
182 DEBUG(0,("is_msdfs_link: Error reading msdfs link %s: %s\n", path, strerror(errno)));
186 referral[referral_len] = '\0';
187 DEBUG(5,("is_msdfs_link: %s -> %s\n",path,referral));
188 if (parse_symlink(referral, reflistp, refcnt))
194 /*****************************************************************
195 Used by other functions to decide if a dfs path is remote,
196 and to get the list of referred locations for that remote path.
198 findfirst_flag: For findfirsts, dfs links themselves are not
199 redirected, but paths beyond the links are. For normal smb calls,
200 even dfs links need to be redirected.
202 self_referralp: clients expect a dfs referral for the same share when
203 they request referrals for dfs roots on a server.
205 consumedcntp: how much of the dfs path is being redirected. the client
206 should try the remaining path on the redirected server.
207 *****************************************************************/
208 static BOOL resolve_dfs_path(char* dfspath, struct dfs_path* dp,
209 connection_struct* conn,
211 struct referral** reflistpp, int* refcntp,
212 BOOL* self_referralp, int* consumedcntp)
220 DEBUG(1,("resolve_dfs_path: NULL dfs_path* or NULL connection_struct*!\n"));
224 if (dp->reqpath[0] == '\0') {
225 if (self_referralp) {
226 DEBUG(6,("resolve_dfs_path: self-referral. returning False\n"));
227 *self_referralp = True;
232 /* check if need to redirect */
233 fstrcpy(localpath, conn->connectpath);
234 fstrcat(localpath, "/");
235 fstrcat(localpath, dp->reqpath);
236 if (is_msdfs_link(conn, localpath, reflistpp, refcntp, NULL)) {
237 if (findfirst_flag) {
238 DEBUG(6,("resolve_dfs_path (FindFirst) No redirection "
239 "for dfs link %s.\n", dfspath));
242 DEBUG(6,("resolve_dfs_path: %s resolves to a valid Dfs link.\n",
245 *consumedcntp = strlen(dfspath);
250 /* also redirect if the parent directory is a dfs link */
251 fstrcpy(reqpath, dp->reqpath);
252 p = strrchr(reqpath, '/');
255 fstrcpy(localpath, conn->connectpath);
256 fstrcat(localpath, "/");
257 fstrcat(localpath, reqpath);
258 if (is_msdfs_link(conn, localpath, reflistpp, refcntp, NULL)) {
259 DEBUG(4, ("resolve_dfs_path: Redirecting %s because parent %s is dfs link\n", dfspath, localpath));
261 /* To find the path consumed, we truncate the original
262 DFS pathname passed to use to remove the last
263 component. The length of the resulting string is
269 pstrcpy(buf, dfspath);
270 trim_string(buf, NULL, "\\");
271 q = strrchr(buf, '\\');
274 *consumedcntp = strlen(buf);
275 DEBUG(10, ("resolve_dfs_path: Path consumed: %d\n", *consumedcntp));
285 /*****************************************************************
286 Decides if a dfs pathname should be redirected or not.
287 If not, the pathname is converted to a tcon-relative local unix path
288 *****************************************************************/
289 BOOL dfs_redirect(char* pathname, connection_struct* conn,
294 if (!conn || !pathname)
297 parse_dfs_path(pathname, &dp);
299 /* if dfs pathname for a non-dfs share, convert to tcon-relative
300 path and return false */
301 if (!lp_msdfs_root(SNUM(conn))) {
302 fstrcpy(pathname, dp.reqpath);
306 if (strcasecmp(dp.servicename, lp_servicename(SNUM(conn)) ) != 0)
309 if (resolve_dfs_path(pathname, &dp, conn, findfirst_flag,
310 NULL, NULL, NULL, NULL)) {
311 DEBUG(3,("dfs_redirect: Redirecting %s\n", pathname));
314 DEBUG(3,("dfs_redirect: Not redirecting %s.\n", pathname));
316 /* Form non-dfs tcon-relative path */
317 fstrcpy(pathname, dp.reqpath);
318 DEBUG(3,("dfs_redirect: Path converted to non-dfs path %s\n",
326 /**********************************************************************
327 Gets valid referrals for a dfs path and fills up the
328 junction_map structure
329 **********************************************************************/
330 BOOL get_referred_path(char *pathname, struct junction_map* jn,
331 int* consumedcntp, BOOL* self_referralp)
335 struct connection_struct conns;
336 struct connection_struct* conn = &conns;
340 BOOL self_referral = False;
342 if (!pathname || !jn)
346 *self_referralp = False;
348 self_referralp = &self_referral;
350 parse_dfs_path(pathname, &dp);
352 /* Verify hostname in path */
353 if (local_machine && (strcasecmp(local_machine, dp.hostname) != 0)) {
355 /* Hostname mismatch, check if one of our IP addresses */
356 if (!ismyip(*interpret_addr2(dp.hostname))) {
358 DEBUG(3, ("get_referred_path: Invalid hostname %s in path %s\n",
359 dp.hostname, pathname));
364 pstrcpy(jn->service_name, dp.servicename);
365 pstrcpy(jn->volume_name, dp.reqpath);
367 /* Verify the share is a dfs root */
368 snum = lp_servicenumber(jn->service_name);
370 if ((snum = find_service(jn->service_name)) < 0)
374 pstrcpy(conn_path, lp_pathname(snum));
375 if (!create_conn_struct(conn, snum, conn_path))
378 if (!lp_msdfs_root(SNUM(conn))) {
379 DEBUG(3,("get_referred_path: .%s. in dfs path %s is not a dfs root.\n",
380 dp.servicename, pathname));
384 if (*lp_msdfs_proxy(snum) != '\0') {
385 struct referral* ref;
386 jn->referral_count = 1;
387 if ((ref = (struct referral*) malloc(sizeof(struct referral)))
389 DEBUG(0, ("malloc failed for referral\n"));
393 pstrcpy(ref->alternate_path, lp_msdfs_proxy(snum));
394 if (dp.reqpath[0] != '\0')
395 pstrcat(ref->alternate_path, dp.reqpath);
397 ref->ttl = REFERRAL_TTL;
398 jn->referral_list = ref;
400 *consumedcntp = strlen(pathname);
404 /* If not remote & not a self referral, return False */
405 if (!resolve_dfs_path(pathname, &dp, conn, False,
406 &jn->referral_list, &jn->referral_count,
407 self_referralp, consumedcntp)) {
408 if (!*self_referralp) {
409 DEBUG(3,("get_referred_path: No valid referrals for path %s\n", pathname));
414 /* if self_referral, fill up the junction map */
415 if (*self_referralp) {
416 struct referral* ref;
417 jn->referral_count = 1;
418 if((ref = (struct referral*) malloc(sizeof(struct referral)))
420 DEBUG(0,("malloc failed for referral\n"));
424 pstrcpy(ref->alternate_path,pathname);
426 ref->ttl = REFERRAL_TTL;
427 jn->referral_list = ref;
429 *consumedcntp = strlen(pathname);
435 static int setup_ver2_dfs_referral(char* pathname, char** ppdata,
436 struct junction_map* junction,
440 char* pdata = *ppdata;
442 unsigned char uni_requestedpath[1024];
443 int uni_reqpathoffset1,uni_reqpathoffset2;
445 int requestedpathlen=0;
450 DEBUG(10,("setting up version2 referral\nRequested path:\n"));
452 requestedpathlen = rpcstr_push(uni_requestedpath, pathname, -1,
455 dump_data(10, (const char *) uni_requestedpath,requestedpathlen);
457 DEBUG(10,("ref count = %u\n",junction->referral_count));
459 uni_reqpathoffset1 = REFERRAL_HEADER_SIZE +
460 VERSION2_REFERRAL_SIZE * junction->referral_count;
462 uni_reqpathoffset2 = uni_reqpathoffset1 + requestedpathlen;
464 uni_curroffset = uni_reqpathoffset2 + requestedpathlen;
466 reply_size = REFERRAL_HEADER_SIZE + VERSION2_REFERRAL_SIZE*junction->referral_count +
467 2 * requestedpathlen;
468 DEBUG(10,("reply_size: %u\n",reply_size));
470 /* add up the unicode lengths of all the referral paths */
471 for(i=0;i<junction->referral_count;i++) {
472 DEBUG(10,("referral %u : %s\n",i,junction->referral_list[i].alternate_path));
473 reply_size += (strlen(junction->referral_list[i].alternate_path)+1)*2;
476 DEBUG(10,("reply_size = %u\n",reply_size));
477 /* add the unexplained 0x16 bytes */
480 pdata = Realloc(pdata,reply_size);
482 DEBUG(0,("malloc failed for Realloc!\n"));
487 /* copy in the dfs requested paths.. required for offset calculations */
488 memcpy(pdata+uni_reqpathoffset1,uni_requestedpath,requestedpathlen);
489 memcpy(pdata+uni_reqpathoffset2,uni_requestedpath,requestedpathlen);
491 /* create the header */
492 SSVAL(pdata,0,consumedcnt * 2); /* path consumed */
493 SSVAL(pdata,2,junction->referral_count); /* number of referral in this pkt */
495 SIVAL(pdata,4,DFSREF_REFERRAL_SERVER | DFSREF_STORAGE_SERVER);
497 SIVAL(pdata,4,DFSREF_STORAGE_SERVER);
500 /* add the referral elements */
501 for(i=0;i<junction->referral_count;i++) {
502 struct referral* ref = &(junction->referral_list[i]);
505 SSVAL(pdata,offset,2); /* version 2 */
506 SSVAL(pdata,offset+2,VERSION2_REFERRAL_SIZE);
508 SSVAL(pdata,offset+4,1);
510 SSVAL(pdata,offset+4,0);
511 SSVAL(pdata,offset+6,0); /* ref_flags :use path_consumed bytes? */
512 SIVAL(pdata,offset+8,ref->proximity);
513 SIVAL(pdata,offset+12,ref->ttl);
515 SSVAL(pdata,offset+16,uni_reqpathoffset1-offset);
516 SSVAL(pdata,offset+18,uni_reqpathoffset2-offset);
517 /* copy referred path into current offset */
518 unilen = rpcstr_push(pdata+uni_curroffset, ref->alternate_path,
521 SSVAL(pdata,offset+20,uni_curroffset-offset);
523 uni_curroffset += unilen;
524 offset += VERSION2_REFERRAL_SIZE;
526 /* add in the unexplained 22 (0x16) bytes at the end */
527 memset(pdata+uni_curroffset,'\0',0x16);
531 static int setup_ver3_dfs_referral(char* pathname, char** ppdata,
532 struct junction_map* junction,
536 char* pdata = *ppdata;
538 unsigned char uni_reqpath[1024];
539 int uni_reqpathoffset1, uni_reqpathoffset2;
546 DEBUG(10,("setting up version3 referral\n"));
548 reqpathlen = rpcstr_push(uni_reqpath, pathname, -1, STR_TERMINATE);
550 dump_data(10, (char *) uni_reqpath,reqpathlen);
552 uni_reqpathoffset1 = REFERRAL_HEADER_SIZE + VERSION3_REFERRAL_SIZE * junction->referral_count;
553 uni_reqpathoffset2 = uni_reqpathoffset1 + reqpathlen;
554 reply_size = uni_curroffset = uni_reqpathoffset2 + reqpathlen;
556 for(i=0;i<junction->referral_count;i++) {
557 DEBUG(10,("referral %u : %s\n",i,junction->referral_list[i].alternate_path));
558 reply_size += (strlen(junction->referral_list[i].alternate_path)+1)*2;
561 pdata = Realloc(pdata,reply_size);
563 DEBUG(0,("version3 referral setup: malloc failed for Realloc!\n"));
568 /* create the header */
569 SSVAL(pdata,0,consumedcnt * 2); /* path consumed */
570 SSVAL(pdata,2,junction->referral_count); /* number of referral */
572 SIVAL(pdata,4,DFSREF_REFERRAL_SERVER | DFSREF_STORAGE_SERVER);
574 SIVAL(pdata,4,DFSREF_STORAGE_SERVER);
576 /* copy in the reqpaths */
577 memcpy(pdata+uni_reqpathoffset1,uni_reqpath,reqpathlen);
578 memcpy(pdata+uni_reqpathoffset2,uni_reqpath,reqpathlen);
581 for(i=0;i<junction->referral_count;i++) {
582 struct referral* ref = &(junction->referral_list[i]);
585 SSVAL(pdata,offset,3); /* version 3 */
586 SSVAL(pdata,offset+2,VERSION3_REFERRAL_SIZE);
588 SSVAL(pdata,offset+4,1);
590 SSVAL(pdata,offset+4,0);
592 SSVAL(pdata,offset+6,0); /* ref_flags :use path_consumed bytes? */
593 SIVAL(pdata,offset+8,ref->ttl);
595 SSVAL(pdata,offset+12,uni_reqpathoffset1-offset);
596 SSVAL(pdata,offset+14,uni_reqpathoffset2-offset);
597 /* copy referred path into current offset */
598 unilen = rpcstr_push(pdata+uni_curroffset,ref->alternate_path,
599 -1, STR_UNICODE | STR_TERMINATE);
600 SSVAL(pdata,offset+16,uni_curroffset-offset);
601 /* copy 0x10 bytes of 00's in the ServiceSite GUID */
602 memset(pdata+offset+18,'\0',16);
604 uni_curroffset += unilen;
605 offset += VERSION3_REFERRAL_SIZE;
610 /******************************************************************
611 * Set up the Dfs referral for the dfs pathname
612 ******************************************************************/
614 int setup_dfs_referral(char* pathname, int max_referral_level, char** ppdata)
616 struct junction_map junction;
618 BOOL self_referral = False;
621 char *pathnamep = pathname;
623 ZERO_STRUCT(junction);
625 /* get the junction entry */
629 /* Trim pathname sent by client so it begins with only one backslash.
630 Two backslashes confuse some dfs clients
632 while (strlen(pathnamep) > 1 && pathnamep[0] == '\\'
633 && pathnamep[1] == '\\')
636 pstrcpy(buf, pathnamep);
637 if (!get_referred_path(buf, &junction, &consumedcnt,
643 pathnamep[consumedcnt] = '\0';
645 if( DEBUGLVL( 3 ) ) {
647 dbgtext("setup_dfs_referral: Path %s to alternate path(s):",pathnamep);
648 for(i=0;i<junction.referral_count;i++)
649 dbgtext(" %s",junction.referral_list[i].alternate_path);
654 /* create the referral depeding on version */
655 DEBUG(10,("max_referral_level :%d\n",max_referral_level));
656 if(max_referral_level<2 || max_referral_level>3)
657 max_referral_level = 2;
659 switch(max_referral_level) {
662 reply_size = setup_ver2_dfs_referral(pathnamep, ppdata, &junction,
663 consumedcnt, self_referral);
664 SAFE_FREE(junction.referral_list);
669 reply_size = setup_ver3_dfs_referral(pathnamep, ppdata, &junction,
670 consumedcnt, self_referral);
671 SAFE_FREE(junction.referral_list);
676 DEBUG(0,("setup_dfs_referral: Invalid dfs referral version: %d\n", max_referral_level));
681 DEBUG(10,("DFS Referral pdata:\n"));
682 dump_data(10,*ppdata,reply_size);
686 /**********************************************************************
687 The following functions are called by the NETDFS RPC pipe functions
688 **********************************************************************/
690 /**********************************************************************
691 Creates a junction structure from a Dfs pathname
692 **********************************************************************/
693 BOOL create_junction(char* pathname, struct junction_map* jn)
697 parse_dfs_path(pathname,&dp);
699 /* check if path is dfs : validate first token */
700 if (local_machine && (strcasecmp(local_machine,dp.hostname)!=0)) {
702 /* Hostname mismatch, check if one of our IP addresses */
703 if (!ismyip(*interpret_addr2(dp.hostname))) {
704 DEBUG(4,("create_junction: Invalid hostname %s in dfs path %s\n",
705 dp.hostname, pathname));
710 /* Check for a non-DFS share */
711 if(!lp_msdfs_root(lp_servicenumber(dp.servicename))) {
712 DEBUG(4,("create_junction: %s is not an msdfs root.\n",
717 pstrcpy(jn->service_name,dp.servicename);
718 pstrcpy(jn->volume_name,dp.reqpath);
722 /**********************************************************************
723 Forms a valid Unix pathname from the junction
724 **********************************************************************/
726 static BOOL junction_to_local_path(struct junction_map* jn, char* path,
727 int max_pathlen, connection_struct *conn)
735 snum = lp_servicenumber(jn->service_name);
739 safe_strcpy(path, lp_pathname(snum), max_pathlen-1);
740 safe_strcat(path, "/", max_pathlen-1);
741 strlower(jn->volume_name);
742 safe_strcat(path, jn->volume_name, max_pathlen-1);
744 pstrcpy(conn_path, lp_pathname(snum));
745 if (!create_conn_struct(conn, snum, conn_path))
751 BOOL create_msdfs_link(struct junction_map* jn, BOOL exists)
755 connection_struct conns;
756 connection_struct *conn = &conns;
758 BOOL insert_comma = False;
760 if(!junction_to_local_path(jn, path, sizeof(path), conn))
763 /* form the msdfs_link contents */
764 pstrcpy(msdfs_link, "msdfs:");
765 for(i=0; i<jn->referral_count; i++) {
766 char* refpath = jn->referral_list[i].alternate_path;
768 trim_string(refpath, "\\", "\\");
769 if(*refpath == '\0') {
771 insert_comma = False;
774 if (i > 0 && insert_comma)
775 pstrcat(msdfs_link, ",");
777 pstrcat(msdfs_link, refpath);
783 DEBUG(5,("create_msdfs_link: Creating new msdfs link: %s -> %s\n", path, msdfs_link));
786 if(conn->vfs_ops.unlink(conn,path)!=0)
789 if(conn->vfs_ops.symlink(conn, msdfs_link, path) < 0) {
790 DEBUG(1,("create_msdfs_link: symlink failed %s -> %s\nError: %s\n",
791 path, msdfs_link, strerror(errno)));
797 BOOL remove_msdfs_link(struct junction_map* jn)
800 connection_struct conns;
801 connection_struct *conn = &conns;
803 if(!junction_to_local_path(jn, path, sizeof(path), conn))
806 if(conn->vfs_ops.unlink(conn, path)!=0)
812 static BOOL form_junctions(int snum, struct junction_map* jn, int* jn_count)
817 pstring connect_path;
818 char* service_name = lp_servicename(snum);
819 connection_struct conns;
820 connection_struct *conn = &conns;
821 struct referral *ref = NULL;
823 pstrcpy(connect_path,lp_pathname(snum));
825 if(*connect_path == '\0')
829 * Fake up a connection struct for the VFS layer.
832 if (!create_conn_struct(conn, snum, connect_path))
835 /* form a junction for the msdfs root - convention
836 DO NOT REMOVE THIS: NT clients will not work with us
837 if this is not present
839 pstrcpy(jn[cnt].service_name, service_name);
840 jn[cnt].volume_name[0] = '\0';
841 jn[cnt].referral_count = 1;
843 ref = jn[cnt].referral_list
844 = (struct referral*) malloc(sizeof(struct referral));
845 if (jn[cnt].referral_list == NULL) {
846 DEBUG(0, ("Malloc failed!\n"));
851 ref->ttl = REFERRAL_TTL;
852 if (*lp_msdfs_proxy(snum) != '\0') {
853 pstrcpy(ref->alternate_path, lp_msdfs_proxy(snum));
858 slprintf(ref->alternate_path, sizeof(pstring)-1,
859 "\\\\%s\\%s", local_machine, service_name);
862 /* Now enumerate all dfs links */
863 dirp = conn->vfs_ops.opendir(conn, connect_path);
867 while((dname = vfs_readdirname(conn, dirp)) != NULL) {
870 pstrcpy(pathreal, connect_path);
871 pstrcat(pathreal, "/");
872 pstrcat(pathreal, dname);
874 if (is_msdfs_link(conn, pathreal, &(jn[cnt].referral_list),
875 &(jn[cnt].referral_count), NULL)) {
876 pstrcpy(jn[cnt].service_name, service_name);
877 pstrcpy(jn[cnt].volume_name, dname);
882 conn->vfs_ops.closedir(conn,dirp);
887 int enum_msdfs_links(struct junction_map* jn)
895 for(i=0;*lp_servicename(i);i++) {
897 form_junctions(i,jn,&jn_count);