pathgraph_encoding 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61f5140f2543a7cabf91ad37ca4caa617441264c
+  data.tar.gz: 1d30966e594ad575883be4d4f4d98f99aa58168a
+SHA512:
+  metadata.gz: 60408328d70ee527ff7e9e0d95d46e66f5ccbf0775bcf35494927fd5bcb92c4eb6a97a1161ec204cffcc3448b1f18a1b095b682561a7e46c76b3eb6e61e4b44d
+  data.tar.gz: cd58cf35f08d76b96967a52ab52c1cd8c878d5bf1f4b2733c98eb253a22b5d167770e480cf7d1592f19fbb8b65a4ed097be5abe13896f7eb7853b0481c645cdb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+pathgraph_encoding

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pathgraph_encoding.gemspec
+gemspec
+
+gem 'yard', '~> 0.8.7.6'
+gem 'minitest', '~> 5.6.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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/PathGraphs.asn

@@ -0,0 +1,24 @@
+PathGraph DEFINITIONS IMPLICIT TAGS ::= BEGIN
+  version   INTEGER,
+
+  PrivateKey ::= SEQUENCE {
+    n   INTEGER (4..8),
+    pi  SEQUENCE OF MSequence      
+  }
+
+  PublicKey ::= SEQUENCE {
+    n   INTEGER (4..8),
+    k   INTEGER,
+    m   INTEGER,
+    phi SEQUENCE OF MSequence      
+  }
+
+  MSequence ::= SEQUENCE {
+    pgVertex  PGVertex
+  }
+
+  PGVertex ::= SEQUENCE {
+    qn_vertex  INTEGER
+  }
+
+END

data/README.md

@@ -0,0 +1,118 @@
+# PathgraphEncoding
+
+PathgraphEnconding is a library to encode and decode Pathgraph keys (public and private) to [ASN.1 DER format](http://luca.ntop.org/Teaching/Appunti/asn1.html "A Layman's Guide to a Subset of ASN.1, BER, and DER").
+
+Pathgraph ANS.1 descriptor file is `PathGraphs.asn`.
+
+## Installation
+
+### Prerequisites
+
+This a Ruby library packed into a [gem](http://guides.rubygems.org/what-is-a-gem/ "RubyGems Guides"), so you need Ruby interpreter installed, it is strongly recommended to use at least [Ruby 2.1.0](http://ruby-doc.org/core-2.1.0/ "Ruby 2.1.0 core documentation").
+
+### Library installation
+
+Add this line to your application's [Gemfile](http://bundler.io/v1.5/gemfile.html "Bundler documentation"):
+
+```ruby
+gem 'pathgraph_encoding'
+```
+
+then execute in shell:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install pathgraph_encoding
+```
+
+### Testing
+
+This library has included a little suite of test cases to verify library algorithmic correctness. So it is suggested to execute tests before install or use this gem.
+
+#### Executing tests
+
+You can execute test cases with `rake` command:
+
+```bash
+$ rake test
+```
+
+## Library usage
+
+This library has two specific tasks: encoding and decoding keys.
+
+### Include library
+
+You must include this library in your source code file, adding at the top a line like this:
+
+```ruby
+require 'pathgraph_encoding'
+```
+
+### Encoding a private key
+
+Given an instance of a private key, like this:
+
+```ruby
+# Your private key
+key = {
+  n: 4,
+  pi: [
+    [0,1,3,2],
+    [6,7,5,4],
+    [12,13,15,14],
+    [10,11,9,8]
+  ]
+}
+```
+
+call `PrivateKey::to_der` method:
+
+```ruby
+der = PathgraphEncoding::PrivateKey::to_der(key)
+```
+
+### Decoding a private key
+
+Given an instance of a DER encoded key:
+
+```ruby
+der = "0F\x13\x050.0.10=\x02\x01\x04080\f\x02\x01\x00"\
+      "\x02\x01\x01\x02\x01\x03\x02\x01\x020\f\x02\x01"\
+      "\x06\x02\x01\a\x02\x01\x05\x02\x01\x040\f\x02\x01"\
+      "\f\x02\x01\r\x02\x01\x0F\x02\x01\x0E0\f\x02\x01\n"\
+      "\x02\x01\v\x02\x01\t\x02\x01\b"
+```
+
+call `PrivateKey::from_der` method:
+
+```ruby
+key = PathgraphEncoding::PrivateKey::from_der(der)
+```
+
+it will return a key like:
+
+```ruby
+key = {
+  version: "0.0.1",
+  n: 4,
+  pi: [[0,1,3,2],[6,7,5,4],[12,13,15,14],[10,11,9,8]]
+}
+```
+
+
+## Contributing
+
+I will be grateful to have your contributions.
+Feel free to make modifications, fix bugs or add new features.
+
+1. Fork the project (https://gitlab.com/israelbuitron/pathgraph_encoding)
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/test_*.rb"
+end
+
+task default: :test

data/lib/pathgraph_encoding.rb

@@ -0,0 +1,209 @@
+require "pathgraph_encoding/version"
+require 'openssl'
+require 'pp'
+
+# @author Israel Buitron
+module PathgraphEncoding
+
+  # Represents a pathgraph private key.
+  #
+  # An instance of a private key can be like this:
+  #
+  #   key = {
+  #     n: 4,
+  #     pi: [[0,1,3,2],[6,7,5,4],[12,13,15,14],[10,11,9,8]]
+  #   }
+  module PrivateKey
+
+    # Compute DER-formatted bytes array of a pathgraph private key.
+    #
+    # == Parameters:
+    # key::
+    #   A private key to encode.
+    #
+    # == Returns:
+    # A byte array representing the private key specified.
+    #
+    def self.to_der(key)
+      n = OpenSSL::ASN1::Integer.new(key[:n])
+      pi = OpenSSL::ASN1::Sequence.new(
+        key[:pi].map do |p|
+          arr = p.map { |x| OpenSSL::ASN1::Integer.new(x) }
+          OpenSSL::ASN1::Sequence.new(arr)
+        end
+      )
+      privateKey = OpenSSL::ASN1::Sequence.new([n,pi])
+
+      version = OpenSSL::ASN1::PrintableString.new("0.0.1")
+      instance = OpenSSL::ASN1::Sequence.new([version,privateKey])
+
+      instance.to_der
+    end
+
+    # Decode and build a instance of a pathgraph private key from a
+    # DER-formatted bytes array.
+    #
+    # == Parameters:
+    # der::
+    #   A byte array representing the private key specified.
+    #
+    # == Returns:
+    # key::
+    #   The private key dencoded.
+    #
+    def self.from_der(der)
+      asn1 = OpenSSL::ASN1.decode(der)
+      {
+        version: OpenSSL::ASN1.decode(asn1.value[0]).value,
+        n: OpenSSL::ASN1.decode(asn1.value[1].value[0]).value.to_i,
+        pi: OpenSSL::ASN1.decode(asn1.value[1].value[1]).value.map { |e| e.map { |d| d.value.to_i } }
+      }
+    end
+    
+    # Check if is a valid private key.
+    #
+    # == Parameters:
+    # key::
+    #   A byte array representing the private key specified.
+    #
+    # == Returns:
+    # Returns `true` if is a valid private key, otherwise
+    # `false`.
+    #
+    def self.is_valid?(key)
+      # Check valid hypercube degree
+      return false if is_valid_hypercube_degree(key[:n])
+
+      # Check valid hypercube vertices
+      # max_vertex = (1<<key[:n])-1
+      key[:pi].each do |pi|
+        pi.each do |vertex|
+          return false unless is_valid_hypercube_vertex?(vertex,key[:n])
+        end
+
+        pi[0...-1].each_with_index do |i,j|
+          return false unless is_adyacent_in_hp?(i,pi[j+1])
+        end
+      end
+
+      true
+    end
+
+    # Check if a number is a valid hypercube degree is an integer
+    # between 4 and 8.
+    #
+    # == Parameters:
+    # n::
+    #   Hypercube degree.
+    #
+    # == Returns:
+    # If is a valid hypercube degree, returns `true`, otherwise
+    # `false`.
+    #
+    def self.is_valid_hypercube_degree?(n)
+      n >= 4 && n <= 8 && n.is_a?(Integer)
+    end
+
+    # Check if a number is a valid hypercube vertex.
+    #
+    # == Parameters:
+    # v::
+    #   Hypercube vertex.
+    # n::
+    #   Hypercube degree.
+    #
+    # == Returns:
+    # If is a valid hypercube vertex, returns `true`, otherwise
+    # `false`.
+    #
+    def self.is_valid_hypercube_vertex?(v,n)
+      v >= 0 && v <= (1<<n)-1 && v.is_a?(Integer)
+    end
+
+    # Check if two vertices are adjacent in a hypercube.
+    #
+    # == Parameters:
+    # a::
+    #   First hypercube vertex.
+    # b::
+    #   Second hypercube vertex.
+    #
+    # == Returns:
+    # If both are adjacent vertices, returns `true`, otherwise
+    # `false`.
+    #
+    def self.is_adyacent_in_hp?(a,b)
+      (a^b).to_s(2).count(1) == 1
+    end
+
+    def self.gen_public_key(key)
+      {
+        n: key[:n],
+        sigma: key[:pi].map! { |p| [p[0],p[-1]] }
+      }
+    end
+
+  end
+
+  # Represents a pathgraph public key.
+  module PublicKey
+
+    # Compute DER-formatted bytes array of a pathgraph public key.
+    #
+    # == Parameters:
+    # key::
+    #   A public key to encode.
+    #
+    # == Returns:
+    # A byte array representing the public key specified.
+    #
+    def self.to_der(key)
+      n = OpenSSL::ASN1::Integer.new(key[:n])
+      # m = OpenSSL::ASN1::Integer.new(key[:m])
+      # k = OpenSSL::ASN1::Integer.new(key[:k])
+      sigma = OpenSSL::ASN1::Sequence.new(
+        key[:sigma].map do |sig|
+          arr = sig.map { |x| OpenSSL::ASN1::Integer.new(x) }
+          OpenSSL::ASN1::Sequence.new(arr)
+        end
+      )
+      publicKey = OpenSSL::ASN1::Sequence.new([n,sigma])
+
+      version = OpenSSL::ASN1::PrintableString.new("0.0.1")
+      instance = OpenSSL::ASN1::Sequence.new([version,publicKey])
+
+      instance.to_der
+    end
+
+    # Decode and build a instance of a pathgraph public key from a
+    # DER-formatted bytes array.
+    #
+    # == Parameters:
+    # der::
+    #   A byte array representing the public key specified.
+    #
+    # == Returns:
+    # key::
+    #   The public key dencoded.
+    #
+    def self.from_der(der)
+      # TODO: implement this method
+    end
+
+    # Check if is a valid public key.
+    #
+    # == Parameters:
+    # key::
+    #   A byte array representing the public key specified.
+    #
+    # == Returns:
+    # Returns `true` if is a valid public key, otherwise
+    # `false`.
+    #
+    def self.is_valid?(key)
+      # TODO: implement this method
+    end
+
+  end
+
+end

data/lib/pathgraph_encoding/version.rb

@@ -0,0 +1,4 @@
+module PathgraphEncoding
+  # Pathgraph encoding library version
+  VERSION = "0.0.1"
+end

data/pathgraph_encoding.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pathgraph_encoding/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pathgraph_encoding"
+  spec.version       = PathgraphEncoding::VERSION
+  spec.authors       = ["Israel Buitron"]
+  spec.email         = ["ibuitron@ipn.mx"]
+  spec.summary       = %q{PathgraphEnconding is a library to encode Pathgraph keys to ASN.1}
+  spec.description   = %q{PathgraphEnconding is a library to encode and decode Pathgraph keys (public and private) to ASN.1 DER format.}
+  spec.homepage      = "http://computacion.cs.cinvestav.mx/~ibuitron/"
+  spec.license       = "MIT"
+  spec.metadata      = { 'issue_tracker' => "https://gitlab.com/israelbuitron/pathgraph_encoding/issues" }
+
+  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.5"
+  spec.add_development_dependency "rake", '~> 10.4'
+end

data/test/test_pathgraph_privatekey.rb

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+require 'pathgraph_encoding'
+
+class TestPathGraphPrivateKey < Minitest::Test
+
+  def setup
+    @private_key = {
+      n: 4,
+      pi: [[0,1,3,2],[6,7,5,4],[12,13,15,14],[10,11,9,8]]
+    }
+    @der_private_key = "0F\x13\x050.0.10=\x02\x01\x04080\f\x02\x01\x00"\
+    "\x02\x01\x01\x02\x01\x03\x02\x01\x020\f\x02\x01\x06\x02\x01\a\x02"\
+    "\x01\x05\x02\x01\x040\f\x02\x01\f\x02\x01\r\x02\x01\x0F\x02\x01"\
+    "\x0E0\f\x02\x01\n\x02\x01\v\x02\x01\t\x02\x01\b"
+  end
+
+  def test_to_der
+    der = PathgraphEncoding::PrivateKey::to_der(@private_key)
+    assert_equal 72, der.size
+    assert_equal @der_private_key, der
+  end
+
+  def test_from_der
+    der = "0*\x13\x050.0.10!\x02\x01\x040\x1C0\f\x02\x01\x01\x02\x01\x02\x02\x01\x03\x02\x01\x040\f\x02\x01\x05\x02\x01\x06\x02\x01\a\x02\x01\b"
+    key = PathgraphEncoding::PrivateKey::from_der(der)
+    exp = {version: "0.0.1", n: 4, pi: [[1, 2, 3, 4], [5, 6, 7, 8]]}
+    assert_equal key, exp
+  end
+
+  def test_is_valid
+    skip "TODO: implement 'is_valid' testcase"
+  end
+
+  def test_is_valid_hypercube_degree
+    (4..8).each do |i|
+      assert PathgraphEncoding::PrivateKey::is_valid_hypercube_degree?(i)
+    end
+  end
+
+  def test_is_adyacent_in_hp
+    skip "TODO: implement 'is_adyacent_in_hp' testcase"
+  end
+
+  def test_gen_public_key
+    expected = {
+      n: 4,
+      sigma: [[0,2],[6,4],[12,14],[10,8]]
+    }
+    key = PathgraphEncoding::PrivateKey::gen_public_key(@private_key)
+    assert_equal expected, key
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: pathgraph_encoding
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Israel Buitron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: PathgraphEnconding is a library to encode and decode Pathgraph keys (public
+  and private) to ASN.1 DER format.
+email:
+- ibuitron@ipn.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- PathGraphs.asn
+- README.md
+- Rakefile
+- lib/pathgraph_encoding.rb
+- lib/pathgraph_encoding/version.rb
+- pathgraph_encoding.gemspec
+- test/test_pathgraph_privatekey.rb
+homepage: http://computacion.cs.cinvestav.mx/~ibuitron/
+licenses:
+- MIT
+metadata:
+  issue_tracker: https://gitlab.com/israelbuitron/pathgraph_encoding/issues
+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: PathgraphEnconding is a library to encode Pathgraph keys to ASN.1
+test_files:
+- test/test_pathgraph_privatekey.rb
+has_rdoc: