secure_string 1.1.2 → 1.2.0

data/README.rdoc

@@ -79,7 +79,7 @@ Additionally, you can get at the byte data in various ways:
 
   ss.to_hex    --> "48656c6c6f20576f726c6421"
   ss.to_i      --> 22405534230753928650781647905
-  ss.to_base64 --> "SGVsbG8gV29ybGQh"
+  ss.to_base64 --> "SGVsbG8gV29ybGQh\n"
 
 One can initialize a SecureString from any of these types like so:
 
@@ -99,7 +99,7 @@ All of these create equal-valued strings to <tt>"HelloWorld!"</tt>.
 
 The SecureString::Base64Methods module adds +to_base64+, which we've seen:
 
-  SecureString.new("Hello World!").to_base64 --> "SGVsbG8gV29ybGQh"
+  SecureString.new("Hello World!").to_base64 --> "SGVsbG8gV29ybGQh\n"
 
 It also adds +from_base64+, which can decode a Base64 encoded string.  The
 following example shows the various ways of decoding Bas64 data:
@@ -234,7 +234,12 @@ or directly via e-mail at:
 mailto:jeff@paploo.net
 
 = Version History
-[1.1.2 - 2010-Nov-08] Minor gemspec file change for compatability with bundler.
+[1.2.0 - 2010-May-17] Re-wrote Base64 module to address problems with RFC 2045 vs. RFC 4648 compatibility.
+                      * Added testing against source strings that generate incompatible encodings between RFC 2045 and RFC 4648.
+                      * (FEATURE) added option to strip newlines from the returned base64 string.
+                      * (CHANGE) to_base64 defaults to the standard Base64 instead of websafe Base64.
+                      * (FIX) added option to decode as websafe Base64.
+[1.1.2 - 2010-Nov-08] Minor gemspec file change for compatibility with bundler.
 [1.1.1 - 2010-Nov-05] Backed down requirements to ruby 1.9.x; Bugfixes and minor changes.
                       * Tested in 1.9.1 and 1.9.2.
                       * Added some documentation and tests on String encodings.

data/lib/securize_string/base64_methods.rb

@@ -13,17 +13,33 @@ module SecurizeString
     # SecurizeString::Base64Methods to a class.
     module InstanceMethods
       
-      # Encodes to Base64.  By default, the output is made URL safe, which means all
-      # newlines are stripped out.  If you want standard formatted Base64 with
-      # newlines, then call this method with url_safe as false.
-      def to_base64(url_safe = true)
-        encoded_data = (url_safe ? Base64.urlsafe_encode64(self) : Base64.encode64(self))
-        return self.class.new( encoded_data )
+      # Encodes to Base64.
+      #
+      # By deault, this is the normal RFC 2045 Base64 encoding.
+      #
+      # If the <tt>url_safe</tt> option is set to true, then the RFC 4648
+      # encoding is used, which uses a slightly different encoding mechanism
+      # which is sometimes compatible, but often incompatible with RFC 2045.
+      #
+      # If the <tt>nobreak</tt> option is set to true, all line feeds are
+      # removed from the input.
+      def to_base64(opts={})
+        raise ArgumentError, "__method__ expects an argument hash but got #{opts.class.name}" unless opts.kind_of?(Hash)
+        data = (opts[:url_safe] ? Base64.urlsafe_encode64(self) : Base64.encode64(self))
+        data.delete!("\n\r") if opts[:no_break] # Delete on \n and \r is about 3x faster than gsub on /\s+/.
+        return data
       end
       
-      # Decode self as a Base64 data string and return the result.
-      def from_base64
-        return self.class.new( Base64.decode64(self) )
+      # Decodes from base64.
+      #
+      # By default, this decodes the normal RFC 2045 Base64.
+      #
+      # If the <tt>url_safe</tt> option is set to true, then it decodes the
+      # RFC 4648 encoding, which uses a slightly different encoding mechanism
+      # which is sometimes compatible, but often incompatible with RFC 2045.
+      def from_base64(opts={})
+        raise ArgumentError, "__method__ expects an argument hash but got #{opts.class.name}" unless opts.kind_of?(Hash)
+        return (opts[:url_safe] ? Base64.urlsafe_decode64(self) : Base64.decode64(self))
       end
       
     end

data/spec/base64_methods_spec.rb

@@ -11,27 +11,30 @@ describe "SecureString" do
     it 'should convert self to Base64; not URL safe' do
       @messages.each do |message|
         ss = SecureString.new(message[:string])
-        # First make sure that line feeds are being put in somewhere.
-        ss.to_base64(false).should include("\n")
-        # Now, compare the data itself (no line-feeds).
-        ss.to_base64(false).delete("\n").should == message[:base64].delete("\n")
+        # Compare the data with the base ruby methods.
+        ss.to_base64.should == Base64.encode64(message[:string])
       end
     end
     
     it 'should convert self to Base64; URL safe' do
       @messages.each do |message|
         ss = SecureString.new(message[:string])
-        # First make sure that there are no line feeds.
-        ss.to_base64(true).should_not include("\n")
-        # Now compare the result with the line-feed less expected value.
-        ss.to_base64(true).should == message[:base64].delete("\n")
+        # Compare the result with the base ruby methods.
+        ss.to_base64(:url_safe => true).should == Base64.urlsafe_encode64(message[:string])
       end
     end
     
-    it 'should default to URL safe' do
+    it 'should convert base64 with no line breaks' do
       @messages.each do |message|
         ss = SecureString.new(message[:string])
-        ss.to_base64.should == ss.to_base64(true)
+        ss.to_base64(:no_break => true).should == message[:base64].delete("\n")
+      end
+    end
+    
+    it 'should default to NOT URL safe' do
+      @messages.each do |message|
+        ss = SecureString.new(message[:string])
+        ss.to_base64.should == ss.to_base64(:url_safe => false)
       end
     end
     
@@ -42,6 +45,13 @@ describe "SecureString" do
       end
     end
     
+    it 'should gracefully error if you provide something other than a hash to options.' do
+      @messages.each do |message|
+        ss = SecureString.new(message[:string])
+        (lambda {ss.to_base64(true)}).should raise_error(ArgumentError)
+        (lambda {ss.from_base64(true)}).should raise_error(ArgumentError)
+      end
+    end
   end
   
 end

data/spec/example_spec.rb

@@ -10,7 +10,7 @@ describe "Examples" do
     
     ss.to_hex.should == "48656c6c6f20576f726c6421"
     ss.to_i.should == 22405534230753928650781647905
-    ss.to_base64.should == "SGVsbG8gV29ybGQh"
+    ss.to_base64.should == "SGVsbG8gV29ybGQh\n"
     
     ss1 = SecureString.new(:data, "Hello World!")
     ss2 = SecureString.new(:hex, "48656c6c6f20576f726c6421")
@@ -24,7 +24,7 @@ describe "Examples" do
   end
   
   it 'should perform the base64 example' do
-    SecureString.new("Hello World!").to_base64.should == "SGVsbG8gV29ybGQh"
+    SecureString.new("Hello World!").to_base64.should == "SGVsbG8gV29ybGQh\n"
     
     (SecureString.new(:base64, "SGVsbG8gV29ybGQh") == "Hello World!"   ).should be_true
     (SecureString.new("SGVsbG8gV29ybGQh") == "Hello World!"            ).should be_false

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ MESSAGES = [
     :string => "Hello",
     :hex => "48656c6c6f",
     :int => 310939249775,
-    :base64 => "SGVsbG8="
+    :base64 => "SGVsbG8=" # Leave off the \n on purpose so that we can make sure it handles that case appropriately when instantiating using base64.
   },
   
   {
@@ -16,5 +16,13 @@ MESSAGES = [
     :hex => "5468697320697320612074657374206f662074686520656d657267656e63792062726f6164636173742073797374656d3b2074686973206973206f6e6c79206120746573742e",
     :int => 1244344095146357680190496293767338268850834164562379171846588371816488740307922111470765515885864931093899586331709567338989540039042962957732585272476408412061178229806,
     :base64 => "VGhpcyBpcyBhIHRlc3Qgb2YgdGhlIGVtZXJnZW5jeSBicm9hZGNhc3Qgc3lz\ndGVtOyB0aGlzIGlzIG9ubHkgYSB0ZXN0Lg==\n"
+  },
+  
+  # This one tests a special case where url safe encodes differently than the standard.
+  {
+    :string => "HI?",
+    :hex => "48493f",
+    :int => 4737343,
+    :base64 => "SEk/\n"
   }
 ].freeze

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: secure_string
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 2
-  version: 1.1.2
+  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jeff Reinecke
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 -08:00
+date: 2011-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -61,23 +57,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 0
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A String subclass for simple handling of binary data and encryption.