xaes_256_gcm 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef71e358ba4956fd8741d2f0a2b40c1fb43af910c83ed100f93e2f4b8115af5
-  data.tar.gz: 8121bbb3b12266bd94e4a516226a880d41d22719af8c273b1969fe3ac096503f
+  metadata.gz: ac1cc1abd232a39d6e2a51c78f1eda1f5b3a90068580b00fe82f4ff018117a24
+  data.tar.gz: d5f0bdc7d7dff95d7ce44731ed6db968f1d426890987ede195d776b29dcf7ccf
 SHA512:
-  metadata.gz: 2cdbd2478078a837754587ad5afb56d74904d55429a9764975eed58ec783c1060f96f52237247599bcfb7f7fed7bedcf0f9a8d170511906be12b42c8d1716e9d
-  data.tar.gz: f9e10e5a46c21b7c082c410a833119b6bc1220d578e20242fa250296b8e040870d7b7c81d82b363c364cee763841b29ff056db21ec0cd3f768879a902e36895f
+  metadata.gz: bf56e9eeec474c19e8f54d0d725f134b3c77276a465451b37f9eaccb75ebe8ab3b035ac1483612ea285766adc46ed3224fd9297924994dba9e3ecc60fb207a4f
+  data.tar.gz: c3286d8510040cfe971f94d69d672768ee4874e53609ed2be4b4c4f74f2515eedbc9cc42dc2929a0b56c2ccc466896847921e52325c55881625fcd2dcd54a63a

data/3RD_PARTY_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020
+The C2SP Authors.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+THIS SOFTWARE IS PROVIDED BY The C2SP Authors ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL The C2SP Authors BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/lib/xaes_256_gcm/version.rb

@@ -2,5 +2,5 @@
 
 module Xaes256Gcm
   # The current version of the gem.
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/lib/xaes_256_gcm/xaes_256_gcm_cipher.rb

@@ -47,8 +47,8 @@ module Xaes256Gcm
       @k1 = NoInspectBox.new(k1)
     end
 
-    # Seals, or encrypts, a plaintext with a nonce.  Optional additional authenticated data can be provided.
-    def seal(plaintext, nonce, additionalData = nil)
+    # Encrypts a plaintext with a nonce.  Optional additional authenticated data can be provided.
+    def encrypt(plaintext, nonce, additionalData = nil)
       raise InvalidNonceError if nonce.bytesize != NONCE_SIZE
 
       key = derive_key(nonce.byteslice(0, 12))
@@ -64,8 +64,14 @@ module Xaes256Gcm
       ciphertext + gcm.auth_tag
     end
 
-    # Opens, or decrypts, a ciphertext with a nonce. Optional additional authenticated data can be provided.
-    def open(ciphertext, nonce, additionalData = nil)
+    # Seals a plaintext with a random nonce. Optional additional authenticated data can be provided.
+    def seal(plaintext, additionalData = nil)
+      nonce = OpenSSL::Random.random_bytes(NONCE_SIZE)
+      return nonce + encrypt(plaintext, nonce, additionalData)
+    end
+
+    # Decrypts a ciphertext with a nonce. Optional additional authenticated data can be provided.
+    def decrypt(ciphertext, nonce, additionalData = nil)
       ct_bytes = ciphertext.bytesize
       raise InvalidNonceError if nonce.bytesize != NONCE_SIZE
       raise InvalidCiphertextError if ciphertext.bytesize < OVERHEAD
@@ -73,6 +79,8 @@ module Xaes256Gcm
       tagless_ciphertext = ciphertext.byteslice(0, ct_bytes - OVERHEAD)
       tag = ciphertext.byteslice(ct_bytes - OVERHEAD, OVERHEAD)
 
+      raise InvalidCiphertextError if tag.bytesize != OVERHEAD
+
       key = derive_key(nonce.byteslice(0, 12))
       gcm = OpenSSL::Cipher::AES256.new(:GCM)
       gcm.decrypt
@@ -93,6 +101,13 @@ module Xaes256Gcm
       return plaintext
     end
 
+    def open(ciphertext, additionalData = nil)
+      raise InvalidCiphertextError if ciphertext.nil? || ciphertext.bytesize < OVERHEAD + NONCE_SIZE
+      nonce = ciphertext.byteslice(0, NONCE_SIZE)
+      ct = ciphertext.byteslice(NONCE_SIZE, ciphertext.bytesize - NONCE_SIZE)
+      return decrypt(ct, nonce, additionalData)
+    end
+
     private
 
     def derive_key(nonce)
@@ -114,7 +129,7 @@ module Xaes256Gcm
       end
     end
 
-    # This is just a smaller helper class that returns a redacted value for to_s and inspect.
+    # This is just a small helper class that returns a redacted value for to_s and inspect.
     # It exists to simply make sure any state on the instance is not accidentally logged or printed.
     class NoInspectBox
       def initialize(value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xaes_256_gcm
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - vcsjones
@@ -47,6 +47,7 @@ files:
 - "./lib/xaes_256_gcm/errors.rb"
 - "./lib/xaes_256_gcm/version.rb"
 - "./lib/xaes_256_gcm/xaes_256_gcm_cipher.rb"
+- 3RD_PARTY_LICENSE
 homepage: https://github.com/vcsjones/xaes_256_gcm
 licenses:
 - MIT