openssl-cmac 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16491a689fe7f5d899159d3762cd7618f3150bc2a1ecede264731ef308a5d876
-  data.tar.gz: b4df90a8d51cdba9649101217df4978181a93ea680ac67c3b6cd0b15939e55e7
+  metadata.gz: eeaa9487886f72ffd7c689661ccd9d8dd0686e96df697963658f2d262fd1faea
+  data.tar.gz: 330603ff0c555473cfa1506b0de06bde9b365c3ba0b2f78da6edf1b747fb6e6b
 SHA512:
-  metadata.gz: 0b26a6dd073ebdef048598ccec4a44ab0fe7510a785a5dc656cc28760dfa596b7f7e358abd3d1940709687dc1e4ad730348198a0bd9174df166636055715b2fc
-  data.tar.gz: 82292fbd9b159ca48b8062093c8a6c093960b52813717729a38648f880ad84c2b9843e91b5d42782e91ee51a38dd05288ea76b3bdbe4e8b4552667144a540d5b
+  metadata.gz: daccd0c4ae792fce56c26ba8540e2d5c1afe530dd75f55982028b12cfe389fede43918202000caedef08bdd2f8d28e31551dde5dec5cc118dee424d1f454bfaf
+  data.tar.gz: 310141d8937441a8bd77c70d09542305a9bfe6cf8b04733a58f84cad27ee0bf2ff64fd726abf8a01f842142ad4764da724e5eae659bc2516b35e0f31143144aa

data/README.md

@@ -1,8 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/openssl-cmac.png)](http://badge.fury.io/rb/openssl-cmac)
-[![Dependency Status](https://gemnasium.com/SmallLars/openssl-cmac.png)](https://gemnasium.com/SmallLars/openssl-cmac)
-[![Build Status](https://travis-ci.org/SmallLars/openssl-cmac.png?branch=master)](https://travis-ci.org/SmallLars/openssl-cmac)
 [![Coverage Status](https://coveralls.io/repos/SmallLars/openssl-cmac/badge.png?branch=master)](https://coveralls.io/r/SmallLars/openssl-cmac)
-[![Code Climate](https://codeclimate.com/github/SmallLars/openssl-cmac.png)](https://codeclimate.com/github/SmallLars/openssl-cmac)
+[![Maintainability](https://qlty.sh/gh/SmallLars/projects/openssl-cmac/maintainability.svg)](https://qlty.sh/gh/SmallLars/projects/openssl-cmac)
 [![Inline docs](http://inch-ci.org/github/smalllars/openssl-cmac.png)](http://inch-ci.org/github/smalllars/openssl-cmac)
 
 # openssl-cmac

data/lib/openssl/cmac/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OpenSSL
   class CMAC
-    VERSION = '2.0.2'
+    VERSION = '2.1.0'
   end
 end

data/lib/openssl/cmac.rb

@@ -1,5 +1,11 @@
+# frozen_string_literal: true
+
 require 'openssl'
 
+# Extends Ruby's standard OpenSSL module with the CCM (Counter with CBC-MAC) class.
+#
+# This module is part of Ruby's standard library and is only reopened here
+# to provide support for the CCM authenticated encryption mode (as defined in RFC 3610).
 module OpenSSL
   # CMACError used for wrong parameter resonse.
   class CMACError < StandardError
@@ -42,8 +48,6 @@ module OpenSSL
       CMAC.new(cipher, key).update(data).digest(length)
     end
 
-    public
-
     # Returns an instance of OpenSSL::CMAC set with the cipher algorithm and
     # key to be used. The instance represents the initial state of the message
     # authentication code before any data has been processed. To process data
@@ -54,12 +58,10 @@ module OpenSSL
     #
     # @return [Object] the new CMAC object
     def initialize(cipher, key = '')
-      unless CMAC.ciphers.include?(cipher.upcase)
-        fail CMACError, "unsupported cipher algorithm (#{cipher})"
-      end
+      raise CMACError, "unsupported cipher algorithm (#{cipher})" unless CMAC.ciphers.include?(cipher.upcase)
 
       @keys = []
-      @buffer = ''.force_encoding('ASCII-8BIT')
+      @buffer = String.new.force_encoding('ASCII-8BIT')
       @cipher = OpenSSL::Cipher.new("#{cipher.upcase}-128-CBC")
 
       self.key = key unless key == ''
@@ -69,27 +71,13 @@ module OpenSSL
     # with all processed data cleared from it.
     #
     # @param key [String] binary key string
-    #
-    # @return [Object] self with initial state and new key
     def key=(key)
       reset
       key = CMAC.digest('AES', "\x00" * 16, key, 16) unless key.b.length == 16
 
       @keys[0] = key.dup
       @cipher.key = @keys[0]
-
-      cipher = OpenSSL::Cipher.new(@cipher.name)
-      cipher.encrypt
-      cipher.key = @keys[0]
-      k = (cipher.update("\x00" * 16) + cipher.final).bytes[0...16]
-      1.upto(2) do |i|
-        k = k.pack('C*').unpack('B*')[0]
-        msb = k.slice!(0)
-        k = [k, '0'].pack('B*').bytes
-        k[15] ^= 0x87 if msb == '1'
-        @keys[i] = k.dup
-      end
-      self
+      generate_subkey
     end
 
     # Alias for: update
@@ -123,12 +111,7 @@ module OpenSSL
     #
     # @return [Object] self with initial state
     def reset
-      @keys.clear
-      @buffer.clear
-      @cipher.reset unless @keys[0].nil?
-      @cipher.iv = "\x00" * 16
-      @cipher.encrypt
-      self
+      reset_with_key
     end
 
     # Returns self updated with the message to be authenticated.
@@ -138,7 +121,7 @@ module OpenSSL
     #
     # @return [Object] self with new state
     def update(data)
-      fail CMACError, 'no key is set' if @keys[0].nil?
+      raise CMACError, 'no key is set' if @keys[0].nil?
 
       @buffer += data
       @cipher.update(@buffer.slice!(0...16)) while @buffer.length > 16
@@ -149,23 +132,49 @@ module OpenSSL
     #
     # @param length [Number] length of the authentication code
     def digest(length = 16)
-      fail CMACError, 'no key is set' if @keys[0].nil?
-      fail CMACError, 'no key is set' unless length.between?(1, 16)
+      raise CMACError, 'no key is set' if @keys[0].nil?
+      raise CMACError, 'no key is set' unless length.between?(1, 16)
 
       block = @buffer.bytes
-      @buffer.clear
       k = @keys[block.length == 16 ? 1 : 2].dup
       i = block.length.times { |t| k[t] ^= block[t] }
       k[i] ^= 0x80 if i < 16
       mac = @cipher.update(k.pack('C*')) + @cipher.final
-      @cipher.reset
-      @cipher.encrypt
-      @cipher.key = @keys[0]
-      @cipher.iv = "\x00" * 16
+      reset_with_key(@keys[0])
       # Each block is 16-bytes and the last block will always be PKCS#7 padding
       # which we want to discard.  Take the last block prior to the padding for
       # the MAC.
       mac[-32...(-32 + length)]
     end
+
+    private
+
+    def reset_with_key(key = '')
+      @buffer.clear
+      @cipher.reset
+      @cipher.encrypt
+      @cipher.iv = "\x00" * 16
+
+      if key.empty?
+        @keys.clear
+      else
+        @cipher.key = key
+      end
+
+      self
+    end
+
+    def generate_subkey
+      cipher = OpenSSL::Cipher.new(@cipher.name).encrypt
+      cipher.key = @keys[0]
+      k = (cipher.update("\x00" * 16) + cipher.final).bytes[0...16]
+      1.upto(2) do |i|
+        k = k.pack('C*').unpack('B*')[0]
+        msb = k.slice!(0)
+        k = [k, '0'].pack('B*').bytes
+        k[15] ^= 0x87 if msb == '1'
+        @keys[i] = k.dup
+      end
+    end
   end
 end

metadata

@@ -1,136 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openssl-cmac
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Maxim M. Chechel
 - Lars Schmertmann
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.2
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.16
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.16
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.9
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.9
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.22
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.22
+        version: '3.0'
 description: Ruby Gem for RFC 4493, 4494, 4615 - The AES-CMAC Algorithm
 email:
 - maximchick@gmail.com
@@ -138,22 +31,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
-- ".rubocop.yml"
-- ".yardopts"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/openssl/cmac.rb
 - lib/openssl/cmac/version.rb
-- test/test_cmac.rb
 homepage: https://github.com/smalllars/openssl-cmac
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/smalllars/openssl-cmac
 post_install_message: Thanks for installing!
 rdoc_options:
 - "-x"
@@ -171,9 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RFC 4493, 4494, 4615 - CMAC
-test_files:
-- test/test_cmac.rb
+test_files: []

data/.rubocop.yml

@@ -1,12 +0,0 @@
-
-ClassLength:
-  Max: 256
-
-MethodLength:
-  Max: 32
-
-CyclomaticComplexity:
-  Max: 8
-
-Documentation:
-  Enabled: false

data/.yardopts

@@ -1,4 +0,0 @@
---no-private
---protected
-lib/**/**/*.rb -
-LICENSE

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '>=12.3.2'
-gem 'rdoc', '>=4.3.0'
-gem 'yard', '>=0.9.16'
-gem 'rubocop', '>=0.50.0'
-gem 'test-unit', '>=3.2.9'
-gem 'coveralls', '>=0.8.22'

data/Rakefile

@@ -1,31 +0,0 @@
-require './lib/openssl/cmac/version'
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-task :default => :build
-
-desc "Run tests"
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Create documentation"
-task :doc do
-  sh "gem rdoc --rdoc openssl-cmac"
-  sh "yardoc"
-end
-
-desc "Uninstall and clean documentation"
-task :clean do
-  sh "gem uninstall openssl-cmac"
-  begin; sh "rm -R ./coverage"; rescue; end
-  begin; sh "rm -R ./.yardoc";  rescue; end
-  begin; sh "rm -R ./doc";      rescue; end
-end
-
-desc "Development Dependencies"
-task (:devinst) { sh "gem install --dev ./pkg/openssl-cmac-#{OpenSSL::CMAC::VERSION}.gem" }
-
-desc "Bundle install"
-task (:bundle) { sh "bundle install" }
-

data/test/test_cmac.rb

@@ -1,167 +0,0 @@
-require 'coveralls'
-Coveralls.wear!
-require 'test/unit'
-require 'openssl/cmac'
-
-# Testclass with Test Vectors from RFC's
-class CMACTest < Test::Unit::TestCase
-  # http://tools.ietf.org/html/rfc4493#section-4
-  KEY = ['2b7e151628aed2a6abf7158809cf4f3c'].pack('H*')
-  DATA = [[''].pack('H*'),
-          ['6bc1bee22e409f96e93d7e117393172a'].pack('H*'),
-          ['6bc1bee22e409f96e93d7e117393172a'\
-           'ae2d8a571e03ac9c9eb76fac45af8e51'\
-           '30c81c46a35ce411'].pack('H*'),
-          ['6bc1bee22e409f96e93d7e117393172a'\
-           'ae2d8a571e03ac9c9eb76fac45af8e51'\
-           '30c81c46a35ce411e5fbc1191a0a52ef'\
-           'f69f2445df4f9b17ad2b417be66c3710'].pack('H*')]
-  MAC = %w(bb1d6929e95937287fa37d129b756746
-           070a16b46b4d4144f79bdd9dd04a287c
-           dfa66747de9ae63030ca32611497c827
-           51f0bebf7e3b9d92fc49741779363cfe)
-
-  # http://tools.ietf.org/html/rfc4615#section-4
-  PRF_KEYS = [['000102030405060708090a0b0c0d0e0fedcb'].pack('H*'),
-              ['000102030405060708090a0b0c0d0e0f'].pack('H*'),
-              ['00010203040506070809'].pack('H*')]
-  PRF_DATA = ['000102030405060708090a0b0c0d0e0f10111213'].pack('H*')
-  PRF_OUTS = %w(84a348a4a45d235babfffc0d2b4da09a
-                980ae87b5f4c9c5214f5b6a8455e4c2d
-                290d9e112edb09ee141fcf64c0b72f3d)
-
-  def test_cmac_keys
-    cmac = OpenSSL::CMAC.new('AES')
-    cmac.key = KEY
-    check_keys(cmac)
-
-    cmac = OpenSSL::CMAC.new('AES', KEY)
-    check_keys(cmac)
-
-    assert(cmac.instance_variable_get(:@buffer).empty?, 'Wrong buffer')
-    cmac.update(DATA[2])
-    assert(cmac.instance_variable_get(:@buffer).length == 8, 'Wrong buffer')
-    cmac.update(DATA[2])
-    assert(cmac.instance_variable_get(:@buffer).length == 16, 'Wrong buffer')
-
-    cmac.reset
-    assert(cmac.instance_variable_get(:@keys)[0].nil?, 'Reset fail')
-    assert(cmac.instance_variable_get(:@keys)[1].nil?, 'Reset fail')
-    assert(cmac.instance_variable_get(:@keys)[2].nil?, 'Reset fail')
-    assert_equal('', cmac.instance_variable_get(:@buffer), 'Reset fail')
-
-    assert_raise(OpenSSL::CMACError) { cmac.update(DATA[2]) }
-    assert_raise(OpenSSL::CMACError) { cmac.digest }
-
-    cmac.key = KEY
-    check_keys(cmac)
-
-    m = cmac.update(DATA[2]).digest.unpack('H*')[0]
-    assert_equal(MAC[2], m)
-  end
-
-  def check_keys(cmac)
-    assert_equal(
-      '2b7e151628aed2a6abf7158809cf4f3c',
-      cmac.instance_variable_get(:@keys)[0].unpack('H*')[0],
-      'Key ERROR'
-    )
-    assert_equal(
-      'fbeed618357133667c85e08f7236a8de',
-      cmac.instance_variable_get(:@keys)[1].pack('C*').unpack('H*')[0],
-      'SubKey 1 ERROR'
-    )
-
-    assert_equal(
-      'f7ddac306ae266ccf90bc11ee46d513b',
-      cmac.instance_variable_get(:@keys)[2].pack('C*').unpack('H*')[0],
-      'SubKey 2 ERROR'
-    )
-  end
-
-  def test_cmac_vars
-    cmac = OpenSSL::CMAC.new('AES')
-    assert_equal(16, cmac.block_length)
-    assert_equal(16, cmac.digest_max_length)
-    assert_equal('CMAC with AES', cmac.name)
-  end
-
-  def test_cmac_update
-    for cipher in ['aes', 'AES']
-      # Test with 1 call of update and new CCM object for each test.
-      DATA.length.times do |i|
-        cmac = OpenSSL::CMAC.new(cipher, KEY)
-        m = cmac.update(DATA[i]).digest.unpack('H*')[0]
-        assert_equal(MAC[i], m, "Test: 1, Vector: #{i + 1}")
-      end
-
-      # Test with 1 call of update and same CCM object for each test.
-      # There is no reset, because it should be possible to calculate
-      # a new mac after digest without reset.
-      cmac = OpenSSL::CMAC.new(cipher, KEY)
-      DATA.length.times do |i|
-        m = cmac.update(DATA[i]).digest.unpack('H*')[0]
-        assert_equal(MAC[i], m, "Test: 2, Vector: #{i + 1}")
-      end
-
-      # Test with multiple calls of update and new CCM object for each test
-      1.upto(DATA.length - 1) do |i|
-        1.upto(17) do |c|
-          cmac = OpenSSL::CMAC.new(cipher, KEY)
-          DATA[i].bytes.each_slice(c) { |w| cmac.update(w.pack('C*')) }
-          m = cmac.digest.unpack('H*')[0]
-          assert_equal(MAC[i], m, "Test: 3, Vector: #{i + 1}, Tokenlen: #{c}")
-        end
-      end
-
-      # Test with multiple calls of update and same CCM object for each test
-      cmac = OpenSSL::CMAC.new(cipher, KEY)
-      1.upto(DATA.length - 1) do |i|
-        1.upto(17) do |c|
-          DATA[i].bytes.each_slice(c) { |w| cmac.update(w.pack('C*')) }
-          m = cmac.digest.unpack('H*')[0]
-          assert_equal(MAC[i], m, "Test: 4, Vector: #{i + 1}, Tokenlen: #{c}")
-        end
-      end
-    end
-
-    # Test for Operator <<
-    DATA[3].bytes.each_slice(5) { |w| cmac << w.pack('C*') }
-    m = cmac.digest.unpack('H*')[0]
-    assert_equal(MAC[3], m, 'Test: 5, Vector: 4, Tokenlen: 5')
-  end
-
-  def test_cmac_digest
-    for cipher in ['aes', 'AES']
-      cmac = OpenSSL::CMAC.new(cipher, KEY)
-      m = cmac.update(DATA[3]).digest.unpack('H*')[0]
-      assert_equal(MAC[3], m, 'Digest with no update')
-
-      cmac.update(DATA[3].b[0...20])
-      m = cmac.update(DATA[3].b[20...64]).digest.unpack('H*')[0]
-      assert_equal(MAC[3], m, 'Digest after update')
-
-      cmac.update(DATA[3])
-      m = cmac.update('').digest.unpack('H*')[0]
-      assert_equal(MAC[3], m, 'Empty digest')
-
-      DATA.length.times do |i|
-        m = OpenSSL::CMAC.digest(cipher, KEY, DATA[i]).unpack('H*')[0]
-        assert_equal(MAC[i], m, "Vector: #{i + 1}")
-
-        m = OpenSSL::CMAC.digest(cipher, KEY, DATA[i], 12).unpack('H*')[0]
-        assert_equal(24, m.length, "Vector: #{i + 1} - length")
-        assert_equal(MAC[i][0...24], m, "Vector: #{i + 1} - 12")
-      end
-    end
-  end
-
-  def test_cmac_prf
-    cmac = OpenSSL::CMAC.new('AES')
-    3.times do |i|
-      cmac.key = PRF_KEYS[i]
-      m = cmac.update(PRF_DATA).digest.unpack('H*')[0]
-      assert_equal(PRF_OUTS[i], m, "Vector: #{i + 1}")
-    end
-  end
-end