base58block 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d77a784c0b92e665ae1d0f03fb92307d78335d1
+  data.tar.gz: 628a12d811841276f0321339bae069db2642e07e
+SHA512:
+  metadata.gz: cd87241e1e8d9561718520205a00c290d12c7fa80f3131b0f325d227b3476ae874f9d5443ac7acf93a4b629a3c30e8b02d25f6a0e7fa24f03632dbbe8cd29fd8
+  data.tar.gz: 1aaaaaef83a9f52d797c5356734a8c2f2632d74e41890423a236e3180a2ea220d7d507fa416053648f8a65180a1d89353bac26ca908de61f3c3e4c855ea14cb3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Waite
+
+MIT License
+
+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,116 @@
+# Base58block
+
+Implementation of the Base58 Block algorithm
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base58block'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install base58block
+
+## Usage
+
+The library itself currently just consists of an encode and decode method.
+
+### Encoding
+The encoding is relatively simple. Using a 58 character dictionary
+(matching the bitcoin dictionary), we divide the input into 8 byte (64 bit) 
+blocks, then convert these to 64 bit integers (in network octet order). This 
+block is converted to base58, with each base58 'digit' represented by a
+different character in the dictionary. The value is always represented by a
+full 11 base58 'digit' number. So for example:
+
+```ruby
+Base58Block.encode "\0\0\0\0\0\0\0\0" # => "11111111"
+```
+  
+This is because the zero base58 digit is represented by the character "1" in
+the dictionary.
+
+The maximum value 64 bit number is represented in hex as 0xffffffffffffffff
+
+```ruby
+Base58Block.encode(["FFFFFFFFFFFFFFFF"].pack("H*")) # => "jpXCZedGfVQ"
+```
+
+You may need to represent the last bytes in a sequence total less than eight
+bytes. This is done rather simply - pad the highest order bytes with zero values
+before converting to an integer, convert to base58 per normal, then change the
+highest order base58 'digit' to a flag value.
+
+This flag value is `43 + {number of bytes in original block}`. This technique
+was chosen because:
+1. The highest leading base58 'digit' for a 64 bit unsigned number will be 42,
+   so no Base58 value will ever result in the leading digit set to one of the
+   flag values
+2. The highest leading base58 'digit' for a 56 bit/7 byte unsigned number will
+   always be zero, so we will not lose information by assigning an additional
+   purpose to the leading digit.
+
+To show an example:
+
+```ruby
+# Convert the highest seven byte value, 0x00ffffffffffffff
+result = Base58Block.encode(["00FFFFFFFFFFFFFF"].pack("H*")) # => "1Ahg1opVcGW"
+
+# Change first 'digit' to indicate we had only seven bytes input
+result[0] = DICTIONARY[43+7] # => "s"
+  
+Base58Block.encode(["FFFFFFFFFFFFFF".pack("H*")]) == result # => true
+```
+
+Note that a partial block still results in 11 characters of output.
+
+###Decoding
+Decoding works along the same lines as encoding, so it will likely be useful to
+familiarize yourself with encoding before reading the following description.
+
+Given an 11 character block, treat that block as a base58 number. The
+individual 'digits' of this number are represented by the character values
+within the dictionary. Reverse the dictionary mapping to come up with the
+individual digit values of the base58 number. This will allow you to construct
+an integer value, which should always be representable with an unsigned 64 bit
+value. Then, convert this 64 bit value to network order bytes.
+
+There is a special case when decoding a partial block. If the first 'digit' in
+the base 58 value is 43 or higher, this value is a flag indicating a partial
+block. Subtracting 43 from this value will give the number of bytes to be output
+(1 - 7). 
+
+To convert this value to an integer, you should first set the leading 'digit' to
+a zero value. You can then generate an eight byte output as normal. Strip off 
+the high order bytes (which will all be zero) to get a value of the desired size.
+
+### Normalization
+For the purpose of cryptographic validity, it is useful to have a single source
+value represented with a single base58 block encoded value. To this end, the
+following additional rules are provided for normalization:
+
+1. Only the last block can be a partial block
+2. Partial blocks must indicate between 1 and 7 bytes
+3. No additional characters (including whitespace) may appear within the encoded
+   value.
+   
+
+## Known issues
+
+- The current decoding algorithm will fail if whitespace or invalid characters
+  are in the input value
+
+## Contributing
+
+1. Fork it ( https://github.com/dwaite/base58block/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/base58block.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'base58block/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "base58block"
+  spec.version       = Base58block::VERSION
+  spec.authors       = ["David Waite"]
+  spec.email         = ["david@alkaline-solutions.com"]
+  spec.summary       = %q{Implementation of my own Base58-Block algorithm}
+  spec.description   = %q{Encoding algorithm for human input of binary values}
+  spec.homepage      = "https://github.com/dwaite/base58block"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/base58block.rb

@@ -0,0 +1,98 @@
+require "base58block/version"
+
+module Base58Block
+  DICTIONARY = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
+  REVERSE    = [
+      0,   1,   2,   3,   4,   5,   6,   7,   8, nil, nil, nil, nil, 
+    nil, nil, nil,   9,  10,  11,  12,  13,  14,  15,  16, nil,  17, 
+     18,  19,  20,  21, nil,  22,  23,  24,  25,  26,  27,  28,  29,
+     30,  31,  32, nil, nil, nil, nil, nil, nil,  33,  34,  35,  36,
+     37,  38,  39,  40,  41,  42,  43, nil,  44,  45,  46,  47,  48,
+     49,  50,  51,  52,  53,  54,  55,  56,  57 ]
+  REVERSE_START = 49
+
+  private
+  def self.reverse_dictionary c
+    idx = c.bytes.first
+    if idx < REVERSE_START
+      nil
+    else
+      REVERSE[ idx - REVERSE_START]
+    end
+  end
+
+  public
+  def self.encode data
+    data = data.dup
+    result = ""
+    
+    # operate on blocks of 8 bytes. The last block may less than 8 bytes
+    data.each_byte.each_slice(8) do |block|
+      encoded_block = ""
+      count = block.length
+
+      #convert input block into an integer using network order
+      total = block.inject {|sum, n| sum * 256 + n }
+
+      # repeatedly mod/divide 
+      while total > 0 do
+        total, index = total.divmod 58
+        encoded_block << DICTIONARY[index]
+      end
+
+      # if output is less than 11 characters, pad with "1"
+      padding = 11 - encoded_block.bytesize
+      encoded_block << "1" * padding
+      
+      # indicate less than eight bytes by changing the high order character
+      # (which is always '1' if you have less than eight bytes input) to
+      # a value which cannot occur
+      if count < 8
+        encoded_block[10] = DICTIONARY[43+count]
+      end
+      
+      # We want the data to be in network order, so we reverse it now
+      encoded_block = encoded_block.reverse
+      result << encoded_block
+    end
+    result
+  end
+
+  def self.decode text
+    text = text.dup
+    result = "".force_encoding "binary"
+  
+    # operate on blocks of 8 bytes. The last block may less than 8 bytes
+    text.each_char.each_slice(11) do |block|
+      
+      # create an array of the individual base 58 'digits'
+      decoded_block = block.map{|c| reverse_dictionary c }
+      if decoded_block.include? nil
+        return nil
+      end
+
+      # decode the byte count, stripping off the flag if needed
+      byte_count = 8
+      if decoded_block[0] >= 43
+        byte_count = c[0] - 43
+        decoded_block = decoded_block[1..-1]
+      end
+
+      # convert to integer value
+      integer = decoded_block.inject{|sum, i| sum * 58 + i }
+
+      # convert integer to 8 byte array (in reverse order)
+      data = []
+      8.times do
+        integer, mod = integer.divmod 256
+        data << mod
+      end
+      # strip off the leading zero bytes if we are a different byte count
+      data = data[0...byte_count].reverse
+
+      # pack bytes to a (binary) string and append to result
+      result << data.pack("C*")
+    end
+    result
+  end
+end

data/lib/base58block/version.rb

@@ -0,0 +1,3 @@
+module Base58block
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: base58block
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Waite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Encoding algorithm for human input of binary values
+email:
+- david@alkaline-solutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- base58block.gemspec
+- lib/base58block.rb
+- lib/base58block/version.rb
+homepage: https://github.com/dwaite/base58block
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Implementation of my own Base58-Block algorithm
+test_files: []