123456789_123456789_123456789_123456789_123456789_

Class: ActiveSupport::KeyGenerator

Relationships & Source Files
Inherits: Object
Defined in: activesupport/lib/active_support/key_generator.rb

Overview

KeyGenerator is a simple wrapper around OpenSSL’s implementation of PBKDF2. It can be used to derive a number of keys for various purposes from a given secret. This lets ::Rails applications have a single secure secret, but avoid reusing that key in multiple incompatible contexts.

Class Method Summary

Instance Method Summary

Constructor Details

.new(secret, options = {}) ⇒ KeyGenerator

[ GitHub ] 

  


# File 'activesupport/lib/active_support/key_generator.rb', line 12



def initialize(secret, options = {})
  @secret = secret
  # The default iterations are higher than required for our key derivation uses
  # on the off chance someone uses this for password storage
  @iterations = options[:iterations] || 2**16
end


  







Instance Method Details



  

    #generate_key(salt, key_size = 64)  
  



  

    

Returns a derived key suitable for use.  The default key_size is chosen to be compatible with the default settings of MessageVerifier. i.e. OpenSSL::Digest::SHA1#block_length


  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/key_generator.rb', line 22



def generate_key(salt, key_size = 64)
  OpenSSL::PKCS5.pbkdf2_hmac_sha1(@secret, salt, @iterations, key_size)
end