ruby_home 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb157eb26583418aa02ef31fe2b4ed2f8f40f8cb57e46f78e7603cdd531256b
-  data.tar.gz: 5ed756570a2e0f3992a0b4b53eb0521bc94d7c46f55e5318a80e6bf74da27304
+  metadata.gz: cace8911ec7e8999b154e2bbcf7794ff7e9ca890b1b53fb8167091c316565bc6
+  data.tar.gz: 9f623241d8dd6bbca8e504919af18bd2084a722f5c9ee33a701714cbd82f73c1
 SHA512:
-  metadata.gz: a8732ab9a3caa1e9d61a371bbed0495eb523d6e0b1e0c248f1f7f1fc7d6ab6848ccaa8a5105a78214ad4375bb15df57e84df00d664cf4ad554bbab89a53e375d
-  data.tar.gz: 3f0b97b56c9785b1664a5fa7885407a37ae75bce6924f1b8c7dbee6b72ab3037b8037f5872c38e7fad6ed5bd88fa34f73f955a70138774b6b1fe18bfe218956a
+  metadata.gz: a4787d16e0be2c98a35d8428ef90ef83cd8462f2fa9189f6243367ef8eca006812a86c26d4c29afa5c3d09827401fb61909f5320b7e1d5ac2d4c5ab0d3e95f78
+  data.tar.gz: 138ef40f9cf8e9c0fa8820c2611d1bf70dd4398578e40139165359d93558fe7df8205676fa660426debc49c9852d7f42d770f9a4b99cb9bf4d224bec21821384

data/README.md

@@ -17,7 +17,7 @@ For OS X users, libsodium is available via homebrew and can be installed with:
 
     brew install libsodium
 
-For Debian users, libsodium is available both via apt:
+For Debian users, libsodium is available via apt:
 
     sudo apt-get install libsodium-dev
 
@@ -33,13 +33,13 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install ruby_home
 
 ## Basic usage
 
-Create a fan with an on/off switch.
+Create a fan with an on/off switch:
 
 ```ruby
 require 'ruby_home'
@@ -60,7 +60,7 @@ RubyHome.run
 
 ## Configuration
 
-The configuration options can be set by using the `configure` helper
+The configuration options can be set by using the `configure` helper:
 
 ```ruby
 RubyHome.configure do |c|
@@ -74,7 +74,7 @@ The following is the full list of available configuration options:
 |---|---|---|---|---|
 | `discovery_name` |  The user-visible name of the accessory | `"RubyHome"` | `"My Home"` | String |
 | `model_name` |  The model name of the accessory | `"RubyHome"` | `"Device1,1"` | String |
-| `password` | Used for pairing must conform to the format XXX-XX-XXX where each X is a 0-9 digit and dashes are required | Randomly generated | `"101-48-005"` | String |
+| `password` | Used for pairing, must conform to the format XXX-XX-XXX where each X is a 0-9 digit and dashes are required | Randomly generated | `"101-48-005"` | String |
 | `host` | The hostname or IP address of the interface to listen on | `"0.0.0.0"` | `"192.168.0.2"` | String  |
 | `port` | The port that should be used when starting the built-in web server | `4567` | `8080` | Integer |
 
@@ -117,9 +117,9 @@ RubyHome.run
 
 ## Updating a characteristics value
 
-If you have a service with characteristics that can be changed outside of Ruby Home. You'll want to keep Ruby Home in sync with these modifications. Otherwise, the characteristics current value won't correspond with reality. The simplest way to do this is a background job that periodically polls the devices current status and updates the corresponding characteristics value if it's changed.
+If you have a service with characteristics that can be changed outside of Ruby Home, you'll want to keep Ruby Home in sync with these modifications. Otherwise, the characteristics current value won't correspond with reality. The simplest way to do this is a background job that periodically polls the devices current status and updates the corresponding characteristics value if it's changed.
 
-Given a fan which can be switched on / off with a remote control. Which has a JSON API endpoint at http://example.org/fan_status.json that returns its current status `{ "on": true }` or `{ "on": false }`. We can spawn a thread that keeps polling the fans current status and if its changed update our fan service "on" characteristic.
+Given a fan which can be switched on / off with a remote control, which has a JSON API endpoint at http://example.org/fan_status.json that returns its current status `{ "on": true }` or `{ "on": false }`, we can spawn a thread that keeps polling the fans current status and if it's changed update our fan service "on" characteristic.
 
 ```ruby
 require 'json'
@@ -150,7 +150,7 @@ RubyHome.run
 
 ## More examples
 
-### Create a garage door opener.
+### Create a garage door opener
 
 ```ruby
 require 'ruby_home'
@@ -171,7 +171,7 @@ end
 RubyHome.run
 ```
 
-### Create a thermostat.
+### Create a thermostat
 
 ```ruby
 require 'ruby_home'

data/lib/ruby_home/dns/service.rb

@@ -6,6 +6,8 @@ module RubyHome
       end
 
       def update
+        return if RbConfig::CONFIG['target_os'] =~ /linux/
+
         dnssd_service.add_record(DNSSD::Record::TXT, text_record.encode)
       end
 

data/lib/ruby_home/errors.rb

@@ -0,0 +1,4 @@
+module RubyHome
+  class RubyHomeError < StandardError; end
+  class UnknownValueError < RubyHomeError; end
+end

data/lib/ruby_home/hap/server_handler.rb

@@ -35,29 +35,20 @@ module RubyHome
           Host: bind_address,
           ServerSoftware: 'RubyHome',
           Logger: server_logger,
-          AccessLog: access_logger
+          AccessLog: []
         }
       end
 
       def server_logger
-        if ENV['DEBUG']
+        if ENV['DEBUG'] == 'debug'
           WEBrick::Log::new(STDOUT, WEBrick::BasicLog::DEBUG)
+        elsif ENV['DEBUG'] == 'info'
+          WEBrick::Log::new(STDOUT, WEBrick::BasicLog::INFO)
         else
           WEBrick::Log::new("/dev/null", WEBrick::BasicLog::WARN)
         end
       end
 
-      def access_logger
-        if ENV['DEBUG']
-          [
-            [ STDOUT, WEBrick::AccessLog::COMMON_LOG_FORMAT ],
-            [ STDOUT, WEBrick::AccessLog::REFERER_LOG_FORMAT ]
-          ]
-        else
-          []
-        end
-      end
-
       def bind_address
         configuration.host
       end

data/lib/ruby_home/hap/values/uint8_value.rb

@@ -13,7 +13,17 @@ module RubyHome
       end
 
       def valid_values
-        template.constraints.fetch('ValidValues')
+        defined_values || range_values || raise(UnknownValueError, "Constraint contains an unrecognized list of values: #{template.constraints.inspect }")
+      end
+
+      def defined_values
+        template.constraints.dig('ValidValues')
+      end
+
+      def range_values
+        if min = template.constraints.dig('MinimumValue')
+          { min.to_s => min }
+        end
       end
   end
 end

data/lib/ruby_home/http/controllers/application_controller.rb

@@ -5,10 +5,17 @@ module RubyHome
     class ApplicationController < Sinatra::Base
       disable :protection
 
-      if ENV['DEBUG']
-        enable :logging
-        set :logger, Logger.new(STDOUT)
+      logger = Logger.new(STDOUT)
+      logger.level = case ENV['DEBUG']
+      when 'debug'
+        Logger::DEBUG
+      when 'info'
+        Logger::INFO
+      else
+        Logger::WARN
       end
+      set :logger, logger
+      enable :logging if ENV['DEBUG']
 
       before do
         logger.debug "Session"

data/lib/ruby_home/http/controllers/pair_setups_controller.rb

@@ -38,9 +38,9 @@ module RubyHome
           device_proof: unpack_request[:proof],
           srp_session: session.srp_session,
           public_key: unpack_request[:public_key],
-        )
+        ).run
 
-        if verify_srp.valid?
+        if verify_srp.success?
           session.session_key = verify_srp.session_key
           session.srp_session = nil
 

data/lib/ruby_home/http/controllers/pair_verifies_controller.rb

@@ -48,18 +48,16 @@ module RubyHome
       end
 
       def verify_finish_response
-        encrypted_data = unpack_request[:encrypted_data]
-
-        chacha20poly1305ietf = HAP::Crypto::ChaCha20Poly1305.new(session.session_key)
-        nonce = HexHelper.pad('PV-Msg03')
-        decrypted_data = chacha20poly1305ietf.decrypt(nonce, encrypted_data)
-        unpacked_decrypted_data = TLV.decode(decrypted_data)
-
-        if accessory_info.paired_clients.any? {|h| h[:identifier] == unpacked_decrypted_data[:identifier]}
-          shared_secret = HAP::Crypto::SessionKey.new(session.shared_secret)
-
-          session.controller_to_accessory_key = shared_secret.controller_to_accessory_key
-          session.accessory_to_controller_key = shared_secret.accessory_to_controller_key
+        verify_finish = VerifyFinishService.new(
+          encrypted_data: unpack_request[:encrypted_data],
+          session_key: session.session_key,
+          shared_secret: session.shared_secret,
+          accessory_info: accessory_info
+        ).run
+
+        if verify_finish.success?
+          session.controller_to_accessory_key = verify_finish.controller_to_accessory_key
+          session.accessory_to_controller_key = verify_finish.accessory_to_controller_key
 
           session.session_key = nil
           session.shared_secret = nil

data/lib/ruby_home/http/services/verify_finish_service.rb

@@ -0,0 +1,56 @@
+module RubyHome
+  class VerifyFinishService
+    def initialize(accessory_info: , encrypted_data: , session_key:, shared_secret:)
+      @accessory_info = accessory_info
+      @encrypted_data = encrypted_data
+      @session_key = session_key
+      @shared_secret = HAP::Crypto::SessionKey.new(shared_secret)
+    end
+
+    def run
+      if paired_client_exists?
+        RubyHome.dns_service.update
+
+        OpenStruct.new(
+          success?: true,
+          controller_to_accessory_key: shared_secret.controller_to_accessory_key,
+          accessory_to_controller_key: shared_secret.accessory_to_controller_key
+        )
+      else
+        OpenStruct.new(success?: false)
+      end
+    end
+
+    private
+
+      NONCE = -'PV-Msg03'
+
+      attr_reader :accessory_info, :encrypted_data, :session_key, :shared_secret
+
+      def paired_client_exists?
+        accessory_info.paired_clients.any? do |paired_client|
+          paired_client[:identifier] == identifier
+        end
+      end
+
+      def chacha20poly1305
+        HAP::Crypto::ChaCha20Poly1305.new(session_key)
+      end
+
+      def nonce
+        HexHelper.pad(NONCE)
+      end
+
+      def decrypted_data
+        chacha20poly1305.decrypt(nonce, encrypted_data)
+      end
+
+      def unpacked_decrypted_data
+        TLV.decode(decrypted_data)
+      end
+
+      def identifier
+        unpacked_decrypted_data[:identifier]
+      end
+  end
+end

data/lib/ruby_home/http/services/verify_srp_service.rb

@@ -1,57 +1,48 @@
 module RubyHome
   class VerifySRPService
-    def initialize(public_key: , device_proof: , srp_session: )
-      @device_proof = device_proof
+    def initialize(device_proof: , public_key: , srp_session: )
+      @device_proof_bytes = device_proof.to_s.unpack1('H*')
+      @public_key_bytes = public_key.to_s.unpack1('H*')
       @srp_session = srp_session
-      @public_key = public_key
     end
 
-    def valid?
-      return false unless public_key
-      return false unless device_proof
-      return false unless srp_session
-      return false unless valid_session?
-
-      true
-    end
-
-    def session_key
-      srp_verifier.K
-    end
-
-    def server_proof
-      verify_session_bytes
+    def run
+      if valid_session?
+        OpenStruct.new(
+          success?: true,
+          session_key: session_key,
+          server_proof: verify_session_bytes
+        )
+      else
+        OpenStruct.new(success?: false)
+      end
     end
 
     private
 
-    def valid_session?
-      !!verify_session
-    end
-
-    def verify_session_bytes
-      [verify_session].pack('H*')
-    end
+      def valid_session?
+        !!verify_session
+      end
 
-    def verify_session
-      @_verify_session ||= srp_verifier.verify_session(
-        srp_session.merge({A: public_key_bytes}),
-        device_proof_bytes
-      )
-    end
+      def session_key
+        srp_verifier.K
+      end
 
-    def public_key_bytes
-      public_key.unpack1('H*')
-    end
+      def verify_session_bytes
+        [verify_session].pack('H*')
+      end
 
-    def device_proof_bytes
-      device_proof.unpack1('H*')
-    end
+      def verify_session
+        srp_verifier.verify_session(
+          srp_session.merge({A: public_key_bytes}),
+          device_proof_bytes
+        )
+      end
 
-    def srp_verifier
-      @_verifier ||= RubyHome::SRP::Verifier.new
-    end
+      def srp_verifier
+        @_verifier ||= RubyHome::SRP::Verifier.new
+      end
 
-    attr_reader :public_key, :device_proof, :srp_session
+      attr_reader :public_key_bytes, :device_proof_bytes, :srp_session
   end
 end

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/rubyhome.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dnssd', '~> 3.0'
   spec.add_dependency 'facets', '~> 3.1'
   spec.add_dependency 'hkdf', '~> 0.3.0'
-  spec.add_dependency 'oj', '3.7.9'
+  spec.add_dependency 'oj', '3.7.12'
   spec.add_dependency 'rbnacl', '~> 6.0'
   spec.add_dependency 'ruby_home-srp', '~> 1.3'
   spec.add_dependency 'ruby_home-tlv', '~> 0.1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.9
+        version: 3.7.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.9
+        version: 3.7.12
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,7 @@ files:
 - lib/ruby_home/device_id.rb
 - lib/ruby_home/dns/service.rb
 - lib/ruby_home/dns/text_record.rb
+- lib/ruby_home/errors.rb
 - lib/ruby_home/factories/characteristic_factory.rb
 - lib/ruby_home/factories/service_factory.rb
 - lib/ruby_home/factories/templates/characteristic_template.rb
@@ -304,6 +305,7 @@ files:
 - lib/ruby_home/http/serializers/uuid_helper.rb
 - lib/ruby_home/http/services/session_notifier.rb
 - lib/ruby_home/http/services/start_srp_service.rb
+- lib/ruby_home/http/services/verify_finish_service.rb
 - lib/ruby_home/http/services/verify_srp_service.rb
 - lib/ruby_home/identifier_cache.rb
 - lib/ruby_home/password.rb