vagrant-hostsupdater 1.1.1.160 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65e7b1e42f104505255bfa53fd108d470833d15bcbbb0d56df9ce5688889fa44
-  data.tar.gz: b89c69cc787f8fedbc45d98ec143d526db1b9e29cb5140a9bd0b608cd66e3f34
+  metadata.gz: c931c60a9148df5bd393def93d08d89be804047f19249ccf253c4760d789f346
+  data.tar.gz: 89c817fbfa2232694ac757058fbeed8fc519765f07078372828ffc2a66b70167
 SHA512:
-  metadata.gz: 5d39da2abf80d915f8d7f2c42ef95f2734c4addbcc6ef8110b02a8cd341fdd83efba813a89152acaf96512b34f67ec9689b2b32f8d793f3b89406ca6866a1997
-  data.tar.gz: 12147031b83bd69fc6ac1dcf5ccb14fd3bc692e1d0f1598dd0a13302e964a9a006eeb595211d9c1aa2c12b0ad7126e23db1402dd6b0b38476d287bf570856559
+  metadata.gz: 68b582634e6a0c4fe5a10b5633a0e1bc18f7f2ce21cc78b2a0650d2413ca4c6e8ead758fc4e21455e1dba01284e3c213312bf3b2085a4559c8c06d506581a82e
+  data.tar.gz: 3376c1d9f2a7889aea6de4e8eda2c67661e4fe9995a5a0d6a3c4ecf15018142c20ff3f3540183997f3bdd644b2c788788bad5181c8f6719b2bb0d2cc893bb32c

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Falk Kühnel
+Copyright 2018 Chris Smith
 
 MIT License
 

data/README.md

@@ -10,7 +10,7 @@
 
 This plugin adds an entry to your /etc/hosts file on the host system.
 
-On **up**, **resume** and **reload** commands, it tries to add the information, if its not already existant in your hosts file. If it needs to be added, you will be asked for an administrator password, since it uses sudo to edit the file.
+On **up**, **resume** and **reload** commands, it tries to add the information, if it does not already exist in your hosts file. If it needs to be added, you will be asked for an administrator password, since it uses sudo to edit the file.
 
 On **halt**, **destroy**, and **suspend**, those entries will be removed again.
 By setting the `config.hostsupdater.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
@@ -38,6 +38,27 @@ You currently only need the `hostname` and a `:private_network` network with a f
 
 This IP address and the hostname will be used for the entry in the `/etc/hosts` file.
 
+### Multiple private network adapters
+
+If you have multiple network adapters i.e.:
+
+    config.vm.network :private_network, ip: "10.0.0.1"
+    config.vm.network :private_network, ip: "10.0.0.2"
+
+you can specify which hostnames are bound to which IP by passing a hash mapping the IP of the network to an array of hostnames to create, e.g.:
+
+    config.hostsupdater.aliases = {
+        '10.0.0.1' => ['foo.com', 'bar.com'],
+        '10.0.0.2' => ['baz.com', 'bat.com']
+    }
+
+This will produce `/etc/hosts` entries like so:
+
+    10.0.0.1 foo.com
+    10.0.0.1 bar.com
+    10.0.0.2 baz.com
+    10.0.0.2 bat.com
+
 ### Skipping hostupdater
 
 To skip adding some entries to the /etc/hosts file add `hostsupdater: "skip"` option to network configuration:
@@ -56,22 +77,77 @@ Example:
 
 To keep your /etc/hosts file unchanged simply add the line below to your `VagrantFile`:
 
-    config.hostsupdater.resume_on_suspend = false
+    config.hostsupdater.remove_on_suspend = false
     
 This disables vagrant-hostsupdater from running on **suspend** and **halt**.
         
 
-## Passwordless sudo
+## Suppressing prompts for elevating privileges
+
+These prompts exist to prevent anything that is being run by the user from inadvertently updating the hosts file. 
+If you understand the risks that go with supressing them, here's how to do it.
+
+### Linux/OS X: Passwordless sudo
+
+To allow vagrant to automatically update the hosts file without asking for a sudo password, add one of the following snippets to a new sudoers file include, i.e. `sudo visudo -f /etc/sudoers.d/vagrant_hostsupdater`.
+
+For Ubuntu and most Linux environments:
+
+    # Allow passwordless startup of Vagrant with vagrant-hostsupdater.
+    Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c echo "*" >> /etc/hosts
+    Cmnd_Alias VAGRANT_HOSTS_REMOVE = /bin/sed -i -e /*/ d /etc/hosts
+    %sudo ALL=(root) NOPASSWD: VAGRANT_HOSTS_ADD, VAGRANT_HOSTS_REMOVE
 
-Add the following snippet to the top of the sudoers file using `sudo visudo`. It will make vagrant
-stop asking password when updating hosts file:
+For MacOS:
 
     # Allow passwordless startup of Vagrant with vagrant-hostsupdater.
     Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c echo "*" >> /etc/hosts
     Cmnd_Alias VAGRANT_HOSTS_REMOVE = /usr/bin/sed -i -e /*/ d /etc/hosts
     %admin ALL=(root) NOPASSWD: VAGRANT_HOSTS_ADD, VAGRANT_HOSTS_REMOVE
     
-        
+- If vagrant still asks for a password on commands that trigger the `VAGRANT_HOSTS_ADD` alias above (like **up**), you might need to wrap the echo statement in quotes, i.e. `Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c 'echo "*" >> /etc/hosts'`. This seems to be a problem with older versions of Linux and MacOS.
+- If vagrant still asks for a password on commands that trigger the `VAGRANT_HOSTS_REMOVE` alias above (like
+**halt** or **suspend**), this might indicate that the location of **sed** in the `VAGRANT_HOSTS_REMOVE` alias is
+pointing to the wrong location. The solution is to find the location of **sed** (ex. `which sed`) and
+replace that location in the `VAGRANT_HOSTS_REMOVE` alias.
+    
+### Windows: UAC Prompt
+
+You can use `cacls` or `icacls` to grant your user account permanent write permission to the system's hosts file. 
+You have to open an elevated command prompt; hold `❖ Win` and press `X`, then choose "Command Prompt (Admin)"
+
+    cacls %SYSTEMROOT%\system32\drivers\etc\hosts /E /G %USERNAME%:W 
+
+## Using AWS as a Provider
+
+If you'd like AWS as a provider using [vagrant-aws](https://github.com/mitchellh/vagrant-aws) or other plugin,
+this plugin will detect the instance public IP by the tag infomations.  
+For example, [vagrant-aws](https://github.com/mitchellh/vagrant-aws) configures a tag infomations like the following.
+
+    config.vm.provider :aws do |aws, override|
+      aws.tags = {
+        "Name" => "vagrant",
+        ...
+      }
+      aws.elastic_ip = true
+      ...
+    end
+
+* [AWS CLI](https://aws.amazon.com/cli/) is required
+* The tag informations be unique for the instance
+* Enable Elastic IP for the instance
+
+## Using Google as a provider
+
+If you'd like a Google provider using [vagrant-google](https://github.com/mitchellh/vagrant-google), this plugin will detect the public IP from the name of the instance.
+[vagrant-google](https://github.com/mitchellh/vagrant-google) provides a default name, but you can specify your own as follows:
+
+    config.vm.provider :google do |google, override|
+      google.name = "somename"
+      ...
+    end
+
+* [Google Cloud SDK](https://cloud.google.com/sdk/) is required.
 
 ## Installing development version
 
@@ -96,6 +172,19 @@ vagrant plugin install vagrant-hostsupdater-*.gem
 
 ## Versions
 
+### 1.1.1
+* Bugfix: AWS Feature broke part of the code [#155](/../../issues/155)
+
+### 1.1.0
+* Feature: Added AWS support [#74](/../../pull/74)
+* Feature: Added libvirt provider [#122](/../../pull/122)
+* Feature: Add support for multiple private network adapters [#96](/../../pull/96)
+* Feature: Add support for VMs without private/public networking [#23](/../../issues/23)
+* Feature: Add Docker support [#149](/../../pull/149)
+* Bugfix: Windows users get UAC prompt [#40](/../../issues/40)
+* Bugfix: Documentation update and type fix
+* Misc: Added a note about suppressing UAC prompts
+
 ### 1.0.2
 * Feature: Added `remove_on_suspend` for `vagrant_halt` [#71](/../../issues/71)
 * Feature: Skip entries if they already exist [#69](/../../issues/69)
@@ -143,4 +232,4 @@ vagrant plugin install vagrant-hostsupdater-*.gem
 * fixed problem with removing hosts entries on destroy command (Thanks to Andy Bohne)
 
 ### 0.0.3
-* added aliases config option to define additional hostnames
+* added aliases config option to define additional hostnames

data/lib/vagrant-hostsupdater/HostsUpdater.rb

@@ -1,39 +1,91 @@
+require 'open3'
+
 module VagrantPlugins
   module HostsUpdater
     module HostsUpdater
-      @@hosts_path = Vagrant::Util::Platform.windows? ? File.expand_path('system32/drivers/etc/hosts', ENV['windir']) : '/etc/hosts'
+      if ENV['VAGRANT_HOSTSUPDATER_PATH']
+        @@hosts_path = ENV['VAGRANT_HOSTSUPDATER_PATH']
+      else
+        @@hosts_path = Vagrant::Util::Platform.windows? ? File.expand_path('system32/drivers/etc/hosts', ENV['windir']) : '/etc/hosts'
+      end
+      @isWindowsHost = Vagrant::Util::Platform.windows?
+      @@ssh_known_hosts_path = '~/.ssh/known_hosts'
 
       def getIps
         ips = []
-        @machine.config.vm.networks.each do |network|
-          key, options = network[0], network[1]
-          ip = options[:ip] if (key == :private_network || key == :public_network) && options[:hostsupdater] != "skip"
-          ips.push(ip) if ip
-          if options[:hostsupdater] == 'skip'
-            @ui.info '[vagrant-hostsupdater] Skipping adding host entries (config.vm.network hostsupdater: "skip" is set)'
+
+        if ip = getAwsPublicIp
+          ips.push(ip)
+        elsif ip = getGooglePublicIp
+          ips.push(ip)
+        else
+            @machine.config.vm.networks.each do |network|
+              key, options = network[0], network[1]
+              ip = options[:ip] if (key == :private_network || key == :public_network) && options[:hostsupdater] != "skip"
+              ips.push(ip) if ip
+              if options[:hostsupdater] == 'skip'
+                @ui.info '[vagrant-hostsupdater] Skipping adding host entries (config.vm.network hostsupdater: "skip" is set)'
+            end
           end
         end
-        return ips
-      end
 
-      def getHostnames
-        hostnames = Array(@machine.config.vm.hostname)
-        if @machine.config.hostsupdater.aliases
-          hostnames.concat(@machine.config.hostsupdater.aliases)
+        if @machine.provider_name == :lxc
+          ip = @machine.provider.capability(:public_address)
+          ips.push(ip)
+        elsif @machine.provider_name == :docker
+          ip = @machine.provider.capability(:public_address)
+          ips.push(ip)
+        elsif @machine.provider_name == :libvirt
+          ssh_info = @machine.ssh_info
+          if ssh_info
+            ips.push(ssh_info[:host])
+          end
+        end
+        if not ips.any?
+          ips.push( '127.0.0.1' )
+        end
+        return ips.uniq
+        end
+
+      # Get a hash of hostnames indexed by ip, e.g. { 'ip1': ['host1'], 'ip2': ['host2', 'host3'] }
+      def getHostnames(ips)
+        hostnames = Hash.new { |h, k| h[k] = [] }
+
+        case @machine.config.hostsupdater.aliases
+        when Array
+          # simple list of aliases to link to all ips
+          ips.each do |ip|
+            hostnames[ip] += @machine.config.hostsupdater.aliases
+          end
+        when Hash
+          # complex definition of aliases for various ips
+          @machine.config.hostsupdater.aliases.each do |ip, hosts|
+            hostnames[ip] += Array(hosts)
+          end
         end
+
+        # handle default hostname(s) if not already specified in the aliases
+        Array(@machine.config.vm.hostname).each do |host|
+          if hostnames.none? { |k, v| v.include?(host) }
+            ips.each do |ip|
+              hostnames[ip].unshift host
+            end
+          end
+        end
+
         return hostnames
       end
 
-      def addHostEntries()
+      def addHostEntries
         ips = getIps
-        hostnames = getHostnames
+        hostnames = getHostnames(ips)
         file = File.open(@@hosts_path, "rb")
         hostsContents = file.read
         uuid = @machine.id
         name = @machine.name
         entries = []
         ips.each do |ip|
-          hostnames.each do |hostname|
+          hostnames[ip].each do |hostname|
             entryPattern = hostEntryPattern(ip, hostname)
 
             if hostsContents.match(/#{entryPattern}/)
@@ -61,7 +113,8 @@ module VagrantPlugins
         uuid = @machine.id || @machine.config.hostsupdater.id
         hashedId = Digest::MD5.hexdigest(uuid)
         if hostsContents.match(/#{hashedId}/)
-            removeFromHosts
+          removeFromHosts
+          removeFromSshKnownHosts
         end
       end
 
@@ -70,7 +123,7 @@ module VagrantPlugins
       end
 
       def createHostEntry(ip, hostname, name, uuid = self.uuid)
-        %Q(#{ip}  #{hostname}  #{signature(name, uuid)})
+        %Q(#{ip}  #{hostname}  #{signature(name, uuid.to_s)})
       end
 
       # Create a regular expression that will match *any* entry describing the
@@ -86,15 +139,24 @@ module VagrantPlugins
 
         @ui.info "[vagrant-hostsupdater] Writing the following entries to (#@@hosts_path)"
         @ui.info "[vagrant-hostsupdater]   " + entries.join("\n[vagrant-hostsupdater]   ")
-        @ui.info "[vagrant-hostsupdater] This operation requires administrative access. You may " +
-          "skip it by manually adding equivalent entries to the hosts file."
         if !File.writable_real?(@@hosts_path)
+          @ui.info "[vagrant-hostsupdater] This operation requires administrative access. You may " +
+                       "skip it by manually adding equivalent entries to the hosts file."
           if !sudo(%Q(sh -c 'echo "#{content}" >> #@@hosts_path'))
             @ui.error "[vagrant-hostsupdater] Failed to add hosts, could not use sudo"
             adviseOnSudo
           end
+        elsif Vagrant::Util::Platform.windows?
+          require 'tmpdir'
+          uuid = @machine.id || @machine.config.hostsupdater.id
+          tmpPath = File.join(Dir.tmpdir, 'hosts-' + uuid + '.cmd')
+          File.open(tmpPath, "w") do |tmpFile|
+          entries.each { |line| tmpFile.puts(">>\"#{@@hosts_path}\" echo #{line}") }
+          end
+          sudo(tmpPath)
+          File.delete(tmpPath)
         else
-          content = "\n" + content
+          content = "\n" + content + "\n"
           hostsFile = File.open(@@hosts_path, "a")
           hostsFile.write(content)
           hostsFile.close()
@@ -104,7 +166,7 @@ module VagrantPlugins
       def removeFromHosts(options = {})
         uuid = @machine.id || @machine.config.hostsupdater.id
         hashedId = Digest::MD5.hexdigest(uuid)
-        if !File.writable_real?(@@hosts_path)
+        if !File.writable_real?(@@hosts_path) || Vagrant::Util::Platform.windows?
           if !sudo(%Q(sed -i -e '/#{hashedId}/ d' #@@hosts_path))
             @ui.error "[vagrant-hostsupdater] Failed to remove hosts, could not use sudo"
             adviseOnSudo
@@ -114,13 +176,27 @@ module VagrantPlugins
           File.open(@@hosts_path).each do |line|
             hosts << line unless line.include?(hashedId)
           end
+          hosts.strip!
           hostsFile = File.open(@@hosts_path, "w")
           hostsFile.write(hosts)
           hostsFile.close()
         end
       end
 
-
+      def removeFromSshKnownHosts
+        if !@isWindowsHost
+          ips = getIps
+          hostnames = getHostnames(ips)
+          ips.each do |ip|
+            hostnames[ip].each do |hostname|
+              command = %Q(sed -i -e '/#{hostname}/ d' #@@ssh_known_hosts_path)
+              if system(command)
+                @ui.info "[vagrant-hostsupdater] Removed host: #{hostname} from ssh_known_hosts file: #@@ssh_known_hosts_path"
+              end
+            end
+          end
+        end
+      end
 
       def signature(name, uuid = self.uuid)
         hashedId = Digest::MD5.hexdigest(uuid)
@@ -130,7 +206,11 @@ module VagrantPlugins
       def sudo(command)
         return if !command
         if Vagrant::Util::Platform.windows?
-          `#{command}`
+          require 'win32ole'
+          args = command.split(" ")
+          command = args.shift
+          sh = WIN32OLE.new('Shell.Application')
+          sh.ShellExecute(command, args.join(" "), '', 'runas', 0)
         else
           return system("sudo #{command}")
         end
@@ -138,7 +218,38 @@ module VagrantPlugins
 
       def adviseOnSudo
         @ui.error "[vagrant-hostsupdater] Consider adding the following to your sudoers file:"
-        @ui.error "[vagrant-hostsupdater]   https://github.com/cogitatio/vagrant-hostsupdater#passwordless-sudo"
+        @ui.error "[vagrant-hostsupdater]   https://github.com/cogitatio/vagrant-hostsupdater#suppressing-prompts-for-elevating-privileges"
+      end
+
+      def getAwsPublicIp
+        return nil if ! Vagrant.has_plugin?("vagrant-aws")
+        aws_conf = @machine.config.vm.get_provider_config(:aws)
+        return nil if ! aws_conf.is_a?(VagrantPlugins::AWS::Config)
+        filters = ( aws_conf.tags || [] ).map {|k,v| sprintf('"Name=tag:%s,Values=%s"', k, v) }.join(' ')
+        return nil if filters == ''
+        cmd = 'aws ec2 describe-instances --filter '+filters
+        stdout, stderr, stat = Open3.capture3(cmd)
+        @ui.error sprintf("Failed to execute '%s' : %s", cmd, stderr) if stderr != ''
+        return nil if stat.exitstatus != 0
+        begin
+          return JSON.parse(stdout)["Reservations"].first()["Instances"].first()["PublicIpAddress"]
+        rescue => e
+          @ui.error sprintf("Failed to get IP from the result of '%s' : %s", cmd, e.message)
+          return nil
+        end
+      end
+
+      def getGooglePublicIp
+        return nil if ! defined?(VagrantPlugins::Google)
+        google_conf = @machine.config.vm.get_provider_config(:google)
+        return nil if ! google_conf.is_a?(VagrantPlugins::Google::Config)
+        cmd = 'gcloud compute instances list --filter="name=%s" --format="value(networkInterfaces[0].accessConfigs[0].natIP)"'
+        cmd = sprintf(cmd, google_conf.name)
+        stdout, stderr, stat = Open3.capture3(cmd)
+        @ui.error "Failed to execute '#{cmd}' : #{stderr}" if stderr != ''
+        ip = stdout.strip
+        return nil if stat.exitstatus != 0 || ip == nil || ip == ''
+        return ip
       end
     end
   end

data/lib/vagrant-hostsupdater/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module HostsUpdater
-    VERSION = '1.0.2'
+    VERSION = '1.2.0'
   end
 end

data/vagrant-hostsupdater.gemspec

@@ -5,7 +5,7 @@ require 'vagrant-hostsupdater/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'vagrant-hostsupdater'
-  spec.version       = '1.1.1.160' #VagrantPlugins::HostsUpdater::VERSION
+  spec.version       = VagrantPlugins::HostsUpdater::VERSION
   spec.authors       = ['Falk Kühnel', 'Chris Smith']
   spec.email         = ['fk@cogitatio.de', 'chris@cgsmith.net']
   spec.description   = %q{Enables Vagrant to update hosts file on the host machine}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hostsupdater
 version: !ruby/object:Gem::Version
-  version: 1.1.1.160
+  version: 1.2.0
 platform: ruby
 authors:
 - Falk Kühnel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Enables Vagrant to update hosts file on the host machine