vagrant-reverse-proxy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5afc6f0add3b80d836ec3c2213d457bb11876a3
+  data.tar.gz: b95de26303e6bc4f8e5ef010e93935364f92694f
+SHA512:
+  metadata.gz: bcc2c346c8fa987eab7bed882a33619b25e72a2fbee9191a7ce75e2f997f4fe841784e173b274d79f7cc365dd5ab3f23dc03da60a797de79ceb4cee056f37bb0
+  data.tar.gz: ac6e4a7fd17913ae04119176e6ad9dbc15888f7bf2464968b27943e3ab2e499551269d6e2f69df49494054025557fbe45675c24b0740944ced4a3b3fe71d5b18

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/vendor/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+group :development do
+    gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.7.4'
+end
+
+group :plugins do
+  # This gem's dependencies are in vagrant-reverse-proxy.gemspec
+  gemspec
+
+  # Useful when testing
+  #gem 'vagrant-libvirt'
+  #gem 'vagrant-hostmanager'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Code Yellow BV
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Vagrant Reverse Proxy
+
+This Vagrant plugin automatically installs a reverse proxy
+configuration for each of your Vagrant machines.
+
+This means you can access the HTTP interface of your virtual machines
+by accessing HTTP on your machine's IP address or DNS hostname, with
+a suffix that indicates the VM.
+
+In other words, `http://localhost/my-vm` refers to `http://my-vm/` on
+the local machine.  This also works if you access it from an external
+machine, even though `my-vm` is a local machine name unknown on the
+network.
+
+This plugin currently only supports NGINX, but patches are accepted to
+integrate it with other web servers.
+
+## Installation
+
+Install the plugin as usual:
+
+    $ vagrant plugin install vagrant-reverse-proxy
+
+## Usage
+
+First, install NGINX and create a configuration as usual.  Then, in
+the `server` configuration block for the host you want to use for
+proxying, simply put `include "vagrant-proxy-config";` in the file.
+
+If you don't need anything specific, just put the following in
+`/etc/nginx/sites-enabled/default`:
+
+    server {
+        listen [::]:80 default ipv6only=off;
+        # This is the fallback server
+        server_name default;
+        # Redirect http://localhost/hostname/lalala
+        # to http://hostname/lalala
+        include "vagrant-proxy-config";
+    }
+
+This will load the `/etc/nginx/vagrant-proxy-config` file which is
+managed by this plugin.  This file contains `location` statements for
+each of your virtual machines, such that `http://localhost/foo` will
+proxy to port 80 on the virtual machine with a `config.vm.hostname`
+value of `foo`.  This is only done for virtual machines that have
+`config.reverse_proxy.enabled` set to `true` in their config.
+
+Whenever you bring up or halt a machine, the plugin updates the proxy
+config file and invokes `sudo systemctl reload nginx` to make the
+change immediately visible.
+
+### Custom host names
+
+Sometimes you want to support several virtual hosts for one VM.  To
+set that up, you can override the `vhosts` option:
+
+    config.reverse_proxy.vhosts = ['foo.test', 'bar.test']
+
+This will proxy `http://localhost/foo.test` and
+`http://localhost/bar.test` to this VM, with a matching `Host` header.
+
+## Adding proxy support to your application
+
+This plugin will instruct NGINX to pass the following headers to your
+Vagrant box:
+
+- `X-Forwarded-For`: This contains the IP address of the client.
+- `X-Forwarded-Host`: This contains the IP address of your hypervisor.
+- `X-Forwarded-Port`: This contains the port number of NGINX on your hypervisor.
+- `X-Base-Url`: This contains the base URL that redirects to this VM.
+
+Redirects are transparently rewritten by NGINX, but if your
+application generates links with absolute URLs, you'll need to ensure
+that those links are prefixed with the value of `X-Base-Url`, but only
+if the request originated from the trusted NGINX proxy on your
+hypervisor.
+
+Be sure to avoid using these headers when the request originated
+elsewhere, because trusting these headers as sent by arbitrary clients
+is a potential security issue!  If you're using Laravel, you could
+consider using the
+[trusted proxies middleware](https://github.com/fideloper/TrustedProxy).
+If you're using Symfony, just use `setTrustedProxies()` on your
+`Request` object, and Symfony takes care of the rest.  Note that
+`X-Base-Url` is not supported by either framework, so you'll need to
+add a bit of custom code there if you need to override the base URL.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/vagrant-reverse-proxy/action/write_nginx_config.rb

@@ -0,0 +1,83 @@
+module VagrantPlugins
+  module ReverseProxy
+    module Action
+      class WriteNginxConfig
+        def initialize(app, env)
+          @app = app
+          @global_env = env[:machine].env
+          @provider = env[:machine].provider_name
+          @config = @global_env.vagrantfile.config
+        end
+
+        def call(env)
+          @app.call(env)
+
+          return unless @config.reverse_proxy.enabled?
+
+          # Determine temp file and target file
+          tmp_file = @global_env.tmp_path.join('nginx.vagrant-proxies')
+          nginx_site = '/etc/nginx/vagrant-proxy-config'
+
+          env[:ui].info('Updating nginx configuration. Administrator privileges will be required...')
+
+          File.open(tmp_file, 'w') do |f|
+            get_machines().each do |m|
+              f.write(server_block(m))
+            end
+          end
+
+          Kernel.system('sudo', 'cp', tmp_file.to_s, nginx_site)
+          Kernel.system('sudo', 'systemctl', 'reload', 'nginx')
+        end
+
+        def server_block(machine)
+          if @config.reverse_proxy.vhosts
+            vhosts = @config.reverse_proxy.vhosts
+          else
+            vhosts = [machine.config.vm.hostname || machine.name]
+          end
+          ip = get_ip_address(machine)
+          vhosts.collect do |vhost| <<EOF
+location /#{vhost}/ {
+    proxy_set_header Host #{vhost};
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_set_header X-Forwarded-Host $host;
+    proxy_set_header X-Forwarded-Port $server_port;
+    proxy_set_header X-Base-Url http://$host:$server_port/nl.dr.dev/;
+
+    proxy_pass http://#{ip}/;
+    proxy_redirect http://#{vhost}/ /#{vhost}/;
+}
+EOF
+          end.join("\n")
+        end
+
+        # Machine-finding code stolen from vagrant-hostmanager :)
+        def get_machines()
+          # Collect only machines that exist for the current provider
+          @global_env.active_machines.collect do |name, provider|
+            if provider == @provider
+              begin
+                m = @global_env.machine(name, @provider)
+                m.state.id == :running ? m : nil
+              rescue Vagrant::Errors::MachineNotFound
+                nil #ignore
+              end
+            end
+          end.compact
+        end
+
+        # Also from vagrant-hostmanager
+        def get_ip_address(machine)
+          ip = nil
+          machine.config.vm.networks.each do |network|
+            key, options = network[0], network[1]
+            ip = options[:ip] if key == :private_network
+            break if ip
+          end
+          ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-reverse-proxy/action.rb

@@ -0,0 +1,25 @@
+require_relative 'action/write_nginx_config'
+
+module VagrantPlugins
+  module ReverseProxy
+    module Action
+      include Vagrant::Action::Builtin
+
+      # We (currently) don't distinguish between upping and downing a
+      # machine; we always write a complete config with all machines.
+      def self.add_machine
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use WriteNginxConfig
+        end
+      end
+
+      def self.remove_machine
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use WriteNginxConfig
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-reverse-proxy/config.rb

@@ -0,0 +1,34 @@
+module VagrantPlugins
+  module ReverseProxy
+    class Plugin
+      class Config < Vagrant.plugin(2, :config)
+        attr_accessor :enabled, :vhosts
+        alias_method :enabled?, :enabled
+
+        def initialize
+          @enabled = UNSET_VALUE
+          @vhosts = UNSET_VALUE
+        end
+
+        def finalize!
+          @enabled = false if @enabled == UNSET_VALUE
+          @vhosts = nil if @vhosts == UNSET_VALUE
+        end
+
+        def validate(machine)
+          errors = _detected_errors
+
+          unless [true, false, UNSET_VALUE].include?(@enabled)
+            errors << 'enabled must be a boolean'
+          end
+
+          unless @vhosts.instance_of?(Array) || @vhosts == nil || @vhosts == UNSET_VALUE
+            errors << 'vhosts must be an array of hostnames (or nil to use default name)'
+          end
+
+          { 'Reverse proxy configuration' => errors.compact }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-reverse-proxy/plugin.rb

@@ -0,0 +1,37 @@
+module VagrantPlugins
+  module ReverseProxy
+    class Plugin < Vagrant.plugin(2)
+        name 'Reverse Proxy'
+
+      description <<-DESC
+        This plugin automatically manages a reverse proxy
+        configuration in your host machine's web server, which makes
+        it easy to access the web servers of your guest machines.
+
+        This is safer and easier than making the guest machine
+        completely available on the outside network.
+      DESC
+
+      config :reverse_proxy do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:reverse_proxy, :machine_action_up) do |hook|
+        hook.append(Action.add_machine)
+      end
+
+      action_hook(:reverse_proxy, :machine_action_suspend) do |hook|
+        hook.append(Action.remove_machine)
+      end
+
+      action_hook(:reverse_proxy, :machine_action_resume) do |hook|
+        hook.append(Action.add_machine)
+      end
+
+      action_hook(:reverse_proxy, :machine_action_halt) do |hook|
+        hook.append(Action.remove_machine)
+      end
+    end
+  end
+end

data/lib/vagrant-reverse-proxy/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ReverseProxy
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-reverse-proxy.rb

@@ -0,0 +1,8 @@
+require "vagrant-reverse-proxy/plugin"
+require "vagrant-reverse-proxy/action"
+require "vagrant-reverse-proxy/version"
+
+module VagrantPlugins
+  module ReverseProxy
+  end
+end

data/vagrant-reverse-proxy.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-reverse-proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-reverse-proxy"
+  spec.version       = VagrantPlugins::ReverseProxy::VERSION
+  spec.authors       = ["Peter Bex"]
+  spec.email         = ["peter@codeyellow.nl"]
+  spec.summary       = %q{A vagrant plugin that adds reverse proxies for your VMs}
+  spec.description   = %q{This plugin manages reverse proxy configuration (currently nginx-only) so you can reach your Vagrant VM's web servers externally without having to set up bridge networking.}
+  spec.homepage      = "https://github.com/CodeYellowBV/vagrant-reverse-proxy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-reverse-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Bex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This plugin manages reverse proxy configuration (currently nginx-only)
+  so you can reach your Vagrant VM's web servers externally without having to set
+  up bridge networking.
+email:
+- peter@codeyellow.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-reverse-proxy.rb
+- lib/vagrant-reverse-proxy/action.rb
+- lib/vagrant-reverse-proxy/action/write_nginx_config.rb
+- lib/vagrant-reverse-proxy/config.rb
+- lib/vagrant-reverse-proxy/plugin.rb
+- lib/vagrant-reverse-proxy/version.rb
+- vagrant-reverse-proxy.gemspec
+homepage: https://github.com/CodeYellowBV/vagrant-reverse-proxy
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A vagrant plugin that adds reverse proxies for your VMs
+test_files: []