ruby-aes-optimized 1.0

data/doc/rdoc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/examples/encrypt_block.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'ruby-aes'
+require 'example_helper'
+
+class RubyAES_block
+
+    include RubyAES_helper
+
+    def initialize
+        setup
+        pt = "0123467890ABCDEF"
+        puts "Using #{@kl}-#{@mode} encryption/decryption"
+        puts "Plaintext is: #{pt} (a block should be 16 octets)"
+        ct = Aes.encrypt_block(@kl, @mode, @keys[@kl], @iv, pt)
+        puts "Ciphertext (unpacked) is: #{ct.unpack("H*").first}"
+        npt = Aes.decrypt_block(@kl, @mode, @keys[@kl], @iv, ct)
+        puts "Decrypted ciphertext is: #{npt} (should be: #{pt})"
+    end
+
+end
+RubyAES_block.new

data/examples/encrypt_buffer.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'ruby-aes'
+require 'example_helper'
+
+class RubyAES_buffer
+
+    include RubyAES_helper
+
+    def initialize
+        setup
+        puts "Using #{@kl}-#{@mode} encryption/decryption"
+        pt = "The quick brown fox jumps over the lazy dog"
+        puts "Plaintext is: '#{pt}'"
+        puts "(a buffer will be padded so that its length will be a multiple of 16)"
+        ct = Aes.encrypt_buffer(@kl, @mode, @keys[@kl], @iv, pt)
+        puts "Ciphertext (unpacked) is: #{ct.unpack("H*").first}"
+        npt = Aes.decrypt_buffer(@kl, @mode, @keys[@kl], @iv, ct)
+        puts "Decrypted ciphertext is: '#{npt}'"
+        puts "(should be: '#{pt}')"
+    end
+
+end
+RubyAES_buffer.new

data/examples/encrypt_stream.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'ruby-aes'
+require 'example_helper'
+require 'fileutils'
+
+class RubyAES_stream
+
+    include RubyAES_helper
+
+    def initialize
+        setup
+        puts "Using #{@kl}-#{@mode} encryption/decryption"
+        file = "_ruby-aes_encrypt_stream_"
+
+        sin = File.open(file, "w+b")
+        sin.puts "The quick brown fox jumps over the lazy dog"
+        sin.rewind
+        sout = File.open("#{file}.aes", "w+b")
+        Aes.encrypt_stream(@kl, @mode, @keys[@kl], @iv, sin, sout)
+        sin.close
+        sout.close
+
+        sin = File.open("#{file}.aes", "rb")
+        sout = File.open("#{file}.plain", "w+b")
+        Aes.decrypt_stream(@kl, @mode, @keys[@kl], @iv, sin, sout)
+        sin.close
+        sout.close
+
+        if IO.read(file) == IO.read("#{file}.plain")
+            puts "The decrypted file is exactly the same as the original one"
+        else
+            puts "The decrypted file differs from the orginal one"
+        end
+        FileUtils.rm_f [ file, "#{file}.aes", "#{file}.plain" ]
+    end
+
+end
+RubyAES_stream.new

data/examples/example_helper.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+module RubyAES_helper
+
+    KEY_LENGTH = [128,192,256].freeze
+    MODES = ['ECB','CBC','OFB','CFB'].freeze
+
+    def random_fill(n, buffer)
+        n.times do
+            buffer << rand(256).chr
+        end
+    end
+
+    def setup
+        @keys = {}
+        KEY_LENGTH.each do |kl|
+            @keys[kl] = ""
+            random_fill(kl/8, @keys[kl])
+        end
+
+        @iv = ""; random_fill(16, @iv)
+        @pt = ""; random_fill(64, @pt)
+        @kl = KEY_LENGTH[(rand * KEY_LENGTH.length).to_i]
+        @mode = MODES[(rand * MODES.length).to_i]
+    end
+
+end

data/lib/ruby-aes/aes_alg.rb

@@ -0,0 +1,280 @@
+=begin
+    This file is a part of ruby-aes <http://rubyforge.org/projects/ruby-aes>
+    Written by Alex Boussinet <alex.boussinet@gmail.com>
+
+    ruby-aes (optimized version)
+    Based on "Normal" code
+    Adapted from the Rijndael Specifications (dfips-AES.pdf)
+=end
+
+require 'ruby-aes/aes_cons'
+
+class AesAlg
+    include AesCons
+
+    def mixColumns
+        t = ""
+        4.times do |j| i = j*4
+            t << (G2X[@state[i]] ^ G3X[@state[i+1]] ^ @state[i+2] ^ @state[i+3])
+            t << (@state[i] ^ G2X[@state[i+1]] ^ G3X[@state[i+2]] ^ @state[i+3])
+            t << (@state[i] ^ @state[i+1] ^ G2X[@state[i+2]] ^ G3X[@state[i+3]])
+            t << (G3X[@state[i]] ^ @state[i+1] ^ @state[i+2] ^ G2X[@state[i+3]])
+        end
+        @state = t
+    end
+    protected :mixColumns
+
+    def imixColumns
+        t = ""
+        4.times do |j| i = j*4
+            t << (GEX[@state[i]] ^ GBX[@state[i+1]] ^ GDX[@state[i+2]] ^ G9X[@state[i+3]])
+            t << (G9X[@state[i]] ^ GEX[@state[i+1]] ^ GBX[@state[i+2]] ^ GDX[@state[i+3]])
+            t << (GDX[@state[i]] ^ G9X[@state[i+1]] ^ GEX[@state[i+2]] ^ GBX[@state[i+3]])
+            t << (GBX[@state[i]] ^ GDX[@state[i+1]] ^ G9X[@state[i+2]] ^ GEX[@state[i+3]])
+        end
+        @state = t
+    end
+    protected :imixColumns
+
+    # Combine -- shiftRows, subBytes -- as one method
+    def subShiftRows
+        @state[0], @state[4], @state[8], @state[12] = 
+            S_BOX[@state[0]], S_BOX[@state[4]], S_BOX[@state[8]], S_BOX[@state[12]]
+        @state[1], @state[5], @state[9], @state[13] = 
+            S_BOX[@state[5]], S_BOX[@state[9]], S_BOX[@state[13]], S_BOX[@state[1]]
+        @state[2], @state[6], @state[10], @state[14] = 
+            S_BOX[@state[10]], S_BOX[@state[14]], S_BOX[@state[2]], S_BOX[@state[6]]
+        @state[3], @state[7], @state[11], @state[15] = 
+            S_BOX[@state[15]], S_BOX[@state[3]], S_BOX[@state[7]], S_BOX[@state[11]]
+    end
+    protected :subShiftRows
+
+    # Combine -- shiftRows, subBytes, addRoundkey -- as one method
+    def lastEncryptRound
+        i = 16*@nr
+        @state[0], @state[4], @state[8], @state[12] = 
+            S_BOX[@state[0]] ^ @w[i], S_BOX[@state[4]] ^ @w[i+4],
+            S_BOX[@state[8]] ^ @w[i+8], S_BOX[@state[12]] ^ @w[i+12]
+        @state[1], @state[5], @state[9], @state[13] = 
+            S_BOX[@state[5]] ^ @w[i+1], S_BOX[@state[9]] ^ @w[i+5],
+            S_BOX[@state[13]] ^ @w[i+9], S_BOX[@state[1]] ^ @w[i+13]
+        @state[2], @state[6], @state[10], @state[14] = 
+            S_BOX[@state[10]] ^ @w[i+2], S_BOX[@state[14]] ^ @w[i+6],
+            S_BOX[@state[2]] ^ @w[i+10], S_BOX[@state[6]] ^ @w[i+14]
+        @state[3], @state[7], @state[11], @state[15] = 
+            S_BOX[@state[15]] ^ @w[i+3], S_BOX[@state[3]] ^ @w[i+7],
+            S_BOX[@state[7]] ^ @w[i+11], S_BOX[@state[11]] ^ @w[i+15]
+    end
+    protected :lastEncryptRound
+
+    # Combine -- ishiftRows, isubBytes, addRoundkey -- as one method
+    def decryptSubRound(n)
+        i = 16*n
+        @state[0], @state[4], @state[8], @state[12] = 
+            IS_BOX[@state[0]] ^ @w[i], IS_BOX[@state[4]] ^ @w[i+4],
+            IS_BOX[@state[8]] ^ @w[i+8], IS_BOX[@state[12]] ^ @w[i+12]
+        @state[1], @state[5], @state[9], @state[13] = 
+            IS_BOX[@state[13]] ^ @w[i+1], IS_BOX[@state[1]] ^ @w[i+5],
+            IS_BOX[@state[5]] ^ @w[i+9], IS_BOX[@state[9]] ^ @w[i+13]
+        @state[2], @state[6], @state[10], @state[14] = 
+            IS_BOX[@state[10]] ^ @w[i+2], IS_BOX[@state[14]] ^ @w[i+6],
+            IS_BOX[@state[2]] ^ @w[i+10], IS_BOX[@state[6]] ^ @w[i+14]
+        @state[3], @state[7], @state[11], @state[15] = 
+            IS_BOX[@state[7]] ^ @w[i+3], IS_BOX[@state[11]] ^ @w[i+7],
+            IS_BOX[@state[15]] ^ @w[i+11], IS_BOX[@state[3]] ^@w[i+15]
+    end
+    protected :decryptSubRound
+
+    def addRoundKey(n)
+        j = n*16
+        16.times do |i|
+            @state[i] ^= @w[i+j]
+        end
+    end
+    protected :addRoundKey
+
+    def key_expansion(key)
+        0.upto(@nk*4-1) do
+            |i| @w[i] = key[i]
+        end
+        @nk.upto(@nb*(@nr+1)-1) do |i|
+            j = i*4
+            k = j-(@nk*4) 
+            t0, t1, t2, t3 = @w[j-4], @w[j-3], @w[j-2], @w[j-1] 
+            if (i % @nk == 0)
+                t0, t1, t2, t3 =
+                    S_BOX[t1] ^ RCON[i/@nk - 1], S_BOX[t2], S_BOX[t3], S_BOX[t0]
+            elsif (@nk > 6) && (i % @nk == 4)
+                t0, t1, t2, t3 = S_BOX[t0], S_BOX[t1], S_BOX[t2], S_BOX[t3]
+            end
+            @w[j], @w[j+1], @w[j+2], @w[j+3] = 
+                @w[k] ^ t0, @w[k+1] ^ t1, @w[k+2] ^ t2, @w[k+3] ^ t3
+        end
+    end
+    protected :key_expansion
+
+    def _encrypt_block
+        addRoundKey 0
+        1.upto(@nr-1) do |n|
+            subShiftRows
+            mixColumns
+            addRoundKey n
+        end
+        lastEncryptRound
+        @state
+    end
+    protected :_encrypt_block
+
+    def _decrypt_block
+        addRoundKey @nr
+        (@nr-1).downto(1) do |n|
+            decryptSubRound n
+            imixColumns
+        end
+        decryptSubRound 0 
+        @state
+    end
+    protected :_decrypt_block
+
+    def xor(a,b)
+        c = ""
+        16.times do |i|
+            c << (a[i] ^ b[i]).chr 
+        end
+        c
+    end
+    protected :xor
+
+    def encrypt_block(block)
+        @state = block.dup
+        case @mode
+        when 'ECB'
+            _encrypt_block
+        when 'CBC'
+            @state = xor(block, @iv)
+            @iv = _encrypt_block
+        when 'OFB'
+            @state = @iv.dup
+            @iv = _encrypt_block
+            xor(@iv, block)
+        when 'CFB'
+            @state = @iv.dup
+            @iv = xor(_encrypt_block, block)
+        end
+    end
+
+    def decrypt_block(block)
+        @state = block.dup
+        case @mode
+        when 'ECB'
+            _decrypt_block
+        when 'CBC'
+            o = xor(_decrypt_block, @iv)
+            @iv = block
+            o
+        when 'OFB'
+            @state = @iv.dup
+            @iv = _encrypt_block
+            xor(@iv, block)
+        when 'CFB'
+            @state = @iv.dup
+            o = xor(_encrypt_block, block)
+            @iv = block
+            o
+        end
+    end
+
+    def encrypt_blocks(buffer)
+        raise "Bad block length" unless (buffer.length % 16).zero?
+        ct = ""
+        block = ""
+        buffer.each_byte do |char|
+            block << char
+            if block.length == 16
+                ct << encrypt_block(block)
+                block = ""
+            end
+        end
+    end
+
+    def decrypt_blocks(buffer)
+        raise "Bad block length" unless (buffer.length % 16).zero?
+        pt = ""
+        block = ""
+        buffer.each_byte do |char|
+            block << char
+            if block.length == 16
+                pt << decrypt_block(block)
+                block = ""
+            end
+        end
+    end
+
+    def encrypt_buffer(buffer)
+        ct = ""
+        block = ""
+        buffer.each_byte do |char|
+            block << char
+            if block.length == 16
+                ct << encrypt_block(block)
+                block = ""
+            end
+        end
+        m = 16 - block.length % 16
+        ct << (m == 16 ? 0 : encrypt_block(block << m.chr * m))
+    end
+
+    def decrypt_buffer(buffer)
+        pt = ""
+        block = ""
+        buffer.each_byte do |char|
+            block << char
+            if block.length == 16
+                pt << decrypt_block(block)
+                block = ""
+            end
+        end
+        if block.length == 0
+            c = pt[-1]
+            c.chr * c == pt[-c..-1] ? pt[0..-(c+1)] : (raise "Bad Block Padding")
+        else
+            pt
+        end
+    end
+
+    def init(key_length, mode, key, iv = nil)
+        @iv = "\000" * 16
+        @iv = iv if iv
+        @nb = 4
+        @nk = 4
+        @nr = 10
+        @mode = 'ECB'
+        @state = nil
+        @w = []
+        case key_length
+        when 128
+            @nk = 4
+            @nr = 10
+        when 192
+            @nk = 6
+            @nr = 12
+        when 256
+            @nk = 8
+            @nr = 14
+        else
+            raise 'Bad Key length'
+        end
+        case mode
+        when 'ECB', 'CBC', 'OFB', 'CFB'
+            @mode = mode
+        else
+            raise 'Bad AES mode'
+        end
+        key_expansion key
+    end
+
+    def initialize(key_length, mode, key, iv = nil)
+        init(key_length, mode, key, iv)
+    end
+
+end # class aes