present-cipher 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4d550b256ef6e8fa10b22344cf852ebf870cc78e6e56b586dd0c04eb115a2cf
-  data.tar.gz: 3deea46829f0af9b682ba519b015e9966ea2a93f0b1136099bc8f706f9362a21
+  metadata.gz: 8d413a6ed44a1ceb352368fa7f8e7f6276514a46a92c0838e3b93af3f9ed4343
+  data.tar.gz: fb9b9276e79f3cb470f739b78ffcf7257c92e4cebb661396a810ea9f47ac15fb
 SHA512:
-  metadata.gz: 6d0766eb00c53da4ec27b2589c285d5ce345f790e688f8331151de56ca2d99ad89ec0fc888762e757eb5893f74985cb8a516b802e055a484d3f49da4a098b80e
-  data.tar.gz: b78a7a4f805f175ddfda9274fd81aa9c289adf4131e5a1c6b2770ec6b8634466c303d9e7e36c3cf0b87ebe99d5d7cef4cf8f4ff2d9709d0973fb2ea1e7a0e227
+  metadata.gz: db2022abb3b908aec2e94aadf22603db90693de82c6ac2415df6f7b39e4330341b6aeac32f4857b7aa777997e73499f74aa5a34fd01465589d1da6483a1eae3a
+  data.tar.gz: b22482efef37294160ed4e5d3c8af74e8b137d9f5cb5184b00e54491bb848c05ed09ac62c24ac903615a04080967b28d7940b76ff05c21b67c900317fc8ef432

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.3.0] - 2022-12-02
+
+### Added
+
+- Support for encrypting 64-bit plaintexts using 128-bit keys.
+- Support for decrypting 64-bit ciphertexts using 128-bit keys.
+
+### Changed
+
+- DRYed up key and block validation.
+
+## [0.2.0] - 2022-11-29
+
+### Added
+
+- Key and block length validation.
+
 ## [0.1.0] - 2022-11-26
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    present-cipher (0.1.0)
+    present-cipher (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,6 +14,21 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Present::Cipher encrypts 64-bit plaintexts and decrypts 64-bit ciphertexts using 80- or 128-bit keys.
+
+### Generating a Key
+
+Using `SecureRandom`:
+
+```
+require "present/cipher"
+require "securerandom"
+
+key = SecureRandom.bytes(Present::Cipher::KEY_BYTESIZE_80) # Make sure to save this value somewhere safe!
+```
+
+If you prefer, pass `Present::Cipher::KEY_BYTESIZE_128` to generate a 128-bit key.
+
 ### Encrypting
 
 ```
@@ -32,10 +47,6 @@ cipher = Present::Cipher.new(key)
 plaintext = cipher.decrypt(ciphertext)
 ```
 
-### Caveats
-
-Present::Cipher currently supports only 80-bit keys and 64-bit plaintexts and ciphertexts.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/present/cipher/error.rb

@@ -0,0 +1,15 @@
+module Present
+  class Cipher
+    class Error < StandardError
+    end
+
+    class NotSupportedError < Error
+    end
+
+    class KeyError < Error
+    end
+
+    class BlockError < Error
+    end
+  end
+end

data/lib/present/cipher/version.rb

@@ -2,6 +2,6 @@
 
 module Present
   class Cipher
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/present/cipher.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
+require_relative "cipher/error"
 require_relative "cipher/version"
 
 module Present
   class Cipher
+    KEY_BITSIZE_80 = 80
+    KEY_BITSIZE_128 = 128
+    BLOCK_BITSIZE = 64
+
+    KEY_BYTESIZE_80 = KEY_BITSIZE_80 / 8
+    KEY_BYTESIZE_128 = KEY_BITSIZE_128 / 8
+    BLOCK_BYTESIZE = BLOCK_BITSIZE / 8
+
     S_BOX = [
-      0x0C, 0x05, 0x06, 0x0b, 0x09, 0x00, 0x0a, 0x0d, 0x03, 0x0e, 0x0f, 0x08, 0x04, 0x07, 0x01, 0x02
+      0x0C, 0x05, 0x06, 0x0b, 0x09, 0x00, 0x0a, 0x0d, 0x03, 0x0e, 0x0f, 0x08, 0x04, 0x07, 0x01, 0x02,
     ]
 
     INVERSE_S_BOX = 0.upto(S_BOX.length - 1).map { |n| S_BOX.index(n) }
@@ -20,10 +29,14 @@ module Present
     INVERSE_P_BOX = 0.upto(P_BOX.length - 1).map { |n| P_BOX.index(n) }
 
     def initialize(key)
-      @key = key
+      validate(key, as: :key)
+
+      @key = key.dup
     end
 
     def encrypt(bytes)
+      validate(bytes, as: :block)
+
       bits = bytes.unpack1("Q>")
 
       0.upto(30) do |i|
@@ -38,6 +51,8 @@ module Present
     end
 
     def decrypt(bytes)
+      validate(bytes, as: :block)
+
       bits = bytes.unpack1("Q>")
 
       31.downto(1) do |i|
@@ -53,27 +68,80 @@ module Present
 
     private
 
+    def validate(bytes, parameters)
+      bitsize = bytes.bytesize * 8
+      aspect = parameters[:as]
+
+      case aspect
+      when :key
+        klass = KeyError
+        bitsizes = [KEY_BITSIZE_80, KEY_BITSIZE_128]
+      when :block
+        klass = BlockError
+        bitsizes = [BLOCK_BITSIZE]
+      else
+        raise ArgumentError, "aspect passed via :as must be one of :key or :block"
+      end
+
+      raise klass, "#{aspect} length is invalid (expected #{bitsizes.join(" or ")} bits; got #{bitsize})" unless bitsizes.include?(bitsize)
+    end
+
     def round_keys
       @round_keys ||= begin
-        round_keys = []
+        case @key.bytesize
+        when KEY_BYTESIZE_80
+          round_keys_80(@key)
+        when KEY_BYTESIZE_128
+          round_keys_128(@key)
+        else
+          raise NotSupportedError
+        end
+      end
+    end
 
-        bits = @key.unpack1("B80").to_i(2)
+    def round_keys_80(key)
+      round_keys = []
 
-        1.upto(32) do |i|
-          round_keys << (bits >> 16)
+      register = key.unpack1("B80").to_i(2)
 
-          # Rotate 61 bits to the left.
-          bits = ((bits & ((1 << 19) - 1)) << 61) | (bits >> 19)
+      1.upto(32) do |i|
+        round_keys << (register >> 16)
 
-          # Push the top four bits through the substitution box.
-          bits = (S_BOX[(bits >> 76)] << 76) | (bits & ((1 << 76) - 1))
+        # Rotate 61 bits to the left.
+        register = ((register & ((1 << 19) - 1)) << 61) | (register >> 19)
 
-          # XOR the round counter into bits 19 to 15.
-          bits = ((bits >> 20) << 20) | ((((bits >> 15) & ((1 << 5) - 1)) ^ i) << 15) | (bits & ((1 << 15) - 1))
-        end
+        # Push the leftmost four bits through the substitution box.
+        register = (S_BOX[(register >> 76)] << 76) | (register & ((1 << 76) - 1))
+
+        # XOR the round counter into registers 19 through 15.
+        register = ((register >> 20) << 20) | ((((register >> 15) & ((1 << 5) - 1)) ^ i) << 15) | (register & ((1 << 15) - 1))
+      end
+
+      round_keys
+    end
+
+    def round_keys_128(key)
+      round_keys = []
 
-        round_keys
+      register = key.unpack1("B128").to_i(2)
+
+      1.upto(32) do |i|
+        round_keys << (register >> 64)
+
+        # Rotate 61 bits to the left.
+        register = ((register & ((1 << 67) - 1)) << 61) | (register >> 67)
+
+        # Push the leftmost four bits through the substitution box.
+        register = (S_BOX[(register >> 124)] << 124) | (register & ((1 << 124) - 1))
+
+        # Push the next leftmost four bits through the substitution box.
+        register = ((register >> 124) << 124) | (S_BOX[(register >> 120) & ((1 << 4) - 1)] << 120) | (register & ((1 << 120) - 1))
+
+        # XOR the round counter into registers 66 through 62.
+        register = ((register >> 67) << 67) | ((((register >> 62) & ((1 << 5) - 1)) ^ i) << 62) | (register & ((1 << 62) - 1))
       end
+
+      round_keys
     end
 
     def apply_round_key(bits, key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: present-cipher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Henry Phan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -25,8 +25,8 @@ files:
 - README.md
 - Rakefile
 - lib/present/cipher.rb
+- lib/present/cipher/error.rb
 - lib/present/cipher/version.rb
-- present-cipher.gemspec
 - sig/present/cipher.rbs
 homepage: https://codeberg.org/htp/present-cipher
 licenses:

data/present-cipher.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/present/cipher/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "present-cipher"
-  spec.version = Present::Cipher::VERSION
-  spec.authors = ["Henry Phan"]
-  spec.email = ["henry@henryphan.com"]
-
-  spec.summary = "A Ruby implementation of the PRESENT block cipher."
-  spec.homepage = "https://codeberg.org/htp/present-cipher"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://codeberg.org/htp/present-cipher"
-  spec.metadata["changelog_uri"] = "https://codeberg.org/htp/present-cipher/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end