Contents

module EncryptedAttributes
  # Adds support for embedding salts in the encrypted value
  class ShaCipher < EncryptedStrings::ShaCipher
    class << self
      # Whether to embed the salt by default
      attr_accessor :default_embed_salt
    end
    
    # Set defaults
    @default_embed_salt = false
    
    # Tracks the lengths generated for each hashing algorithm
    @@algorithm_lengths = {
      'MD5' => 32,
      'SHA1' => 40,
      'SHA2' => 64,
      'SHA256' => 64,
      'SHA384' => 96,
      'SHA512' => 128
    }
    
    # Encrypts a string using a Secure Hash Algorithm (SHA), specifically SHA-1.
    # 
    # Configuration options:
    # * <tt>:salt</tt> - Random bytes used as one of the inputs for generating
    #   the encrypted string
    # * <tt>:embed_salt</tt> - Whether to embed the salt directly within the
    #   encrypted value.  Default is false.  This is useful for storing both
    #   the salt and the encrypted value in the same attribute.
    def initialize(value, options = {}) #:nodoc:
      if @embed_salt = options.delete(:embed_salt) || self.class.default_embed_salt
        # The salt is at the end of the value
        algorithm = (options[:algorithm] || EncryptedStrings::ShaCipher.default_algorithm).upcase
        salt = value[@@algorithm_lengths[algorithm]..-1]
        options[:salt] = salt unless salt.blank?
      end
      
      super(options)
    end
    
    # Encrypts the data, embedding the salt at the end of the string if
    # configured to do so
    def encrypt(data)
      encrypted_data = super
      encrypted_data << salt if @embed_salt
      encrypted_data
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
encrypted_attributes-0.4.1	lib/encrypted_attributes/sha_cipher.rb