knocker 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b4289625cc8b8ca43224fc4529d4472a91a2aeb
+  data.tar.gz: eeda48021083930707232a70ead8f0d268d0aca4
+SHA512:
+  metadata.gz: 70096d1ec8d32d66acee9e44f3a2b640d214f4ca61e7c8352dc7338f65d7048ec2acd964fb9ad9a7feaf50a9dee0ce1116ad78c588afe87336fdbd2c39a97f86
+  data.tar.gz: 67a4544b1cc2c67de4e647b1d56ae498e7692399c61ce04d455a3ddce214b538324fc4cc0cc8810b87f33582d804df8654e010fd91e53265910f38fbfed6fe2e

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knocker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert McLeod
+
+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,81 @@
+# Knocker
+
+I wanted to use knock servers but wasn't sure how to remember all the knock patterns, plus I pretty much always want to run specific commands straight after knocking.
+
+I also love `.ssh/config` files (if you don't use one, you are missing out!), so simple yet so powerful.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knocker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knocker
+
+## Usage
+
+Like an SSH config is powerful for connecting to SSH daemons:
+
+```
+# SSH config file
+Host myvps
+  Hostname vps.example.com
+  User robert
+  Port 22022
+  DynamicForward 50000
+  LocalForward 3000:localhost:3000
+  ForwardX11 yes
+```
+
+I want knocker to be powerful for connecting to knock daemons:
+
+Each config file stores knock patterns which include:
+
+* hostname
+* knock specs
+* commands to run after knocking
+
+```
+# Knocker config file
+# keep this secret, knock patterns are almost like passwords
+pattern pvtchatops
+  host myvps.example.com
+  u 5445
+  t 4456
+  t 63854
+  c xchat --url=irc://myvps.example.com:36777/chatops
+```
+
+So when you run `nkr pvtchatops` it actually runs two commands:
+
+* The knock client command: `knock myvps.example.com 5445:udp 4456:tcp 63854:tcp`
+* The post command: `xchat --url=irc://myvps.example.com:36777/chatops`
+
+Easy!
+
+### The rules
+
+As you saw, the config syntax is simple.
+
+* h and then the hostname/ip to connect to
+* t and the port number for a tcp knock (multiples allowed)
+* u and the port number for a udp knock (multiples allowed)
+* c and the command to run after knocking (multiples allowed)
+
+**Mix this with SSH config files and you will an unstoppable sysadmin!**
+
+**KEEP THE CONFIG FILE SECRET!!!**
+
+## Contributing
+
+1. Fork it ( http://github.com/penguinpowernz/knocker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :console do
+  system "bundle console"
+end
+
+task :c do
+  system "bundle console"
+end
+
+task :test => :spec

data/bin/nkr

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'knocker'
+require 'fileutils'
+
+name = ARGV[0]
+
+begin
+  pattern = Knocker.pattern(name)
+  system pattern.knock_command
+  
+  pattern.post_commands.each do |cmd|
+    system cmd
+  end
+rescue Knocker::Errors::ConfigNotFound
+  print "No config found, create one at #{Knocker.config}? [y/n]: "
+  FileUtils.touch Knocker.config if STDIN.gets.match /y/i
+rescue Knocker::Errors::PatternNotFound
+  abort "No such pattern #{name}"
+rescue Knocker::Errors::NoHostSpecified
+  abort "No host specified in pattern #{name}"
+rescue Knocker::Errors::NoKnockSpecified
+  abort "No port-knocks specified in pattern #{name}"
+rescue Knocker::Errors::InvalidProtocol => e
+  abort "Invalid protocol #{e.message} in pattern #{name}"
+rescue Knocker::Errors::InvalidPort => e
+  abort "Invalid port #{e.message} in pattern #{name}"
+end

data/examples/config

@@ -0,0 +1,18 @@
+# Knocker config file
+
+# pattern name
+#   u udp_port knock_count
+#   t tcp_port knock_count
+#   c command to run
+
+# pattern vps1ssh
+#   u 4444 3
+#   t 3333 4
+#   u 7685 2
+#   c ssh usavps01
+
+# pattern chatops
+#   u 2456 4
+#   t 6767 5
+#   t 2245 3
+#   c xchat irc://my.private.irc:26777/chatops

data/knocker.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knocker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knocker"
+  spec.version       = Knocker::VERSION
+  spec.authors       = ["Robert McLeod"]
+  spec.email         = ["robert@penguinpower.co.nz"]
+  spec.summary       = %q{Uses stored config to knocks on knock daemons}
+  spec.description   = %q{Uses a config file to knock on a host and execute command(s), tries to mimic .ssh/config function}
+  spec.homepage      = "https://github.com/penguinpowernz/knocker"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/knocker.rb

@@ -0,0 +1,16 @@
+require "knocker/version"
+require "knocker/errors"
+require "knocker/parser"
+require "knocker/pattern"
+
+module Knocker
+  class << self
+    def config
+      "#{ENV["HOME"]}/.config/knocker/config"
+    end
+
+    def pattern(name)
+      Knocker::Parser.new(config).find(name).to_hash
+    end
+  end
+end

data/lib/knocker/errors.rb

@@ -0,0 +1,10 @@
+module Knocker
+  module Errors
+    class ConfigNotFound < StandardError; end
+    class PatternNotFound < StandardError; end
+    class NoHostSpecified < StandardError; end
+    class NoKnockSpecified < StandardError; end
+    class InvalidProtocol < StandardError; end
+    class InvalidPort < StandardError; end
+  end
+end

data/lib/knocker/parser.rb

@@ -0,0 +1,29 @@
+module Knocker
+  class Parser
+    def initialize(config)
+      raise Knocker::Errors::ConfigNotFound unless File.exist? config
+      @config = File.read(config).reject! {|line| line.start_with? "#"}
+    end
+
+    def find(name)
+      has_pattern! name
+      Pattern.new name, extract(name)
+    end
+
+    private
+
+    def has_pattern!(name)
+      raise Knocker::Errors::PatterNotFound unless 
+        @config.include? "pattern #{name}"
+    end
+
+    def extract(name)
+      start = @config.lines.index("pattern #{name}")
+      
+      @config.lines[start..-1].collect { |line|
+        break if line.blank?
+        line
+      }.join("\n")
+    end
+  end
+end

data/lib/knocker/pattern.rb

@@ -0,0 +1,56 @@
+module Knocker
+  class Pattern
+    attr_reader :name
+
+    def initialize(name, text)
+      @name = name
+      @text = text
+    end
+
+    def to_hash
+      {
+        :host => host,
+        :knock_command => knock_command,
+        :name => @name
+      }
+    end
+
+    def host
+      host = @text.scan(/  h (.*)/).flatten.first
+      raise Knocker::Errors::NoHostSpecified if host.nil? or host.blank?
+    end
+
+    def knock_command
+      patterns = []
+
+      patterns = @text.scan(/  ([ut]) (\d+)/).collect do |proto, port|
+        valid_port!(port)
+        "#{port}:#{protocol!(proto)}"
+      end
+
+      raise Knocker::Errors::NoKnockSpecified if patterns.empty?
+
+      "knock #{host} #{patterns.join(" ")}"
+    end
+
+    def post_commands
+      cmds = @text.scan(/^  c (.*)$/)
+      cmds.map! do |cmd|
+        cmd.gsub! /\$host/, host
+      end
+    end
+
+    private
+
+    def protocol!(char)
+      return "udp" if char == "u"
+      return "tcp" if char == "t"
+      raise Knocker::Errors::InvalidProtocol, char
+    end
+
+    def valid_port!(port)
+      raise Errors::InvalidPort, port if port.to_i.zero?
+      raise Errors::InvalidPort, port if port.to_i > 65535
+    end
+  end
+end

data/lib/knocker/version.rb

@@ -0,0 +1,3 @@
+module Knocker
+  VERSION = "0.2.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: knocker
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Robert McLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  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'
+description: Uses a config file to knock on a host and execute command(s), tries to
+  mimic .ssh/config function
+email:
+- robert@penguinpower.co.nz
+executables:
+- nkr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nkr
+- examples/config
+- knocker.gemspec
+- lib/knocker.rb
+- lib/knocker/errors.rb
+- lib/knocker/parser.rb
+- lib/knocker/pattern.rb
+- lib/knocker/version.rb
+homepage: https://github.com/penguinpowernz/knocker
+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: Uses stored config to knocks on knock daemons
+test_files: []