aescrypt 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aescrypt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gurpartap Singh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# AESCrypt - Simple AES encryption / decryption for Ruby
+
+AESCrypt is a simple to use, opinionated AES encryption / decryption Ruby gem that just works.
+
+AESCrypt uses the AES-256-CBC cipher and encodes the encrypted data with Base64.
+
+A corresponding gem to easily handle AES encryption / decryption in Objective-C is available at http://github.com/Gurpartap/AESCrypt-ObjC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aescrypt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aescrypt
+
+## Usage
+
+    message = "top secret message"
+    password = "p4ssw0rd"
+
+Encrypting
+
+    encrypted_data = AESCrypt.encrypt(message, password)
+
+Decrypting
+
+    message = AESCrypt.decrypt(encrypted_data, password)
+
+## Advanced usage
+
+Encrypting
+
+    encrypted_data = encrypt_data(data, key, iv, cipher_type)
+
+Decrypting
+
+    decrypted_data = decrypt_data(encrypted_data, key, iv, cipher_type)
+
+## Corresponding usage in Objective-C
+
+The AESCrypt Objective-C class, available at https://github.com/Gurpartap/AESCrypt-ObjC, understands what you're talking about in your Ruby code. The purpose of the Ruby gem and Objective-C class is to have something that works out of the box across the server (Ruby) and client (Objective-C). However, a standard encryption technique is implemented, which ensures that you can handle the data with any AES compatible library available across the web. So, you're not locked-in.
+
+Here's how you would use the AESCrypt Objective-C class:
+
+    NSString *message = @"top secret message";
+    NSString *password = @"p4ssw0rd";
+
+Encrypting
+
+    NSString *encryptedData = [AESCrypt encrypt:message password:password];
+
+Decrypting
+
+    NSString *message = [AESCrypt decrypt:encryptedData password:password];
+
+See the Objective-C class README at http://github.com/Gurpartap/AESCrypt-ObjC for more details.
+
+## License
+
+Copyright (c) 2012 Gurpartap Singh
+
+The encrypt_data and decrypt_data methods are Copyright (c) 2007 Brent Sowers and have been included in the gem with prior permission. Thanks Brent! :)
+
+See LICENSE for license terms.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/aescrypt.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gurpartap Singh"]
+  gem.email         = ["contact@gurpartap.com"]
+  gem.description   = "Simple AES encryption / decryption for Ruby"
+  gem.summary       = "AESCrypt is a simple to use, opinionated AES encryption / decryption Ruby gem that just works."
+  gem.homepage      = "http://github.com/Gurpartap/aescrypt"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.name          = "aescrypt"
+  gem.require_paths = ["lib"]
+  gem.version       = "1.0.0"
+
+  gem.add_development_dependency "rake"
+end

data/lib/aescrypt.rb

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+# The encrypt_data and decrypt_data methods are Copyright (c) 2007 Brent Sowers
+# and have been included with prior permission.
+#
+# Copyright (c) 2012 Gurpartap Singh
+# 
+# MIT License
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'openssl'
+
+module AESCrypt
+  def self.encrypt(message, password)
+    Base64.encode64(self.encrypt_data(message.to_s.strip, self.key_digest(password), nil, "AES-256-CBC"))
+  end
+
+  def self.decrypt(message, password)
+    base64_decoded = Base64.decode64(message.to_s.strip)
+    self.decrypt_data(base64_decoded, self.key_digest(password), nil, "AES-256-CBC")
+  end
+
+  def self.key_digest(password)
+    OpenSSL::Digest::SHA256.new(password).digest
+  end
+
+  # Decrypts a block of data (encrypted_data) given an encryption key
+  # and an initialization vector (iv).  Keys, iv's, and the data 
+  # returned are all binary strings.  Cipher_type should be
+  # "AES-256-CBC", "AES-256-ECB", or any of the cipher types
+  # supported by OpenSSL.  Pass nil for the iv if the encryption type
+  # doesn't use iv's (like ECB).
+  #:return: => String
+  #:arg: encrypted_data => String 
+  #:arg: key => String
+  #:arg: iv => String
+  #:arg: cipher_type => String
+  def self.decrypt_data(encrypted_data, key, iv, cipher_type)
+    aes = OpenSSL::Cipher::Cipher.new(cipher_type)
+    aes.decrypt
+    aes.key = key
+    aes.iv = iv if iv != nil
+    aes.update(encrypted_data) + aes.final  
+  end
+
+  # Encrypts a block of data given an encryption key and an 
+  # initialization vector (iv).  Keys, iv's, and the data returned 
+  # are all binary strings.  Cipher_type should be "AES-256-CBC",
+  # "AES-256-ECB", or any of the cipher types supported by OpenSSL.  
+  # Pass nil for the iv if the encryption type doesn't use iv's (like
+  # ECB).
+  #:return: => String
+  #:arg: data => String 
+  #:arg: key => String
+  #:arg: iv => String
+  #:arg: cipher_type => String  
+  def self.encrypt_data(data, key, iv, cipher_type)
+    aes = OpenSSL::Cipher::Cipher.new(cipher_type)
+    aes.encrypt
+    aes.key = key
+    aes.iv = iv if iv != nil
+    aes.update(data) + aes.final      
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: aescrypt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gurpartap Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple AES encryption / decryption for Ruby
+email:
+- contact@gurpartap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aescrypt.gemspec
+- lib/aescrypt.rb
+homepage: http://github.com/Gurpartap/aescrypt
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1373182486440895594
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1373182486440895594
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: AESCrypt is a simple to use, opinionated AES encryption / decryption Ruby
+  gem that just works.
+test_files: []