dionysus 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/dionysus.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dionysus}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis D. Warlick, Jr."]
@@ -25,10 +25,15 @@ Gem::Specification.new do |s|
      "dionysus.gemspec",
      "lib/dionysus.rb",
      "lib/dionysus/configuration.rb",
+     "lib/dionysus/security.rb",
+     "lib/dionysus/security/string.rb",
+     "lib/dionysus/string.rb",
      "spec/configuration_spec.rb",
      "spec/dionysus_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/string_security_spec.rb",
+     "spec/string_spec.rb"
   ]
   s.homepage = %q{http://github.com/tekwiz/dionysus}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -38,7 +43,9 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/configuration_spec.rb",
      "spec/dionysus_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/string_security_spec.rb",
+     "spec/string_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/dionysus/configuration.rb

@@ -1,3 +1,5 @@
+require 'dionysus'
+
 ##
 # = Configuration
 #

data/lib/dionysus/security.rb

@@ -0,0 +1 @@
+require 'dionysus/security/string'

data/lib/dionysus/security/string.rb

@@ -0,0 +1,105 @@
+require 'digest/sha1'
+require 'digest/sha2'
+require 'digest/md5'
+
+require 'dionysus'
+require 'dionysus/string'
+##
+# Adds String hashing and salting convenience methods.
+#
+#   require 'dionysus/security/string'
+class String
+  ##
+  # Generate a random, binary salt with the given length (default 16)
+  def self.salt( length = 16 )
+    length.times.to_a.collect {|v| rand(255).chr}.join[0...length]
+  end
+  
+  ##
+  # Generate the SHA 512 HASh, with the given salt appended
+  # 
+  # Options:
+  # [salt]      Salt to append to the string.
+  #             Default: ''
+  # [encoding]  Encoding for the hash: <tt>:binary</tt>, <tt>:hex</tt>, <tt>:hexidecimal</tt>, <tt>:base64</tt>
+  #             Default: <tt>:base64</tt>
+  def sha512( options = {} )
+    d = Digest::SHA512.digest(_salted(options[:salt]))
+    _encode(d, options[:encoding] || :base64)
+  end
+  
+  ##
+  # Generate the SHA 256 HASh, with the given salt appended
+  # 
+  # Options:
+  # [salt]      Salt to append to the string.
+  #             Default: ''
+  # [encoding]  Encoding for the hash: <tt>:binary</tt>, <tt>:hex</tt>, <tt>:hexidecimal</tt>, <tt>:base64</tt>
+  #             Default: <tt>:base64</tt>
+  def sha256( options = {} )
+    d = Digest::SHA256.digest(_salted(options[:salt]))
+    _encode(d, options[:encoding] || :base64)
+  end
+  
+  ##
+  # Generate the SHA 2 HASh, with the given salt appended
+  # 
+  # Options:
+  # [salt]      Salt to append to the string.
+  #             Default: ''
+  # [encoding]  Encoding for the hash: <tt>:binary</tt>, <tt>:hex</tt>, <tt>:hexidecimal</tt>, <tt>:base64</tt>
+  #             Default: <tt>:base64</tt>
+  def sha2( options = {} )
+    d = Digest::SHA2.digest(_salted(options[:salt]))
+    _encode(d, options[:encoding] || :base64)
+  end
+  
+  ##
+  # Generate the SHA 1 hash, with the given salt appended
+  # 
+  # Options:
+  # [salt]      Salt to append to the string.
+  #             Default: ''
+  # [encoding]  Encoding for the hash: <tt>:binary</tt>, <tt>:hex</tt>, <tt>:hexidecimal</tt>, <tt>:base64</tt>
+  #             Default: <tt>:base64</tt>
+  def sha1( options = {} )
+    d = Digest::SHA1.digest(_salted(options[:salt]))
+    _encode(d, options[:encoding] || :base64)
+  end
+  
+  ##
+  # Generate the MD5 hash, with the given salt appended.
+  # 
+  # Options:
+  # [salt]      Salt to append to the string.
+  #             Default: ''
+  # [encoding]  Encoding for the hash: <tt>:binary</tt>, <tt>:hex</tt>, <tt>:hexidecimal</tt>, <tt>:base64</tt>
+  #             Default: <tt>:base64</tt>
+  def md5( options = {} )
+    d = Digest::MD5.digest(_salted(options[:salt]))
+    _encode(d, options[:encoding] || :base64)
+  end
+  
+  private
+  
+  ##
+  # Salt the string by appending it to the end.
+  def _salted( salt )
+    self + (salt || '')
+  end
+  
+  ##
+  # Encode the value to the given encoding
+  def _encode( value, encoding )
+    case encoding
+    when :binary
+      value
+    when :base64
+      value.encode64s
+    when :hex, :hexidecimal
+      value.encodeHex
+    else
+      raise ArgumentError, "Invalid encoding: #{encoding}"
+    end
+  end
+end

data/lib/dionysus/string.rb

@@ -0,0 +1,30 @@
+require 'dionysus'
+require 'active_support/base64'
+
+##
+# Adds string encoding convenience methods.
+#
+#     require 'dionysus/string'
+class String
+  ##
+  # Encode the Base64 (without newlines)
+  def encode64s() Base64.encode64s(self); end
+  
+  ##
+  # Encode to Base 64
+  def encode64() Base64.encode64(self); end
+  
+  ##
+  # Decode from Base 64
+  def decode64() Base64.decode64(self); end
+  
+  ##
+  # Encode to hexidecimal
+  def encodeHexidecimal() self.unpack('H*').first; end
+  alias_method :encodeHex, :encodeHexidecimal
+  
+  ##
+  # Decode from hexidecimal
+  def decodeHexidecimal() [self].pack('H*'); end
+  alias_method :decodeHex, :decodeHexidecimal
+end

data/spec/dionysus_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+require 'dionysus'
 describe Dionysus do
   it "should have a version number" do
     Dionysus::VERSION.should match(/\A\d+(\.\d+)+(\.\w+)??\Z/)

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'dionysus'
 require 'spec'
 require 'spec/autorun'
 

data/spec/string_security_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'dionysus/security/string'
+describe String do
+  it "should generate a salt 16 bytes long" do
+    String.salt.length.should == 16
+  end
+  
+  it "should generate a salt arbitrary nubmer of bytes long" do
+    String.salt(5).length.should == 5
+    String.salt(1).length.should == 1
+  end
+  
+  it "should calculate sha512 in base64" do
+    digest = "KHErTuI/5urCF3vi6yTDxvAHBydW1CN3zVfBWDP/ItbmgeVi5IFq47ew0hPHzyK3AuMDh+Z9MBBlf3/mACgVMQ=="
+    "abcde\240z405".sha512.should == digest
+    "abcde\240z405".sha512(:encoding => :base64).should == digest
+  end
+  
+  it "should calculate sha256/sha2 in base64" do
+    digest = "vGeWpAMcqj2XuE8P4FirA2oUt1S78c6puQk03EOdnQY="
+    "abcde\240z405".sha256.should == digest
+    "abcde\240z405".sha256(:encoding => :base64).should == digest
+    "abcde\240z405".sha2.should == digest
+    "abcde\240z405".sha2(:encoding => :base64).should == digest
+  end
+  
+  it "should calculate sha1 in base64" do
+    digest = "wxeCFXPVXePFcpwuFDjonyn1G/w="
+    "abcde\240z405".sha1.should == digest
+    "abcde\240z405".sha1(:encoding => :base64).should == digest
+  end
+  
+  it "should calculate md5 in base64" do
+    digest = "ThT0y7KbAinjLpuChqsRuQ=="
+    "abcde\240z405".md5.should == digest
+    "abcde\240z405".md5(:encoding => :base64).should == digest
+  end
+  
+  it "should calculate sha512 with a salt" do
+    salt = 'abcdefg'
+    digest = "oxoD5Mwq6ck4B1P2tfsrCQnNHzBYQRKOFGTj1T0EFPWeNuy1/YPtsKGiz2os9ljt0/OwXEt/l8LsK/ktbwEHbg=="
+    "abcde\240z405".sha512(:salt => salt).should == digest
+  end
+  
+  it "should calculate sha256/sha2 with a salt" do
+    salt = 'abcdefg'
+    digest = "fWzU2g2GFAS5EAgTS09djo2eDDQdNp1xSTdrRO7m9v4="
+    "abcde\240z405".sha256(:salt => salt).should == digest
+    "abcde\240z405".sha2(:salt => salt).should == digest
+  end
+  
+  it "should calculate sha1 with a salt" do
+    salt = 'abcdefg'
+    digest = "JFdwlGl341qtbqX6mPQbjs8d1/U="
+    "abcde\240z405".sha1(:salt => salt).should == digest
+  end
+  
+  it "should calculate md5 with a salt" do
+    salt = 'abcdefg'
+    digest = "m59029ys/bc2HpeuZqcQ3w=="
+    "abcde\240z405".md5(:salt => salt).should == digest
+  end
+  
+  it "should calculate sha512 in hex/hexidecimal" do
+    digest = "28712b4ee23fe6eac2177be2eb24c3c6f007072756d42377cd57c15833ff22d6e681e562e4816ae3b7b0d213c7cf22b702e30387e67d3010657f7fe600281531"
+    "abcde\240z405".sha512(:encoding => :hex).should == digest
+    "abcde\240z405".sha512(:encoding => :hexidecimal).should == digest
+  end
+  
+  it "should calculate sha256/sha2 in hex/hexidecimal" do
+    digest = "bc6796a4031caa3d97b84f0fe058ab036a14b754bbf1cea9b90934dc439d9d06"
+    "abcde\240z405".sha256(:encoding => :hex).should == digest
+    "abcde\240z405".sha2(:encoding => :hex).should == digest
+    "abcde\240z405".sha256(:encoding => :hexidecimal).should == digest
+    "abcde\240z405".sha2(:encoding => :hexidecimal).should == digest
+  end
+  
+  it "should calculate sha1 in hex/hexidecimal" do
+    digest = "c317821573d55de3c5729c2e1438e89f29f51bfc"
+    "abcde\240z405".sha1(:encoding => :hex).should == digest
+    "abcde\240z405".sha1(:encoding => :hexidecimal).should == digest
+  end
+  
+  it "should calculate md5 in hex/hexidecimal" do
+    digest = "4e14f4cbb29b0229e32e9b8286ab11b9"
+    "abcde\240z405".md5(:encoding => :hex).should == digest
+    "abcde\240z405".md5(:encoding => :hexidecimal).should == digest
+  end
+  
+  it "should calculate sha512 in binary" do
+    digest = "(q+N\342?\346\352\302\027{\342\353$\303\306\360\a\a'V\324#w\315W\301X3\377\"\326\346\201\345b\344\201j\343\267\260\322\023\307\317\"\267\002\343\003\207\346}0\020e\177\177\346\000(\0251"
+    "abcde\240z405".sha512(:encoding => :binary).should == digest
+  end
+  
+  it "should calculate sha256/sha2 in binary" do
+    digest = "\274g\226\244\003\034\252=\227\270O\017\340X\253\003j\024\267T\273\361\316\251\271\t4\334C\235\235\006"
+    "abcde\240z405".sha256(:encoding => :binary).should == digest
+    "abcde\240z405".sha2(:encoding => :binary).should == digest
+  end
+  
+  it "should calculate sha1 in binary" do
+    digest = "\303\027\202\025s\325]\343\305r\234.\0248\350\237)\365\e\374"
+    "abcde\240z405".sha1(:encoding => :binary).should == digest
+  end
+  
+  it "should calculate md5 in binary" do
+    digest = "N\024\364\313\262\233\002)\343.\233\202\206\253\021\271"
+    "abcde\240z405".md5(:encoding => :binary).should == digest
+  end
+end

data/spec/string_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'dionysus/string'
+describe String do
+  it "should encode64s" do
+    "abcde\240z405".encode64s.should == "YWJjZGWgejQwNQ=="
+  end
+  
+  it "should encode64" do
+    "abcde\240z405".encode64.should == "YWJjZGWgejQwNQ==\n"
+  end
+  
+  it "should decode64" do
+    "YWJjZGWgejQwNQ==".decode64.should == "abcde\240z405"
+    "YWJjZGWgejQwNQ==\n".decode64.should == "abcde\240z405"
+  end
+  
+  it "should encodeHex" do
+    "abcde\240z405".encodeHex.should == "6162636465a07a343035"
+    "abcde\240z405".encodeHexidecimal.should == "6162636465a07a343035"
+  end
+  
+  it "should decodeHex" do
+    '6162636465a07a343035'.decodeHexidecimal.should == "abcde\240z405"
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Travis D. Warlick, Jr.
@@ -65,10 +65,15 @@ files:
 - dionysus.gemspec
 - lib/dionysus.rb
 - lib/dionysus/configuration.rb
+- lib/dionysus/security.rb
+- lib/dionysus/security/string.rb
+- lib/dionysus/string.rb
 - spec/configuration_spec.rb
 - spec/dionysus_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/string_security_spec.rb
+- spec/string_spec.rb
 has_rdoc: true
 homepage: http://github.com/tekwiz/dionysus
 licenses: []
@@ -103,3 +108,5 @@ test_files:
 - spec/configuration_spec.rb
 - spec/dionysus_spec.rb
 - spec/spec_helper.rb
+- spec/string_security_spec.rb
+- spec/string_spec.rb