cryptic 1.0.0.beta.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cryptic.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Erran Carey
+
+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,29 @@
+# Public Key Encryption/Decryption
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cryptic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cryptic
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Thorfile

@@ -0,0 +1,33 @@
+# encoding: utf-8
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'bundler/setup'
+require 'thor/rake_compat'
+require 'yard'
+
+class Default < Thor
+  include Thor::RakeCompat
+  require 'bundler/gem_tasks'
+
+  desc 'build', "Build cryptic-#{Cryptic::VERSION}.gem"
+  def build
+    Rake::Task['build'].execute
+  end
+
+  desc 'install', "Build and install cryptic-#{Cryptic::VERSION}.gem into system gems"
+  def install
+    Rake::Task['install'].execute
+  end
+
+  desc 'release', "Create tag v#{Cryptic::VERSION} and build and push cryptic-#{Cryptic::VERSION}.gem to Rubygems"
+  def release
+    Rake::Task['release'].execute
+  end
+
+  YARD::Rake::YardocTask.new
+  desc 'yard', 'Generate YARD Documentation'
+  def yard
+    Rake::Task['yard'].execute
+  end
+end

data/bin/cryptic

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'cryptic'
+require 'cryptic/keypair'
+require 'thor'
+
+class CrypticCLI < Thor
+  desc 'decrypt [PRIVATE_KEY] [ENCRYPTED_FILE] [OPTIONS]', 'Decrypt a file with a private key'
+  method_option :passphrase, aliases: %w[-p], default: nil, desc: 'The passphrase to unlock the private key with'
+  method_option :encoding, aliases: %w[-e], default: :none, desc: 'The encoding to use, one of: [:none, :base64]'
+  method_option :path, aliases: %w[-o], default: "cryptic_#{rand(1000..9999)}.txt", desc: 'Where to place the encrypted file'
+  def decrypt(private_key, file)
+    # TODO: Update error handling
+    #   * Better utilize custom exceptions
+    #   * Catch file read errors
+    data = File.read(file)
+    encrypted = Cryptic::EncryptedData.load(data, options[:encoding])
+    decrypted_str = encrypted.decrypt(private_key, options[:passphrase])
+
+    if decrypted_str.eql?('')
+      $stderr.puts '[Error]: Unable to save the decrypted file'
+      exit 1
+    else
+      File.open(options[:path], 'w') do |file|
+        file.write decrypted_str
+      end
+    end
+  rescue Cryptic::InvalidData => e
+    $stderr.puts "[Error]: #{e.inspect}".red
+    exit 1
+  rescue Cryptic::KeyMismatch => e
+    $stderr.puts "[Error]: #{e.inspect}".red
+    exit 1
+  end
+
+  desc 'encrypt [PUBLIC_KEY] [TEXT_FILE] [OPTIONS]', 'Encrypt a file with a public key'
+  method_option :encoding, aliases: %w[-e], default: :none, desc: 'The encoding to use, one of: [:none, :base64]'
+  method_option :path, aliases: %w[-o], default: "cryptic_#{rand(1000..9999)}.ctxt", desc: 'Where to place the encrypted file'
+  def encrypt(public_key, file)
+    # TODO: Update error handling; See above TODO.
+    data = File.read(file)
+    encrypted = Cryptic::EncryptedData.new(data, public_key)
+    encrypted_str = encrypted.data
+
+    if encrypted_str.eql?('')
+      $stderr.puts '[Error]: Unable to save the encrypted file'
+      exit 1
+    else
+      File.open(options[:path], 'w') do |file|
+        file.write encrypted_str
+      end
+    end
+  end
+
+  desc 'generate [OPTIONS]', 'Generate a private/public keypair', aliases: %w[gen key-gen]
+  method_option :bits, aliases: %w[-b size], default: 2048, desc: 'The number of bits to use when generating your key'
+  method_option :passphrase, aliases: %w[-p], default: nil, desc: 'The passphrase to generate the private key with'
+  method_option :path, aliases: %w[-o], default: '.', desc: 'Where to place the generated keys'
+  def generate
+    keypair = Cryptic::Keypair.new(options[:passphrase], options[:bits])
+    keypair.save(options[:path])
+    $stdout.puts "Generated keys saved as '#{File.expand_path(options[:path])}/cryptic_public.pem' and '#{File.expand_path(options[:path])}/cryptic_private.pem'"
+  rescue Cryptic::KeyGenerationFailure => e
+    $stderr.puts "[Error]: #{e.message}".red
+    exit 1
+  end
+end
+
+CrypticCLI.start(ARGV)

data/cryptic.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cryptic'
+  spec.version       = Cryptic::VERSION
+  spec.authors       = ['Erran Carey']
+  spec.email         = ['me@errancarey.com']
+  spec.description   = 'A gem to encrypt data using public keys.'
+  spec.summary       = 'A quick way to encrypt data using public keys. Only people with the private key can decrypt said data.'
+  spec.homepage      = 'https://github.com/ipwnstuff/cryptic'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redcarpet'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'yard'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cryptic.rb

@@ -0,0 +1,12 @@
+require 'cryptic/encrypted_data'
+require 'cryptic/exceptions'
+require 'cryptic/version'
+
+# A module to encrypt data using public keys
+#
+# @author Erran Carey <me@errancarey.com>
+module Cryptic
+  # Including Cryptic::Exceptions allows you to use shorthand for exceptions:
+  # Cryptic::DecryptionError instead of Cryptic::Exceptions::DecryptionError
+  include Cryptic::Exceptions
+end

data/lib/cryptic/encrypted_data.rb

@@ -0,0 +1,115 @@
+require 'base64'
+require 'openssl'
+require 'cryptic/exceptions'
+
+module Cryptic
+  # Allow the use of shorthand error handling
+  include Cryptic::Exceptions
+
+  # A class with methods to encrypt/decrypt data
+  #
+  # @!attribute [Symbol] encoding the encoding to use
+  # @!attribute [String] data the encrypted data string
+  # @author Erran Carey <me@errancarey.com>
+  class EncryptedData
+    attr_reader :data
+    attr_reader :encoding
+
+    # Initializes the encrypted data object
+    #
+    # @note If called without a public key's file name this doesn't
+    #   automatically encrypt the data
+    # @param [String] data the data to encrypt
+    # @param [String] public_key_file the filename of the public key to use in
+    #   the encryption process
+    # @param [Symbol] encoding the encoding to use
+    # @raise [KeyNotFound] if the specified public key wasn't found on the
+    #   file system
+    # @return [EncryptedData] an encrypted data object
+    def initialize(data, public_key_file = nil, encoding = :none)
+      @encoding = encoding
+
+      if !public_key_file
+        # If no public key was provided the data should already be encrypted
+        @data = data
+      elsif File.exists? public_key_file.to_s
+        public_key = OpenSSL::PKey::RSA.new(File.read(public_key_file))
+        encrypted_data = public_key.public_encrypt(data)
+        @data = encode(encrypted_data)
+      else
+        raise KeyNotFound
+      end
+    end
+
+    # Creates a new encrypted data object from an encrypted data string
+    #
+    # @param [String] data the encrypted data to load
+    # @return [EncryptedData] an encrypted data object
+    def self.load(data, encoding = :none)
+      new(data, nil, encoding)
+    end
+
+    # Decrypts the data encrypted via a public key
+    #
+    # @note This doesn't have a partner encrypt method as the EncryptedData
+    #   class encrypts data on initialization
+    # @note The passphrase can be left nil in the case that you're using a
+    #   terminal that will allow you to enter the passphrase when prompted
+    # @param [String] private_key_file the private key to use during decryption
+    # @param [String] passphrase the passphrase to unlock the private key with
+    # @raise [KeyNotFound] if the specified public key wasn't found on the
+    #   file system
+    def decrypt(private_key_file, passphrase = nil)
+      if File.exists? private_key_file.to_s
+        private_key = OpenSSL::PKey::RSA.new(File.read(private_key_file), passphrase)
+        decoded_string = decode(@data)
+        private_key.private_decrypt(decoded_string)
+      else
+        raise KeyNotFound
+      end
+    end
+
+    # @return [String] the encrypted data string
+    def to_s; @data; end
+
+    private
+
+    # TODO: The decode/encode methods shouldn't share so much code
+    # TODO: These methods also shouldn't raise an exception that could be raised
+    #   earlier. Use something along the lines of:
+    #   `SUPPORTED_ENCODING = [:base64, :none]` and checking whether the
+    #   encoding supplied in initialize is included in it
+
+    # Decode a string using the specified encoding
+    #
+    # @param [String] data the data to encode
+    # @raise [UnsupportedEncoding] if the specified encoding isn't a valid
+    # @return [String] the encoded data
+    def decode(data)
+      case @encoding
+      when nil, :none, :raw
+        data
+      when :base64
+        Base64.decode64(data)
+      else
+        raise Cryptic::UnsupportedEncoding, @encoding
+      end
+    end
+
+    # Encode a string using the specified encoding
+    #
+    # @raise [UnsupportedEncoding] if the specified encoding isn't a valid
+    #   encoding
+    # @return [String] the unencoded data
+    def encode(data)
+      case @encoding
+      when nil, :none, :raw
+        data
+      when :base64
+        Base64.encode64(data)
+      else
+        raise Cryptic::UnsupportedEncoding, @encoding
+      end
+    end
+  end
+end

data/lib/cryptic/exceptions.rb

@@ -0,0 +1,17 @@
+require 'colorize'
+require 'cryptic/exceptions/decryption_error'
+require 'cryptic/exceptions/encryption_error'
+require 'cryptic/exceptions/invalid_data'
+require 'cryptic/exceptions/key_generation_failure'
+require 'cryptic/exceptions/key_mismatch'
+require 'cryptic/exceptions/key_not_found'
+require 'cryptic/exceptions/unsupported_encoding'
+
+module Cryptic
+  # A namepace for exceptions that's included in the Cryptic module for
+  # convenience
+  #
+  # @author Erran Carey <me@errancarey.com>
+  module Exceptions
+  end
+end

data/lib/cryptic/exceptions/decryption_error.rb

@@ -0,0 +1,10 @@
+require 'cryptic/exceptions/encryption_error'
+
+module Cryptic
+  module Exceptions
+    # An exception to throw when there's a problem with decryption
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class DecryptionError < EncryptionError; end
+  end
+end

data/lib/cryptic/exceptions/encryption_error.rb

@@ -0,0 +1,8 @@
+module Cryptic
+  module Exceptions
+    # A generic exception to throw when there's a problem with encryption
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class EncryptionError < RuntimeError; end
+  end
+end

data/lib/cryptic/exceptions/invalid_data.rb

@@ -0,0 +1,8 @@
+module Cryptic
+  module Exceptions
+    # A exception to throw if the encrypted data looks bogus
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class InvalidData < ArgumentError; end
+  end
+end

data/lib/cryptic/exceptions/key_generation_failure.rb

@@ -0,0 +1,8 @@
+module Cryptic
+  module Exceptions
+    # An generic exception that gets raised when key generation fails
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class KeyGenerationFailure < RuntimeError; end
+  end
+end

data/lib/cryptic/exceptions/key_mismatch.rb

@@ -0,0 +1,10 @@
+require 'cryptic/exceptions/decryption_error'
+
+module Cryptic
+  module Exceptions
+    # An exception to raise when you try to decrypt with the wrong private key
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class KeyMismatch < DecryptionError; end
+  end
+end

data/lib/cryptic/exceptions/key_not_found.rb

@@ -0,0 +1,8 @@
+module Cryptic
+  module Exceptions
+    # An exception to raise in the case of a key not being on the file system
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class KeyNotFound < Errno::ENOENT; end
+  end
+end

data/lib/cryptic/exceptions/unsupported_encoding.rb

@@ -0,0 +1,8 @@
+module Cryptic
+  module Exceptions
+    # An exception to raise when a valid encoding is specified
+    #
+    # @author Erran Carey <me@errancarey.com>
+    class UnsupportedEncoding < EncodingError; end
+  end
+end

data/lib/cryptic/keypair.rb

@@ -0,0 +1,64 @@
+require 'cryptic/exceptions'
+require 'fileutils'
+require 'openssl'
+
+module Cryptic
+  # Allow the use of shorthand error handling
+  include Cryptic::Exceptions
+
+  # A class that represents a private and public keypair
+  #
+  # @!attribute [String] private_key the contents of the private key file
+  # @!attribute [String] public_key the contents of the public key file
+  # @author Erran Carey <me@errancarey.com>
+  class Keypair
+    attr_reader :private_key
+    attr_reader :public_key
+    # Creates a keypair to be saved with #save
+    #
+    # @param [Fixnum] size the amount of bits to use in your key
+    # @return [Keypair] an object representing a private/public keypair
+    def initialize(passphrase = nil, size = 2048)
+      @saved = false
+
+      attempts ||= 0
+      attempts += 1
+
+      rsa_key = OpenSSL::PKey::RSA.new(size)
+      cipher = OpenSSL::Cipher::AES256.new(:CBC)
+
+      @private_key = rsa_key.to_pem(cipher, passphrase)
+      @public_key = rsa_key.public_key.to_pem
+    rescue OpenSSL::PKey::RSAError => e
+      if e.message =~ /^read key$/
+        retry unless attempts > 1
+      else
+        raise e
+      end
+    end
+
+    # Save the file
+    #
+    # @param [String] path the path to save the keypair into
+    # @todo Document what save may raise
+    # @return [String] returns the path files were saved to
+    def save(path = '.')
+      if @private_key.to_s.eql?('') || @public_key.to_s.eql?('')
+        raise Cryptic::KeyGenerationFailure, "The keypair was never successfully generated"
+      end
+
+      FileUtils.mkdir_p(File.dirname(path))
+
+      File.open("#{File.expand_path(path)}/cryptic_private.pem", 'w') do |file|
+        file.write @private_key
+      end
+
+      File.open("#{File.expand_path(path)}/cryptic_public.pem", 'w') do |file|
+        file.write @public_key
+      end
+
+      @saved = true
+      path
+    end
+  end
+end

data/lib/cryptic/version.rb

@@ -0,0 +1,4 @@
+module Cryptic
+  # The version of the cryptic gem
+  VERSION = '1.0.0.beta.1'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: cryptic
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.1
+  prerelease: 6
+platform: ruby
+authors:
+- Erran Carey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: A gem to encrypt data using public keys.
+email:
+- me@errancarey.com
+executables:
+- cryptic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Thorfile
+- bin/cryptic
+- cryptic.gemspec
+- lib/cryptic.rb
+- lib/cryptic/encrypted_data.rb
+- lib/cryptic/exceptions.rb
+- lib/cryptic/exceptions/decryption_error.rb
+- lib/cryptic/exceptions/encryption_error.rb
+- lib/cryptic/exceptions/invalid_data.rb
+- lib/cryptic/exceptions/key_generation_failure.rb
+- lib/cryptic/exceptions/key_mismatch.rb
+- lib/cryptic/exceptions/key_not_found.rb
+- lib/cryptic/exceptions/unsupported_encoding.rb
+- lib/cryptic/keypair.rb
+- lib/cryptic/version.rb
+homepage: https://github.com/ipwnstuff/cryptic
+licenses:
+- MIT
+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: 1237837409677303508
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A quick way to encrypt data using public keys. Only people with the private
+  key can decrypt said data.
+test_files: []
+has_rdoc: