krypter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e0dfa5c8ff00e53057804420023fe37efb06f4b
+  data.tar.gz: b7daec95060bf484e2203fce88174f383375a0b6
+SHA512:
+  metadata.gz: 8260c08cb857ee43e15a2652bfb3a17141cae99c6e9345a9772eb7b5e2dcf2d7f0e5fbf339a97674a901e7c9b9eb9a1a9a672bf9197c8556922d5128f9066d8a
+  data.tar.gz: f0a2c5226ea6b3add326e8760398d80f07c8a2073208aa4f60ff0d90acb91148cfecbd6c1c3feae3526f3232ca4754ef050ebb226a4190a67f9cb5ebad34f9d3

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Francesco Rodríguez
+
+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,54 @@
+krypter
+=======
+
+Encrypts messages with authentication.
+
+Usage
+-----
+
+Pass a secret token. This must be at least 32 bytes
+long and should be really random. You can generate
+a random secret with `SecureRandom.hex(32)`.
+
+```ruby
+require "securerandom"
+require "krypter"
+
+secret = SecureRandom.hex(32)
+encryptor = Krypter.new(secret)
+encrypted = encryptor.encrypt("message")
+encryptor.decrypt(encrypted) == "message"
+# => true
+
+# If the signature is invalid, it raises a `InvalidSignature` error.
+encryptor.decrypt("")
+# => Krypter::InvalidSignature
+
+# If the message is changed, it raises a `InvalidMessage` error.
+ciphertext, signature = encrypted.split("--")
+ciphertext.reverse!
+
+encryptor.decrypt([ciphertext, signature].join("--"))
+# => Krypter::InvalidMessage
+```
+
+By default, the messages are encrypted with 256-bit AES in CBC mode
+(with random IV). The encrypted message is then signed with HMAC-SHA256,
+to prevent tampering and chosen ciphertext attacks.
+
+The defaults can be changed when instantiating the encryptor object.
+
+```ruby
+encryptor = Encryptor.new(secret,
+  cipher: "aes-256-cbc",
+  digest: "SHA256",
+  separator: "--"
+)
+```
+
+Installation
+------------
+
+```
+$ gem install krypter
+```

data/krypter.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = "krypter"
+  s.version = "1.0.0"
+  s.summary = "Encrypts and signs messages."
+  s.description = s.summary
+  s.authors = ["Francesco Rodríguez", "Mayn Kjær"]
+  s.email = ["frodsan@me.com", "mayn.kjaer@gmail.com"]
+  s.homepage = "https://github.com/harmoni-io/krypter"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end

data/lib/krypter.rb

@@ -0,0 +1,96 @@
+require "base64"
+require "openssl"
+
+class Krypter
+  InvalidSignature = Class.new(StandardError)
+  InvalidMessage = Class.new(StandardError)
+
+  def initialize(secret, cipher: "aes-256-cbc", digest: "SHA256", separator: "--")
+    @cipher = cipher
+    @digest = digest
+    @separator = separator
+    @encrypt_secret = hmac(secret, "encryption key")
+    @sign_secret = hmac(secret, "signin key")
+  end
+
+  def encrypt(message)
+    return sign(_encrypt(message))
+  end
+
+  def decrypt(message)
+    ciphertext = verify(message)
+
+    if ciphertext
+      return _decrypt(ciphertext)
+    end
+  end
+
+  private
+
+  def hmac(secret, message)
+    return OpenSSL::HMAC.hexdigest(@digest, secret, message)
+  end
+
+  def _encrypt(message)
+    cipher = OpenSSL::Cipher.new(@cipher)
+    cipher.encrypt
+    cipher.key = @encrypt_secret
+
+    iv = cipher.random_iv
+    ciphertext = cipher.update(message)
+    ciphertext << cipher.final
+
+    return [ciphertext, iv].join(@separator)
+  end
+
+  def _decrypt(encrypted)
+    ciphertext, iv = encrypted.split(@separator)
+
+    decipher = OpenSSL::Cipher.new(@cipher)
+    decipher.decrypt
+    decipher.key = @encrypt_secret
+    decipher.iv = iv
+
+    decrypted = decipher.update(ciphertext)
+    decrypted << decipher.final
+
+    return decrypted
+  rescue OpenSSL::Cipher::CipherError
+    raise InvalidMessage
+  end
+
+  def sign(value)
+    encoded = Base64.strict_encode64(value)
+    signature = authenticate(encoded)
+
+    return [encoded, signature].join(@separator)
+  end
+
+  def authenticate(message)
+    return hmac(@sign_secret, message)
+  end
+
+  def verify(message)
+    value, signature = message.split(@separator)
+
+    if value && signature && secure_compare(signature, authenticate(value))
+      return Base64.strict_decode64(value)
+    else
+      raise InvalidSignature
+    end
+  end
+
+  # Prevents timing attacks: http://codahale.com/a-lesson-in-timing-attacks/.
+  def secure_compare(a, b)
+    return false unless a.bytesize == b.bytesize
+
+    cmp = b.bytes
+    result = 0
+
+    a.bytes.each_with_index do |char, index|
+      result |= char ^ cmp[index]
+    end
+
+    return result == 0
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest test/*.rb

data/test/krypter.rb

@@ -0,0 +1,73 @@
+require "cutest"
+require "securerandom"
+require_relative "../lib/krypter"
+
+setup do
+  Krypter.new(SecureRandom.hex(32))
+end
+
+test "encrypts and decrypts" do |encryptor|
+  encrypted = encryptor.encrypt("message")
+  decrypted = encryptor.decrypt(encrypted)
+
+  assert_equal("message", decrypted)
+end
+
+test "encrypt returns different ciphertexts" do |encryptor|
+  encrypted1 = encryptor.encrypt("message")
+  encrypted2 = encryptor.encrypt("message")
+
+  assert encrypted1 != encrypted2
+end
+
+test "wrong signature" do |encryptor|
+  encrypted = encryptor.encrypt("message")
+  separator = encryptor.instance_variable_get(:@separator)
+  ciphertext, signature = encrypted.split(separator)
+
+  message = [signature, ciphertext] * separator
+  assert_raise(Krypter::InvalidSignature) do
+    encryptor.decrypt(message)
+  end
+
+  message = [ciphertext, signature.reverse] * separator
+  assert_raise(Krypter::InvalidSignature) do
+    encryptor.decrypt(message)
+  end
+
+  message = [ciphertext.reverse, signature] * separator
+  assert_raise(Krypter::InvalidSignature) do
+    encryptor.decrypt(message)
+  end
+
+  message = [ciphertext.reverse, signature.reverse] * separator
+  assert_raise(Krypter::InvalidSignature) do
+    encryptor.decrypt(message)
+  end
+end
+
+test "tampered data" do |encryptor|
+  encrypted = encryptor.encrypt("message")
+  separator = encryptor.instance_variable_get(:@separator)
+  ciphertext, iv = encryptor.send(:verify, encrypted).split(separator)
+
+  message = encryptor.send(:sign, [iv, ciphertext] * separator)
+  assert_raise(Krypter::InvalidMessage) do
+    encryptor.decrypt(message)
+  end
+
+  message = encryptor.send(:sign, [ciphertext, iv.reverse] * separator)
+  assert_raise(Krypter::InvalidMessage) do
+    encryptor.decrypt(message)
+  end
+
+  message = encryptor.send(:sign, [ciphertext.reverse, iv] * separator)
+  assert_raise(Krypter::InvalidMessage) do
+    encryptor.decrypt(message)
+  end
+
+  message = encryptor.send(:sign, [ciphertext.reverse, iv.reverse] * separator)
+  assert_raise(Krypter::InvalidMessage) do
+    encryptor.decrypt(message)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: krypter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francesco Rodríguez
+- Mayn Kjær
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Encrypts and signs messages.
+email:
+- frodsan@me.com
+- mayn.kjaer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- LICENSE
+- README.md
+- krypter.gemspec
+- lib/krypter.rb
+- makefile
+- test/krypter.rb
+homepage: https://github.com/harmoni-io/krypter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Encrypts and signs messages.
+test_files: []