lightning-onion 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a47804ce3e79e397833b1e477eda7bf1531a025
-  data.tar.gz: 1b790426dada286bf65e320870b0f8f65a95b758
+  metadata.gz: '079f7534c2a4cbce4c4f7c272b498f08433d2d09'
+  data.tar.gz: d99082b353d85e7c9a32bb7bb3c08ffaf614c094
 SHA512:
-  metadata.gz: d993a816fed1fb15c3fc20e1b306397766289ad125e2bb08dd8f3eff7444e27cc0e24a6ff7efc04bbe193d79d95d641cefa4c7e0230b46b0a035858234206bfe
-  data.tar.gz: 879b2eb37d5c7c87c026021c6a6b14cab285e876edd477dd13c4ac007ad24aeb5f2e6fafd3213eb341146b1d6a5e35b8115596d18f1f54a212d6b5f7687cafdc
+  metadata.gz: 4925aecf07e1782b9316b676e2a67c8e669a4fb528a3e6235f397d7e185a4c371d4be75cbd100af07f3668b8276719a1663028c72ba49c2e7987032f6781f8d3
+  data.tar.gz: 256905de4a28f346b9a49172fd0d2dac789230e2096db59e9f9a6328104a0994d8bc51d8d4d95a74df3619240e994fd1a208f29b098fb7dfb6e1fb9f5dc95e5e

data/.rubocop.yml

@@ -10,6 +10,12 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 30
 
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/ParameterLists:
+  Max: 7
+
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lightningrb-onion'
+gem 'lightning-onion'
 ```
 
 And then execute:
@@ -18,11 +18,55 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install lightningrb-onion
+    $ gem install lightning-onion
 
 ## Usage
 
-TODO: Write usage instructions here
+### Build Onion Packet 
+
+    $ ./bin/console
+    irb(main):001:0> irb(main):002:0> session_key = '4141414141414141414141414141414141414141414141414141414141414141'
+    irb(main):003:0> public_keys = [
+    irb(main):004:1*       '02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619',
+    irb(main):005:1*       '0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c',
+    irb(main):006:1*       '027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007',
+    irb(main):007:1*       '032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991',
+    irb(main):008:1*       '02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145'
+    irb(main):009:1> ]
+    irb(main):010:0> payloads = [
+    irb(main):011:1*       '000000000000000000000000000000000000000000000000000000000000000000',
+    irb(main):012:1*       '000101010101010101000000010000000100000000000000000000000000000000',
+    irb(main):013:1*       '000202020202020202000000020000000200000000000000000000000000000000',
+    irb(main):014:1*       '000303030303030303000000030000000300000000000000000000000000000000',
+    irb(main):015:1*       '000404040404040404000000040000000400000000000000000000000000000000'
+    irb(main):016:1> ]
+    irb(main):017:0> associated_data = '4242424242424242424242424242424242424242424242424242424242424242'
+    irb(main):018:0> onion, secrets = Lightning::Onion::Sphinx.make_packet(session_key, public_keys, payloads, associated_data)
+
+### Parse Onion Packet 
+
+    irb(main):019:0> private_keys = [
+    irb(main):020:1*       '4141414141414141414141414141414141414141414141414141414141414141',
+    irb(main):021:1*       '4242424242424242424242424242424242424242424242424242424242424242',
+    irb(main):022:1*       '4343434343434343434343434343434343434343434343434343434343434343',
+    irb(main):023:1*       '4444444444444444444444444444444444444444444444444444444444444444',
+    irb(main):024:1*       '4545454545454545454545454545454545454545454545454545454545454545'
+    irb(main):025:1> ]
+    irb(main):028:0> payload0, next_packet0, = Lightning::Onion::Sphinx.parse(private_keys[0], onion.to_payload)
+    irb(main):029:0> payload1, next_packet1, = Lightning::Onion::Sphinx.parse(private_keys[1], next_packet0.to_payload)
+    irb(main):030:0> payload2, next_packet2, = Lightning::Onion::Sphinx.parse(private_keys[2], next_packet1.to_payload)
+    irb(main):031:0> payload3, next_packet3, = Lightning::Onion::Sphinx.parse(private_keys[3], next_packet2.to_payload)
+    irb(main):032:0> payload4, next_packet4, = Lightning::Onion::Sphinx.parse(private_keys[4], next_packet3.to_payload)
+    irb(main):035:0> payload0.bth
+    => "000000000000000000000000000000000000000000000000000000000000000000"
+    irb(main):036:0> payload1.bth
+    => "000101010101010101000000010000000100000000000000000000000000000000"
+    irb(main):037:0> payload2.bth
+    => "000202020202020202000000020000000200000000000000000000000000000000"
+    irb(main):038:0> payload3.bth
+    => "000303030303030303000000030000000300000000000000000000000000000000"
+    irb(main):039:0> payload4.bth
+    => "000404040404040404000000040000000400000000000000000000000000000000"
 
 ## Development
 

data/lib/lightning/onion.rb

@@ -2,12 +2,17 @@
 
 require 'lightning/onion/version'
 
-require 'rbnacl'
+require 'algebrick'
 require 'bitcoin'
+require 'rbnacl'
+
+require 'lightning/utils/string'
 
 module Lightning
   module Onion
     autoload :ChaCha20, 'lightning/onion/chacha20'
+    autoload :ErrorPacket, 'lightning/onion/error_packet'
+    autoload :FailureMessages, 'lightning/onion/failure_messages'
     autoload :HopData, 'lightning/onion/hop_data'
     autoload :PerHop, 'lightning/onion/per_hop'
     autoload :Packet, 'lightning/onion/packet'

data/lib/lightning/onion/error_packet.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    class ErrorPacket
+      attr_accessor :onion_node, :failure_message
+      def initialize(onion_node, failure_message)
+        @onion_node = onion_node
+        @failure_message = failure_message
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      # unparsable onion encrypted by sending peer
+      BADONION = 0x8000
+
+      # permanent failure (otherwise transient)
+      PERM = 0x4000
+
+      # node failure (otherwise channel)
+      NODE = 0x2000
+
+      # new channel update enclosed
+      UPDATE = 0x1000
+
+      TYPES = {
+        invalid_realm: PERM | 1,
+        temporary_node_failure: NODE | 2,
+        permanent_node_failure: PERM | NODE | 2,
+        required_node_feature_missing: PERM | NODE | 3,
+        invalid_onion_version: BADONION | PERM | 4,
+        invalid_onion_hmac: BADONION | PERM | 5,
+        invalid_onion_key: BADONION | PERM | 6,
+        temporary_channel_failure: UPDATE | 7,
+        permanent_channel_failure: PERM | 8,
+        required_channel_feature_missing: PERM | 9,
+        unknown_next_peer: PERM | 10,
+        amount_below_minimum: UPDATE | 11,
+        fee_insufficient: UPDATE | 12,
+        incorrect_cltv_expiry: UPDATE | 13,
+        expiry_too_soon: UPDATE | 14,
+        unknown_payment_hash: PERM | 15,
+        incorrect_payment_amount: PERM | 16,
+        final_expiry_too_soon: 17,
+        final_incorrect_cltv_expiry: 18,
+        final_incorrect_htlc_amount: 19,
+        channel_disabled: 20,
+        expiry_too_far: 21
+      }.freeze
+
+      FailureMessage = Algebrick.type do
+        InvalidRealm = type do
+          fields! type_code: Numeric
+        end
+        TemporaryNodeFailure = type do
+          fields! type_code: Numeric
+        end
+        PermanentNodeFailure = type do
+          fields! type_code: Numeric
+        end
+        RequiredNodeFeatureMissing = type do
+          fields! type_code: Numeric
+        end
+        InvalidOnionVersion = type do
+          fields! type_code: Numeric,
+                  sha256_of_onion: String
+        end
+        InvalidOnionHmac = type do
+          fields! type_code: Numeric,
+                  sha256_of_onion: String
+        end
+        InvalidOnionKey = type do
+          fields! type_code: Numeric,
+                  sha256_of_onion: String
+        end
+        TemporaryChannelFailure = type do
+          fields! type_code: Numeric,
+                  channel_update: String
+        end
+        PermanentChannelFailure = type do
+          fields! type_code: Numeric
+        end
+        RequiredChannelFeatureMissing = type do
+          fields! type_code: Numeric
+        end
+        UnknownNextPeer = type do
+          fields! type_code: Numeric
+        end
+        AmountBelowMinimum = type do
+          fields! type_code: Numeric,
+                  htlc_msat: Numeric,
+                  channel_update: String
+        end
+        FeeInsufficient = type do
+          fields! type_code: Numeric,
+                  htlc_msat: Numeric,
+                  channel_update: String
+        end
+        IncorrectCltvExpiry = type do
+          fields! type_code: Numeric,
+                  cltv_expiry: Numeric,
+                  channel_update: String
+        end
+        ExpiryTooSoon = type do
+          fields! type_code: Numeric,
+                  channel_update: String
+        end
+        UnknownPaymentHash = type do
+          fields! type_code: Numeric
+        end
+        IncorrectPaymentAmount = type do
+          fields! type_code: Numeric
+        end
+        FinalExpiryTooSoon = type do
+          fields! type_code: Numeric
+        end
+        FinalIncorrectCltvExpiry = type do
+          fields! type_code: Numeric,
+                  cltv_expiry: Numeric
+        end
+        FinalIncorrectHtlcAmount = type do
+          fields! type_code: Numeric,
+                  incoming_htlc_amt: Numeric
+        end
+        ChannelDisabled = type do
+          fields! type_code: Numeric,
+                  flags: String,
+                  channel_update: String
+        end
+        ExpiryTooFar = type do
+          fields! type_code: Numeric
+        end
+        variants  InvalidRealm,
+                  TemporaryNodeFailure,
+                  PermanentNodeFailure,
+                  RequiredNodeFeatureMissing,
+                  InvalidOnionVersion,
+                  InvalidOnionHmac,
+                  InvalidOnionKey,
+                  TemporaryChannelFailure,
+                  PermanentChannelFailure,
+                  RequiredChannelFeatureMissing,
+                  UnknownNextPeer,
+                  AmountBelowMinimum,
+                  FeeInsufficient,
+                  IncorrectCltvExpiry,
+                  ExpiryTooSoon,
+                  UnknownPaymentHash,
+                  IncorrectPaymentAmount,
+                  FinalExpiryTooSoon,
+                  FinalIncorrectCltvExpiry,
+                  FinalIncorrectHtlcAmount,
+                  ChannelDisabled,
+                  ExpiryTooFar
+      end
+
+      def self.load(payload)
+        type, = payload.unpack('na*')
+        message_class = FailureMessage.variants.find do |t|
+          TYPES[t.name.split('::').last.snake.to_sym] == type
+        end
+        message_class.load(payload)
+      end
+
+      require 'lightning/onion/failure_messages/invalid_realm'
+      require 'lightning/onion/failure_messages/temporary_node_failure'
+      require 'lightning/onion/failure_messages/permanent_node_failure'
+      require 'lightning/onion/failure_messages/required_node_feature_missing'
+      require 'lightning/onion/failure_messages/invalid_onion_version'
+      require 'lightning/onion/failure_messages/invalid_onion_hmac'
+      require 'lightning/onion/failure_messages/invalid_onion_key'
+      require 'lightning/onion/failure_messages/temporary_channel_failure'
+      require 'lightning/onion/failure_messages/permanent_channel_failure'
+      require 'lightning/onion/failure_messages/required_channel_feature_missing'
+      require 'lightning/onion/failure_messages/unknown_next_peer'
+      require 'lightning/onion/failure_messages/amount_below_minimum'
+      require 'lightning/onion/failure_messages/fee_insufficient'
+      require 'lightning/onion/failure_messages/incorrect_cltv_expiry'
+      require 'lightning/onion/failure_messages/expiry_too_soon'
+      require 'lightning/onion/failure_messages/unknown_payment_hash'
+      require 'lightning/onion/failure_messages/incorrect_payment_amount'
+      require 'lightning/onion/failure_messages/final_expiry_too_soon'
+      require 'lightning/onion/failure_messages/final_incorrect_cltv_expiry'
+      require 'lightning/onion/failure_messages/final_incorrect_htlc_amount'
+      require 'lightning/onion/failure_messages/channel_disabled'
+      require 'lightning/onion/failure_messages/expiry_too_far'
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/amount_below_minimum.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module AmountBelowMinimum
+        def to_payload
+          [type_code, htlc_msat, channel_update.htb.bytesize].pack('nq>n') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, htlc_msat, len, rest = payload.unpack('nq>nH*')
+          new(type_code, htlc_msat, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/channel_disabled.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module ChannelDisabled
+        def to_payload
+          [type_code].pack('n') + flags + [channel_update.htb.bytesize].pack('n') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, flags, len, rest = payload.unpack('na4nH*')
+          new(type_code, flags, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/expiry_too_far.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module ExpiryTooFar
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/expiry_too_soon.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module ExpiryTooSoon
+        def to_payload
+          [type_code, channel_update.htb.bytesize].pack('nn') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, len, rest = payload.unpack('nnH*')
+          new(type_code, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/fee_insufficient.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module FeeInsufficient
+        def to_payload
+          [type_code, htlc_msat, channel_update.htb.bytesize].pack('nq>n') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, htlc_msat, len, rest = payload.unpack('nq>nH*')
+          new(type_code, htlc_msat, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/final_expiry_too_soon.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module FinalExpiryTooSoon
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/final_incorrect_cltv_expiry.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module FinalIncorrectCltvExpiry
+        def to_payload
+          [type_code, cltv_expiry].pack('nq>')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('nq>'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/final_incorrect_htlc_amount.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module FinalIncorrectHtlcAmount
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/incorrect_cltv_expiry.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module IncorrectCltvExpiry
+        def to_payload
+          [type_code, cltv_expiry, channel_update.htb.bytesize].pack('nq>n') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, cltv_expiry, len, rest = payload.unpack('nq>nH*')
+          new(type_code, cltv_expiry, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/incorrect_payment_amount.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module IncorrectPaymentAmount
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/invalid_onion_hmac.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module InvalidOnionHmac
+        def to_payload
+          [type_code, sha256_of_onion.htb.bytesize].pack('nn') + sha256_of_onion.htb
+        end
+
+        def self.load(payload)
+          type_code, len, rest = payload.unpack('nnH*')
+          new(type_code, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/invalid_onion_key.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module InvalidOnionKey
+        def to_payload
+          [type_code, sha256_of_onion.htb.bytesize].pack('nn') + sha256_of_onion.htb
+        end
+
+        def self.load(payload)
+          type_code, len, rest = payload.unpack('nnH*')
+          new(type_code, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/invalid_onion_version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module InvalidOnionVersion
+        def to_payload
+          [type_code, sha256_of_onion.htb.bytesize].pack('nn') + sha256_of_onion.htb
+        end
+
+        def self.load(payload)
+          type_code, len, rest = payload.unpack('nnH*')
+          new(type_code, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/invalid_realm.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module InvalidRealm
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/permanent_channel_failure.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module PermanentChannelFailure
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/permanent_node_failure.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module PermanentNodeFailure
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/required_channel_feature_missing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module RequiredChannelFeatureMissing
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/required_node_feature_missing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module RequiredNodeFeatureMissing
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/temporary_channel_failure.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module TemporaryChannelFailure
+        def to_payload
+          [type_code, channel_update.bytesize].pack('nn') + channel_update.htb
+        end
+
+        def self.load(payload)
+          type_code, len, rest = payload.unpack('nnH*')
+          new(type_code, rest[0..len * 2])
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/temporary_node_failure.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module TemporaryNodeFailure
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/unknown_next_peer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module UnknownNextPeer
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/failure_messages/unknown_payment_hash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightning
+  module Onion
+    module FailureMessages
+      module UnknownPaymentHash
+        def to_payload
+          [type_code].pack('n')
+        end
+
+        def self.load(payload)
+          new(*payload.unpack('n'))
+        end
+      end
+    end
+  end
+end

data/lib/lightning/onion/sphinx.rb

@@ -8,24 +8,39 @@ module Lightning
       MAC_LENGTH = 32
       MAX_HOPS = 20
       HOP_LENGTH = PAYLOAD_LENGTH + MAC_LENGTH
+      MAX_ERROR_PAYLOAD_LENGTH = 256
+      ERROR_PACKET_LENGTH = MAC_LENGTH + MAX_ERROR_PAYLOAD_LENGTH + 2 + 2
 
       ZERO_HOP = Lightning::Onion::HopData.parse("\x00" * HOP_LENGTH)
-      LAST_PACKET = Lightning::Onion::Packet.new(VERSION, "\x00" * PAYLOAD_LENGTH, [ZERO_HOP] * MAX_HOPS, "\x00" * MAC_LENGTH)
-
-      def self.loop(hop_payloads, keys, shared_secrets, packet, associated_data)
-        return packet if hop_payloads.empty?
-        next_packet = make_next_packet(hop_payloads.last, associated_data, keys.last, shared_secrets.last, packet)
-        loop(hop_payloads[0...-1], keys[0...-1], shared_secrets[0...-1], next_packet, associated_data)
-      end
+      LAST_PACKET = Lightning::Onion::Packet.new(VERSION, "\x00" * 33, [ZERO_HOP] * MAX_HOPS, "\x00" * MAC_LENGTH)
 
       def self.make_packet(session_key, public_keys, payloads, associated_data)
-        ephemereal_public_keys, shared_secrets = compute_ephemereal_public_keys_and_shared_secrets(session_key, public_keys)
+        ephemereal_public_keys, shared_secrets = compute_keys_and_secrets(session_key, public_keys)
         filler = generate_filler('rho', shared_secrets[0...-1], HOP_LENGTH, MAX_HOPS)
-        last_packet = make_next_packet(payloads.last, associated_data, ephemereal_public_keys.last, shared_secrets.last, LAST_PACKET, filler)
-        packet = loop(payloads[0...-1], ephemereal_public_keys[0...-1], shared_secrets[0...-1], last_packet, associated_data)
+        last_packet = make_next_packet(
+          payloads.last,
+          associated_data,
+          ephemereal_public_keys.last,
+          shared_secrets.last,
+          LAST_PACKET,
+          filler
+        )
+        packet = internal_make_packet(
+          payloads[0...-1],
+          ephemereal_public_keys[0...-1],
+          shared_secrets[0...-1],
+          last_packet,
+          associated_data
+        )
         [packet, shared_secrets.zip(public_keys)]
       end
 
+      def self.internal_make_packet(hop_payloads, keys, shared_secrets, packet, associated_data)
+        return packet if hop_payloads.empty?
+        next_packet = make_next_packet(hop_payloads.last, associated_data, keys.last, shared_secrets.last, packet)
+        internal_make_packet(hop_payloads[0...-1], keys[0...-1], shared_secrets[0...-1], next_packet, associated_data)
+      end
+
       def self.make_next_packet(payload, associated_data, ephemereal_public_key, shared_secret, packet, filler = '')
         hops_data1 = payload.htb << packet.hmac << packet.hops_data.map(&:to_payload).join[0...-HOP_LENGTH]
         stream = generate_cipher_stream(generate_key('rho', shared_secret), MAX_HOPS * HOP_LENGTH)
@@ -46,16 +61,28 @@ module Lightning
         Lightning::Onion::Packet.new(VERSION, ephemereal_public_key, hops_data, next_hmac)
       end
 
-      def self.compute_ephemereal_public_keys_and_shared_secrets(session_key, public_keys)
+      def self.compute_keys_and_secrets(session_key, public_keys)
         point = ECDSA::Group::Secp256k1.generator
         generator_pubkey = ECDSA::Format::PointOctetString.encode(point, compression: true)
         ephemereal_public_key0 = make_blind(generator_pubkey.bth, session_key)
         secret0 = compute_shared_secret(public_keys[0], session_key)
         blinding_factor0 = compute_blinding_factor(ephemereal_public_key0, secret0)
-        internal_compute_ephemereal_public_keys_and_shared_secrets(session_key, public_keys[1..-1], [ephemereal_public_key0], [blinding_factor0], [secret0])
+        internal_compute_keys_and_secrets(
+          session_key,
+          public_keys[1..-1],
+          [ephemereal_public_key0],
+          [blinding_factor0],
+          [secret0]
+        )
       end
 
-      def self.internal_compute_ephemereal_public_keys_and_shared_secrets(session_key, public_keys, ephemereal_public_keys, blinding_factors, shared_secrets)
+      def self.internal_compute_keys_and_secrets(
+        session_key,
+        public_keys,
+        ephemereal_public_keys,
+        blinding_factors,
+        shared_secrets
+      )
         if public_keys.empty?
           [ephemereal_public_keys, shared_secrets]
         else
@@ -65,7 +92,13 @@ module Lightning
           ephemereal_public_keys << ephemereal_public_key
           blinding_factors << blinding_factor
           shared_secrets << secret
-          internal_compute_ephemereal_public_keys_and_shared_secrets(session_key, public_keys[1..-1], ephemereal_public_keys, blinding_factors, shared_secrets)
+          internal_compute_keys_and_secrets(
+            session_key,
+            public_keys[1..-1],
+            ephemereal_public_keys,
+            blinding_factors,
+            shared_secrets
+          )
         end
       end
 
@@ -103,12 +136,6 @@ module Lightning
         end.pack('C*').bth
       end
 
-      module KeyType
-        RHO = 0x72686F
-        MU = 0x6d75
-        UM = 0x756d
-      end
-
       def self.hmac256(key, message)
         OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, message)
       end
@@ -150,6 +177,53 @@ module Lightning
         end
         [payload, Lightning::Onion::Packet.new(VERSION, next_public_key, hops_data, hmac), shared_secret]
       end
+
+      def self.make_error_packet(shared_secret, failure)
+        message = failure.to_payload
+        um = generate_key('um', shared_secret)
+        padlen = MAX_ERROR_PAYLOAD_LENGTH - message.length
+        payload = +''
+        payload << [message.length].pack('n')
+        payload << message
+        payload << [padlen].pack('n')
+        payload << "\x00" * padlen
+        forward_error_packet(mac(um, payload.unpack('C*')) + payload, shared_secret)
+      end
+
+      def self.forward_error_packet(payload, shared_secret)
+        key = generate_key('ammag', shared_secret)
+        stream = generate_cipher_stream(key, ERROR_PACKET_LENGTH)
+        xor(payload.unpack('C*'), stream.unpack('C*')).pack('C*')
+      end
+
+      def self.parse_error(payload, node_shared_secrets)
+        raise "invalid length: #{payload.htb.bytesize}" unless payload.htb.bytesize == ERROR_PACKET_LENGTH
+        internal_parse_error(payload.htb, node_shared_secrets)
+      end
+
+      def self.internal_parse_error(payload, node_shared_secrets)
+        raise RuntimeError unless node_shared_secrets
+        node_shared_secret = node_shared_secrets.last
+        next_payload = forward_error_packet(payload, node_shared_secret[0])
+        if check_mac(node_shared_secret[0], next_payload)
+          ErrorPacket.new(node_shared_secret[1], extract_failure_message(next_payload))
+        else
+          internal_parse_error(next_payload, node_shared_secrets[0...-1])
+        end
+      end
+
+      def self.check_mac(secret, payload)
+        mac = payload[0...MAC_LENGTH]
+        payload1 = payload[MAC_LENGTH..-1]
+        um = generate_key('um', secret)
+        mac == mac(um, payload1.unpack('C*'))
+      end
+
+      def self.extract_failure_message(payload)
+        raise "invalid length: #{payload.bytesize}" unless payload.bytesize == ERROR_PACKET_LENGTH
+        _mac, len, rest = payload.unpack("a#{MAC_LENGTH}na*")
+        FailureMessages.load(rest[0...len])
+      end
     end
   end
 end

data/lib/lightning/onion/version.rb

@@ -2,6 +2,6 @@
 
 module Lightning
   module Onion
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/lightning/utils/string.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class String
+  def camel
+    split('_').map { |w| w[0].upcase + w[1..-1] }.join
+  end
+
+  def snake
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+  end
+end

data/lightningrb-onion.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'algebrick'
   spec.add_runtime_dependency 'bitcoinrb'
   spec.add_runtime_dependency 'rbnacl'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lightning-onion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hajime Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: algebrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bitcoinrb
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -100,11 +115,36 @@ files:
 - bin/setup
 - lib/lightning/onion.rb
 - lib/lightning/onion/chacha20.rb
+- lib/lightning/onion/error_packet.rb
+- lib/lightning/onion/failure_messages.rb
+- lib/lightning/onion/failure_messages/amount_below_minimum.rb
+- lib/lightning/onion/failure_messages/channel_disabled.rb
+- lib/lightning/onion/failure_messages/expiry_too_far.rb
+- lib/lightning/onion/failure_messages/expiry_too_soon.rb
+- lib/lightning/onion/failure_messages/fee_insufficient.rb
+- lib/lightning/onion/failure_messages/final_expiry_too_soon.rb
+- lib/lightning/onion/failure_messages/final_incorrect_cltv_expiry.rb
+- lib/lightning/onion/failure_messages/final_incorrect_htlc_amount.rb
+- lib/lightning/onion/failure_messages/incorrect_cltv_expiry.rb
+- lib/lightning/onion/failure_messages/incorrect_payment_amount.rb
+- lib/lightning/onion/failure_messages/invalid_onion_hmac.rb
+- lib/lightning/onion/failure_messages/invalid_onion_key.rb
+- lib/lightning/onion/failure_messages/invalid_onion_version.rb
+- lib/lightning/onion/failure_messages/invalid_realm.rb
+- lib/lightning/onion/failure_messages/permanent_channel_failure.rb
+- lib/lightning/onion/failure_messages/permanent_node_failure.rb
+- lib/lightning/onion/failure_messages/required_channel_feature_missing.rb
+- lib/lightning/onion/failure_messages/required_node_feature_missing.rb
+- lib/lightning/onion/failure_messages/temporary_channel_failure.rb
+- lib/lightning/onion/failure_messages/temporary_node_failure.rb
+- lib/lightning/onion/failure_messages/unknown_next_peer.rb
+- lib/lightning/onion/failure_messages/unknown_payment_hash.rb
 - lib/lightning/onion/hop_data.rb
 - lib/lightning/onion/packet.rb
 - lib/lightning/onion/per_hop.rb
 - lib/lightning/onion/sphinx.rb
 - lib/lightning/onion/version.rb
+- lib/lightning/utils/string.rb
 - lightningrb-onion.gemspec
 homepage: https://github.com/Yamaguchi/lightningrb-onion
 licenses: