encrypted_text 0.1.1 → 0.1.2

data/README.md

@@ -1,12 +1,15 @@
 encrypted_text
 ==============
 
-Password-based, two-way encryption with string output. Uses AES encryption
+Password-based, two-way encryption with string output. Uses AES encryption.
 
 Usage example
 -------------
 
-In order to encode or decode a message, you should know the **key** and **signature** ahead of time. The key is a 16-, 24-, or 32-character string used for AES encryption key. The signature is prepended to the message before encryption, and verified after decryption.
+In order to encode or decode a message, you should know the **key** and **signature** ahead of time.
+
+- The key is a 16-, 24-, or 32-character string, used as an AES encryption key.
+- The signature is prepended to the message before encryption, and verified after decryption.
 
 ```ruby
 require 'encrypted_text'
@@ -20,7 +23,7 @@ encoded = codec.encode("Hello, world!")
 original_message = codec.decode(encoded)
 ```
 
-You can also add a random seed, so that repeated encodings of the same message produce different results.
+You can also add a random salt, so that repeated encodings of the same message produce different results.
 
 ```ruby
 # Continued from previous example
@@ -34,6 +37,6 @@ b = codec.encode(message) # Should be a different result!
 Motivation
 ----------
 
-I wrote this library so I could generate tokens that encoded actual information, but seemed opaque and pseudo-random to the outside world.
+Among other things, this library is useful for generating tokens that seem opaque to the outside world, but actually encode real information.
 
-In situations where tokens are passed from a service to an outside party and then back again, the service needs some way of resolving tokens passed back to it. Oftentimes this means performing a lookup on a stored mapping (e.g. a database query) between the token and some kind of cleartext data that outside parties never see. But this comes with all the clumsiness of maintaining and interacting with a persistent data store. For some applications, it might be acceptable simply to encode data directly into the token itself, using a secret that only the originating service has access to. EncryptedText provides a simple API to accomplish this.
+For example, in situations where tokens are passed from a service to an outside party and then back again, the service needs some way of resolving tokens passed back to it. Oftentimes this means performing a lookup on a stored mapping (e.g. a database query) between the token and some kind of cleartext data that outside parties never see. But this comes with all the clumsiness of maintaining and interacting with a persistent data store. For some applications, it might be acceptable simply to encode data directly into the token itself, using a secret that only the originating service has access to. EncryptedText provides a simple API to accomplish this.

data/lib/encrypted_text/codec.rb

@@ -11,11 +11,10 @@ module EncryptedText
     attr_reader :charset, :key, :salt_size
 
     KEY_CHAR_SIZES = [16, 24, 32] # An AES key must be 8-bit char strings of these lengths
-    DEFAULT_CHARSET = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9') + [ '-', '_' ] # base 64, URL-safe
+    SALT_CHARSET = Array(32..126).map{ |i| i.chr } # Printable ASCII chars go from 32 to 126
 
     def initialize(opts)
       config = {
-        :charset => DEFAULT_CHARSET,
         :signature => '',
         :key => nil,
         :salt_size => 0,
@@ -28,18 +27,9 @@ module EncryptedText
       end
     end
 
-    def charset=(charset)
-      @charset = charset
-      @reverse_charset = @charset.each.with_index.reduce({}) do |res, (c, i)|
-        res[c] = i
-        res
-      end
-    end
-
     def key=(key)
+      @engine = FastAES.new(key)
       @key = key
-      @engine = FastAES.new(@key)
-      @key
     end
 
     def salt_size=(s)
@@ -47,18 +37,9 @@ module EncryptedText
       @salt_size = s
     end
 
-    def base_encode(val, from_base)
-      val.b(from_base).to_a.map{ |id| @charset[id] }.join
-    end
-
-    def base_decode(val)
-      val.split.map{ |c| @reverse_charset.fetch(c) }.b(@charset.size).to_i
-    end
-
     def encode(message)
-      salt = (0...@salt_size).map { @charset.sample }.join
-      signed = @signature + salt + message
-      encrypted = @engine.encrypt(signed)
+      signed_and_salted = @signature + random_salt + message
+      encrypted = @engine.encrypt(signed_and_salted)
       hex_string = '1' + encrypted.to_hex_string.split(' ').join # Add "1" prefix in case hex_string has leading zeroes
       encoded = Radix.convert(hex_string.upcase, 16, 62) # Radix requires allcaps
     end
@@ -69,16 +50,20 @@ module EncryptedText
         hex_string = hex_string[1..-1] if hex_string[0] == '1' # remove "1" prefix
         hex_string = "0" + hex_string if (hex_string.size % 2) != 0 # Make sure we have an even number of hex digits
         byte_string = hex_string.to_byte_string
-        decrypted = @engine.decrypt(hex_string.to_byte_string)
+        decrypted = @engine.decrypt(byte_string)
       rescue #TODO: don't use generic rescue here
         raise EncryptedText::Err::CannotDecrypt
       end
 
       # Ensure that the message is signed correctly
-      matches = decrypted.match(/^#{Regexp.escape(signature)}(.+)/)
-      raise EncryptedText::Err::BadSignature unless matches
-      salted_message = matches[1]
-      message = salted_message[@salt_size..-1]
+      raise EncryptedText::Err::BadSignature unless decrypted.index(@signature) == 0
+
+      # Remove signature and salt
+      decrypted[(@signature.size + @salt_size)..-1]
+    end
+
+    def random_salt
+      (0...@salt_size).map{ SALT_CHARSET.sample }.join
     end
 
   end

data/lib/encrypted_text/version.rb

@@ -1,3 +1,3 @@
 module EncryptedText
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: encrypted_text
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast-aes