lita-openvpnas 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2ea239c826e325e1ff971172be235aba600c264
-  data.tar.gz: 28c39d30f1353b51a1e8faca59aae67178fb06e6
+  metadata.gz: 988f886884de8479fd6eadab31adaa89b101e60a
+  data.tar.gz: 8c820c371be6d4d0da57c6306b407634aab6888a
 SHA512:
-  metadata.gz: e3d3de3042b4634b1b2a59066c15984d39c5172dc6555577d0651d8af0f11e3de37081c4e363344cbd2b376111e04eb9ce91d6a69a69c6b60b42703925d5efdd
-  data.tar.gz: 5395eb10b54f2e298c84ab3f843f7a3a77cda2a04ac59a0cd2987957452f1a6e56cc041cc0608069f7ad0b036b1efb2a3086fa7e8411064acbc677b6fce50944
+  metadata.gz: ec8cc8e0ab4d93ad3dabc7bdd7377b8c3bf005d673c45a7cab3b2df0b18da54503acdb116e463781c12ecdbf0d901aa0f944031686cb7d062849f5d762df03f9
+  data.tar.gz: 7d2898bcf2a54f76f35647134a18df5223569259e906e7fd91cb9ce61237766d44465fa74c6e4479f1b28bda5c5a75e676ec62ef277ce346044f27708b30b613

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Documentation:
+  Exclude:
+    - lib/lita/handlers/openvpnas.rb
+
+FileName:
+  Exclude:
+    - lib/lita-openvpnas.rb
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 150

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -23,3 +23,5 @@ gem "lita-openvpnas"
 #### Unlock the Google Authenticator for a User
     openvpn otp unlock <user>
 
+#### List Currently Connected VPN users
+    openvpn active users

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+task default: [:spec, :rubocop]

data/lib/lita-openvpnas.rb

@@ -1,14 +1,15 @@
-require "lita"
+require 'lita'
 require 'rye'
 require 'timeout'
+require 'json'
 
 Lita.load_locales Dir[File.expand_path(
-  File.join("..", "..", "locales", "*.yml"), __FILE__
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
 )]
 
-require "lita/handlers/openvpnas"
+require 'lita/handlers/openvpnas'
 
 Lita::Handlers::Openvpnas.template_root File.expand_path(
-  File.join("..", "..", "templates"),
- __FILE__
+  File.join('..', '..', 'templates'),
+  __FILE__
 )

data/lib/lita/handlers/openvpnas.rb

@@ -11,7 +11,16 @@ module Lita
         :openvpn_as_otp_unlock,
         command: true,
         help: {
-          "openvpn otp unlock <user>" => "Unlock the OTP Authenticator for an OpenVPN AS user."
+          'openvpn otp unlock <user>' => 'Unlock the OTP Authenticator for an OpenVPN AS user.'
+        }
+      )
+
+      route(
+        /(openvpn)\s+(active)\s+(users)/i,
+        :openvpn_as_active_users,
+        command: true,
+        help: {
+          'openvpn active users' => 'List the currently connected OpenVPN users.'
         }
       )
 
@@ -20,10 +29,57 @@ module Lita
         ssh_user = config.ssh_user || 'lita'
         ssh_host = config.hostname
         path_to_sacli = config.sacli_dir || '/usr/local/openvpn_as/scripts'
-        username = response.user.name.split(/\s/).first
 
-        response.reply("#{username}, let me unlock that user's OpenVPN authenticator for you.")
+        response.reply_with_mention t('replies.otp_unlock.working')
+
+        command = "./sacli -u #{user} --lock 0 GoogleAuthLock 2>&1"
+        exception = over_ssh(ssh_user, ssh_host, command, path_to_sacli)[1]
+
+        if exception
+          response.reply_with_mention t('replies.otp_unlock.failure')
+          response.reply '/code ' + exception.message
+        end
+
+        # build a reply
+        response.reply_with_mention t('replies.otp_unlock.success', user: user)
+      end
+
+      def openvpn_as_active_users(response)
+        ssh_user = config.ssh_user || 'lita'
+        ssh_host = config.hostname
+        path_to_sacli = config.sacli_dir || '/usr/local/openvpn_as/scripts'
+
+        response.reply_with_mention t('replies.active_users.working')
 
+        command = './sacli VPNStatus 2>&1'
+        result, exception = over_ssh(ssh_user, ssh_host, command, path_to_sacli)
+
+        if exception
+          response.reply_with_mention t('replies.active_users.failure')
+          response.reply '/code ' + exception.message
+        end
+
+        # Figure out who is connected and what their client IP is
+        clients = extract_clients(result)
+
+        # build a reply
+        response.reply_with_mention t('replies.active_users.failure', number: clients.size.to_s)
+        response.reply '/code ' + clients.each { |client, ip| "#{client} @ #{ip}" }.join("\n")
+      end
+
+      private
+
+      def extract_clients(json_data)
+        clients = []
+        JSON.parse(json_data).values.each do |data|
+          data['client_list'].each do |client|
+            clients << { user: client[0], ip: client[2] }
+          end
+        end
+        clients
+      end
+
+      def over_ssh(_user, _host, command, cwd = '/tmp')
         exception = nil
 
         remote = Rye::Box.new(
@@ -34,14 +90,14 @@ module Lita
         )
 
         result = begin
-          Timeout::timeout(60) do
-            remote.cd path_to_sacli
+          Timeout.timeout(60) do
+            remote.cd cwd
             # Need to use sudo
             remote.enable_sudo
             # scary...
             remote.disable_safe_mode
 
-            remote.execute "./sacli -u #{user} --lock 0 GoogleAuthLock 2>&1"
+            remote.execute command
           end
         rescue Rye::Err => e
           exception = e
@@ -50,14 +106,7 @@ module Lita
         ensure
           remote.disconnect
         end
-
-        if exception
-          response.reply_with_mention "That OpenVPN authenticator didn't seem to unlock... ;-("
-          response.reply "/code " + exception.message
-        end
-
-        # build a reply
-        response.reply_with_mention("That OpenVPN authenticator is now available for #{user}!")
+        [result, exception]
       end
 
       Lita.register_handler(self)

data/lita-openvpnas.gemspec

@@ -1,26 +1,27 @@
 Gem::Specification.new do |spec|
-  spec.name          = "lita-openvpnas"
-  spec.version       = "0.1.2"
-  spec.authors       = ["Jonathan Gnagy"].sort
-  spec.email         = ["jgnagy@knuedge.com"]
-  spec.description   = "Some basic OpenVPN Access Server interactions for Lita"
-  spec.summary       = "Allow the Lita bot to handle requests for OpenVPN Access Server tasks"
-  spec.homepage      = "https://github.com/knuedge/lita-openvpnas"
-  spec.license       = "MIT"
-  spec.metadata      = { "lita_plugin_type" => "handler" }
+  spec.name          = 'lita-openvpnas'
+  spec.version       = '0.1.3'
+  spec.authors       = ['Jonathan Gnagy'].sort
+  spec.email         = ['jgnagy@knuedge.com']
+  spec.description   = 'Some basic OpenVPN Access Server interactions for Lita'
+  spec.summary       = 'Allow the Lita bot to handle requests for OpenVPN Access Server tasks'
+  spec.homepage      = 'https://github.com/knuedge/lita-openvpnas'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = ['lib']
 
-  spec.add_runtime_dependency "lita", "~> 4.7"
-  spec.add_runtime_dependency "rye"
+  spec.add_runtime_dependency 'lita', '~> 4.7'
+  spec.add_runtime_dependency 'rye'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'travis', '~> 1.8'
 end

data/locales/en.yml

@@ -2,3 +2,12 @@ en:
   lita:
     handlers:
       openvpnas:
+        replies:
+          otp_unlock:
+            working: let me unlock that user's OpenVPN authenticator for you.
+            failure: That OpenVPN authenticator didn't seem to unlock... ;-(
+            success: "That OpenVPN authenticator is now available for %{user}!"
+          active_users:
+            working: let me see who is connected.
+            failure: The OpenVPN server didn't like my query... ;-(
+            success: "There are %{number} clients connect to the OpenVPN server:"

data/spec/lita/handlers/openvpnas_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Lita::Handlers::Openvpnas, lita_handler: true do
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "lita-openvpnas"
-require "lita/rspec"
+require 'lita-openvpnas'
+require 'lita/rspec'
 
 # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
 # was generated with Lita 4, the compatibility mode should be left disabled.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-openvpnas
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile