lita-openvpnas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75f2d35fa1bd46a324c96a272e8e2d4dd9aa98cb
+  data.tar.gz: 441dc393fa4ed9c870c49f6eb07bbc37492cb654
+SHA512:
+  metadata.gz: 77d243c1711b4b2cad979d2d372571e132b78364eec8d65cdcde6c57454dd1b97e312a28a321af813c509642eed5c3270936a914791051a30dd464a502ecb7b1
+  data.tar.gz: 94dac5ff85cb9f8109e7528d1f7b32f6b9c199d1a9cb22385c275b7e5a3c0b81b06e75d386c988fdb2d6f5e6de8b6487eaf07d7f6304ae3f0f0b2bf330200f71

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+## Welcome!
+
+We're so glad you're thinking about contributing to a KnuEdge open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
+
+We want to ensure a welcoming environment for all of our projects. Our IT staff encourage ethical contribution to our open source projects and all contributors should do the same.
+
+We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE), and its [README](README.md).
+
+If you have any questions just [shoot us an email](mailto:opensource@knuedge.com).
+
+## Licensing
+
+This project and all code contained within it are released under the [MIT License](https://opensource.org/licenses/MIT).
+
+All contributions to this project will be released under the [MIT License](https://opensource.org/licenses/MIT). By submitting a pull request, you are agreeing to comply
+with this license and for any contributions to be released under it.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 KnuEdge
+
+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,25 @@
+# lita-openvpnas
+
+A [Lita](https://www.lita.io/) handler plugin for some basic [OpenVPN Access Server](https://openvpn.net/index.php/access-server/overview.html) operations.
+
+## Installation
+
+Add lita-openvpnas to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-openvpnas"
+```
+
+## Configuration
+
+* `config.handlers.openvpnas.hostname` - OpenVPN Access Server hostname
+* `config.handlers.openvpnas.sacli_dir` - Path to the directory containing the `sacli` utility on the OpenVPN Access Server
+  * Defaults to `/usr/local/openvpn_as/scripts`
+* `config.handlers.openvpnas.ssh_user` - SSH user to connect to OpenVPN Access Server
+  * Defaults to `lita`
+
+## Usage
+
+#### Unlock the Google Authenticator for a User
+    openvpn otp unlock <user>
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-openvpnas.rb

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

data/lib/lita/handlers/openvpnas.rb

@@ -0,0 +1,66 @@
+module Lita
+  module Handlers
+    class Openvpnas < Handler
+      namespace 'OpenVPNAS'
+      config :hostname, required: true, type: String
+      config :ssh_user, required: false, type: String
+      config :sacli_dir, required: false, type: String
+
+      route(
+        /(openvpn)\s+(otp)\s+(unlock)\s+(\S+)/i,
+        :openvpn_as_otp_unlock,
+        command: true,
+        help: {
+          "openvpn otp unlock <user>" => "Unlock the OTP Authenticator for an OpenVPN AS user."
+        }
+      )
+
+      def openvpn_as_otp_unlock(response)
+        user = response.matches[0][3]
+        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.")
+
+        exception = nil
+
+        remote = Rye::Box.new(
+          ssh_host,
+          user: ssh_user,
+          auth_methods: ['publickey'],
+          password_prompt: false
+        )
+
+        result = begin
+          Timeout::timeout(60) do
+            remote.cd 'path_to_sacli'
+            # Need to use sudo
+            remote.enable_sudo
+            # scary...
+            remote.disable_safe_mode
+
+            remote.execute "./sacli -u #{user} --lock 0 GoogleAuthLock 2>&1"
+          end
+        rescue Rye::Err => e
+          exception = e
+        rescue StandardError => e
+          exception = e
+        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}!")
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-openvpnas.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-openvpnas"
+  spec.version       = "0.1.0"
+  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.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_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'
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      openvpnas:

data/spec/lita/handlers/openvpnas_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+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.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: lita-openvpnas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Gnagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  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: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Some basic OpenVPN Access Server interactions for Lita
+email:
+- jgnagy@knuedge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-openvpnas.rb
+- lib/lita/handlers/openvpnas.rb
+- lita-openvpnas.gemspec
+- locales/en.yml
+- spec/lita/handlers/openvpnas_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/knuedge/lita-openvpnas
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Allow the Lita bot to handle requests for OpenVPN Access Server tasks
+test_files:
+- spec/lita/handlers/openvpnas_spec.rb
+- spec/spec_helper.rb