instance method `generate_random_hex_key`

Ruby on Rails 8.1.2

Since v7.0.10

Available in: v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

generate_random_hex_key(length: key_length)

Returns a random key in hexadecimal format. The key will have a size in bytes of :length (configured Cipher‘s length by default)

Hexadecimal format is handy for representing keys as printable text. To maximize the space of characters used, it is good practice including not printable characters. Hexadecimal format ensures that generated keys are representable with plain text

To convert back to the original string with the desired length:

[ value ].pack("H*")

Parameters

length key = key_length

Source

# File activerecord/lib/active_record/encryption/key_generator.rb, line 30
      def generate_random_hex_key(length: key_length)
        generate_random_key(length: length).unpack("H*")[0]
      end

Defined in activerecord/lib/active_record/encryption/key_generator.rb line 30 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::Encryption::KeyGenerator

Signature

Parameters