hashpasswd 0.1.1 → 0.1.2

data/lib/hashpasswd.rb

@@ -1,5 +1,4 @@
 module Hashpasswd
-  VERSION = '0.1.0'
   HASH_SECTIONS = 4
   ITERATIONS_INDEX = 1
   SALT_INDEX = 2
@@ -8,10 +7,16 @@ module Hashpasswd
   require 'securerandom'
   require 'base64'
 
-  def self.version()
-    return VERSION
-  end
-
+  # Creates a hash from a plain text password
+  # @param password [String] A plain text password
+  # @param [Hash{Symbol => String, Number}] options
+  # @option options [Int] :pbkdf2_iterations (2000) The PBKDF2 iteration count
+  # @option options [Int] :salt_byte_size (24) The byte size for the salt
+  # @option options [Int] :hash_byte_size (24) The byte size for the hash
+  # @option options [String] :delimiter (':') The delimeter for the hash string, changing the delimiter is not recommended as you will have to remember it and supply it as an option to validatepasswd()
+  # @option options [String] :digest ('SHA1') The digest, can be any digest supported by OpenSSL on your sytem (eg 'SHA224', 'SHA256', 'SHA384' or 'SHA512')
+  # @return [String] the hash as "<digest>:<pbkdf2_iterations>:<salt>:<hash>"
+  #
   def self.createhash(password, options={})
     @pbkdf2_iterations = options[:pbkdf2_iterations] || 2000
     @salt_byte_size = options[:salt_byte_size] ||24
@@ -30,6 +35,13 @@ module Hashpasswd
     return [@digest, @pbkdf2_iterations, salt, Base64.encode64( pbkdf2 )].join( @delimeter )
   end
 
+  # Validates a password against a hash
+  # @param password [String] A plain text password
+  # @param hash [String] "<digest>:<pbkdf2_iterations>:<salt>:<hash>" 
+  # @param [Hash{Symbol => String}] options 
+  # @option options [String] :delimiter (':') The delimeter for the hash string, only necessary if you did not use the default delimiter (':') when creating the hash. 
+  # @return [Boolean] True if the password matches the hash; False if not.
+  #
   def self.validatepasswd(password, hash, options={})
     @delimeter = options[:delimter] || ':'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashpasswd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -45,3 +45,4 @@ signing_key:
 specification_version: 3
 summary: Password hashing and validation
 test_files: []
+has_rdoc: