stribog 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ab38ecc83a74975f4d9c87d63269e294f9b2189
-  data.tar.gz: 8ce92d234b2715149416ae0c961ddda76630112f
+  metadata.gz: fc696f1b18cb6ec04fce7cf3cc740be1eed204a6
+  data.tar.gz: ad56184c6dae90af01b9edd83424e7ba1864e2d4
 SHA512:
-  metadata.gz: 1cb1ecedd099cad14175d362fd1d11864cec8e4d64fdc72b25cc57157387bf02f3b17abe77207b0510f6b8f73afb86a30563a4af3631c2ae6609641fb7836e8c
-  data.tar.gz: 2df83ff564cd4360b888abe9a0b809c5965004a9ad974a67d51a95d847fa53c55a5414b226006f0b99755122a4d4677c26640c764a5d8ae87efa91de20a3b40c
+  metadata.gz: e02b4f9c61c008e4d0a4b413c0739d8866d645d12152829fd6fda289c524e2baba94e787ba40c04a1734a80e33d9ad70f8c1df2378e493a6e885792902fadafa
+  data.tar.gz: fde879defcd83fb2fb86910fe2c2b2c3177cde3c3580db70551573d6870073b5dcfeb863cd02a7b8854609adac733b4347f592a839cd9e0b9b20043e9109e8ac

data/.rubocop.yml

@@ -1,12 +1,10 @@
 AllCops:
   Exclude:
-    - crypto_gost.gemspec
+    - stribog.gemspec
     - Rakefile
     - bin/test.rb
-    - lib/crypto_gost/digital_signature_gost_12/modular_arithmetic.rb
-    - lib/crypto_gost/digital_signature_gost_12/group/**/*
+    - lib/stribog/hash_params.rb
     - spec/**/*
-    - stribog.gemspec
 
 Metrics/LineLength:
   Max: 100

data/README.rdoc

@@ -0,0 +1,44 @@
+== Stribog
+
+{<img src="https://travis-ci.org/WildDima/stribog.svg?branch=master"
+alt="Build Status" />}[https://travis-ci.org/WildDima/stribog]
+
+Ruby library implementing GOST 34.11-12 Stribog
+
+=== Installation
+
+Add this line to your application's Gemfile:
+
+
+  gem 'stribog'
+
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install stribog
+
+=== Usage
+
+  require 'stribog'
+
+  hash = Stribog::CreateHash.new('ruby')
+
+  # for 256 bit
+  hash.(256).to_hex #=> "cde7864b760a690f4ec24ffe5c66bd2c00db843e9cf1b82b6c467dba5a7846a7"
+
+  # for 512 bit
+  hash.(512).to_hex #=> "f0dafc0703f801d1ecbe7ff246808d07507f67879eaacf887ba041336fd51e0a964f00470ed0eedb0378a39e019eb308876ea8c84bb89e2c35159fb6dbbdc598"
+
+=== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wilddima/stribog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+=== License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/stribog.rb

@@ -4,6 +4,8 @@ require 'stribog/version'
 # @author WildDima
 module Stribog
   require_relative './stribog/create_hash'
+  require_relative './stribog/hash_params'
   require_relative './stribog/compression'
   require_relative './stribog/binary_vector'
+  require_relative './stribog/digest'
 end

data/lib/stribog/compression.rb

@@ -1,8 +1,7 @@
-require_relative 'hash_params'
-
 module Stribog
   # Compression
   #
+  # Class implements compression function of GOST R 34.11-2012 algorithm.
   # @author WildDima
   class Compression
     include HashParams

data/lib/stribog/create_hash.rb

@@ -1,22 +1,47 @@
-require 'byebug'
 module Stribog
-  # Hash function
+  # CreateHash
   #
+  # Class, which creates digests.
   # @author WildDima
   class CreateHash
-    attr_reader :binary_vector, :message_adapter, :message, :digest_length, :message_vector
+    # Original message
+    #
+    # @api public
+    # @example
+    #   hash.message
+    # @return [String] contains original message
+    attr_reader :message
+
+    # Length of digest. Should be equal to 256 or 512.
+    #
+    # @api public
+    # @example
+    #   digest.digest_length
+    # @return [Fixnum] binary representation of digest
+    attr_reader :digest_length
+
+    # Contain message as instance of BinaryVector
+    #
+    # @api public
+    # @example
+    #   digest.message_vector
+    # @return [BinaryVector] binary representation of message
+    attr_reader :message_vector
 
     HASH_LENGTH = 512
 
-    def initialize(message, binary_vector: BinaryVector)
-      @binary_vector = binary_vector
-      @message = binary_vector.from_hex(message)
-      @n = binary_vector_field_by
-      @sum = binary_vector_field_by
+    def initialize(message)
+      @message = message
     end
 
+    # Create digest of {#message}. Default equal to 512.
+    #
+    # @example
+    #   Stribog::CreateHash.new('ruby').call(256)
+    #   Stribog::CreateHash.new('ruby').call(512)
+    # @author WildDima
     def call(digest_length = HASH_LENGTH)
-      create_hash_params!(digest_length: digest_length)
+      prepare_hash_params!(digest_length: digest_length)
 
       return_hash(
         final_compression(
@@ -34,12 +59,16 @@ module Stribog
 
     private
 
-    def create_hash_params!(digest_length:)
+    # Create instance vars for hashing
+    def prepare_hash_params!(digest_length:)
+      @n = binary_vector_field_by
+      @sum = binary_vector_field_by
       @digest_length = digest_length
       @hash_vector = create_hash_vector
-      @message_vector = message.dup
+      @message_vector = binary_vector.from_hex(message)
     end
 
+    # Create hash_vector for hashing
     def create_hash_vector
       case digest_length
       when 512
@@ -52,9 +81,10 @@ module Stribog
       end
     end
 
+    # Method, which slices longer messages, and hashings them by parts.
     def compact_message(sum:, n:, message_vector:, hash_vector:, message_head: nil)
       current_vector = message_head || message_vector
-      if message_vector.size < HASH_LENGTH || !message_head.nil? && message_head.size < HASH_LENGTH
+      if current_vector.size < HASH_LENGTH
         return { sum: sum, n: n, message_vector: current_vector,
                  hash_vector: hash_vector }
       end
@@ -69,14 +99,17 @@ module Stribog
       )
     end
 
+    # Method, which slices head of message
     def slice_message_head(message_vector)
       binary_vector_from_array(message_vector.vector[0...-HASH_LENGTH])
     end
 
+    # Method, which slices head of tail
     def slice_message_tail(message_vector)
       binary_vector_from_array(message_vector.vector[-HASH_LENGTH..-1])
     end
 
+    # Method, which implements main hashing
     def core_hashing(sum:, n:, message_vector:, hash_vector:)
       new_sum = addition_in_ring_to_binary(sum.to_dec,
                                            message_vector
@@ -92,40 +125,60 @@ module Stribog
       { sum: new_sum, n: new_n, hash_vector: new_hash_vector }
     end
 
+    # Method, which implements final compression
     def final_compression(sum:, n:, hash_vector:)
       compress(message: sum, hash_vector: compress(message: n, hash_vector: hash_vector))
     end
 
+    # Method, which return digest, dependent on them length
     def return_hash(final_vector)
       case digest_length
       when 512
-        final_vector
+        create_digest(final_vector)
       when 256
-        binary_vector_from_array(final_vector[0..255])
+        create_digest(binary_vector_from_array(final_vector[0..255]))
       else
         raise ArgumentError,
               "digest length must be equal to 256 or 512, not #{digest_length}"
       end
     end
 
+    # Method implements addition in ring
     def addition_in_ring(first, second, ring)
       (first + second) % ring
     end
 
+    # Method implements addition in ring and creates binary vector
     def addition_in_ring_to_binary(first, second, ring = 2**HASH_LENGTH, size: HASH_LENGTH)
       binary_vector.from_byte(addition_in_ring(first, second, ring), size: size)
     end
 
+    # Compression method
     def compress(message:, hash_vector:, n: binary_vector_field_by)
       Compression.new(n, message, hash_vector).call
     end
 
+    # Method creates binary vector from array
     def binary_vector_from_array(vector)
       binary_vector.new(vector)
     end
 
+    # Method creates binary vector and fields it by passed values
     def binary_vector_field_by(size: HASH_LENGTH, value: 0)
       binary_vector_from_array(Array.new(size, value))
     end
+
+    # Create new instance of Digest
+    def create_digest(binary_vector)
+      digest.new(binary_vector: binary_vector)
+    end
+
+    def binary_vector
+      @binary_vector ||= BinaryVector
+    end
+
+    def digest
+      @digest ||= Digest
+    end
   end
 end

data/lib/stribog/digest.rb

@@ -0,0 +1,29 @@
+module Stribog
+  # Digest
+  #
+  # Class, returning by CreateHash#call
+  # Contains binary and hex representation of digest.
+  # You can use {#binary} to get array and {#hex} to get digest in hash.
+  # @author WildDima
+  class Digest
+    # Contains binary representation of hash
+    #
+    # @api public
+    # @example
+    #   digest.binary
+    # @return [Array] binary representation of digest
+    attr_reader :binary
+    # Contains hex value of hash
+    #
+    # @api public
+    # @example
+    #   digest.hex
+    # @return [String] hex representation of digest
+    attr_reader :hex
+
+    def initialize(binary_vector:)
+      @binary = binary_vector.vector
+      @hex = binary_vector.to_hex
+    end
+  end
+end

data/lib/stribog/hash_params.rb

@@ -1,5 +1,7 @@
 module Stribog
-  # rubocop:disable Metrics/LineLength
+  # Contains constants for hashing
+  #
+  # @author WildDima
   module HashParams
     PI = [252, 238, 221, 17, 207, 110, 49, 22, 251, 196, 250, 218, 35, 197, 4, 77, 233, 119, 240,
           219, 147, 46, 153, 186, 23, 54, 241, 187, 20, 205, 95, 193, 249, 24, 101, 90, 226, 92, 239,
@@ -48,6 +50,5 @@ module Stribog
                      abbedea680056f52382ae548b2e4f3f38941e71cff8a78db1fffe18a1b3361039fe76702af69334b7a1e6c303b7652f43698fad1153bb6c374b4c7fb98459ced
                      7bcd9ed0efc889fb3002c6cd635afe94d8fa6bbbebab076120018021148466798a1d71efea48b9caefbacd1d7d476e98dea2594ac06fd85d6bcaa4cd81f32d1b
                      378ee767f11631bad21380b00449b17acda43c32bcdf1d77f82012d430219f9b5d80ef9d1891cc86e71da4aa88e12852faf417d5d9b21b9948bc924af11bd720).freeze
-    # rubocop:enable Metrics/LineLength
   end
 end

data/lib/stribog/version.rb

@@ -1,3 +1,3 @@
 module Stribog
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stribog
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - WildDima
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-02 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rdoc
 - Rakefile
 - bin/console
 - bin/setup
@@ -102,6 +102,7 @@ files:
 - lib/stribog/binary_vector.rb
 - lib/stribog/compression.rb
 - lib/stribog/create_hash.rb
+- lib/stribog/digest.rb
 - lib/stribog/hash_params.rb
 - lib/stribog/version.rb
 - stribog.gemspec

data/README.md

@@ -1,41 +0,0 @@
-# Stribog
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stribog`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'stribog'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install stribog
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stribog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-