arp-revolver 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23c8932ff3df114607d2b3d2b6acf2db8146fe25980007ca291bcac97def0b68
+  data.tar.gz: fe51e196fad058166eb795ce5c95bc027d67c8a43a8128a1e07bc15c50a9ab29
+SHA512:
+  metadata.gz: f45d674327a6e066aafbb80cc262aa262e57735496e4fe33dce7156efbcffc270ff2120b9df7797c4792b146cdca1d2aea2466fef8dd6afdfbaa8866e31a986d
+  data.tar.gz: 44b98768b09ed9a4407ce8b84bb5cafe09f935bdbcb647728a039c3c7ca5726c3767bf1ccd17f2558d5c5811dc506ab04880e27d774d4e933bc4a2c61a5335fd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

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 kylewang@teamt5.org. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    arp-revolver (0.1.1)
+      sentry-raven (~> 3.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+    sentry-raven (3.1.1)
+      faraday (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arp-revolver!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 kylewang
+
+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,43 @@
+# ArpRevolver
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/arp_revolver`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arp-revolver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ sudo gem install arp-revolver
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/arp-revolver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 ArpRevolver project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/arp-revolver/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/arp-revolver.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "arp_revolver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "arp-revolver"
+  spec.version       = ArpRevolver::VERSION
+  spec.authors       = "Komami"
+  spec.email         = ""
+  spec.license       = "MIT"
+  spec.summary       = "Switch Mac Address"
+  spec.description   = <<-DESC
+    To switch mac address for static arp endpoint.
+
+    This invokes arping command for health checking.
+    If no responding for 3 times, it'll try to switch mac address for the target host,
+    according to the config file /etc/arp-revolver/arp-revolver.yml.
+
+    Before execute must to make sure that user is root,
+    because changed the mac address is a root command.
+  DESC
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "sentry-raven", "~> 3.1.1"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arp_revolver"
+
+# 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,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+touch /etc/arp-revolver.yml
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/arp_revolver.rb

@@ -0,0 +1,98 @@
+# Structure for arp-revolver.yml
+#
+# pings: 3
+# online_threshold: 1
+# sentry_dsn: $sentry_dsn
+# hosts:
+#   $hostname:
+#     interface: $interface
+#     mac_addrs:
+#       - $mac_addr1
+#       - $mac_addr1
+#
+# sentry_dsn will be the log morintor endpoint.
+
+require "arp_revolver/version"
+require 'net/http'
+require 'raven'
+require 'yaml'
+
+module ArpRevolver
+  class << self
+    def revolver_config
+      file_path = "/etc/arp-revolver.yml"
+
+      raise StandardError, "config file must be 640 mode" unless File.stat(file_path).mode.to_s(8)[3..5] == "640"
+
+      @revolver_config ||= YAML.load_file(file_path)
+
+      raise StandardError, "config file is needed" unless @revolver_config
+
+      @revolver_config
+    end
+
+    def trigger
+      revolver_config["hosts"]&.each do |host, config|
+        return puts "Info: #{host} connection is OK" if health_trigger(config["interface"], host)
+
+        error_msg = "Error: #{host} connection Fail, try to change the MAC address."
+
+        puts error_msg
+
+        send_sentry(error_msg, level: :error)
+
+        old_mac_addr = config["mac_addrs"].delete(current_mac_addr(host))
+
+        config["mac_addrs"].each do |mac_addr|
+          IO.popen "echo $(arp -s #{host} #{mac_addr})"
+
+          if health_trigger(config["interface"], host)
+            puts "ARP Revolver: switch mac address from <#{old_mac_addr}> to <#{mac_addr}> for HOST (#{host})"
+
+            return
+          else
+            error_msg = "Error: #{host}[#{current_mac_addr(host)}] connection Fail, try to change the MAC address."
+
+            puts error_msg
+          end
+        end
+
+        unless health_trigger(config["interface"], host)
+          error_msg = "Error: #{host} connection still Fail, after tried all MAC addresses."
+
+          puts error_msg
+
+          send_sentry(error_msg, level: :error)
+        end
+      end
+    end
+
+    def health_trigger(interface, host)
+      IO.popen("arping -c #{revolver_config["pings"]} -I #{interface} #{host}") do |io|
+        result = io.read.lines.last.strip.match(/Received\ (?<num>\d)\ response\(s\)/)
+
+        result[:num].to_i >= revolver_config["online_threshold"]
+      end
+    end
+
+    def current_mac_addr(host)
+      IO.popen("arp -e") do |io|
+        info = io.read.lines.select { |line| line.match(/#{host}/) }
+
+        info.first&.split(" ")&.[](2)
+      end
+    end
+
+    def send_sentry(message, level: :error)
+      return puts(message) unless (sentry_dsn = revolver_config["sentry_dsn"])
+
+      Raven.configure do |config|
+        config.dsn = revolver_config["sentry_dsn"]
+      end
+
+      Raven.capture_message(message, level: level)
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/arp_revolver/version.rb

@@ -0,0 +1,3 @@
+module ArpRevolver
+  VERSION = "0.1.1"
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,19 @@
+Gem.post_install do
+  puts "Create config file"
+
+  File.open("/etc/arp-revolver.yml", "w") do |file|
+    file.write <<~YML
+      pings: 3
+      online_threshold: 1
+      # sentry_dsn: $sentry_dsn
+      # hosts:
+      #   $hostname:
+      #     interface: $interface
+      #     mac_addrs:
+      #       - $mac_addr1
+      #       - $mac_addr1
+    YML
+  end
+
+  File.chmod(0640, "/etc/arp-revolver.yml")
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: arp-revolver
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Komami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: |2
+      To switch mac address for static arp endpoint.
+
+      This invokes arping command for health checking.
+      If no responding for 3 times, it'll try to switch mac address for the target host,
+      according to the config file /etc/arp-revolver/arp-revolver.yml.
+
+      Before execute must to make sure that user is root,
+      because changed the mac address is a root command.
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- arp-revolver.gemspec
+- bin/console
+- bin/setup
+- lib/arp_revolver.rb
+- lib/arp_revolver/version.rb
+- lib/rubygems_plugin.rb
+homepage: 
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Switch Mac Address
+test_files: []