breach-mitigation-rails 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,8 @@
 # breach-mitigation-rails
 
-Makes Rails applications less susceptible to the BREACH / CRIME
-attacks. See [breachattack.com](http://breachattack.com/) for details.
+Makes Rails 3 and 4 applications less susceptible to the BREACH /
+CRIME attacks. See [breachattack.com](http://breachattack.com/) for
+details.
 
 ## How it works
 
@@ -21,6 +22,12 @@ prevent plaintext recovery, but it can slow the attack and it's
 relatively inexpensive to implement. Unlike the CSRF token masking,
 length hiding protects the entire page body from recovery.
 
+In addition to these mitigations, you should check out Twitter's
+[secure_headers](https://github.com/twitter/secureheaders) gem.
+Setting the X-Frame-Options header can make it harder for an attacker
+to carry out this attack (by making it impossible to put your site in
+an iframe).
+
 ## Warning!
 
 BREACH and CRIME are **complicated and wide-ranging attacks**, and this
@@ -39,20 +46,23 @@ And then execute:
 
     $ bundle
 
-TODO And then?
+For most Rails apps, that should be enough, but read on for the gory
+details...
 
 ## Gotchas
 
-length padding can screw up etags
-length padding increases your bandwidth, could increase page load
-times
-if you have overridden verified_request? in your app, need to make sure you call +super+
+* The length-hiding middleware adds random text (in the form of an HTML
+  comment) to every page you serve. This can break HTTP caching / ETags for
+  public pages since they are no longer identical on each request.
+* The length-hiding middleware adds up to 2k of text to each page you
+  serve, which means more bandwidth consumed and potentially slower
+  performance.
+* If you have overridden the verified_request? method in your
+  application (likely in ApplicationController) you may need to update
+  it to be compatible with the secret masking code. See
+  `lib/breach_mitigation/railtie.rb` for an example.
 
 ## Contributing
 
 Pull requests are welcome, either to enhance the existing mitigation
 strategies or to add new ways to mitigate against the attack.
-
-## License
-
-MIT - see LICENSE.txt

data/lib/breach_mitigation/length_hiding.rb

@@ -38,11 +38,8 @@ module BreachMitigation
       # The length of the padding should be strongly random, but the
       # data itself doesn't need to be strongly random; it just needs
       # to be resistant to compression
-      length = SecureRandom.random_number(1024)
-
-      # TODO make this faster
-      junk = ''
-      length.times { junk << ALPHABET.sample }
+      length = SecureRandom.random_number(MAX_LENGTH)
+      junk = ALPHABET.sample(length).join
 
       "\n<!-- This is a random-length HTML comment: #{junk} -->"
     end

data/lib/breach_mitigation/masking_secrets.rb

@@ -21,15 +21,27 @@ module BreachMitigation
 
         masked_token = Base64.strict_decode64(encoded_masked_token)
 
-        return false if masked_token.length != AUTHENTICITY_TOKEN_LENGTH * 2
-
-        # Split the token into the one-time pad and the encrypted
-        # value and decrypt it
-        one_time_pad = masked_token[0...AUTHENTICITY_TOKEN_LENGTH]
-        encrypted_csrf_token = masked_token[AUTHENTICITY_TOKEN_LENGTH..-1]
-        csrf_token = xor_byte_strings(one_time_pad, encrypted_csrf_token)
-
-        csrf_token == real_csrf_token(session)
+        # See if it's actually a masked token or not. In order to
+        # deploy this code, we should be able to handle any unmasked
+        # tokens that we've issued without error.
+
+        if masked_token.length == AUTHENTICITY_TOKEN_LENGTH
+          # This is actually an unmasked token
+          Rails.logger.warn "WARNING: the client is using an unmasked authenticity token. This is expected if you have just upgraded to masked tokens, but if these messages continue long after the upgrade, then something fishy is going on."
+          masked_token == real_csrf_token(session)
+
+        elsif masked_token.length == AUTHENTICITY_TOKEN_LENGTH * 2
+          # Split the token into the one-time pad and the encrypted
+          # value and decrypt it
+          one_time_pad = masked_token[0...AUTHENTICITY_TOKEN_LENGTH]
+          encrypted_csrf_token = masked_token[AUTHENTICITY_TOKEN_LENGTH..-1]
+          csrf_token = xor_byte_strings(one_time_pad, encrypted_csrf_token)
+
+          csrf_token == real_csrf_token(session)
+
+        else
+          false # Token is malformed
+        end
       end
 
       private

data/lib/breach_mitigation/version.rb

@@ -1,3 +1,3 @@
 module BreachMitigation
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -2,14 +2,14 @@
 name: breach-mitigation-rails
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bradley Buda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement