bitpay-key-utils 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e7c32f43dd65ee8f2978c596ceae25ab5554c7
-  data.tar.gz: 1d9d8a9921b01e5c79ee85ad190eb8c443248d8f
+  metadata.gz: 85114def0e839cb4dbf3f9b5e3fca31190f45c80
+  data.tar.gz: d0848a5549a96ddc69167ce3e942ef532a04a659
 SHA512:
-  metadata.gz: 23b464c38bf539f3a80f2cde38dbe2b9c6b6397ec16a7a74cb5005fb9324120f5eb9ad0ee6807dade17a6ec40f14bee974fa3f306bc67a3c089993dda8cdb354
-  data.tar.gz: 400893ec62fdfa9cdc9766784dd06968ff2d3a3f60d38eb8c33ba598ca4160bfd734ef5498aefba660eefdea58ccd69b847077a5b54174a7d5076ec3a854bd2d
+  metadata.gz: f06a652fdfc8247875b269645f4d93a4c980ccef43efb0a5dfdc3dbbac43f48ce50dba9c94bdc3ade411f14ffbb0f38edabff5d154c5f5180d52d97017a977c1
+  data.tar.gz: 5e81f4d5629f25f56130188baa2cbf3592f7cd15910e627cf597179a4bd18a14ab5be39872f1df98aeaf41c391d86d7d9e245b0934d897d0bc82723db351323b

data/.gitignore

@@ -27,7 +27,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+- 2.1.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.0.1] - 2015-04-16
+### Changed
+- Add method: sign\_with\_pem

data/GUIDE.md

@@ -0,0 +1,42 @@
+# Using the BitPay Key Utilities Library
+
+This gem provides utilities for use with the BitPay API. It enables creating keys, retrieving public keys, retrieiving private keys, creating the SIN that is used in retrieving tokens from BitPay, and signing payloads for the `X-Signature` header in a BitPay API request.
+## Quick Start
+### Installation
+```bash
+gem install 'bitpay-key-utils'
+```
+
+In your Gemfile:
+
+```ruby
+gem 'bitpay-key-utils', :require => 'bitpay_key_utils'
+```
+
+Or directly:
+
+```irb
+[1] pry(main)> require 'bitpay_key_utils'
+=> true
+[2] pry(main)> pem = BitPay::KeyUtils.generate_pem
+=> "-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEIF2HghUnVK/MbkS+y8PGOoVpswunIgWHd8GTzWvI97e/oAcGBSuBBAAK\noUQDQgAEA0Jz4UdYJZJugoxUn1k4PVoLKOUus3TkRq0xqoHkZL4QIzzxqS1DmGWr\nfb9Eot6w7QcWRWACF/G/xIp6Nap8bA==\n-----END EC PRIVATE KEY-----\n"
+[3] pry(main)> sin = BitPay::KeyUtils.generate_sin_from_pem pem
+=> "TfEKWr2FcX2XnWxUNPJ3iD5Xe6X5frZb1DG"
+[4] pry(main)> priv = BitPay::KeyUtils.get_private_key_from_pem pem
+=> "5d8782152754afcc6e44becbc3c63a8569b30ba722058777c193cd6bc8f7b7bf"
+[5] pry(main)> pub = BitPay::KeyUtils.get_public_key_from_pem pem
+=> "02034273e1475825926e828c549f59383d5a0b28e52eb374e446ad31aa81e464be"
+[6] pry(main)> BitPay::KeyUtils.sign "this message", priv
+=> "304402207b6d2d59f0e2061519c47744fcdff87e8136f0086aa4b94bd667d62221dfbcb802201a0ce7929eed614ff71972879cd0b31813c9ad7ed0e7bbde4590e9a836007db6"
+```
+
+## API Documentation
+
+API Documentation is available on the [BitPay site](https://bitpay.com/api).
+
+## Running the Tests
+
+```bash
+$ bundle
+$ rspec
+```

data/README.md

@@ -1,2 +1,13 @@
 # bitpay-ruby-keyutils
-Crypto methods
+
+[![](https://secure.travis-ci.org/bitpay/bitpay-ruby-keyutils.png)](http://travis-ci.org/bitpay/bitpay-ruby-keyutils)    [![Gem Version](https://badge.fury.io/rb/bitpay-key-utils.svg)](http://badge.fury.io/rb/bitpay-key-utils) 
+
+Provides required cryptographic functions to use the BitPay 2.0 API.
+
+## [Getting Started »](http://dev.bitpay.com/guides/ruby-key-utils.html)
+
+## Found a bug?
+Let us know! Send a pull request or a patch. Questions? Ask! We're here to help. We will respond to all filed issues.
+
+## Contributors
+[Click here](https://github.com/bitpay/bitpay-ruby-keyutils/graphs/contributors) to see a list of the contributors to this library.

data/Rakefile

@@ -0,0 +1,6 @@
+begin
+    require 'rspec/core/rake_task'
+      RSpec::Core::RakeTask.new(:spec)
+      task :default => :spec
+rescue LoadError
+end

data/bitpay-key-utils.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
   s.authors = 'Bitpay, Inc.'
   s.email = 'info@bitpay.com'
-  s.homepage = 'https://github.com/bitpay/ruby-key-utils'
+  s.homepage = 'https://github.com/bitpay/bitpay-ruby-keyutils'
   s.summary = 'Official Ruby library for the BitPay API'
   s.description = 'Powerful, flexible, lightweight, thread-safe interface to the BitPay developers API'
 

data/lib/bitpay/key_utils.rb

@@ -84,6 +84,11 @@ module BitPay
         end
       end
 
+      def sign_with_pem pem, message
+        priv = get_private_key_from_pem pem
+        sign(message, priv)
+      end
+      
       ########## Private Class Methods ################
 
       ## Base58 Encoding Method

data/lib/bitpay/key_version.rb

@@ -1,3 +1,3 @@
 module BitPay
-  KEY_UTILS_VERSION="2.0.0"
+  KEY_UTILS_VERSION="2.0.1"
 end

data/spec/key_utils_spec.rb

@@ -28,7 +28,23 @@ describe BitPay::KeyUtils do
     it 'will return the right sin for the right pem' do
       expect(key_utils.generate_sin_from_pem(pem)).to eq sin
     end
+  end
+
+  describe '.sign_with_pem' do
+    it "should provide a valid signature" do
+      message = "hello cincinatti"
+      digest = Digest::SHA256.digest(message)
 
+      pem = PEM
+      signature = key_utils.sign_with_pem pem, message
+
+      priv= OpenSSL::PKey::EC.new(pem).private_key.to_i
+      group = ECDSA::Group::Secp256k1
+      pk = group.generator.multiply_by_scalar(priv)
+      decoded = ECDSA::Format::SignatureDerString.decode(signature.to_i(16).to_bn.to_s(2))
+      valid = ECDSA.valid_signature?(pk, digest, decoded)
+      expect(valid).to be(true)
+    end
   end
 
   context "errors when priv_key is not provided" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitpay-key-utils
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Bitpay, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -103,17 +103,20 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- GUIDE.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bitpay-key-utils.gemspec
 - lib/bitpay/key_utils.rb
 - lib/bitpay/key_version.rb
 - lib/bitpay_key_utils.rb
 - spec/key_utils_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/bitpay/ruby-key-utils
+homepage: https://github.com/bitpay/bitpay-ruby-keyutils
 licenses:
 - MIT
 metadata: {}

data/Gemfile.lock

@@ -1,55 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bitpay-key-utils (2.0.1)
-      ecdsa (~> 1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.2.5)
-    ecdsa (1.2.0)
-    interception (0.5)
-    method_source (0.8.2)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (2.0.0)
-      byebug (~> 3.4)
-      pry (~> 0.10)
-    pry-rescue (1.4.1)
-      interception (>= 0.5)
-      pry
-    rake (10.3.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    slop (3.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bitpay-key-utils!
-  pry (= 0.10.1)
-  pry-byebug (= 2.0.0)
-  pry-rescue (= 1.4.1)
-  rake (= 10.3.2)
-  rspec (= 3.1.0)