@@ -76,10 +76,10 @@ module EncryptedStrings # Creates a new cipher that uses an asymmetric encryption strategy. # # Configuration options: - # * +private_key_file+ - Encrypted private key file - # * +public_key_file+ - Public key file - # * +password+ - The password to use in the symmetric cipher - # * +algorithm+ - Algorithm to use symmetrically encrypted strings + # * <tt>:private_key_file</tt> - Encrypted private key file + # * <tt>:public_key_file</tt> - Public key file + # * <tt>:password</tt> - The password to use in the symmetric cipher + # * <tt>:algorithm</tt> - Algorithm to use symmetrically encrypted strings def initialize(options = {}) invalid_options = options.keys - [:private_key_file, :public_key_file, :algorithm, :password] raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty? lib/encrypted_strings/asymmetric_cipher.rb @@ -41,7 +41,8 @@ module EncryptedStrings # Creates a new cipher that uses an SHA encryption strategy. # # Configuration options: - # * +salt+ - Random bytes used as one of the inputs for generating the encrypted string + # * <tt>:salt</tt> - Random bytes used as one of the inputs for generating + # the encrypted string def initialize(options = {}) invalid_options = options.keys - [:salt] raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty? lib/encrypted_strings/sha_cipher.rb @@ -60,8 +60,9 @@ module EncryptedStrings # Creates a new cipher that uses a symmetric encryption strategy. # # Configuration options: - # * +algorithm+ - The algorithm to use for generating the encrypted string - # * +password+ - The secret value to use for generating the key/initialization vector for the algorithm + # * <tt>:algorithm</tt> - The algorithm to use for generating the encrypted string + # * <tt>:password</tt> - The secret value to use for generating the + # key/initialization vector for the algorithm def initialize(options = {}) invalid_options = options.keys - [:algorithm, :password] raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty? lib/encrypted_strings/symmetric_cipher.rb 36a1834cf1181cbd08a71086773baaa35da5c10f Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/encrypted_strings/commit/cc16f1928f6e99d12f7aa87549a962bff7277f8d cc16f1928f6e99d12f7aa87549a962bff7277f8d 2009-01-11T16:05:43-08:00 2009-01-11T16:05:43-08:00 Tweak docs b3ba7700eb56a39e4f81d11fb06a7a3e3602ac8a Aaron Pfeifer aaron.pfeifer@gmail.com