vagrant-better-smb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e7e0dfa577c1d154a7e01618af61ef510865c22
+  data.tar.gz: 60eb224da97674d6b6b61bb9d92fc9666fa03bbe
+SHA512:
+  metadata.gz: 9f3f7d3170af07d24bae8949fd5f7b9d59f2fe86b75c72c99706106b71af4726b7c3cd44b7a5e13b5807127c005b6dc18567e44e907e23f286f54a54becb8a64
+  data.tar.gz: b6dee4a9ec31a468f5dd221cf15ed1784cfe2d225313990ca5b9a68a48fa8b50cf6da38f0c4f4fd0c3f1ff4c7dd29f849486c1aeca0e44f2c83fe4109850556b

data/README.md

@@ -0,0 +1,65 @@
+# Better SMB support for Vagrant
+
+Vagrant's core SMB synced folder implementation doesn't use guest and host
+capabilities and doesn't provide developers with an easy means of extending
+support to non-Windows platforms. This plugin aims to fix this problem by
+providing an alternative synced folder implementation.
+
+* * *
+
+## Work in progress
+
+Don't use me for anything important just yet -- I'm still undergoing heavy
+development. I'll be on RubyGems soon.
+
+## Using
+
+To install the plugin:
+
+    $ vagrant plugin install vagrant-better-smb
+
+Then, in your ```Vagrantfile```:
+
+    config.vm.network :private_network, ip: "<your guest ip>"
+
+    config.vm.synced_folder "testdata", "<your drive letter>:", type: "better_smb",
+                            better_smb_machine_ip: "<your guest ip>",
+                            better_smb_share_name: "<your share name>",
+                            better_smb_host_ip: "<your host ip>",
+                            better_smb_share_user: "<your username>",
+                            better_smb_share_password: "<your password>"
+
+## Debugging
+
+1. Have you added your user account as an SMB user with
+   ```sudo smbpasswd -a <your username>```?
+2. Is your password up to date? Update it with ```smbpasswd```.
+3. Can you see your share in ```smbclient -L 127.0.0.1 -U <your username>```?
+4. Have you configured SELinux correctly? Allow Samba to access home directories
+   with ```setsebool -P samba_enable_home_dirs 1```
+
+## Hacking
+
+1. Install Ruby and Bundler.
+2. If you need any local dependencies (i.e. ```json```), pop them into a new
+   file called ```Gemfile.local```. We'll source it for you -- there's no need
+   to alter the top level ```Gemfile```.
+3. Install the bundle with ```bundle install```.
+4. Use Vagrant as normal -- just run it with ```bundle exec vagrant```.
+
+### Building
+
+It's easy:
+
+    $ bundle install
+    $ rake build
+    $ ls pkg/
+
+### To do
+
+* Enable multiple clients to connect to the same SMB share
+* Sanity check and cleanse the values we're placing in samba.conf
+* Implement support for Windows hosts
+* Implement support for Linux guests
+* Clean up existing shares
+* Ensure Linux server implementation works outside of Fedora

data/lib/vagrant-better-smb.rb

@@ -0,0 +1,21 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+require "vagrant"
+require "vagrant-better-smb/plugin"
+
+module VagrantPlugins
+  module BetterSmb
+    autoload :Caps,   "vagrant-better-smb/caps"
+    autoload :Errors, "vagrant-better-smb/errors"
+
+    def self.source_root
+      @source_root ||= Pathname.new File.expand_path("../../", __FILE__)
+     end
+  end
+end

data/lib/vagrant-better-smb/action_prepare_valid_ids.rb

@@ -0,0 +1,22 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    class ActionPrepareValidIDs
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        env[:better_smb_valid_ids] = env[:machine].provider.driver.read_vms.values
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/action_prune.rb

@@ -0,0 +1,27 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    class ActionPrune
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        if env[:machine].env.host.capability?(:smb_folders_prune) &&
+            env[:better_smb_valid_ids]
+          env[:machine].env.host.capability(
+              :smb_folders_prune, env[:machine].ui, env[:better_smb_valid_ids])
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/caps.rb

@@ -0,0 +1,16 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    module Caps
+      autoload :Linux,   "vagrant-better-smb/caps/linux"
+      autoload :Windows, "vagrant-better-smb/caps/windows"
+    end
+  end
+end

data/lib/vagrant-better-smb/caps/linux.rb

@@ -0,0 +1,110 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    module Caps
+      class Linux
+        SAMBA_CONF    = "/etc/samba/smb.conf"
+        SAMBA_ETC_DIR = "/etc/samba"
+        SAMBA_SMBD    = "/usr/sbin/smbd"
+
+        SMBD_STATUS_COMMAND  = "systemctl status smb"
+        SMBD_START_COMMAND   = "systemctl start smb"
+        SMBD_RESTART_COMMAND = "systemctl restart smb"
+
+        def self.smb_folders_export(env, ui, id, folders)
+          config = share_config(Process.uid, id, folders)
+
+          sudo_command = ""
+          sudo_command = "sudo " unless File.writable?(SAMBA_CONF)
+
+          cleanup_exports(id)
+
+          config.split("\n").each do |line|
+            line = Vagrant::Util::ShellQuote.escape(line, "'")
+            system(%Q[echo '#{line}' | #{sudo_command}tee -a #{SAMBA_CONF} >/dev/null])
+          end
+
+          if smb_running?
+            restart_smb
+          else
+            start_smb
+          end
+        end
+
+        def self.smb_folders_prune(env, ui, valid_ids)
+          return unless File.exist?(SAMBA_CONF)
+
+          output = false
+          user = Process.uid
+
+          File.read(SAMBA_CONF).lines.each do |line|
+            if id = line[/^# VAGRANT-BEGIN:( #{user})? ([\.\/A-Za-z0-9\-_:]+?)$/, 2]
+              unless valid_ids.include?(id)
+                if !output
+                  # We want to warn the user but we only want to output once
+                  ui.info I18n.t("vagrant_plugins.better_smb.messages.pruning")
+                  output = true
+                end
+
+                nfs_cleanup(id)
+              end
+            end
+          end
+        end
+
+        def self.smb_server_installed(env)
+          File.directory?(SAMBA_ETC_DIR) &&
+              File.file?(SAMBA_CONF) &&
+              File.file?(SAMBA_SMBD)
+        end
+
+        protected
+
+        def self.cleanup_exports(id)
+          return unless File.exist?(SAMBA_CONF)
+
+          sudo_command = ""
+          sudo_command = "sudo " unless File.writable?(SAMBA_CONF)
+
+          user = Regexp.escape(Process.uid.to_s)
+          id   = Regexp.escape(id.to_s)
+
+          # Use sed to just strip out the block of code which was inserted
+          # by Vagrant
+          command = "#{sudo_command}sed -r -e '\\\x01^# VAGRANT-BEGIN:( #{user})? #{id}\x01,\\\x01^# VAGRANT-END:( #{user})? #{id}\x01 d' -i.bak #{SAMBA_CONF}"
+          system(command)
+        end
+
+        def self.share_config(uid, id, folders)
+          export_template = File.expand_path(
+              "templates/smb/linux_share", BetterSmb.source_root)
+
+          Vagrant::Util::TemplateRenderer.render(
+              export_template,
+              user: Process.uid,
+              uuid: id,
+              folders: folders)
+        end
+
+        def self.smb_running?
+          system "#{SMBD_STATUS_COMMAND} >/dev/null"
+        end
+
+        def self.restart_smb
+          system "sudo #{SMBD_RESTART_COMMAND} >/dev/null"
+        end
+
+        def self.start_smb
+          system "sudo #{SMBD_START_COMMAND} >/dev/null"
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/caps/windows.rb

@@ -0,0 +1,42 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    module Caps
+      class Windows
+        def self.smb_client_installed(env)
+          true
+        end
+
+        def self.smb_folders_mount(env, machine, folders)
+          folders.each do |folder, opts|
+            share_name = clean_string opts[:better_smb_share_name]
+            guest_path = clean_string opts[:guestpath]
+            user       = clean_string opts[:better_smb_share_user]
+            password   = clean_string opts[:better_smb_share_password]
+
+            share = "\\\\#{opts[:better_smb_host_ip]}\\#{share_name}"
+
+            auth_command   = "cmdkey /add:#{opts[:better_smb_host_ip]} /user:#{user} /pass:#{password}"
+            clean_command  = "NET USE #{guest_path} /DELETE /Y"
+            unfuck_command = "NET USE #{share}"
+            mount_command  = "NET USE #{guest_path} #{share} /PERSISTENT:yes"
+
+            machine.communicate.execute "#{auth_command} ; #{clean_command} ; #{unfuck_command} ; #{mount_command}", {
+                shell: :powershell, elevated: true, error_check: false}
+          end
+        end
+
+        def self.clean_string(string)
+          string.gsub "$", "```$"
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/errors.rb

@@ -0,0 +1,25 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    module Errors
+      class BetterSmbError < Vagrant::Errors::VagrantError
+        error_namespace "vagrant_plugins.better_smb.errors"
+      end
+
+      class SmbClientNotInstalledOnGuest < BetterSmbError
+        error_key :smb_client_not_installed_on_guest
+      end
+
+      class SmbServerNotInstalledOnHost < BetterSmbError
+        error_key :smb_server_not_installed_on_host
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/plugin.rb

@@ -0,0 +1,75 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    class Plugin < Vagrant.plugin("2")
+      name "BetterSmb"
+      description "Better SMB support for Vagrant"
+
+      host_capability :linux, :smb_folders_export do
+        init!
+        Caps::Linux
+      end
+
+      host_capability :linux, :smb_folders_prune do
+        init!
+        Caps::Linux
+      end
+
+      host_capability :linux, :smb_server_installed do
+        init!
+        Caps::Linux
+      end
+
+      guest_capability :windows, :smb_client_installed do
+        init!
+        Caps::Windows
+      end
+
+      guest_capability :windows, :smb_folders_mount do
+        init!
+        Caps::Windows
+      end
+
+      synced_folder :better_smb, 1 do
+        init!
+
+        require_relative "synced_folder"
+        SyncedFolder
+      end
+
+      action_hook :better_smb_prepare_valid_ids, :machine_action_up do |hook|
+        init!
+
+        require_relative "action_prepare_valid_ids"
+        hook.append(ActionPrepareValidIDs)
+      end
+
+      action_hook :better_smb_prune, :machine_action_halt do |hook|
+        init!
+
+        require_relative "action_prepare_valid_ids"
+        require_relative "action_prune"
+        hook.append(ActionPrepareValidIDs)
+        hook.after(ActionPrepareValidIDs, ActionPrune)
+      end
+
+      protected
+
+      def self.init!
+        return if defined?(@initialized)
+
+        I18n.load_path << File.expand_path(
+            "templates/locales/better_smb.yml", BetterSmb.source_root)
+        I18n.reload!
+        @initialized = true
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/synced_folder.rb

@@ -0,0 +1,61 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      @@lock = Mutex.new
+      def initialize(*args)
+      end
+
+      def usable?(machine, raise_error=false)
+        installed = machine.env.host.capability(:smb_server_installed)
+        raise Errors::SmbServerNotInstalledOnHost if raise_error and !installed
+
+        installed
+      end
+
+      def prepare(machine, folders, opts)
+        # Pre-boot
+      end
+
+      def enable(machine, folders, opts)
+        if !machine.guest.capability(:smb_client_installed)
+          raise Errors::SmbClientNotInstalledOnGuest
+        end
+
+        @@lock.synchronize do
+          begin
+            machine.env.lock("better-smb-lock") do
+              machine.ui.info I18n.t("vagrant_plugins.better_smb.messages.exporting")
+              machine.env.host.capability(
+                  :smb_folders_export, machine.ui, machine.id, folders)
+            end
+          rescue Vagrant::Errors::EnvironmentLockedError
+            sleep 1
+            retry
+          end
+        end
+
+        machine.ui.info I18n.t("vagrant_plugins.better_smb.messages.mounting")
+        machine.guest.capability(:smb_folders_mount, machine, folders)
+      end
+
+      def cleanup(machine, opts)
+        # Post-halt
+      end
+
+      protected
+
+      def addressable_ip
+        machine.guest.capability(
+            :choose_addressable_ip_addr, candidate_ips)
+      end
+    end
+  end
+end

data/lib/vagrant-better-smb/version.rb

@@ -0,0 +1,13 @@
+#
+# Better SMB for Vagrant
+#
+# @author Luke Carrier <luke@carrier.im>
+# @copyright 2015 Luke Carrier
+# @license GPL v3
+#
+
+module VagrantPlugins
+  module BetterSmb
+    VERSION = "0.1.0"
+  end
+end

data/templates/locales/better_smb.yml

@@ -0,0 +1,16 @@
+---
+en:
+  vagrant_plugins:
+    better_smb:
+      errors:
+        smb_client_not_installed_on_guest: |-
+          No SMB client is installed on the guest
+        smb_server_not_installed_on_host: |-
+          No SMB server is installed on the host
+      messages:
+        exporting: |-
+          Exporting folders as SMB shares
+        mounting: |-
+          Mounting SMB shares on guest
+        pruning: |-
+          Pruning invalid SMB shares from host

data/templates/smb/linux_share.erb

@@ -0,0 +1,8 @@
+# VAGRANT-BEGIN: <%= user %> <%= uuid %>
+<% folders.each do |name, opts| %>
+[<%= opts[:better_smb_share_name] %>]
+    path = <%= opts[:hostpath] %>
+    writeable = yes
+    hosts allow = <%= opts[:better_smb_machine_ip] %>
+<% end %>
+# VAGRANT-END: <%= user %> <%= uuid %>

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-better-smb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Carrier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies: []
+description: Better SMB support for Vagrant
+email: luke@carrier.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/vagrant-better-smb.rb
+- lib/vagrant-better-smb/action_prepare_valid_ids.rb
+- lib/vagrant-better-smb/action_prune.rb
+- lib/vagrant-better-smb/caps.rb
+- lib/vagrant-better-smb/caps/linux.rb
+- lib/vagrant-better-smb/caps/windows.rb
+- lib/vagrant-better-smb/errors.rb
+- lib/vagrant-better-smb/plugin.rb
+- lib/vagrant-better-smb/synced_folder.rb
+- lib/vagrant-better-smb/version.rb
+- templates/locales/better_smb.yml
+- templates/smb/linux_share.erb
+homepage: https://github.com/LukeCarrier/vagrant-better-smb
+licenses:
+- GPL v3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Better SMB support for Vagrant
+test_files: []