vtk 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 469019fb5bc0695ac68a0deab5ff68305f62852cbe38207bbb199cfee99f805b
-  data.tar.gz: e81be7f9896a0f057bf4c0c5fb55e904ffecd1fbd56951a84ac8fe9d334e9e0e
+  metadata.gz: 5330833427f91a051537c3289baa3dff860f28a03fe3b47508d34e2eaeaffe3d
+  data.tar.gz: 00bf91a02ad6e3640c6a70cd1ab58581e70e8b73d04f29c8b8711ae526b3b8a8
 SHA512:
-  metadata.gz: '01898cc5e93c4db7ff791b222f087d64f80730f20388ed35c8fdce2ad4adaec71e4fc417d515876baba10ddf64d38ac9978d1759e10e2418d44f71731f5b616f'
-  data.tar.gz: eddd67f1661dd3a0b7eefe49ab8e531ce1c3b26f4bd534cae9583dfee00c4cf721ae64179bbf42de31bf85c3b961b839c85700852401ef21eb8d54e37eb4afc7
+  metadata.gz: 60b2d9deaa896280656e6ccc25af0d200f020e82bf0a3f2a70244d1b3eed7d0288615049fe4ac1d2153f917475c5b5c48b3f51e9febb945b34bc5325e5ec2e99
+  data.tar.gz: e7a97e25802f2e2c16075b5033e74fe1d79a6878fd6bcad748bbf1272c617f4b1878c75e71996b9326c5a7a6ff85c39c4804ac3a8a1df7f884cc00d7839eaab6

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-07-29 22:40:06 UTC using RuboCop version 1.8.1.
+# on 2021-08-06 20:18:41 UTC using RuboCop version 1.8.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,4 +9,4 @@
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 351
+  Max: 405

data/CHANGELOG.md

@@ -1,11 +1,12 @@
 # Changelog
 
-## [Unreleased](https://github.com/department-of-veterans-affairs/vtk/tree/HEAD)
+## [v0.9.0](https://github.com/department-of-veterans-affairs/vtk/tree/v0.9.0) (2021-08-02)
 
-[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.8.0...HEAD)
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.8.0...v0.9.0)
 
 **Merged pull requests:**
 
+- SOCKS Setup Command [\#11](https://github.com/department-of-veterans-affairs/vtk/pull/11) ([ericboehs](https://github.com/ericboehs))
 - Command Analytics [\#8](https://github.com/department-of-veterans-affairs/vtk/pull/8) ([ericboehs](https://github.com/ericboehs))
 
 ## [v0.8.0](https://github.com/department-of-veterans-affairs/vtk/tree/v0.8.0) (2021-03-01)
@@ -37,10 +38,6 @@
 
 [Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.6...v0.3.0)
 
-**Merged pull requests:**
-
-- SOCKS On/Off Commands [\#9](https://github.com/department-of-veterans-affairs/vtk/pull/9) ([ericboehs](https://github.com/ericboehs))
-
 ## [v0.2.6](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.6) (2021-02-03)
 
 [Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.5...v0.2.6)
@@ -61,6 +58,7 @@
 **Merged pull requests:**
 
 - added Docker instructions to the README [\#10](https://github.com/department-of-veterans-affairs/vtk/pull/10) ([thilton-oddball](https://github.com/thilton-oddball))
+- SOCKS On/Off Commands [\#9](https://github.com/department-of-veterans-affairs/vtk/pull/9) ([ericboehs](https://github.com/ericboehs))
 - use system command [\#7](https://github.com/department-of-veterans-affairs/vtk/pull/7) ([LindseySaari](https://github.com/LindseySaari))
 - Add additional module subcommands [\#6](https://github.com/department-of-veterans-affairs/vtk/pull/6) ([LindseySaari](https://github.com/LindseySaari))
 - Check for Rails dependency [\#5](https://github.com/department-of-veterans-affairs/vtk/pull/5) ([LindseySaari](https://github.com/LindseySaari))
@@ -80,7 +78,6 @@
 **Merged pull requests:**
 
 - fixing markdown in README … [\#3](https://github.com/department-of-veterans-affairs/vtk/pull/3) ([thilton-oddball](https://github.com/thilton-oddball))
-- Open Jenkins [\#1](https://github.com/department-of-veterans-affairs/vtk/pull/1) ([cvalarida](https://github.com/cvalarida))
 
 ## [v0.1.0](https://github.com/department-of-veterans-affairs/vtk/tree/v0.1.0) (2021-01-04)
 
@@ -94,6 +91,10 @@
 
 [Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/79143038509757799edb2bb9be2f925b7d985221...oclif)
 
+**Merged pull requests:**
+
+- Open Jenkins [\#1](https://github.com/department-of-veterans-affairs/vtk/pull/1) ([cvalarida](https://github.com/cvalarida))
+
 
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/lib/vtk/commands/socks/setup.rb

@@ -28,35 +28,49 @@ module Vtk
         end
 
         def execute(input: $stdin, output: $stdout)
-          @input = input
-          @output = output
+          define_stdin_out_vars input: input, output: output
 
           setup_ssh_config
           check_ssh_key
           ssh_agent_add
 
-          test_ssh_connection unless skip_test
-
-          configure_system_boot
-          configure_system_proxy
-
-          test_http_connection unless skip_test
+          unless @ssh_key_created
+            test_ssh_connection unless skip_test
+            configure_system_boot
+            configure_system_proxy
+          end
 
-          log 'SOCKS setup complete.'
+          log "SOCKS setup complete. #{'Re-run `vtk socks setup` after your key is approved.' if @ssh_key_created}"
         end
 
         private
 
+        def define_stdin_out_vars(input:, output:)
+          @input = input
+          @output = output
+        end
+
         def check_ssh_key
-          return true if key_exists?
+          return true if key_exists? && private_and_public_keys_match?
 
-          generate_key_and_open_key_access_request
+          @ssh_key_created = generate_key_and_open_key_access_request
         end
 
         def key_exists?
           File.exist? ssh_key_path
         end
 
+        def private_and_public_keys_match?
+          return true unless public_key_exists?
+
+          pub_key_from_private = `ssh-keygen -y -e -f #{ssh_key_path}`
+          pub_key_from_public = `ssh-keygen -y -e -f #{ssh_key_path}.pub`
+          return true if pub_key_from_private == pub_key_from_public
+
+          log "❌ ERROR: #{ssh_key_path}.pub is not the public key for #{ssh_key_path}."
+          exit 1
+        end
+
         def public_key_exists?
           File.exist? "#{ssh_key_path}.pub"
         end
@@ -67,29 +81,46 @@ module Vtk
 
           if prompt.yes?(copy_and_open_gh)
             copy_key_to_clipboard
-            `#{'xdg-' unless macos?}open "#{access_request_template_url}" 2> /dev/null`
+            open_command access_request_template_url
           else
-            log "You'll need to submit ~/.ssh/id_rsa_vagov.pub for approval to: #{access_request_template_url}."
+            key_contents = File.read "#{ssh_key_path}.pub"
+            log "Copy this key & submit into the access request form (#{access_request_template_url}):\n#{key_contents}"
           end
         end
 
         def copy_key_to_clipboard
           ssh_key_contents = File.read "#{ssh_key_path}.pub"
 
+          if copy_command
+            IO.popen(copy_command, 'w') { |f| f << ssh_key_contents }
+          elsif wsl?
+            system %(powershell.exe Set-Clipboard -Value "'#{ssh_key_contents}'")
+          end
+        end
+
+        def copy_command
           if macos?
-            copy_command = 'pbcopy'
-          elsif ubuntu_like?
+            'pbcopy'
+          elsif ubuntu_like? && !wsl?
             system 'sudo apt-get install -y xsel' if `which xsel`.empty?
-            copy_command = 'xsel --clipboard'
+            'xsel --clipboard'
           end
+        end
 
-          IO.popen(copy_command, 'w') { |f| f << ssh_key_contents }
+        def open_command(url)
+          if macos?
+            `open "#{url}"`
+          elsif wsl?
+            `powershell.exe Start '"#{url}"'`
+          elsif ubuntu_like?
+            `xdg-open "#{url}"`
+          end
         end
 
         def access_request_template_url
           'https://github.com/department-of-veterans-affairs/va.gov-team/issues/new?' \
-            'assignees=&labels=external-request%2C+operations&template=Environment-Access-Request-Template.md&' \
-            'title=Access+for+%5Bindividual%5D'
+            'assignees=&labels=external-request%2C+operations%2C+ops-access-request&' \
+            'template=Environment-Access-Request-Template.md&title=Access+for+%5Bindividual%5D'
         end
 
         def copy_and_open_gh
@@ -138,6 +169,8 @@ module Vtk
           ssh_config_clean_up
 
           ssh_agent_add
+          system 'git config --global credential.helper > /dev/null || ' \
+            "git config --global credential.helper 'cache --timeout=600'"
           cloned = system(
             "git clone --quiet#{' --depth 1' if macos?} --no-checkout --filter=blob:none #{repo_url} '/tmp/dova-devops'"
           )
@@ -250,16 +283,18 @@ module Vtk
 
           add_ip_to_known_hosts
 
-          ssh_output = `ssh -i #{ssh_key_path} -F #{ssh_config_path} -o ConnectTimeout=5 -q socks -D #{port} exit 2>&1`
-
-          if ssh_output.include? 'This account is currently not available.'
-            output.puts ' ✅'
+          if proxy_running? || ssh_output.include?('This account is currently not available.')
+            output.puts ' ✅ DONE'
           else
             check_ssh_error ssh_output
             exit 1
           end
         end
 
+        def ssh_output
+          `ssh -i #{ssh_key_path} -F #{ssh_config_path} -o ConnectTimeout=5 -q socks -D #{port} exit 2>&1`
+        end
+
         def add_ip_to_known_hosts
           jump_box_ip = `grep -A 2 'Host socks' ~/.ssh/config | grep ProxyCommand | awk '{print $6}'`.chomp
           socks_ip = `grep -A 2 'Host socks' ~/.ssh/config | grep HostName | awk '{print $2}'`.chomp
@@ -272,8 +307,8 @@ module Vtk
 
         def check_ssh_error(ssh_output)
           if ssh_output.include? 'Permission denied (publickey)'
-            @skip_test = true
             output.puts '⚠️  WARN: SSH key is not approved yet. Once it is, re-run `vtk socks setup`.'
+            copy_key_to_clipboard if prompt.yes? 'Would you like to copy your VA public key to your clipboard again?'
           else
             ssh_command = "ssh -i #{ssh_key_path} -F #{ssh_config_path} -o ConnectTimeout=5 -vvv socks -D #{port} -N"
             output.puts ' ❌ ERROR: SSH Connection to SOCKS server unsuccessful. Error message:'
@@ -284,10 +319,39 @@ module Vtk
 
         def configure_system_boot
           log 'Configuring SOCKS tunnel to run on system boot...' do
-            install_autossh && (install_launch_agent || install_systemd_service)
+            if wsl?
+              wsl_configure_system_boot && wsl_start_socks_proxy
+            else
+              install_autossh && (install_launch_agent || install_systemd_service)
+            end
           end
         end
 
+        def wsl_configure_system_boot
+          return true if File.exist? socks_bat
+
+          IO.write socks_bat, 'wsl nohup bash -c "/usr/bin/ssh socks -N &" < nul > nul 2>&1', mode: 'a'
+        end
+
+        def socks_bat
+          "#{socks_bat_dir}/gov.va.socks.bat"
+        end
+
+        def socks_bat_dir
+          profile_path = `wslpath "$(wslvar USERPROFILE)"`.chomp
+          "#{profile_path}/AppData/Roaming/Microsoft/Windows/Start Menu/Programs/Startup"
+        end
+
+        def wsl_start_socks_proxy
+          return true if proxy_running?
+
+          system "cd '#{socks_bat_dir}'; cmd.exe /c gov.va.socks.bat > /dev/null"
+        end
+
+        def proxy_running?
+          system("lsof -i:#{port}", out: '/dev/null') || system('lsof -nP | grep ssh | grep -q sock')
+        end
+
         def launch_agent_label
           @launch_agent_label ||= begin
             launch_agent_label = 'gov.va.socks'
@@ -374,6 +438,8 @@ module Vtk
 
           if macos?
             mac_configure_system_proxy
+          elsif wsl?
+            wsl_configure_system_proxy
           elsif ubuntu_like?
             ubuntu_configure_system_proxy
           end
@@ -398,6 +464,13 @@ module Vtk
           end
         end
 
+        def wsl_configure_system_proxy
+          log 'Configuring system proxy to use SOCKS tunnel...' do
+            reg_key = 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Internet Settings'
+            `powershell.exe Set-ItemProperty -path "'#{reg_key}'" AutoConfigURL -Value "'#{PROXY_URL}'"`
+          end
+        end
+
         def mac_system_proxy_already_configured?
           network_interfaces.map do |network_interface|
             output = `networksetup -getautoproxyurl "#{network_interface}"`
@@ -413,25 +486,14 @@ module Vtk
           end
         end
 
-        def test_http_connection
-          output.print '----> Testing SOCKS HTTP connection...'
-
-          success = 5.times.map do
-            sleep 1
-            not_connected = system "nscurl http://grafana.vfs.va.gov 2>&1 | grep -q 'hostname could not be found'"
-
-            break [true] unless not_connected
-          end.all?
-
-          output.puts success ? ' ✅' : ' ❌ ERROR: SOCKS connection failed HTTP test. Try running setup again.'
-
-          exit 1 unless success
-        end
-
         def macos?
           RUBY_PLATFORM.include? 'darwin'
         end
 
+        def wsl?
+          @wsl ||= File.exist?('/proc/version') && File.open('/proc/version').grep(/Microsoft/).size.positive?
+        end
+
         def ubuntu_like?
           return false if `which apt-get`.empty? && `which gsettings`.empty?
 
@@ -456,7 +518,7 @@ module Vtk
 
             return_value = yield
 
-            output.puts return_value ? ' ✅' : ' ❌'
+            output.puts return_value ? ' ✅ DONE' : ' ❌ FAIL'
 
             return_value
           else

data/lib/vtk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vtk
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vtk
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Eric Boehs
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor