A simple wrapper for the standard ruby OpenSSL library
Used by github.com/shuber/attr_encrypted to easily encrypt/decrypt attributes in any class
gem install encryptor
secret_key = Digest::SHA256.hexdigest('a secret key') encrypted_value = Encryptor.encrypt('some string to encrypt', :key => secret_key) # '������{)��q�ށ��ܣ��q���Au/�ޜP' decrypted_value = Encryptor.decrypt(encrypted_value, :key => secret_key) # 'some string to encrypt'
The value to encrypt or decrypt may also be passed as the :value option if you’d like.
encrypted_value = Encryptor.encrypt(:value => 'some string to encrypt', :key => secret_key) # '������{)��q�ށ��ܣ��q���Au/�ޜP' decrypted_value = Encryptor.decrypt(:value => encrypted_value, :key => secret_key) # 'some string to encrypt'
You may also pass the :iv and :algorithm options but they are not required. If an algorithm is not specified, the Encryptor uses the algorithm found at Encryptor.default_options[:algorithm] which is aes-256-cbc by default. You can change the default options by overwriting or merging this attribute:
Encryptor.default_options.merge!(:algorithm => 'bf', :key => 'some default secret key')
Encryptor adds encrypt and decrypt methods to String objects for your convenience. These two methods accept the same arguments as the associated ones in the Encryptor module. They’re nice when you set the default options in the Encryptor.default_options attribute. For example:
Encryptor.default_options.merge!(:key => 'some default secret key') credit_card = 'xxxx xxxx xxxx 1234' encrypted_credit_card = credit_card.encrypt
There’s also encrypt! and decrypt! methods that replace the contents of a string with the encrypted or decrypted version of itself.
Run openssl list-cipher-commands in your terminal to view a list of all cipher algorithms that are supported on your platform.
aes-128-cbc aes-128-ecb aes-192-cbc aes-192-ecb aes-256-cbc aes-256-ecb bf bf-cbc bf-cfb bf-ecb bf-ofb cast cast-cbc cast5-cbc cast5-cfb cast5-ecb cast5-ofb des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb des-ofb des3 desx idea idea-cbc idea-cfb idea-ecb idea-ofb rc2 rc2-40-cbc rc2-64-cbc rc2-cbc rc2-cfb rc2-ecb rc2-ofb rc4 rc4-40
-
Fork the project.
-
Make your feature addition or bug fix.
-
Add tests for it. This is important so I don’t break it in a future version unintentionally.
-
Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-
Send me a pull request. Bonus points for topic branches.