hdkey 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec2d5a6b0b2dbb4996ef8a09211ac1daa588ee43
+  data.tar.gz: c7ac1c704f541c88f52d996b143f084288f1e656
+SHA512:
+  metadata.gz: e8ecd70d2430be25213e409d31155bb16524acbb0e618091a98ef55ffb55466959053341afd702ae57fc2d3b962eb4339dcf8fdd6a46dc2634e7df08137e206f
+  data.tar.gz: eee98f266773d1d3f3dbcad9b25a989050942875dd611ff52d67322308cde88fbaccfa6c07b9834a23c0a5ebe59bc40a25117f633183c0afdbb48cf86441bbc5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+hdkey

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2.2
+  - 2.3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at azuchi@haw.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 azuchi
+
+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,87 @@
+# Hierarchical Deterministic key derivation for Ruby
+[![Build Status](https://travis-ci.org/azuchi/hdkey.svg?branch=master)](https://travis-ci.org/azuchi/hdkey) [![Gem Version](https://badge.fury.io/rb/hdkey.svg)](https://badge.fury.io/rb/hdkey) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+The implementation of Bitcoin hierarchical deterministic key for Ruby.
+
+Bitcoin hierarchical deterministic key is defined by [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
+
+## Requirements
+
+This gem depends on [bitcoin-ruby](https://github.com/lian/bitcoin-ruby).
+
+This gem run with following ruby version.
+
+* 2.1
+* 2.2
+* 2.3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hdkey'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hdkey
+
+## Usage
+
+### generate master key
+
+```ruby
+require 'hdkey'
+
+seed = '000102030405060708090a0b0c0d0e0f'
+
+@master_key = Bitcoin::ExtKey.generate_master(seed.htb)
+```
+
+### derive key
+
+```ruby
+# derive `m/0H` key
+key = @master_key.derive(2**31)
+
+key.depth
+>= 1
+
+key.fingerprint
+=> '5c1bd648'
+
+key.chain_code
+=> '47fdacbd0f1097043b78c63c20c34ef4ed9a111d980047ad16282c7ae6236141'
+
+key.priv_key.priv
+=> 'edb2e14f9ee77d26dd93b4ecede8d16ed408ce149b6cd80b0715a2d911a0afea'
+
+key.to_base58
+=> 'xprv9uHRZZhk6KAJC1avXpDAp4MDc3sQKNxDiPvvkX8Br5ngLNv1TxvUxt4cV1rGL5hj6KCesnDYUhd7oWgT11eZG7XnxHrnYeSvkzY7d2bhkJ7'
+
+key.ext_pubkey.to_base58
+=> 'xpub68Gmy5EdvgibQVfPdqkBBCHxA5htiqg55crXYuXoQRKfDBFA1WEjWgP6LHhwBZeNK1VTsfTFUHCdrfp1bgwQ9xv5ski8PX9rL2dZXvgGDnw'
+
+# derive child(m/0H/1)
+child_key = key.derive(1)
+```
+
+### import key
+
+```ruby
+# import privkey
+ext_privkey = Bitcoin::ExtKey.from_base58('xprv9wTYmMFdV23N2TdNG573QoEsfRrWKQgWeibmLntzniatZvR9BmLnvSxqu53Kw1UmYPxLgboyZQaXwTCg8MSY3H2EU4pWcQDnRnrVA1xe8fs')
+
+# import pubkey
+ext_pubkey = key = Bitcoin::ExtPubkey.from_base58('xpub6ASuArnXKPbfEwhqN6e3mwBcDTgzisQN1wXN9BJcM47sSikHjJf3UFHKkNAWbWMiGj7Wf5uMash7SyYq527Hqck2AxYysAA7xmALppuCkwQ')
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hdkey"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hdkey.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hdkey"
+  spec.version       = "1.0"
+  spec.authors       = ["Shigeyuki Azuchi"]
+  spec.email         = ["azuchi@haw.co.jp"]
+
+  spec.summary       = %q{The implementation of Bitcoin hierarchical deterministic key for Ruby.}
+  spec.description   = %q{The implementation of Bitcoin hierarchical deterministic key for Ruby.}
+  spec.homepage      = "https://github.com/azuchi/hdkey"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bitcoin-ruby", "~> 0.0.10"
+  spec.add_runtime_dependency "ffi"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hdkey.rb

@@ -0,0 +1,4 @@
+require 'bitcoin'
+module Bitcoin
+  autoload :ExtKey, 'hdkey/ext_key'
+end

data/lib/hdkey/ext_key.rb

@@ -0,0 +1,189 @@
+module Bitcoin
+
+  def self.hmac_sha512(key, data)
+    OpenSSL::HMAC.digest(OpenSSL::Digest.new('SHA512'), key, data)
+  end
+
+  # Integers modulo the order of the curve(secp256k1)
+  CURVE_ORDER = 115792089237316195423570985008687907852837564279074904382605163141518161494337
+
+  # BIP32 Extended private key
+  class ExtKey
+
+    attr_accessor :depth
+    attr_accessor :number
+    attr_accessor :chain_code
+    attr_accessor :priv_key
+    attr_accessor :parent_fingerprint
+
+    # generate master key from seed.
+    def self.generate_master(seed)
+      key = ExtKey.new
+      key.depth = key.number = 0
+      key.parent_fingerprint = '00000000'
+      l = Bitcoin.hmac_sha512('Bitcoin seed', seed)
+      left = OpenSSL::BN.from_hex(l[0..31].bth).to_i
+      raise 'invalid key' if left >= CURVE_ORDER || left == 0
+      key.priv_key = Bitcoin::Key.new(l[0..31].bth)
+      key.chain_code = l[32..-1]
+      key
+    end
+
+    # get ExtPubkey from priv_key
+    def ext_pubkey
+      k = ExtPubkey.new
+      k.depth = depth
+      k.number = number
+      k.parent_fingerprint = parent_fingerprint
+      k.chain_code = chain_code
+      key = Bitcoin::Key.new(nil, priv_key.pub, compressed: true)
+      k.pub_key = key.key.public_key
+      k
+    end
+
+    # serialize extended private key
+    def to_payload
+      Bitcoin.network[:extended_privkey_version].htb << [depth].pack('C') << parent_fingerprint.htb << [number].pack('N') << chain_code << [0x00].pack('C') << priv_key.priv.htb
+    end
+
+    # Base58 encoded extended private key
+    def to_base58
+      h = to_payload.bth
+      hex = h + Bitcoin.checksum(h)
+      Bitcoin.encode_base58(hex)
+    end
+
+    # get private key(hex)
+    def priv
+      priv_key.priv
+    end
+
+    # get public key(hex)
+    def pub
+      priv_key.pub
+    end
+
+    # get address
+    def addr
+      priv_key.addr
+    end
+
+    # get key identifier
+    def identifier
+      Bitcoin.hash160(priv_key.pub)
+    end
+
+    # get fingerprint
+    def fingerprint
+      identifier.slice(0..7)
+    end
+
+    # derive new key
+    def derive(number)
+      new_key = ExtKey.new
+      new_key.depth = depth + 1
+      new_key.number = number
+      new_key.parent_fingerprint = fingerprint
+      if number > (2**31 -1)
+        data = [0x00].pack('C') << priv_key.priv.htb << [number].pack('N')
+      else
+        data = priv_key.pub.htb << [number].pack('N')
+      end
+      l = Bitcoin.hmac_sha512(chain_code, data)
+      left = OpenSSL::BN.from_hex(l[0..31].bth).to_i
+      raise 'invalid key' if left >= CURVE_ORDER
+      child_priv = OpenSSL::BN.new((left + OpenSSL::BN.from_hex(priv_key.priv).to_i) % CURVE_ORDER)
+      raise 'invalid key ' if child_priv.to_i >= CURVE_ORDER
+      new_key.priv_key = Bitcoin::Key.new(child_priv.to_hex.rjust(64, '0'))
+      new_key.chain_code = l[32..-1]
+      new_key
+    end
+
+    # import private key from Base58 private key address
+    def self.from_base58(address)
+      data = StringIO.new(Bitcoin.decode_base58(address).htb)
+      key = ExtKey.new
+      data.read(4).bth # version
+      key.depth = data.read(1).unpack('C').first
+      key.parent_fingerprint = data.read(4).bth
+      key.number = data.read(4).unpack('N').first
+      key.chain_code = data.read(32)
+      data.read(1) # 0x00
+      key.priv_key = Bitcoin::Key.new(data.read(32).bth)
+      key
+    end
+
+  end
+
+  # BIP-32 Extended public key
+  class ExtPubkey
+    attr_accessor :depth
+    attr_accessor :number
+    attr_accessor :chain_code
+    attr_accessor :pub_key
+    attr_accessor :parent_fingerprint
+
+    # serialize extended pubkey
+    def to_payload
+      Bitcoin.network[:extended_pubkey_version].htb << [depth].pack('C') << parent_fingerprint.htb << [number].pack('N') << chain_code << pub.htb
+    end
+
+    # get public key(hex)
+    def pub
+      pub_key.group.point_conversion_form = :compressed
+      pub_key.to_hex.rjust(66, '0')
+    end
+
+    # get address
+    def addr
+      Bitcoin.hash160_to_address(Bitcoin.hash160(pub))
+    end
+
+    # get key identifier
+    def identifier
+      Bitcoin.hash160(pub)
+    end
+
+    # get fingerprint
+    def fingerprint
+      identifier.slice(0..7)
+    end
+
+    # Base58 encoded extended pubkey
+    def to_base58
+      h = to_payload.bth
+      hex = h + Bitcoin.checksum(h)
+      Bitcoin.encode_base58(hex)
+    end
+
+    # derive child key
+    def derive(number)
+      new_key = ExtPubkey.new
+      new_key.depth = depth + 1
+      new_key.number = number
+      new_key.parent_fingerprint = fingerprint
+      raise 'hardened key is not support' if number > (2**31 -1)
+      data = pub.htb << [number].pack('N')
+      l = Bitcoin.hmac_sha512(chain_code, data)
+      left = OpenSSL::BN.from_hex(l[0..31].bth)
+      raise 'invalid key' if left.to_i >= CURVE_ORDER
+      new_key.pub_key = bitcoin_elliptic_curve.group.generator.mul(left).ec_add(pub_key)
+      new_key.chain_code = l[32..-1]
+      new_key
+    end
+
+    # import private key from Base58 private key address
+    def self.from_base58(address)
+      data = StringIO.new(Bitcoin.decode_base58(address).htb)
+      key = ExtPubkey.new
+      data.read(4).bth # version
+      key.depth = data.read(1).unpack('C').first
+      key.parent_fingerprint = data.read(4).bth
+      key.number = data.read(4).unpack('N').first
+      key.chain_code = data.read(32)
+      key.pub_key = OpenSSL::PKey::EC::Point.from_hex(bitcoin_elliptic_curve.group, data.read(33).bth)
+      key
+    end
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: hdkey
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Shigeyuki Azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitcoin-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The implementation of Bitcoin hierarchical deterministic key for Ruby.
+email:
+- azuchi@haw.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hdkey.gemspec
+- lib/hdkey.rb
+- lib/hdkey/ext_key.rb
+homepage: https://github.com/azuchi/hdkey
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The implementation of Bitcoin hierarchical deterministic key for Ruby.
+test_files: []