Add comment about the need for truncating keys in Ruby 2.4sh-add-ruby-2.4-comment

[ci skip]

1 files changed, 7 insertions, 0 deletions

diff --git a/config/settings.rb b/config/settings.rb
index 4aa903109ea..58f38d103ea 100644
--- a/config/settings.rb
+++ b/config/settings.rb
@@ -85,7 +85,14 @@ class Settings < Settingslogic
       File.expand_path(path, Rails.root)
     end
 
+    # Returns a 256-bit key for attr_encrypted
     def attr_encrypted_db_key_base
+      # Ruby 2.4+ requires passing in the exact required length for OpenSSL keys
+      # (https://github.com/ruby/ruby/commit/ce635262f53b760284d56bb1027baebaaec175d1).
+      # Previous versions quietly truncated the input.
+      #
+      # The default mode for the attr_encrypted gem is to use a 256-bit key.
+      # We truncate the 128-byte string to 32 bytes.
       Gitlab::Application.secrets.db_key_base[0..31]
     end