2 Mount helper utility for Linux CIFS VFS (virtual filesystem) client
3 Copyright (C) 2003 Steve French (sfrench@us.ibm.com)
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
27 #include <sys/types.h>
28 #include <sys/mount.h>
30 #include <sys/utsname.h>
31 #include <sys/socket.h>
32 #include <arpa/inet.h>
40 #define MOUNT_CIFS_VERSION_MAJOR "1"
41 #define MOUNT_CIFS_VERSION_MINOR "5"
43 #ifndef MOUNT_CIFS_VENDOR_SUFFIX
44 #define MOUNT_CIFS_VENDOR_SUFFIX ""
53 static int got_password = 0;
54 static int got_user = 0;
55 static int got_domain = 0;
56 static int got_ip = 0;
57 static int got_unc = 0;
58 static int got_uid = 0;
59 static int got_gid = 0;
60 static int free_share_name = 0;
61 static char * user_name = NULL;
62 char * mountpassword = NULL;
68 open nofollow - avoid symlink exposure?
69 get owner of dir see if matches self or if root
70 call system(umount argv) etc.
74 static void mount_cifs_usage(void)
76 printf("\nUsage: %s <remotetarget> <dir> -o <options>\n", thisprogram);
77 printf("\nMount the remote target, specified as a UNC name,");
78 printf(" to a local directory.\n\nOptions:\n");
79 printf("\tuser=<arg>\n\tpass=<arg>\n\tdom=<arg>\n");
80 printf("\nLess commonly used options:");
81 printf("\n\tcredentials=<filename>,guest,perm,noperm,setuids,nosetuids,\n\trw,ro,sep=<char>,iocharset=<codepage>,suid,nosuid,exec,noexec");
82 printf("\n\nOptions not needed for servers supporting CIFS Unix extensions (e.g. most Samba versions):");
83 printf("\n\tuid=<uid>,gid=<gid>,dir_mode=<mode>,file_mode=<mode>");
84 printf("\n\nRarely used options:");
85 printf("\n\tport=<tcpport>,rsize=<size>,wsize=<size>,unc=<unc_name>,ip=<ip_address>,dev,nodev");
86 printf("\n\nOptions are described in more detail in the manual page");
87 printf("\n\tman 8 mount.cifs\n");
88 printf("\nTo display the version number of the mount helper:");
89 printf("\n\t%s -V\n",thisprogram);
92 memset(mountpassword,0,64);
98 /* caller frees username if necessary */
99 static char * getusername(void) {
100 char *username = NULL;
101 struct passwd *password = getpwuid(getuid());
104 username = password->pw_name;
109 char * parse_cifs_url(char * unc_name)
111 printf("\nMounting cifs URL not implemented yet. Attempt to mount %s\n",unc_name);
115 static int open_cred_file(char * file_name)
121 fs = fopen(file_name,"r");
124 line_buf = malloc(4096);
128 while(fgets(line_buf,4096,fs)) {
129 /* parse line from credential file */
131 /* eat leading white space */
132 for(i=0;i<4086;i++) {
133 if((line_buf[i] != ' ') && (line_buf[i] != '\t'))
135 /* if whitespace - skip past it */
137 if (strncasecmp("username",line_buf+i,8) == 0) {
138 temp_val = strchr(line_buf + i,'=');
140 /* go past equals sign */
142 for(length = 0;length<4087;length++) {
143 if(temp_val[length] == '\n')
147 printf("mount.cifs failed due to malformed username in credentials file");
148 memset(line_buf,0,4096);
150 memset(mountpassword,0,64);
155 user_name = calloc(1 + length,1);
156 /* BB adding free of user_name string before exit,
157 not really necessary but would be cleaner */
158 strncpy(user_name,temp_val, length);
161 } else if (strncasecmp("password",line_buf+i,8) == 0) {
162 temp_val = strchr(line_buf+i,'=');
164 /* go past equals sign */
166 for(length = 0;length<65;length++) {
167 if(temp_val[length] == '\n')
171 printf("mount.cifs failed: password in credentials file too long\n");
172 memset(line_buf,0, 4096);
174 memset(mountpassword,0,64);
178 if(mountpassword == NULL) {
179 mountpassword = calloc(65,1);
181 memset(mountpassword,0,64);
183 /* BB add handling for commas in password here */
184 strncpy(mountpassword,temp_val,length);
193 memset(line_buf,0,4096);
199 static int get_password_from_file(int file_descript, char * filename)
205 if(mountpassword == NULL)
206 mountpassword = calloc(65,1);
208 memset(mountpassword, 0, 64);
210 if(filename != NULL) {
211 file_descript = open(filename, O_RDONLY);
212 if(file_descript < 0) {
213 printf("mount.cifs failed. %s attempting to open password file %s\n",
214 strerror(errno),filename);
218 /* else file already open and fd provided */
221 rc = read(file_descript,&c,1);
223 printf("mount.cifs failed. Error %s reading password file\n",strerror(errno));
224 memset(mountpassword,0,64);
226 close(file_descript);
229 if(mountpassword[0] == 0) {
231 printf("\nWarning: null password used since cifs password file empty");
234 } else /* read valid character */ {
235 if((c == 0) || (c == '\n')) {
238 mountpassword[i] = c;
241 if((i == 64) && (verboseflag)) {
242 printf("\nWarning: password longer than 64 characters specified in cifs password file");
245 if(filename != NULL) {
246 close(file_descript);
252 static int parse_options(char * options, int * filesys_flags)
255 char * percent_char = NULL;
257 char * next_keyword = NULL;
266 printf("\n parsing options: %s", options);
268 /* while ((data = strsep(&options, ",")) != NULL) { */
269 while(data != NULL) {
270 /* check if ends with trailing comma */
274 /* format is keyword=value,keyword2=value2,keyword3=value3 etc.) */
275 /* data = next keyword */
276 /* value = next value ie stuff after equal sign */
278 next_keyword = strchr(data,',');
280 /* temporarily null terminate end of keyword=value pair */
287 /* temporarily null terminate keyword to make keyword and value distinct */
288 if ((value = strchr(data, '=')) != NULL) {
293 if (strncmp(data, "users",5) == 0) {
294 if(!value || !*value) {
295 strncpy(data,",,,,,",5);
297 } else if (strncmp(data, "user", 4) == 0) {
298 if (!value || !*value) {
299 if(data[4] == '\0') {
301 printf("\nskipping empty user mount parameter\n");
302 /* remove the parm since it would otherwise be confusing
303 to the kernel code which would think it was a real username */
308 /* BB remove it from mount line so as not to confuse kernel code */
310 printf("username specified with no parameter\n");
311 return 1; /* needs_arg; */
314 if (strnlen(value, 260) < 260) {
316 percent_char = strchr(value,'%');
319 if(mountpassword == NULL)
320 mountpassword = calloc(65,1);
323 printf("\nmount.cifs warning - password specified twice\n");
326 strncpy(mountpassword, percent_char,64);
327 /* remove password from username */
328 while(*percent_char != 0) {
335 printf("username too long\n");
339 } else if (strncmp(data, "pass", 4) == 0) {
340 if (!value || !*value) {
342 printf("\npassword specified twice, ignoring second\n");
345 } else if (strnlen(value, 17) < 17) {
347 printf("\nmount.cifs warning - password specified twice\n");
350 printf("password too long\n");
353 } else if (strncmp(data, "ip", 2) == 0) {
354 if (!value || !*value) {
355 printf("target ip address argument missing");
356 } else if (strnlen(value, 35) < 35) {
358 printf("ip address %s override specified\n",value);
361 printf("ip address too long\n");
364 } else if ((strncmp(data, "unc", 3) == 0)
365 || (strncmp(data, "target", 6) == 0)
366 || (strncmp(data, "path", 4) == 0)) {
367 if (!value || !*value) {
368 printf("invalid path to network resource\n");
369 return 1; /* needs_arg; */
370 } else if(strnlen(value,5) < 5) {
371 printf("UNC name too short");
374 if (strnlen(value, 300) < 300) {
376 if (strncmp(value, "//", 2) == 0) {
378 printf("unc name specified twice, ignoring second\n");
381 } else if (strncmp(value, "\\\\", 2) != 0) {
382 printf("UNC Path does not begin with // or \\\\ \n");
386 printf("unc name specified twice, ignoring second\n");
391 printf("CIFS: UNC name too long\n");
394 } else if ((strncmp(data, "domain", 3) == 0)
395 || (strncmp(data, "workgroup", 5) == 0)) {
396 if (!value || !*value) {
397 printf("CIFS: invalid domain name\n");
398 return 1; /* needs_arg; */
400 if (strnlen(value, 65) < 65) {
403 printf("domain name too long\n");
406 } else if (strncmp(data, "cred", 4) == 0) {
407 if (value && *value) {
408 rc = open_cred_file(value);
410 printf("error %d opening credential file %s\n",rc, value);
414 printf("invalid credential file name specified\n");
417 } else if (strncmp(data, "uid", 3) == 0) {
418 if (value && *value) {
421 } else if (strncmp(data, "gid", 3) == 0) {
422 if (value && *value) {
425 /* fmask and dmask synonyms for people used to smbfs syntax */
426 } else if (strcmp(data, "file_mode") == 0 || strcmp(data, "fmask")==0) {
427 if (!value || !*value) {
428 printf ("Option '%s' requires a numerical argument\n", data);
432 if (value[0] != '0') {
433 printf ("WARNING: '%s' not expressed in octal.\n", data);
436 if (strcmp (data, "fmask") == 0) {
437 printf ("WARNING: CIFS mount option 'fmask' is deprecated. Use 'file_mode' instead.\n");
438 data = "file_mode"; /* BB fix this */
440 } else if (strcmp(data, "dir_mode") == 0 || strcmp(data, "dmask")==0) {
441 if (!value || !*value) {
442 printf ("Option '%s' requires a numerical argument\n", data);
446 if (value[0] != '0') {
447 printf ("WARNING: '%s' not expressed in octal.\n", data);
450 if (strcmp (data, "dmask") == 0) {
451 printf ("WARNING: CIFS mount option 'dmask' is deprecated. Use 'dir_mode' instead.\n");
454 /* the following eight mount options should be
455 stripped out from what is passed into the kernel
456 since these eight options are best passed as the
457 mount flags rather than redundantly to the kernel
458 and could generate spurious warnings depending on the
459 level of the corresponding cifs vfs kernel code */
460 } else if (strncmp(data, "nosuid", 6) == 0) {
461 *filesys_flags |= MS_NOSUID;
462 } else if (strncmp(data, "suid", 4) == 0) {
463 *filesys_flags &= ~MS_NOSUID;
464 } else if (strncmp(data, "nodev", 5) == 0) {
465 *filesys_flags |= MS_NODEV;
466 } else if (strncmp(data, "dev", 3) == 0) {
467 *filesys_flags &= ~MS_NODEV;
468 } else if (strncmp(data, "noexec", 6) == 0) {
469 *filesys_flags |= MS_NOEXEC;
470 } else if (strncmp(data, "exec", 4) == 0) {
471 *filesys_flags &= ~MS_NOEXEC;
472 } else if (strncmp(data, "guest", 5) == 0) {
474 /* remove the parm since it would otherwise be logged by kern */
480 } else if (strncmp(data, "ro", 2) == 0) {
481 *filesys_flags |= MS_RDONLY;
482 } else if (strncmp(data, "rw", 2) == 0) {
483 *filesys_flags &= ~MS_RDONLY;
484 } /* else if (strnicmp(data, "port", 4) == 0) {
485 if (value && *value) {
487 simple_strtoul(value, &value, 0);
489 } else if (strnicmp(data, "rsize", 5) == 0) {
490 if (value && *value) {
492 simple_strtoul(value, &value, 0);
494 } else if (strnicmp(data, "wsize", 5) == 0) {
495 if (value && *value) {
497 simple_strtoul(value, &value, 0);
499 } else if (strnicmp(data, "version", 3) == 0) {
501 printf("CIFS: Unknown mount option %s\n",data);
502 } */ /* nothing to do on those four mount options above.
503 Just pass to kernel and ignore them here */
505 /* move to next option */
506 data = next_keyword+1;
508 /* put overwritten equals sign back */
514 /* put previous overwritten comma back */
523 /* Note that caller frees the returned buffer if necessary */
524 char * parse_server(char ** punc_name)
526 char * unc_name = *punc_name;
527 int length = strnlen(unc_name,1024);
529 char * ipaddress_string = NULL;
530 struct hostent * host_entry;
531 struct in_addr server_ipaddr;
535 printf("mount error: UNC name too long");
538 if (strncasecmp("cifs://",unc_name,7) == 0)
539 return parse_cifs_url(unc_name+7);
540 if (strncasecmp("smb://",unc_name,6) == 0) {
541 return parse_cifs_url(unc_name+6);
545 /* BB add code to find DFS root here */
546 printf("\nMounting the DFS root for domain not implemented yet");
549 if(strncmp(unc_name,"//",2) && strncmp(unc_name,"\\\\",2)) {
550 /* check for nfs syntax ie server:share */
551 share = strchr(unc_name,':');
554 *punc_name = malloc(length+3);
556 strncpy((*punc_name)+2,unc_name,length);
557 unc_name = *punc_name;
558 unc_name[length+2] = 0;
559 goto continue_unc_parsing;
561 printf("mount error: improperly formatted UNC name.");
562 printf(" %s does not begin with \\\\ or //\n",unc_name);
566 continue_unc_parsing:
570 if ((share = strchr(unc_name, '/')) ||
571 (share = strchr(unc_name,'\\'))) {
572 *share = 0; /* temporarily terminate the string */
575 host_entry = gethostbyname(unc_name);
577 *(share - 1) = '/'; /* put the slash back */
580 printf("ip address specified explicitly\n");
583 if(host_entry == NULL) {
584 printf("mount error: could not find target server. TCP name %s not found ", unc_name);
585 printf(" rc = %d\n",rc);
588 /* BB should we pass an alternate version of the share name as Unicode */
589 /* BB what about ipv6? BB */
590 /* BB add retries with alternate servers in list */
592 memcpy(&server_ipaddr.s_addr, host_entry->h_addr, 4);
594 ipaddress_string = inet_ntoa(server_ipaddr);
595 if(ipaddress_string == NULL) {
596 printf("mount error: could not get valid ip address for target server\n");
599 return ipaddress_string;
602 /* BB add code to find DFS root (send null path on get DFS Referral to specified server here */
603 printf("Mounting the DFS root for a particular server not implemented yet\n");
610 static struct option longopts[] = {
611 { "all", 0, NULL, 'a' },
612 { "help",0, NULL, 'h' },
613 { "move",0, NULL, 'm' },
614 { "bind",0, NULL, 'b' },
615 { "read-only", 0, NULL, 'r' },
616 { "ro", 0, NULL, 'r' },
617 { "verbose", 0, NULL, 'v' },
618 { "version", 0, NULL, 'V' },
619 { "read-write", 0, NULL, 'w' },
620 { "rw", 0, NULL, 'w' },
621 { "options", 1, NULL, 'o' },
622 { "type", 1, NULL, 't' },
623 { "rsize",1, NULL, 'R' },
624 { "wsize",1, NULL, 'W' },
625 { "uid", 1, NULL, '1'},
626 { "gid", 1, NULL, '2'},
627 { "user",1,NULL,'u'},
628 { "username",1,NULL,'u'},
630 { "domain",1,NULL,'d'},
631 { "password",1,NULL,'p'},
632 { "pass",1,NULL,'p'},
633 { "credentials",1,NULL,'c'},
634 { "port",1,NULL,'P'},
635 /* { "uuid",1,NULL,'U'}, */ /* BB unimplemented */
639 int main(int argc, char ** argv)
642 int flags = MS_MANDLOCK; /* no need to set legacy MS_MGC_VAL */
643 char * orgoptions = NULL;
644 char * share_name = NULL;
645 char * domain_name = NULL;
646 char * ipaddr = NULL;
650 char * resolved_path;
661 struct utsname sysinfo;
662 struct mntent mountent;
665 /* setlocale(LC_ALL, "");
666 bindtextdomain(PACKAGE, LOCALEDIR);
667 textdomain(PACKAGE); */
670 thisprogram = argv[0];
672 if(thisprogram == NULL)
673 thisprogram = "mount.cifs";
676 /* BB add workstation name and domain and pass down */
678 /* #ifdef _GNU_SOURCE
679 printf(" node: %s machine: %s sysname %s domain %s\n", sysinfo.nodename,sysinfo.machine,sysinfo.sysname,sysinfo.domainname);
682 share_name = argv[1];
683 mountpoint = argv[2];
685 /* add sharename in opts string as unc= parm */
687 while ((c = getopt_long (argc, argv, "afFhilL:no:O:rsSU:vVwt:",
688 longopts, NULL)) != -1) {
690 /* No code to do the following options yet */
692 list_with_volumelabel = 1;
695 volumelabel = optarg;
715 orgoptions = strdup(optarg);
717 case 'r': /* mount readonly */
727 printf ("mount.cifs version: %s.%s%s\n",
728 MOUNT_CIFS_VERSION_MAJOR,
729 MOUNT_CIFS_VERSION_MINOR,
730 MOUNT_CIFS_VENDOR_SUFFIX);
732 memset(mountpassword,0,64);
739 rsize = atoi(optarg) ;
742 wsize = atoi(optarg);
755 domain_name = optarg;
758 if(mountpassword == NULL)
759 mountpassword = calloc(65,1);
762 strncpy(mountpassword,optarg,64);
766 get_password_from_file(0 /* stdin */,NULL);
771 printf("unknown mount option %c\n",c);
780 if (getenv("PASSWD")) {
781 if(mountpassword == NULL)
782 mountpassword = calloc(65,1);
784 strncpy(mountpassword,getenv("PASSWD"),64);
787 } else if (getenv("PASSWD_FD")) {
788 get_password_from_file(atoi(getenv("PASSWD_FD")),NULL);
789 } else if (getenv("PASSWD_FILE")) {
790 get_password_from_file(0, getenv("PASSWD_FILE"));
793 if (orgoptions && parse_options(orgoptions, &flags))
796 ipaddr = parse_server(&share_name);
797 if((ipaddr == NULL) && (got_ip == 0)) {
798 printf("No ip address specified and hostname not found\n");
803 /* BB save off path and pop after mount returns? */
804 resolved_path = malloc(PATH_MAX+1);
806 /* Note that if we can not canonicalize the name, we get
807 another chance to see if it is valid when we chdir to it */
808 if (realpath(mountpoint, resolved_path)) {
809 mountpoint = resolved_path;
812 if(chdir(mountpoint)) {
813 printf("mount error: can not change directory into mount target %s\n",mountpoint);
817 if(stat (".", &statbuf)) {
818 printf("mount error: mount point %s does not exist\n",mountpoint);
822 if (S_ISDIR(statbuf.st_mode) == 0) {
823 printf("mount error: mount point %s is not a directory\n",mountpoint);
827 if((getuid() != 0) && (geteuid() == 0)) {
828 if((statbuf.st_uid == getuid()) && (S_IRWXU == (statbuf.st_mode & S_IRWXU))) {
829 #ifndef CIFS_ALLOW_USR_SUID
830 /* Do not allow user mounts to control suid flag
831 for mount unless explicitly built that way */
832 flags |= MS_NOSUID | MS_NODEV;
835 printf("mount error: permission denied or not superuser and mount.cifs not installed SUID\n");
841 user_name = getusername();
843 if(got_password == 0) {
844 mountpassword = getpass("Password: "); /* BB obsolete */
847 /* FIXME launch daemon (handles dfs name resolution and credential change)
848 remember to clear parms and overwrite password field before launching */
850 optlen = strlen(orgoptions);
855 optlen += strlen(share_name) + 4;
857 optlen += strlen(user_name) + 6;
859 optlen += strlen(ipaddr) + 4;
861 optlen += strlen(mountpassword) + 6;
862 options = malloc(optlen + 10);
864 if(options == NULL) {
865 printf("Could not allocate memory for mount options\n");
871 strncat(options,"unc=",4);
872 strcat(options,share_name);
873 /* scan backwards and reverse direction of slash */
874 temp = strrchr(options, '/');
875 if(temp > options + 6)
878 strncat(options,",ip=",4);
879 strcat(options,ipaddr);
882 strncat(options,",user=",6);
883 strcat(options,user_name);
886 strncat(options,",pass=",6);
887 strcat(options,mountpassword);
889 strncat(options,",ver=",5);
890 strcat(options,MOUNT_CIFS_VERSION_MAJOR);
894 strcat(options,orgoptions);
897 printf("\nmount.cifs kernel mount options %s \n",options);
898 if(mount(share_name, mountpoint, "cifs", flags, options)) {
899 /* remember to kill daemon on error */
902 printf("mount failed but no error number set\n");
905 printf("mount error: cifs filesystem not supported by the system\n");
908 printf("mount error %d = %s\n",errno,strerror(errno));
910 printf("Refer to the mount.cifs(8) manual page (e.g.man mount.cifs)\n");
912 memset(mountpassword,0,64);
916 pmntfile = setmntent(MOUNTED, "a+");
918 mountent.mnt_fsname = share_name;
919 mountent.mnt_dir = mountpoint;
920 mountent.mnt_type = "cifs";
921 mountent.mnt_opts = malloc(220);
922 if(mountent.mnt_opts) {
923 char * mount_user = getusername();
924 memset(mountent.mnt_opts,0,200);
925 if(flags & MS_RDONLY)
926 strcat(mountent.mnt_opts,"ro");
928 strcat(mountent.mnt_opts,"rw");
929 if(flags & MS_MANDLOCK)
930 strcat(mountent.mnt_opts,",mand");
932 strcat(mountent.mnt_opts,",nomand");
933 if(flags & MS_NOEXEC)
934 strcat(mountent.mnt_opts,",noexec");
935 if(flags & MS_NOSUID)
936 strcat(mountent.mnt_opts,",nosuid");
938 strcat(mountent.mnt_opts,",nodev");
939 if(flags & MS_SYNCHRONOUS)
940 strcat(mountent.mnt_opts,",synch");
943 strcat(mountent.mnt_opts,",user=");
944 strcat(mountent.mnt_opts,mount_user);
949 mountent.mnt_freq = 0;
950 mountent.mnt_passno = 0;
951 rc = addmntent(pmntfile,&mountent);
953 if(mountent.mnt_opts)
954 free(mountent.mnt_opts);
956 printf("could not update mount table\n");
960 memset(mountpassword,0,64);
965 memset(options,0,optlen);
970 memset(orgoptions,0,orgoptlen);
977 if(free_share_name) {