rg_refresh 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b54c12dfa4a5c985cfe527ab51c870b97ed2d0be2ebe9fd9fe2fed9f67649132
+  data.tar.gz: 7a4834fb5a821b5ad748ef9cfe6d6f60bb69081c4add0950187c942f6d242ea0
+SHA512:
+  metadata.gz: 38176b52ecca576d3e39519020961c6fc24da80c4be79dea040e26d132b53b073d0e87048f512b7d818fe39068c6a881cec5dd22f26830886b0c8dd4242f0163
+  data.tar.gz: 67cf55cf0abdaa33df2cd155050edb6f9b74670b511abb4092d1c1f94f89d41e48a4ec7769fb16bb301b2da18a2321e7880f663742b5df1965946507f1362d04

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rg_refresh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mike Pastore
+
+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,122 @@
+# rg_refresh
+
+Execute a VLAN "flop" to allow the AT&T Residential Gateway (RG) to perform
+802.1x authentication via the Optical Network Terminal (ONT) before falling
+back to the subscriber's "own" router/gateway hardware. The RG is toggled off
+and on as needed via a remote-controlled power outlet (see below).
+
+For more information about this procedure, please see brianlan's [original
+document][1] on DSL Reports.
+
+## Requirements
+
+* [Netgear gigabit-speed "Smart Managed Plus" switch][2]. The following models
+  are known to work:
+  * GS108Ev2
+  * GS105PE
+
+  Please submit a PR if you confirm another working model.
+* [MQTT broker][3] (like [this one][9])
+* "Smart" outlet that can be remotely-controlled (i.e. set "on" or "off") via a
+  message published to a MQTT bus. For example:
+  * SmartThings Hub, Zigbee or Z-Wave outlet, and [MQTT bridge][4]
+  * Z-Wave "stick" and outlet and [Home Assistant][5]
+  * Z-Wave "stick" and outlet and [MQTT bridge][6] (or [this one][7])
+  * Sonoff outlet flashed w/ [Tasmota][8] firmware
+* Host (for the script) with:
+  * Ruby interpreter
+  * Access to the Netgear management console via HTTP
+  * Access to the MQTT broker via TCP/IP
+
+> N.B. With a SmartThings- or other cloud-based solution, an Internet
+> connection is required to perform the VLAN flop, so if the operation fails
+> (or is attempted after your router has already lost its DHCP lease), your
+> network may get stuck in an inconsistent state. To recover, run the script
+> and toggle the RG power manually as indicated.
+
+## Installation
+
+Follow the [guide][1] to establish the initial network environment, which
+includes copying information from the RG to your own router. You should perform
+the VLAN flop one time through by hand to make sure everything is set up and
+working correctly. Jot down your VLAN IDs and port assignments for later.
+
+Next, pick a server where the script will run and install it:
+
+```console
+$ gem install rg_refresh
+```
+
+Create a configuration file and write it somewhere sensible, e.g.
+`/etc/rg_refresh.yml`, using the following template:
+
+```yaml
+---
+:netgear:
+  # Tip: Give your switch a static IP address or DNS name if possible.
+  :address: 'http://a.b.c.d'
+  :password: password
+  :vlans:
+    :rg: 2
+    :my_router: 3
+  :ports_vlans:
+    # ONT is on switch port #1 in this example.
+    # Put .<vlan> to reference above VLAN assignments.
+    # Put ~ to preserve the port's current VLAN assignment; trailing ~ can be
+    # omitted if desired.
+    :reauth: [.rg, .rg, .my_router]
+    :bypass: [.my_router, .rg, .my_router]
+:mqtt:
+  :client:
+    # This section is passed to MQTT::Client.connect as-is.
+    # https://www.rubydoc.info/gems/mqtt/MQTT/Client#instance_attr_details
+    :host: localhost
+    :port: 1883
+  :topic: smartthings/RG/switch
+  :messages:
+    # Remember to quote YAML-reserved terms like "on" and "off".
+    :reauth: 'on'
+    :bypass: 'off'
+```
+
+Run the script to make sure it works correctly, passing in the path to the
+configuration file created above. For example:
+
+```console
+$ rg_refresh -c /etc/rg_refresh.yml
+```
+
+Finally, schedule the script to run once a week or so, during off-hours,
+and/or when your router loses its DHCP lease.
+
+## 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/mwpastore/rg_refresh.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+[1]: http://www.dslreports.com/forum/r29903721-AT-T-Residential-Gateway-Bypass-True-bridge-mode
+[2]: https://www.netgear.com/business/products/switches/web-managed/gigabit-web-managed-switch.aspx
+[3]: https://github.com/mqtt/mqtt.github.io/wiki/servers
+[4]: https://github.com/stjohnjohnson/smartthings-mqtt-bridge#readme
+[5]: https://www.home-assistant.io/components/mqtt/
+[6]: https://github.com/adpeace/zwave-mqtt-bridge#readme
+[7]: https://github.com/ltoinel/ZWave2MQTT#readme
+[8]: https://github.com/arendst/Sonoff-Tasmota/wiki/MQTT-Overview
+[9]: https://github.com/mcollina/mosca#readme

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+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/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rg_refresh'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/rg_refresh

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'optparse'
+require 'rg_refresh'
+require 'yaml'
+
+opts = {}
+optparser = OptionParser.new do |cmd|
+  cmd.banner = "usage: #$0 [options]"
+
+  cmd.on('-c FILE', '--config=FILE', 'Configuration file') do |v|
+    opts[:config_file] = v
+  end
+end
+
+begin
+  optparser.parse!
+rescue OptionParser::InvalidOption=>e
+  $stderr.puts e
+
+  abort optparser.help
+end
+
+abort optparser.help \
+  unless opts[:config_file] && ARGV.empty?
+
+config = YAML.load(File.read(opts[:config_file]), :symbolize_names=>true)
+
+begin
+  puts 'Connecting...'
+  $netgear = RgRefresh::Netgear.start(config.fetch(:netgear))
+  $rg = RgRefresh::PublishWrapper.new(config.fetch(:mqtt))
+
+  puts 'Affirming bypass mode (manually power RG *OFF* if necessary)...'
+  $netgear.transition_to(:bypass)
+  sleep 15
+  $rg.transition_to(:bypass)
+  sleep 15
+
+  puts 'Transitioning to re-auth mode (manually power RG *ON* if necessary)...'
+  $rg.transition_to(:reauth)
+  $netgear.transition_to(:reauth) # point of no return
+
+  puts 'Waiting for re-auth...'
+  sleep 240
+
+  puts 'Transitioning to bypass mode (manually power RG *OFF* if necessary)...'
+  $netgear.transition_to(:bypass)
+  sleep 15
+  $rg.transition_to(:bypass)
+  sleep 15
+ensure
+  puts 'Disconnecting...'
+  $rg.finish
+  $netgear.finish
+end

data/lib/rg_refresh.rb

@@ -0,0 +1,4 @@
+require 'rg_refresh/version'
+
+require 'rg_refresh/netgear'
+require 'rg_refresh/publish_wrapper'

data/lib/rg_refresh/netgear.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+require 'http/cookie'
+require 'net/http'
+require 'uri'
+
+module RgRefresh
+  class Netgear
+    LoginRequired = Class.new(StandardError)
+
+    attr_reader \
+      :base_uri, :http, :password, :jar,
+      :ports_vlans,
+      :hash, :state
+
+    def initialize(opts)
+      @base_uri = URI(opts.fetch(:address))
+      @http = Net::HTTP.new(@base_uri.host, @base_uri.port)
+      @password = opts.fetch(:password)
+      @jar = HTTP::CookieJar.new
+
+      @ports_vlans = opts.fetch(:ports_vlans).each_value do |arr|
+        arr.map! do |vlan|
+          if (vlan_name = vlan.to_s[/^\.(.+)/, 1])
+            opts[:vlans].fetch(vlan_name.to_sym)
+          else
+            vlan
+          end
+        end
+      end
+
+      @hash = nil
+      @state = []
+    end
+
+    def self.start(opts)
+      new(opts).tap do |netgear|
+        netgear.login
+        netgear.sync
+      end
+    end
+
+    def login
+      res = post('/login.cgi', { :password=>password })
+
+      fail 'Maximum sessions reached' \
+        if res.body.include?('Maximum sessions reached')
+    end
+
+    def sync
+      res = request('/8021qBasic.cgi')
+
+      parse_inputs(res.body, /hash/, /port\d+/) do |name, value|
+        if name == 'hash'
+          @hash = value
+        elsif name.sub!(/^port/, '')
+          @state[name.to_i] = value.to_i
+        end
+      end
+    end
+
+    def transition_to(mode)
+      arr = ports_vlans.fetch(mode)
+
+      new_state = state
+        .map
+        .with_index {|vlan, port| arr[port] || vlan }
+
+      form_data = new_state
+        .map
+        .with_index {|vlan, port| ["port#{port}".to_sym, vlan] }
+        .to_h
+        .merge!(:status=>'Enable', :hash=>hash)
+
+      post('/8021qBasic.cgi', form_data)
+
+      sync
+
+      fail 'Unable to set VLANs' unless state == new_state
+    end
+
+    def finish
+      begin
+        request('/logout.cgi')
+      rescue LoginRequired
+      end
+
+      begin
+        http.finish
+      rescue IOError
+      end
+    end
+
+    private
+
+    def request(path, verb=:Get)
+      uri = base_uri.dup
+      uri.path += path
+
+      req = Net::HTTP.const_get(verb).new(uri)
+
+      # HTTP::Cookie's quoting is broken on older Rubies, so we'll do it manually.
+      #req['Cookie'] = HTTP::Cookie.cookie_value(jar.cookies(uri))
+      if (sid_cookie = jar.cookies(uri).find {|cookie| cookie.name == 'SID' })
+        req['Cookie'] = '%s=%s' % [sid_cookie.name, sid_cookie.value]
+      end
+
+      yield req if block_given?
+
+      res = http.request(req)
+      Array(res.get_fields('Set-Cookie')).each do |value|
+        jar.parse(value, uri)
+      end
+
+      raise LoginRequired if res.body.include?('RedirectToLoginPage')
+
+      res
+    end
+
+    def post(path, form_data)
+      request(path, :Post) do |req|
+        req.form_data = form_data
+      end
+    end
+
+    def parse_inputs(data, *pats)
+      name_re = /<input.+name=['"]?(#{Regexp.union(pats)})['"]?/
+      value_re = /value=['"]?(\d+)['"]?/
+
+      data.each_line do |line|
+        if (name = line[name_re, 1]) && (value = line[value_re, 1])
+          yield name, value
+        end
+      end
+    end
+  end
+end

data/lib/rg_refresh/publish_wrapper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'mqtt'
+
+module RgRefresh
+  class PublishWrapper
+    attr_reader :client, :topic, :messages
+
+    def initialize(opts)
+      @client = MQTT::Client.connect(opts.fetch(:client))
+      @topic = opts.fetch(:topic)
+      @messages = opts.fetch(:messages)
+    end
+
+    def transition_to(mode)
+      client.publish(topic, messages.fetch(mode))
+    end
+
+    def finish
+      client.disconnect
+    rescue
+    end
+  end
+end

data/lib/rg_refresh/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: false
+module RgRefresh
+  VERSION = '0.1.2'.freeze
+end

data/rg_refresh.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rg_refresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rg_refresh'
+  spec.version       = RgRefresh::VERSION
+  spec.authors       = ['Mike Pastore']
+  spec.email         = ['mike@oobak.org']
+
+  spec.summary       = 'Automated refresh script for the AT&T Residential Gateway bypass'
+  spec.homepage      = 'https://github.com/mwpastore/rg_refresh#readme'
+  spec.license       = 'MIT'
+
+  spec.files         = %x{git ls-files -z}.split("\x0").reject do |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 = %w{lib}
+
+  spec.required_ruby_version = '~> 2.2'
+
+  spec.add_runtime_dependency 'http-cookie', '~> 1.0', '>= 1.0.3'
+  spec.add_runtime_dependency 'mqtt', '~> 0.5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rg_refresh
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mike Pastore
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- mike@oobak.org
+executables:
+- rg_refresh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rg_refresh
+- lib/rg_refresh.rb
+- lib/rg_refresh/netgear.rb
+- lib/rg_refresh/publish_wrapper.rb
+- lib/rg_refresh/version.rb
+- rg_refresh.gemspec
+homepage: https://github.com/mwpastore/rg_refresh#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Automated refresh script for the AT&T Residential Gateway bypass
+test_files: []