openssl-ccm 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99cd161672c23d850707385c401f21e8112d43b5
-  data.tar.gz: 44d0f782586d03cd9849037ba82d07edcca004f6
+  metadata.gz: 92a532b59b054ccfe21e829d38c498d8ba7bfd89
+  data.tar.gz: 3dce973fb8819b77169e896a3aaeb73854d0f074
 SHA512:
-  metadata.gz: f8bd10043a84337f7f0ab4d90fc83a5deea1874195218f02902b1a2a9f80f2f1baa076ef0c35580c22a20f7ffc94ce5d4e836bc1ecf304280a60f3725d57d797
-  data.tar.gz: 088919b7f4ccf982ec30074ac1bcec285d8c0aef3349bc744b6eb3dca7fd5d79213b1dda961f77ce59edb5b54b85aee4050d04504431683a8d3db946d41d0877
+  metadata.gz: 65a1cb1f4da10606b442551fbec24981c508ce7466b203e931d692e4bfc90e474e15d3e99a24ca0f805efa122d9ccc2ec477b108fa05ceaade01305202d3f198
+  data.tar.gz: a05d1e9b346e0ed7487d3972da57257b91741de4ab8f453f09cd2c0c51099e62c4118933f9689a53ba5dc97a2ac2acf6f9c55f84f71067563892f481d111be2c

data/README.md

@@ -1,4 +1,33 @@
-openssl-ccm
-===========
+# openssl-ccm
 
 Ruby Gem for RFC 3610 - Counter with CBC-MAC (CCM)
+
+Abstract from tools.ietf.org/html/rfc3610: Counter with CBC-MAC (CCM) is a generic authenticated encryption block cipher mode. CCM is defined for use with 128-bit block ciphers, such as the Advanced Encryption Standard (AES).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'openssl-ccm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openssl-ccm
+
+## Usage
+
+Example:
+
+    require 'openssl/ccm'
+
+    ccm = OpenSSL::CCM.new('AES', 'My16Byte LongKey', 8)
+
+    ciphertext = ccm.encrypt('The message to encrypt', 'The nonce')
+
+    plaintext = ccm.decrypt(ciphertext, 'The nonce')
+
+After initialisation, you can use the object as often you need.

data/lib/openssl/ccm.rb

@@ -12,14 +12,14 @@ module OpenSSL
   # ciphers, such as the Advanced Encryption Standard (AES).
   #
   # At the moment there is no update function, because length of
-  # data and additional_data are needed to start of cipher process.
+  # data and additional_data are needed at the begin of cipher process.
   # In future init(nonce, data_len, additional_data_len) could
   # be a solution, to solve this problem. After init, update(data)
   # could be used to set additional_data first followed by data.
   class CCM
     # Searches for supported algorithms within OpenSSL
     #
-    # @return [Stringlist] of supported algorithms
+    # @return [[String]] supported algorithms
     def self.ciphers
       l = OpenSSL::Cipher.ciphers.keep_if { |c| c.end_with?('-128-CBC') }
       l.length.times { |i| l[i] = l[i][0..-9] }

data/lib/openssl/ccm/version.rb

@@ -1,6 +1,5 @@
 module OpenSSL
-  # CCM Version
   class CCM
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openssl-ccm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Lars Schmertmann