README

   1 usmb - Unprivileged mounting of SMB/CIFS shares via FUSE
   2 ========================================================
   3
   4 Acknowledgements
   5 ----------------
   6
   7 Jonathan Schultz (Email firstname at imatix.com) provided a patch
   8 to fix the display of file modification times.
   9
  10 Stijn Hoop (Email firstname at sandcat.nl) provided a patch to fix
  11 a compilation problem on 64-bit platforms.
  12
  13
  14 Introduction
  15 ------------
  16
  17 usmb lets you mount SMB/CIFS shares via FUSE, in the vein of the Map Network
  18 Drive functionality in Windows.
  19
  20 The two existing FUSE filesystems that I know of (SMB for FUSE and fusesmb)
  21 mimic Windows' Network Neighbourhood by letting you browse hosts and shares.
  22 This means that you must run a NetBIOS name server and can't see hosts that
  23 aren't advertised via NetBIOS.
  24
  25 You can build [u]mount.cifs in the Samba distribution and install them
  26 setuid root, but that has its own set of security implications. In any
  27 case there's no need for network filesystem code to be in the kernel:
  28 bugs could lead to remotely exploitable kernel vulnerabilities. Running
  29 the SMB client code in user space as an unprivileged user limits the
  30 potential damage due to bugs.
  31
  32 A user space implementation will be slower than a kernel filesystem since
  33 the data must be copied in and out of the fuse process' context as well as
  34 in/out of the user process' context. Mitigating factors are:
  35
  36 1. Increased security.
  37 2. Containment of bugs.
  38 3. Throughput is more likely to be limited by network bandwidth rather than
  39    local memory copying.
  40 4. The client filesystem code can be upgraded/fixed without kernel changes.
  41
  42
  43 Pre-Requisites
  44 --------------
  45
  46 glib 2.6 or later - www.gtk.org.
  47 libxml2 - ftp.gnome.org.
  48 FUSE 2.6 or later - fuse.sourgeforge.net.
  49 libsmbclient 3.0 (part of Samba) - www.samba.org.
  50
  51
  52 Installation
  53 ------------
  54
  55 Sorry, no autoconf yet.
  56 You need GNU sed.
  57 Edit the Makefile with brain engaged.
  58 Run make.
  59 Run make install (maybe as root).
  60
  61
  62 Configuration
  63 -------------
  64
  65 You need an XML configuration file - ${HOME}/.usmb.conf by default. There's an
  66 example in doc/usmb.conf.
  67
  68 There are two main elements: credentials and mounts.
  69
  70 Credentials:
  71
  72   <credentials id="some_id">
  73     <domain>mydomain</domain>
  74     <username>username</username>
  75     <password>password</password>
  76   </credentials>
  77
  78 Each credentials element gives authentication details. You can have multiple
  79 credentials elements; each must have a distinct id attribute. If you omit
  80 the <password> element then usmb will prompt you for a password.
  81
  82 A mount element describes an SMB share:
  83
  84   <mount id="mount_id" credentials="some_id">
  85     <server>1.2.3.4</server>
  86     <share>sharename</share>
  87     <mountpoint>/tmp/share</mountpoint>
  88   </mount>
  89
  90 The credentials attribute identifies the id of the credentials element that
  91 provides authentication details for the share. The server, share and
  92 mountpoint should be self-explanatory. The id is given on the usmb command
  93 line to identify the SMB share to mount.
  94
  95 You can specify multiple mount elements; each must have a distinct id
  96 (though credentials and mount IDs can be the same).
  97
  98 The whole file is wrapped in a <usmbconfig> element.
  99
 100
 101 Usage
 102 -----
 103
 104 $ usmb [options] mount_ID
 105
 106 Use usmb --help for a list of options.
 107 Mount IDs are defined in the configuration file.
 108