miwifi 0.2.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb6ea39da161011ec13fa9ab16071be68d9533ad2a61f9bdca9e8723dbb1bd70
+  data.tar.gz: d57fccbfb3e61ab20dd9ee83256d43c9ebb5f90c6270ed2d4818aa3e8b31a46f
+SHA512:
+  metadata.gz: eeb32818d0467e035b0d1439d2e92d03e2117f6f5787f1593405c9a1f19e1d107aede1faf6e8928feb006d40fc71d59fe8d6739649e7e4dd6eb9b48cfa09778d
+  data.tar.gz: 353743986d173732d4e6fecf8c1c19fae9bc3251a88c168caee7fc887a6abf6afd1194f1296f1cab4d60f3c65d62adf93d201408fe3df243fcdaef0057c70c2d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.gem
+*.bin
+*.lock
+*.gem
+.idea

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Layout/IndentationStyle:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+# Handcrafted by Aydar N.
+# 2022 - 2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in miwifi.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN 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,23 @@
+# Miwifi
+With miwifi authenticating to your Mi router and getting list of connected devices is as simple as that:
+```ruby
+router = Miwifi::Router.new("192.168.31.1", "password")
+router.auth
+devices = router.device_list
+```
+
+## Installation
+1. [Authenticate](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry#authenticating-to-github-packages) to GitHub Packages
+
+2. Add these lines to your application's Gemfile:
+```ruby
+source "https://rubygems.pkg.github.com/lesterrry" do
+  gem "miwifi"
+end
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Support 
+- Xiaomi Router 3 (R3)

data/Rakefile

@@ -0,0 +1,19 @@
+# Handcrafted by Aydar N.
+# 2023
+#
+# me@aydar.media
+#
+
+# 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'].exclude('test/**/*_bench_test.rb')
+end
+
+desc 'Run all tests'
+task default: :test

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# 
+# COPYRIGHT LESTER COVEY,
+#
+# 2022
+
+require "bundler/setup"
+require "miwifi"
+
+# 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,13 @@
+#!/usr/bin/env bash
+# 
+# COPYRIGHT LESTER COVEY,
+#
+# 2022
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/miwifi/api.rb

@@ -0,0 +1,44 @@
+# Handcrafted by Aydar N.
+# 2022-2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+module Miwifi
+
+	class Router
+		def device_list
+			generic_api_request "http://#{@ip}/cgi-bin/luci/;stok=#{@token}/api/misystem/devicelist"
+		end
+
+		def reboot
+			generic_api_request "http://#{@ip}/cgi-bin/luci/;stok=#{@token}/api/misystem/reboot"
+		end
+
+			private
+
+		def generic_api_request(uri_string)
+			raise Miwifi::NoTokenError if @token.nil?
+
+			uri = URI.parse(uri_string)
+			r = Request.default(uri, false)
+			Request.json_make(r, uri)
+		end
+	end
+
+	class Request
+		def self.json_make(r, uri)
+			response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+				http.request(r)
+			end
+			parsed = JSON.parse(response.body)
+			raise Miwifi::AccessDeniedError if parsed['code'] == 401
+			raise Miwifi::UnexpectedResponseCodeError if parsed['code'] != 0
+
+			parsed
+		end
+	end
+
+end

data/lib/miwifi/extensions.rb

@@ -0,0 +1,13 @@
+# Handcrafted by Aydar N.
+# 2022-2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+class String
+	def between(start, finish)
+		self[/#{Regexp.escape(start)}(.*?)#{Regexp.escape(finish)}/m, 1]
+	end
+end

data/lib/miwifi/router.rb

@@ -0,0 +1,89 @@
+# Handcrafted by Aydar N.
+# 2022-2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+require 'net/http'
+require 'digest/sha1'
+require 'uri'
+require 'json'
+
+module Miwifi
+
+	class Router
+		attr_reader :token
+
+		def initialize(ip, password, username = 'admin', token: nil)
+			@ip = ip
+			@password = password
+			@username = username
+			@token = token
+		end
+
+		def auth
+			uri = URI.parse("http://#{@ip}/cgi-bin/luci/web/home")
+			r = Net::HTTP::Get.new(uri)
+			response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+				http.request(r)
+			end
+			# TODO: This is unsafe as hell but bruh nobody even pays me
+			key = response.body.between("key: '", "',")
+			# iv = response.body.between("iv: '", "',")
+			device_id = response.body.between("deviceId = '", "';")
+			time = Time.now.to_i
+			random = rand(1000..9000)
+			nonce = "0_#{device_id}_#{time}_#{random}"
+			pass = Digest::SHA1.hexdigest(nonce + Digest::SHA1.hexdigest(@password + key))
+			uri = URI.parse("http://#{@ip}/cgi-bin/luci/api/xqsystem/login")
+			r = Request.default(uri, true)
+			r.set_form_data(
+					'logtype' => '2',
+					'nonce' => nonce,
+					'password' => pass,
+					'username' => @username,
+			)
+			response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+				http.request(r)
+			end
+			parsed = JSON.parse(response.body)
+			raise Miwifi::AccessDeniedError if parsed['code'] == 401
+			raise Miwifi::UnexpectedResponseCodeError if parsed['code'] != 0
+
+			@token = parsed['token']
+		end
+
+		def bury_token(file)
+			raise Miwifi::NoTokenError if @token.nil?
+
+			File.open(file, 'wb') do |f|
+				f.write(Marshal.dump(@token))
+			end
+		end
+
+		def restore_token(file)
+			file_data = File.read(file)
+			@token = Marshal.load(file_data)
+		end
+	end
+
+	class Request
+		def self.default(uri, post)
+			request = post ? Net::HTTP::Post.new(uri) : Net::HTTP::Get.new(uri)
+			request.content_type = 'application/x-www-form-urlencoded; charset=UTF-8' if post
+			request['Accept'] = '*/*'
+			request['Accept-Language'] = 'ru'
+			request['Host'] = uri.host
+			request['Origin'] = "http://#{uri.host}"
+			request['User-Agent'] = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15'
+			request['Connection'] = 'keep-alive'
+			request['Referer'] = "http://#{uri.host}/cgi-bin/luci/web"
+			request['Cookie'] = 'monitor_count=1'
+			request['X-Requested-With'] = 'XMLHttpRequest'
+			request
+		end
+	end
+
+end

data/lib/miwifi/version.rb

@@ -0,0 +1,11 @@
+# Handcrafted by Aydar N.
+# 2022-2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+module Miwifi
+	VERSION = '0.2.0-beta'
+end

data/lib/miwifi.rb

@@ -0,0 +1,37 @@
+# Handcrafted by Aydar N.
+# 2022-2023
+#
+# me@aydar.media
+#
+
+# frozen_string_literal: true
+
+require_relative 'miwifi/version'
+require_relative 'miwifi/extensions'
+require_relative 'miwifi/router'
+require_relative 'miwifi/api'
+
+module Miwifi
+
+	class AccessDeniedError < StandardError
+		def initialize(msg = 'Access denied; check your credentials', exception_type = 'custom')
+			@exception_type = exception_type
+			super(msg)
+		end
+	end
+
+	class UnexpectedResponseCodeError < StandardError
+		def initialize(msg = 'Got unexpected response code. Please report this behavior', exception_type = 'custom')
+			@exception_type = exception_type
+			super(msg)
+		end
+	end
+
+	class NoTokenError < StandardError
+		def initialize(msg = 'You are unauthorized', exception_type = 'custom')
+			@exception_type = exception_type
+			super(msg)
+		end
+	end
+
+end

data/miwifi.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'miwifi/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'miwifi'
+	spec.version       = Miwifi::VERSION
+	spec.authors       = ['Aydar N.']
+	spec.email         = ['me@aydar.media']
+
+	spec.required_ruby_version = '>= 2.6.3'
+
+	spec.summary       = 'API wrapper for MiWIFI routers'
+	spec.description   = 'Provides authentication methods as well as some simple API calls'
+	spec.homepage      = 'https://github.com/lesterrry/miwifi'
+	spec.license       = 'MIT'
+
+	# 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(__dir__)) 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.2.33'
+	spec.add_development_dependency 'irb'
+	spec.add_development_dependency 'minitest', '~> 5.0'
+	spec.add_development_dependency 'rake', '~> 13.0'
+	spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: miwifi
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre.beta
+platform: ruby
+authors:
+- Aydar N.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+- !ruby/object:Gem::Dependency
+  name: irb
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+description: Provides authentication methods as well as some simple API calls
+email:
+- me@aydar.media
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/miwifi.rb
+- lib/miwifi/api.rb
+- lib/miwifi/extensions.rb
+- lib/miwifi/router.rb
+- lib/miwifi/version.rb
+- miwifi.gemspec
+homepage: https://github.com/lesterrry/miwifi
+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.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: API wrapper for MiWIFI routers
+test_files: []