cryptor 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5fd951f1826bc584bac34d75f61ed7a75af3875
-  data.tar.gz: e89c7a58275dac153b47b2201fecee4194f0ad72
+  metadata.gz: 3e5e25d2bdd2ae21fb0c12e6874159107d3a0ca4
+  data.tar.gz: f088237f4bc084eddca999e037b4df858155ff78
 SHA512:
-  metadata.gz: fde5ba8749bc1c6fa79ff27a5e8e3fcc733abfd8d164afbdd7cca3984371ce18f1a6e6d372f7c4080dd1e9945366d0d69f960fd835e8e87f1d03f34f6a85f69d
-  data.tar.gz: 26c0c7f57afb309c8d993121e7d2d680f0edfd5b7c4485daed7024d7445186741637e85d7958334bfa97ddab2b5e70c7982049899f10ae8107bcd2e4e88459d8
+  metadata.gz: 87b64b2fe164d3b419f3248b1fbf2828ede7db5bc88f533ea51ad686694d25ce77d4216fe197d4ade5f017e3cdbae53d7f0473d3f6d8f8ab8b0c2e35b15d5a50
+  data.tar.gz: b335aaa66ad842c41b49e7a35b0c72466e9aee2ca9a43b638030f2cdf59660b4d626c29e16e7b49e2737a14781aaad73f5207f136999cbb76a98ec83de03419b

data/CHANGES.md

@@ -1,3 +1,7 @@
+1.1.0 (2014-06-18)
+------------------
+* Add Cryptor::EncryptedAttribute module
+
 1.0.0 (2014-06-14)
 ------------------
 * Key rotation support

data/README.md

@@ -9,8 +9,8 @@ Cryptor
 A safe Ruby encryption library, designed to support features like multiple
 active encryption keys and key rotation.
 
-Cryptor uses [authenticated encryption] *exclusively*, ensuring your data
-remains untamered with, even when it's in the hands of an attacker.
+Cryptor utilizes [authenticated encryption], which ensures the confidentiality,
+integrity, and authenticity of data while still providing a simple API.
 
 Cryptor supports two backends:
 
@@ -23,11 +23,15 @@ Cryptor uses the experimental [ORDO v0 message format][ordo] for serializing
 encrypted messages. Future versions may support additional message formats
 like OpenPGP or JWE.
 
+Need help with Cryptor? Join the [RbNaCl Google Group][group].
+We're also on IRC at #cryptosphere on irc.freenode.net
+
 [authenticated encryption]: https://en.wikipedia.org/wiki/Authenticated_encryption
 [RbNaCl::SimpleBox]: https://github.com/cryptosphere/rbnacl/wiki/SimpleBox
 [libsodium]: https://github.com/jedisct1/libsodium/
 [ActiveSupport::MessageEncryptor]: http://api.rubyonrails.org/classes/ActiveSupport/MessageEncryptor.html
 [ordo]: https://github.com/cryptosphere/ordo/wiki/Message-Format
+[group]: http://groups.google.com/group/rbnacl
 
 ## Installation
 

data/lib/cryptor.rb

@@ -1,6 +1,7 @@
 require 'cryptor/version'
 
 require 'cryptor/encoding'
+require 'cryptor/encrypted_attribute'
 require 'cryptor/symmetric_encryption'
 
 # Multi-backend high-level encryption library

data/lib/cryptor/encrypted_attribute.rb

@@ -0,0 +1,18 @@
+module Cryptor
+  # Support for the attr_encrypted encryptor API
+  module EncryptedAttribute
+    module_function
+
+    def symmetric_encrypt(options)
+      symmetric_cryptor(options).encrypt(options[:value])
+    end
+
+    def symmetric_decrypt(options)
+      symmetric_cryptor(options).decrypt(options[:value])
+    end
+
+    def symmetric_cryptor(options)
+      Cryptor::SymmetricEncryption.new(options[:key], keyring: options[:keyring])
+    end
+  end
+end

data/lib/cryptor/version.rb

@@ -1,4 +1,4 @@
 # An easy-to-use library for real-world Ruby cryptography
 module Cryptor
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/cryptor/encrypted_attribute_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+# "Default" cipher used in non-backend specific tests
+require 'cryptor/symmetric_encryption/ciphers/xsalsa20poly1305'
+
+RSpec.describe Cryptor::EncryptedAttribute do
+  let(:plaintext)  { 'THE MAGIC WORDS ARE SQUEAMISH OSSIFRAGE' }
+  let(:secret_key) { Cryptor::SymmetricEncryption.random_key(:xsalsa20poly1305) }
+
+  context 'symmetric encryption' do
+    it 'encrypts and decrypts' do
+      ciphertext = described_class.symmetric_encrypt(key: secret_key, value: plaintext)
+      expect(described_class.symmetric_decrypt(key: secret_key, value: ciphertext)).to eq plaintext
+    end
+  end
+end

data/spec/cryptor/symmetric_encryption/secret_key_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Cryptor::SymmetricEncryption::SecretKey do
+RSpec.describe Cryptor::SymmetricEncryption::SecretKey do
   let(:algorithm)  { :BassOmatic }
   let(:key_bytes)  { 42 }
   let(:cipher)     { Cryptor::SymmetricEncryption::Cipher.new(algorithm, key_bytes: key_bytes) }

data/spec/{symmetric_encryption_spec.rb → cryptor/symmetric_encryption_spec.rb}

@@ -3,7 +3,7 @@ require 'spec_helper'
 # "Default" cipher used in non-backend specific tests
 require 'cryptor/symmetric_encryption/ciphers/xsalsa20poly1305'
 
-describe Cryptor::SymmetricEncryption do
+RSpec.describe Cryptor::SymmetricEncryption do
   let(:plaintext) { 'THE MAGIC WORDS ARE SQUEAMISH OSSIFRAGE' }
 
   let(:garbage) do

data/spec/spec_helper.rb

@@ -4,3 +4,14 @@ Coveralls.wear!
 
 require 'bundler/setup'
 require 'cryptor'
+
+RSpec.configure do |c|
+  # Setting this config option `false` removes rspec-core's monkey patching of the
+  # top level methods like `describe`, `shared_examples_for` and `shared_context`
+  # on `main` and `Module`. The methods are always available through the `RSpec`
+  # module like `RSpec.describe` regardless of this setting.
+  # For backwards compatibility this defaults to `true`.
+  #
+  # https://relishapp.com/rspec/rspec-core/v/3-0/docs/configuration/global-namespace-dsl
+  c.expose_dsl_globally = false
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-14 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ordo
@@ -116,6 +116,7 @@ files:
 - cryptosaur.png
 - lib/cryptor.rb
 - lib/cryptor/encoding.rb
+- lib/cryptor/encrypted_attribute.rb
 - lib/cryptor/symmetric_encryption.rb
 - lib/cryptor/symmetric_encryption/cipher.rb
 - lib/cryptor/symmetric_encryption/ciphers/message_encryptor.rb
@@ -123,9 +124,10 @@ files:
 - lib/cryptor/symmetric_encryption/keyring.rb
 - lib/cryptor/symmetric_encryption/secret_key.rb
 - lib/cryptor/version.rb
+- spec/cryptor/encrypted_attribute_spec.rb
 - spec/cryptor/symmetric_encryption/secret_key_spec.rb
+- spec/cryptor/symmetric_encryption_spec.rb
 - spec/spec_helper.rb
-- spec/symmetric_encryption_spec.rb
 - tasks/rspec.rake
 - tasks/rubocop.rake
 homepage: https://github.com/cryptosphere/cryptor
@@ -153,6 +155,7 @@ signing_key:
 specification_version: 4
 summary: An easy-to-use library for real-world Ruby cryptography
 test_files:
+- spec/cryptor/encrypted_attribute_spec.rb
 - spec/cryptor/symmetric_encryption/secret_key_spec.rb
+- spec/cryptor/symmetric_encryption_spec.rb
 - spec/spec_helper.rb
-- spec/symmetric_encryption_spec.rb