vagrant-qubes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f6142494a93149537680a6e20b96dc4b12e9f9d238047dca8ee7def967ba6e8
+  data.tar.gz: 298d52208e83ec1a0f08d9b327893506fa8f6e548e1f11d02205dd5fb5f59888
+SHA512:
+  metadata.gz: 7fade5c518b6d4373627986e9fadb73ba4a637eaec0fcb0798169e7925217ab6125b120434827727dcf94b79d67dee2da034af5263298b678772e4133cca66e6
+  data.tar.gz: f2d606de83270ac0235f2922660fd65b9ae0108fd3b8479a2631fa08bb06cdd63bc55845c42ac89e210c4883b7e6ece21699a6f77d9cc18a00ebff69e3dbeaf2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Vagrantfile
+/.vagrant/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gp397@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vagrant-qubes.gemspec
+# gemspec
+
+group :development do
+  gem "vagrant", git: "https://github.com/hashicorp/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-qubes", path: "."
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+GIT
+  remote: https://github.com/hashicorp/vagrant.git
+  revision: 22795b161bf67a4c0ebbe32c9ce8777cb888c4a7
+  specs:
+    vagrant (2.2.11.dev)
+      bcrypt_pbkdf (~> 1.0.0)
+      childprocess (~> 4.0.0)
+      ed25519 (~> 1.2.4)
+      erubi
+      hashicorp-checkpoint (~> 0.1.5)
+      i18n (~> 1.8)
+      listen (~> 3.1)
+      log4r (~> 1.1.9, < 1.1.11)
+      mime (~> 0.4.4)
+      net-scp (~> 1.2.0)
+      net-sftp (~> 3.0)
+      net-ssh (~> 6.0)
+      rb-kqueue (~> 0.2.0)
+      rest-client (>= 1.6.0, < 3.0)
+      ruby_dep (<= 1.3.1)
+      rubyzip (~> 2.0)
+      vagrant_cloud (~> 2.0.3)
+      wdm (~> 0.1.0)
+      winrm (>= 2.3.4, < 3.0)
+      winrm-elevated (>= 1.2.1, < 2.0)
+      winrm-fs (>= 1.3.4, < 2.0)
+
+PATH
+  remote: .
+  specs:
+    vagrant-qubes (0.0.1)
+      log4r (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt_pbkdf (1.0.1)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.9)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ed25519 (1.2.4)
+    erubi (1.10.0)
+    ffi (1.15.3)
+    gssapi (1.3.1)
+      ffi (>= 1.0.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashicorp-checkpoint (0.1.5)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    little-plugger (1.1.4)
+    log4r (1.1.10)
+    logging (2.3.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    mime (0.4.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_json (1.15.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-sftp (3.0.0)
+      net-ssh (>= 5.0.0, < 7.0.0)
+    net-ssh (6.1.0)
+    netrc (0.11.0)
+    nori (2.6.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rb-kqueue (0.2.6)
+      ffi (>= 0.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby_dep (1.3.1)
+    rubyntlm (0.6.3)
+    rubyzip (2.3.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vagrant_cloud (2.0.3)
+      rest-client (~> 2.0.2)
+    wdm (0.1.1)
+    winrm (2.3.6)
+      builder (>= 2.1.2)
+      erubi (~> 1.8)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.3)
+    winrm-elevated (1.2.3)
+      erubi (~> 1.8)
+      winrm (~> 2.0)
+      winrm-fs (~> 1.0)
+    winrm-fs (1.3.5)
+      erubi (~> 1.8)
+      logging (>= 1.6.1, < 3.0)
+      rubyzip (~> 2.0)
+      winrm (~> 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  vagrant!
+  vagrant-qubes!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gary Pentland
+
+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,71 @@
+# Vagrant::Qubes
+
+This is a vagrant provider for qubes.
+
+If you don't know what qubes is, this is probably not somehting that you will want to experiment with yet.
+
+The structure, and large chunks of code in here have been inspired by (and in some cases copied from) Jonathan Senkerik's ESXi plugin "vagrant-vmware-esxi" https://github.com/josenk/vagrant-vmware-esxi  without the help of that I wouldn't have been able to put this together.
+
+Right now, this should be considered alpha at best, basic "up" and "destroy" works for a minimally configured AppVM based on a Vagrantfile along these lines
+
+```
+vms = {
+  "test1" => ["AppVM","red","fedora-33", 2,  2048, "sys-firewall"],
+  "test2" => ["AppVM","red","fedora-33", 2,  2048, "sys-firewall"],
+  "test3" => ["AppVM","red","fedora-33", 2,  2048, "sys-firewall"],
+}
+
+Vagrant.configure("2") do |config|
+  vms.each do | (name, cfg) |
+    type, label, template, numvcpus, memory, network = cfg
+
+    config.vm.define name do |machine|
+      machine.vm.box = "box"
+      machine.vm.hostname = name
+      machine.vm.provider :vagrant_qubes do |qubes|
+        qubes.guest_type = type
+        qubes.guest_label = label
+        qubes.guest_template = template
+        qubes.guest_netvm = network
+        qubes.guest_memsize = memory
+        qubes.guest_numvcpus = numvcpus
+      end
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vagrant-qubes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vagrant-qubes
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gp397/vagrant-qubes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gp397/vagrant-qubes/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vagrant::Qubes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gp397/vagrant-qubes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+require "rubygems"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vagrant/qubes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vagrant-qubes.rb

@@ -0,0 +1,14 @@
+require 'pathname'
+require 'vagrant-qubes/plugin'
+
+module VagrantPlugins
+  module Qubes
+    lib_path = Pathname.new(File.expand_path('../vagrant-qubes', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-qubes/action.rb

@@ -0,0 +1,97 @@
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module Qubes
+    # actions and how to run them
+    module Action
+      include Vagrant::Action::Builtin
+
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadState
+        end
+      end
+
+      def self.action_address
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Address, false
+        end
+      end
+
+      def self.action_address_multi
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Address, true
+        end
+      end
+
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadSSHInfo
+        end
+      end
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          # b.use HandleBox - This downloads the "box"
+          b.use ReadState
+          b.use CreateVM
+          b.use ReadState
+          b.use Boot
+          b.use Call, WaitForState, :running, 240 do |env1, b1|
+            if env1[:result] == 'True'
+              b1.use action_provision
+            end
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadState
+          b.use Call, WaitForState, :running, 240 do |env1, b1|
+            if env1[:result] == 'True'
+              b1.use ReadState
+              #b1.use Provision
+              #b1.use SyncedFolderCleanup
+              #b1.use SyncedFolders
+              #b1.use SetHostname
+            end
+          end
+        end
+      end
+
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, ReadState do |env1, b1|
+            b1.use ReadState
+            if env1[:machine_state].to_s == 'not_created'
+              env1[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+                message: 'Not destroying VM in state ' + env1[:machine_state].to_s)
+            else
+              b1.use Halt unless env1[:machine_state] == 'halted'
+              b1.use ReadState
+              b1.use Call, WaitForState, :halted, 240 do |env2, b2|
+                b2.use ReadState
+                if env2[:result] == 'True'
+                  b2.use Destroy
+                end
+              end
+            end
+          end
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :Boot, action_root.join('boot')
+      autoload :CreateVM, action_root.join('createvm')
+      autoload :ReadState, action_root.join('read_state')
+      autoload :WaitForState, action_root.join('wait_for_state')
+      autoload :Address, action_root.join('address')
+      autoload :ReadSSHInfo, action_root.join('read_ssh_info')
+      autoload :Halt, action_root.join('halt')
+      autoload :Destroy, action_root.join('destroy')
+    end
+  end
+end
+      

data/lib/vagrant-qubes/action/address.rb

@@ -0,0 +1,40 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class Address
+        def initialize(app, _env, multi)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::address')
+          @multi = multi
+        end
+  
+        def call(env)
+          address(env)
+          @app.call(env)
+        end
+  
+        def address(env)
+          @logger.info('vagrant-qubes, address: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          # return nil if machine is down.
+          return nil if machine.state.id != :running
+
+          ssh_info = machine.ssh_info
+          return nil if !ssh_info
+
+          if @multi == true
+            env[:ui].info ssh_info[:host]
+          else
+            env[:ui].info ssh_info[:host]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/boot.rb

@@ -0,0 +1,47 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class Boot
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::boot')
+        end
+
+        def call(env)
+          boot(env)
+          @app.call(env)
+        end
+
+        def boot(env)
+          @logger.info('vagrant-qubes, boot: start...')
+
+          # Get config
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-qubes, boot: machine id: #{machine.id}")
+          @logger.info('vagrant-qubes, boot: current state: '\
+                       "#{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'running'
+            env[:ui].info I18n.t('vagrant_qubes.already_running')
+          elsif env[:machine_state].to_s == 'not_created'
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+              message: 'Cannot boot in state' + env[:machine_state].to_s)
+          else
+            command = 'qrexec-client-vm dom0 vagrant_start+' + env[:machine].config.vm.hostname
+            stdout, stderr, status = Open3.capture3(command)
+            if status != 0
+              raise Errors::QRExecError,
+                    message: 'qrexec failed with status' + status.to_s
+            end
+            env[:ui].info I18n.t('vagrant_qubes.states.running.long')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/createvm.rb

@@ -0,0 +1,68 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class CreateVM
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::createvm')
+        end
+
+        def call(env)
+          createvm(env)
+          @app.call(env)
+        end
+
+        def createvm(env)
+          @logger.info('vagrant-qubes, createvm: start...')
+
+          # Get config
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          if env[:machine_state].to_s == 'not_created'
+            env[:ui].info I18n.t('vagrant_qubes.vmbuild_not_done')
+          else
+            env[:ui].info I18n.t('vagrant_qubes.vmbuild_already_done')
+            return
+          end
+
+          # Do some config validation
+          if env[:machine].config.vm.hostname.nil?
+            raise Errors::GeneralError,
+                  message: 'Hostname is not set, fix Vagrantfile'
+            return
+          end
+
+          if config.guest_type.is_a? String
+            case config.guest_type
+            when 'AppVM'
+              command = 'echo "' + config.guest_type\
+                + ' ' + config.guest_label\
+                + ' ' + config.guest_template\
+                + ' ' + config.guest_numvcpus.to_s\
+                + ' ' + config.guest_memsize.to_s\
+                + ' ' + config.guest_netvm\
+                + '"| qrexec-client-vm dom0 vagrant_create+' + env[:machine].config.vm.hostname
+              stdout, stderr, status = Open3.capture3(command)
+              if status != 0
+                raise Errors::QRExecError,
+                      message: 'qrexec failed with status' + status.to_s
+              end
+            else
+              raise Errors::GeneralError,
+                    message: 'guest type ' + config.guest_type + ' is not supported'
+              return
+            end
+          else
+            raise Errors::GeneralError,
+                  message: 'Type is not a string, fix Vagrantfile'
+            return
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/destroy.rb

@@ -0,0 +1,49 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class Destroy
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::destroy')
+        end
+
+        def call(env)
+          destroy(env)
+          @app.call(env)
+        end
+
+        def destroy(env)
+          @logger.info('vagrant-qubes, destroy: start...')
+
+          # Get config
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-qubes, destroy: machine id: #{machine.id}")
+          @logger.info('vagrant-qubes, destroy: current state: '\
+                       "#{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+              message: 'Cannot destroy in state ' + env[:machine_state].to_s)
+          elsif env[:machine_state].to_s != 'halted'
+            raise Errors::GeneralError,
+            message: 'VM should have been halted before destroy'
+          else
+            command = 'qrexec-client-vm dom0 vagrant_destroy+' + env[:machine].config.vm.hostname
+            stdout, stderr, status = Open3.capture3(command)
+            if status != 0
+              raise Errors::QRExecError,
+                    message: 'qrexec failed with status' + status.to_s
+            end
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+              message: env[:machine].config.vm.hostname + ' Removed')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/halt.rb

@@ -0,0 +1,47 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class Halt
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::halt')
+        end
+
+        def call(env)
+          halt(env)
+          @app.call(env)
+        end
+
+        def halt(env)
+          @logger.info('vagrant-qubes, halt: start...')
+
+          # Get config
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-qubes, halt: machine id: #{machine.id}")
+          @logger.info('vagrant-qubes, halt: current state: '\
+                       "#{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'halted'
+            env[:ui].info I18n.t('vagrant_qubes.already_halted')
+          elsif env[:machine_state].to_s == 'not_created'
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+              message: 'Cannot halt in state ' + env[:machine_state].to_s)
+          else
+            command = 'qrexec-client-vm dom0 vagrant_stop+' + env[:machine].config.vm.hostname
+            stdout, stderr, status = Open3.capture3(command)
+            if status != 0
+              raise Errors::QRExecError,
+                    message: 'qrexec failed with status' + status.to_s
+            end
+            env[:ui].info I18n.t('vagrant_qubes.states.halted.long')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/read_ssh_info.rb

@@ -0,0 +1,72 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class ReadSSHInfo
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::read_ssh_info')
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(env)
+          @app.call(env)
+        end
+
+        def read_ssh_info(env)
+          @logger.info('vagrant-qubes, read_ssh_info: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          # return nil if machine.id.nil?
+
+          #  most of the time, state will be nil.   But that's OK, we need to
+          #  continue to read_ssh_info...
+          if (env[:machine_state].to_s == 'not_created' ||
+            env[:machine_state].to_s == 'halted' )
+            config.saved_ipaddress = nil
+            return nil
+          end
+
+          @logger.info("vagrant-qubes, read_ssh_info: machine id: #{machine.id}")
+          @logger.info('vagrant-qubes, read_ssh_info: current state:'\
+                       " #{env[:machine_state]}")
+
+          if config.saved_ipaddress.nil? or config.local_use_ip_cache == 'False'
+            # Figure out vm_ipaddress
+
+            command = 'qrexec-client-vm dom0 vagrant_list+' + env[:machine].config.vm.hostname
+            stdout, stderr, status = Open3.capture3(command)
+
+            fields = stdout.split('|')
+            ipaddress = fields.at(3).to_s
+
+#            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+#              message: 'address ' + ipaddress)
+
+            return nil if (ipaddress == '')
+
+            config.saved_ipaddress = ipaddress
+
+            return {
+              host: ipaddress,
+              port: 22
+            }
+          else
+            env[:ui].info "Using cached guest IP address"
+            ipaddress = config.saved_ipaddress
+
+            return {
+              host: ipaddress,
+              port: 22
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/read_state.rb

@@ -0,0 +1,54 @@
+require 'log4r'
+require 'open3'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class ReadState
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_qubes::action::read_state')
+        end
+
+        def call(env)
+          env[:machine_state] = read_state(env)
+          @app.call(env)
+        end
+
+        def read_state(env)
+          @logger.info('vagrant-qubes, read_state: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          #return :not_created if machine.id.to_i < 1
+
+          state = ''
+
+          command = 'qrexec-client-vm dom0 vagrant_list+' + env[:machine].config.vm.hostname
+#          env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+#            message: command)
+          stdout, stderr, status = Open3.capture3(command)
+          stdout.each_line do |line|
+            fields = line.split('|')
+            state = fields.at(1)
+#            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+#              message: 'state ' + state)
+          end
+
+          case state
+          when 'Running'
+            return :running
+          when 'Halted'
+            return :halted
+          when 'Transient'
+            return :transient
+          else        
+            return :not_created
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/action/wait_for_state.rb

@@ -0,0 +1,47 @@
+require 'log4r'
+require 'timeout'
+
+module VagrantPlugins
+  module Qubes
+    module Action
+      class WaitForState
+        # env[:result] will be false in case of timeout.
+        # @param [Symbol] state Target machine state.
+        # @param [Number] timeout Timeout in seconds.
+        def initialize(app, _env, state, timeout)
+          @app     = app
+          @logger  = Log4r::Logger.new('vagrant_qubes::action::wait_for_state')
+          @state   = state
+          @timeout = timeout
+        end
+
+        def call(env)
+          env[:result] = 'True'
+          if env[:machine].state.id != @state
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+                                 message: "Waiting for state \"#{@state}\"")
+            begin
+              Timeout.timeout(@timeout) do
+                until env[:machine].state.id == @state
+                  sleep 4
+                end
+                env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+                                     message: "Success, state is now \"#{@state}\"")
+              end
+
+            rescue Timeout::Error
+              env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+                                   message: "Timeout waiting for \"#{@state}\"")
+              env[:result] = 'False' # couldn't reach state in time
+            end
+          else
+            env[:ui].info I18n.t('vagrant_qubes.vagrant_qubes_message',
+              message: "Success, state is now \"#{@state}\"")
+          end
+          env[:machine].provider_config.saved_ipaddress = nil
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/config.rb

@@ -0,0 +1,32 @@
+#  Config
+
+module VagrantPlugins
+  module Qubes
+    # Config class
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :debug
+      attr_accessor :guest_type
+      attr_accessor :guest_label
+      attr_accessor :guest_template
+      attr_accessor :guest_numvcpus
+      attr_accessor :guest_memsize
+      attr_accessor :guest_netvm
+      attr_accessor :saved_ipaddress
+
+      def initialize
+        @debug = 'False'
+        @local_use_ip_cache = 'True'
+        @saved_ipaddress = nil
+      end
+
+      def finalize!
+        if @local_use_ip_cache =~ /false/i
+          @local_use_ip_cache = 'False'
+        else
+          @local_use_ip_cache = 'True'
+        end
+        @saved_ipaddress = nil
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/errors.rb

@@ -0,0 +1,20 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module Qubes
+    module Errors
+      class QubesErrors < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_qubes.errors')
+      end
+
+      class QRExecError < QubesErrors
+        error_key(:qrexec_error)
+      end
+
+      class GeneralError < QubesErrors
+        error_key(:general_error)
+      end
+    end
+  end
+end
+  

data/lib/vagrant-qubes/plugin.rb

@@ -0,0 +1,59 @@
+module VagrantPlugins
+  module Qubes
+    class Plugin < Vagrant.plugin('2')
+      name 'vagrant-qubes'
+      description 'Vagrant Qubes provider plugin'
+      config(:vagrant_qubes, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      provider(
+        :vagrant_qubes,
+        box_format: %w(qubes),
+        parallel: true
+      ) do
+        setup_logging
+        setup_i18n
+      
+      require_relative 'provider'
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        require 'pathname'
+        I18n.load_path << File.expand_path('locales/en.yml', Qubes.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil unless level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_qubes')
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/provider.rb

@@ -0,0 +1,103 @@
+require 'log4r'
+require 'vagrant'
+
+module VagrantPlugins
+  module Qubes
+    # Provider class
+    class Provider < Vagrant.plugin('2', :provider)
+      # @param [Boolean] raise_error If true, raise exception if not usable.
+      # @return [Boolean]
+      def self.usable?(raise_error=false)
+        # Return true by default for backwards compat since this was
+        # introduced long after providers were being written.
+        true
+      end
+
+      # If Environment.can_install_provider? returns false, then an error
+      # will be shown to the user.
+      def self.installed?
+        # By default return true for backwards compat so all providers
+        # continue to work.
+        true
+      end
+
+      # @param [Vagrant::Machine] machine The machine that this provider
+      # is responsible for.
+      def initialize(machine)
+        @machine = machine
+        @logger = Log4r::Logger.new('vagrant_qubes::action::provider')
+      end
+
+      # @param [Symbol] name Name of the action.
+      # @return [Object] A callable action sequence object, whether it
+      #   is a proc, object, etc.
+      def action(name)
+        method = "action_#{name}"
+        if Action.respond_to? method
+          Action.send(method)
+        else
+          # the specified action is not supported
+          nil
+        end
+      end
+
+      # This method is called if the underlying machine ID changes. Providers
+      # can use this method to load in new data for the actual backing
+      # machine or to realize that the machine is now gone (the ID can
+      # become `nil`). No parameters are given, since the underlying machine
+      # is simply the machine instance given to this object. And no
+      # return value is necessary.
+      def machine_id_changed
+      end
+
+      # This should return a hash of information that explains how to
+      # SSH into the machine. If the machine is not at a point where
+      # SSH is even possible, then `nil` should be returned.
+      #
+      # The general structure of this returned hash should be the
+      # following:
+      #
+      #     {
+      #       host: "1.2.3.4",
+      #       port: "22",
+      #       username: "mitchellh",
+      #       private_key_path: "/path/to/my/key"
+      #     }
+      #
+      # **Note:** Vagrant only supports private key based authentication,
+      # mainly for the reason that there is no easy way to exec into an
+      # `ssh` prompt with a password, whereas we can pass a private key
+      # via commandline.
+      #
+      # @return [Hash] SSH information. For the structure of this hash
+      #   read the accompanying documentation for this method.
+      def ssh_info
+        env = @machine.action('read_ssh_info')
+        env[:machine_ssh_info]
+      end
+
+      # This should return the state of the machine within this provider.
+      # The state must be an instance of {MachineState}. Please read the
+      # documentation of that class for more information.
+      #
+      # @return [MachineState]
+      def state
+        env = @machine.action('read_state')
+        state_id = env[:machine_state]
+
+        @logger.info("vagrant-qubes, boot: state_id: #{env[:state_id]}")
+
+        short = I18n.t("vagrant_qubes.states.#{state_id}.short")
+        long  = I18n.t("vagrant_qubes.states.#{state_id}.long")
+
+        # If we're not created, then specify the special ID flag
+        if state_id == :not_created
+          state_id = Vagrant::MachineState::NOT_CREATED_ID
+        end
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+    end
+  end
+end

data/lib/vagrant-qubes/version.rb

@@ -0,0 +1,6 @@
+module VagrantPlugins
+  module Qubes
+    VERSION = "0.0.1"
+    $vagrant_qubes_version = VERSION
+  end
+end

data/locales/en.yml

@@ -0,0 +1,55 @@
+en:
+  vagrant_qubes:
+    support: |-
+      -----------------------:----------------------
+      Please buy me beer if you meet me
+      -----------------------:----------------------
+      Author                 : Gary Pentland
+    errors:
+      general_error: |-
+        There was an error.
+          %{message}
+      qrexec_error: |-
+        There was an error executing qrexec - please configure qubes-rpc.
+          %{message}
+    vagrant_qubes_message: |-
+      --- %{message}
+    vmbuild_not_done: |-
+      Virtual Machine will be built.
+    vmbuild_already_done: |-
+      Virtual Machine is already built.
+    already_running: |-
+      The VM is already running.
+    already_halted: |-
+      The VM is already halted.
+#    already_suspended: |-
+#      The VM is already suspended.
+#    already_destroyed: |-
+#      The VM is destroyed.
+#    snapshot_saved: |-
+#      The snapshot has been saved.
+#    snapshot_deleted: |-
+#      The snapshot has been deleted.
+#    snapshot_restored: |-
+#      The snapshot has been restored.
+    states:
+      running:
+        short: |-
+          running
+        long: |-
+          The virtual machine is running.
+      halted:
+        short: |-
+          halted
+        long: |-
+          The virtual machine is halted.
+      transient:
+        short: |-
+          transient
+        long: |-
+          The virtual machine is transitioning between states.
+      not_created:
+        short: |-
+          not created
+        long: |-
+          No Virtual Machines are created.

data/qrexec-client-vm

@@ -0,0 +1 @@
+1 2 3 4 5 6 dom0 vagrant_create+test1

data/vagrant-qubes.gemspec

@@ -0,0 +1,33 @@
+# require_relative 'lib/vagrant-qubes/version'
+require File.expand_path('../lib/vagrant-qubes/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-qubes"
+  spec.version       = VagrantPlugins::Qubes::VERSION
+  spec.date          = '2021-06-30'
+  spec.authors       = ["Gary Pentland"]
+  spec.email         = [""]
+
+  spec.summary       = "Vagrant Qubes provider plugin"
+  spec.description   = "A plugin for vagrant to provision machines within a qubes environment"
+  spec.homepage      = "https://github.com/gp397/vagrant-qubes"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.add_runtime_dependency 'log4r', '~> 1.1'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-qubes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary Pentland
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A plugin for vagrant to provision machines within a qubes environment
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vagrant-qubes.rb
+- lib/vagrant-qubes/action.rb
+- lib/vagrant-qubes/action/address.rb
+- lib/vagrant-qubes/action/boot.rb
+- lib/vagrant-qubes/action/createvm.rb
+- lib/vagrant-qubes/action/destroy.rb
+- lib/vagrant-qubes/action/halt.rb
+- lib/vagrant-qubes/action/read_ssh_info.rb
+- lib/vagrant-qubes/action/read_state.rb
+- lib/vagrant-qubes/action/wait_for_state.rb
+- lib/vagrant-qubes/config.rb
+- lib/vagrant-qubes/errors.rb
+- lib/vagrant-qubes/plugin.rb
+- lib/vagrant-qubes/provider.rb
+- lib/vagrant-qubes/version.rb
+- locales/en.yml
+- qrexec-client-vm
+- vagrant-qubes.gemspec
+homepage: https://github.com/gp397/vagrant-qubes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gp397/vagrant-qubes
+  source_code_uri: https://github.com/gp397/vagrant-qubes
+  changelog_uri: https://github.com/gp397/vagrant-qubes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Vagrant Qubes provider plugin
+test_files: []