polarssl 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3aefd27c4837aa5c16a20f4fdb9ccdf861bca42
-  data.tar.gz: d906ff3c64af979f00c88477a6e692d74c7a8f55
+  metadata.gz: 1fd9d49d8ac891f5554252d42b1de6c9f1b4c4e5
+  data.tar.gz: f6fea6507b3f0614b6bbe33bf3b620a72fb21390
 SHA512:
-  metadata.gz: c7e47febacb18ce4c6e987abb07ff411492e015f5fe5d781147573ca1d89101582cc6cb0c46e60377ee88007b4427a449da95f6b6afee22ab7374655655dc259
-  data.tar.gz: 57b9a7d1ed9d4e33483e597bf6fc527d9952e4c65599c742da462aceb2d6120e77b795dcc885c0ccc8ceb3f811baaacf9e102d6099f97af1c06090ec5c546bdc
+  metadata.gz: 6ed864224bc4bf545953f0bc5076f8f668ef74151755d70410879e0b85d6e9ddc1c32fab951c8411da0a9027c5b97e5ccb7e2f0112bad383de7af71d09584306
+  data.tar.gz: 8333074c510c02044f704563c2b4ea9999d4cb228ba74218bc888cc32c54e9ddfdd1d4b684b7311a1faab0b8f5b9e3e326c3ed5d58e9755fc5c1dfc8b6755b55

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p195
+2.1.2

data/.travis.yml

@@ -1,8 +1,18 @@
 before_install:
   - sudo apt-get update -qq
-  - sudo apt-get install -qq libpolarssl-dev
+
+install:
+  - bundle install
+  - wget https://polarssl.org/download/polarssl-1.3.9-gpl.tgz 
+  - tar -xzvf polarssl-1.3.9-gpl.tgz
+  - cd polarssl-1.3.9 && cmake -D USE_SHARED_POLARSSL_LIBRARY:BOOL=ON . && make && sudo make install
 
 language: ruby
+
 rvm:
-  - "2.0.0"
-  - "1.9.3"
+  - 2.0.0
+  - 1.9.3
+
+notifications:
+  slack:
+    secure: gnM7a3r5oNA/O/+2NXDB6akdyRlio3RP0v0HCi3+/zOuph03JAWVE8u321vkDYdDUhOzWKA37FH3buUwULKjl3TBGto5DFDHh4BCT7jJyt2cLC2cZzC8Q5NZYDTUwXFlJnbWI81yZuTAG80MSrhQLRi7wZyZjWmWCQXbwIk179I=

data/README.md

@@ -4,12 +4,26 @@ PolarSSL for Ruby
 * API documentation: http://michiels.github.io/polarssl-ruby/doc
 * RubyGems.org: http://rubygems.org/gems/polarssl
 
+<table>
+  <tr>
+    <th>PolarSSL version</th>
+    <th>Gem version</th>
+  </tr>
+  <tr>
+    <td>&lt;= 1.2.x</td><td>0.0.7</td>
+  </tr>
+  <tr>
+    <td>&gt;= 1.3.x</td><td>1.x.x</td>
+  </tr>
+</table>
+
 ## Description
 
 With PolarSSL for Ruby, you can use SSL and cryptography functionality from PolarSSL in your Ruby programs.
 
 ## Features
 
+* Encrypt/decrypt data.
 * Set up encrypted SSL connections.
 
 ## Installation
@@ -18,6 +32,12 @@ With PolarSSL for Ruby, you can use SSL and cryptography functionality from Pola
 gem install polarssl
 ```
 
+Or in your Gemfile:
+
+```
+gem "polarssl", "~> 1.0.0"
+```
+
 ## Usage
 
 ### Setting up a SSL connection
@@ -72,7 +92,7 @@ cipher = PolarSSL::Cipher.new("AES-128-CTR")
 
 my_iv = SecureRandom.random_bytes(16)
 
-cipher.reset(my_iv)
+cipher.set_iv(my_iv, 16)
 cipher.setkey("my16bytekey23456", 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
 cipher.update("some secret message I want to keep")
 encrypted_data = cipher.finish
@@ -81,7 +101,7 @@ encoded_encrypted_data = Base64.encode64(encrypted_data)
 encoded_iv = Base64.encode64(my_iv)
 ```
 
-See the documentation for the `Cipher` class in the [API documentation](http://michiels.github.io/polarssl-ruby/doc) 
+See the documentation for the `Cipher` class in the [API documentation](http://michiels.github.io/polarssl-ruby/doc)
 for all the available options.
 
 ## Contributing
@@ -138,4 +158,4 @@ GNU Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-```
+```

data/ext/polarssl/cipher.c

@@ -30,6 +30,7 @@ VALUE rb_cipher_initialize();
 VALUE rb_cipher_setkey();
 VALUE rb_cipher_update();
 VALUE rb_cipher_finish();
+VALUE rb_cipher_set_iv();
 VALUE rb_cipher_reset();
 void  rb_cipher_free();
 
@@ -59,7 +60,7 @@ void Init_cipher(void)
       *   my_iv = SecureRandom.random_bytes(16)
       *
       *   cipher = PolarSSL::Cipher.new("AES-128-CTR")
-      *   cipher.reset(my_iv)
+      *   cipher.set_iv(my_iv, 16)
       *   cipher.setkey("mykey", 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
       *   cipher.update("secret stuff I want encrypted")
       *   encrypted_data = cipher.finish()
@@ -148,7 +149,8 @@ void Init_cipher(void)
     rb_define_method( cCipher, "setkey", rb_cipher_setkey, 3 );
     rb_define_method( cCipher, "update", rb_cipher_update, 1 );
     rb_define_method( cCipher, "finish", rb_cipher_finish, 0 );
-    rb_define_method( cCipher, "reset", rb_cipher_reset, 1 );
+    rb_define_method( cCipher, "set_iv", rb_cipher_set_iv, 2 );
+    rb_define_method( cCipher, "reset", rb_cipher_reset, 0 );
 }
 
 VALUE rb_cipher_allocate( VALUE klass )
@@ -170,7 +172,11 @@ VALUE rb_cipher_allocate( VALUE klass )
 /*
  *  call-seq: new(cipher_type)
  *
- *  Initializes a new Cipher object to encrypt data with. For supported cipher types,
+ *  Initializes a new Cipher object to encrypt data with.
+ *
+ *    cipher = PolarSSL::Cipher.new('AES-128-CTR')
+ *
+ *  For supported cipher types,
  *  see: https://github.com/michiels/polarssl-ruby/wiki/Using-PolarSSL::Cipher
  *
  */
@@ -204,35 +210,55 @@ VALUE rb_cipher_initialize( VALUE self, VALUE cipher_type )
 }
 
 /*
- *  call-seq: reset(initialization_vector)
+ *  call-seq: set_iv(iv_val, iv_len_val)
  *
- *  Sets or resets the initialization vector for the cipher. An initialization
+ *  Sets the initialization vector for the cipher. An initialization
  *  vector is used to "randomize" the output ciphertext so attackers cannot
  *  guess your data based on a partially decrypted data.
  *
- *  This method needs to be called before you run the first #update.
+ *    cipher.set_iv("16byteiv12345678", 16)
  *
  *  One option to generate a random initialization vector is by using
  *  SecureRandom.random_bytes. Store this initialization vector with the
  *  ciphertext and you'll easily able to decrypt the ciphertext.
  *
  */
-VALUE rb_cipher_reset( VALUE self, VALUE initialization_vector )
+VALUE rb_cipher_set_iv( VALUE self, VALUE iv_val, VALUE iv_len_val )
 {
+    int ret = 0;
     rb_cipher_t *rb_cipher;
     unsigned char *iv;
-    int ret;
+    size_t iv_len;
 
-    Check_Type( initialization_vector, T_STRING );
+    Data_Get_Struct( self, rb_cipher_t, rb_cipher );
+    Check_Type( iv_val, T_STRING );
+    iv = (unsigned char *) StringValuePtr( iv_val );
+    Check_Type( iv_len_val, T_FIXNUM );
+    iv_len = FIX2INT( iv_len_val );
 
-    iv = (unsigned char *) StringValuePtr( initialization_vector );
+    if ( ( ret = cipher_set_iv( rb_cipher->ctx, iv, iv_len ) ) != 0 )
+        rb_raise( e_CipherError, "Failed to set IV. PolarSSL error: -0x%x", -ret );
 
-    Data_Get_Struct( self, rb_cipher_t, rb_cipher );
+    return Qtrue;
+}
 
-    ret = cipher_reset( rb_cipher->ctx, iv );
+/*
+ *  call-seq: reset
+ *
+ *  Reset the cipher context and buffers.
+ *
+ *  cipher.reset()
+ *
+ */
+VALUE rb_cipher_reset( VALUE self )
+{
+    int ret;
+    rb_cipher_t *rb_cipher;
 
-    if ( ret < 0 )
-        rb_raise( e_BadInputData, "Either the cipher type, key or initialization vector was not set." );
+    Data_Get_Struct( self, rb_cipher_t, rb_cipher );
+
+    if ( ( ret = cipher_reset( rb_cipher->ctx ) ) != 0 )
+        rb_raise( e_CipherError, "Failed to reset cipher. PolarSSL error: -0x%x", -ret );
 
     return Qtrue;
 }
@@ -243,8 +269,7 @@ VALUE rb_cipher_reset( VALUE self, VALUE initialization_vector )
  *  Sets the key to be used for encrypting/decrypting this cipher. The key, key_length and operation
  *  depend on which cipher you are using. For example, when using AES-128-CTR you would use something like:
  *
- *    cipher = PolarSSL::Cipher.new('AES-128-CTR')
- *    cipher.setkey('mykey', 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
+ *    cipher.setkey('my16bytekey12345', 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
  *
  *  for both encryping and decrypting your cipher.
  *
@@ -273,6 +298,8 @@ VALUE rb_cipher_setkey( VALUE self, VALUE key, VALUE key_length, VALUE operation
  *
  *  Adds input to your cipher.
  *
+ *  cipher.update("Some message I want to encrypt")
+ *
  */
 VALUE rb_cipher_update( VALUE self, VALUE rb_input )
 {
@@ -305,6 +332,8 @@ VALUE rb_cipher_update( VALUE self, VALUE rb_input )
  *
  *  Finishes encrypting the data added by one or multiple update() calls and returns the encrypted data.
  *
+ *    encrypted_ciphertext = cipher.finish()
+ *
  */
 VALUE rb_cipher_finish( VALUE self )
 {
@@ -328,4 +357,4 @@ void rb_cipher_free( rb_cipher_t *rb_cipher )
     cipher_free_ctx(rb_cipher->ctx );
 
   xfree( rb_cipher );
-}
+}

data/lib/polarssl/version.rb

@@ -1,5 +1,5 @@
 module PolarSSL
 
-  VERSION = '0.0.7'
+  VERSION = '1.0.0'
 
-end
+end

data/test/cipher_encryption_test.rb

@@ -3,72 +3,38 @@ require 'base64'
 require 'securerandom'
 
 class CipherTest < MiniTest::Unit::TestCase
+  CIPHER = 'AES-128-CTR'
+  VALUE = 'test data value'
+  KEY = 'bar'
 
   def test_aes_128_ctr_encrypt
-    # These are hex-formatted strings that come from NIST Special Publication 800-38A 2001 Edition:
-    # Recommendation for Block Cipher Modes of Operation, Methods and Techniques by Morris Dworkin.
-    key = hex_to_bin("2b7e151628aed2a6abf7158809cf4f3c")
-    iv = hex_to_bin("f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff")
-    input = hex_to_bin("6bc1bee22e409f96e93d7e117393172aae2d8a571e03ac9c9eb76fac45af8e51")
-    should_encrypt_as = hex_to_bin("874d6191b620e3261bef6864990db6ce9806f66b7970fdff8617187bb9fffdff")
-    
-    cipher = PolarSSL::Cipher.new("AES-128-CTR")
-    cipher.setkey(key, 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
-    cipher.reset(iv)
-    cipher.update(input)
+    iv = SecureRandom.random_bytes(16)
+
+    cipher = PolarSSL::Cipher.new CIPHER
+    cipher.setkey KEY, 128, PolarSSL::Cipher::OPERATION_ENCRYPT
+    cipher.set_iv(iv, 16)
+    cipher.update(VALUE)
     encrypted = cipher.finish
 
-    assert_equal should_encrypt_as, encrypted    
-  end
-  
-  def test_aes_128_ctr_decrypt
-    key = hex_to_bin("2b7e151628aed2a6abf7158809cf4f3c")
-    iv = hex_to_bin("f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff")
-    input = hex_to_bin("874d6191b620e3261bef6864990db6ce")
-    should_decrypt_as = hex_to_bin("6bc1bee22e409f96e93d7e117393172a")
-    
-    cipher = PolarSSL::Cipher.new("AES-128-CTR")
-    cipher.setkey(key, 128, PolarSSL::Cipher::OPERATION_ENCRYPT)
-    cipher.reset(iv)
-    cipher.update(input)
+    cipher = PolarSSL::Cipher.new CIPHER
+    cipher.setkey KEY, 128, PolarSSL::Cipher::OPERATION_DECRYPT
+    cipher.set_iv(iv, 16)
+    cipher.update(encrypted)
     decrypted = cipher.finish
-    
-    assert_equal should_decrypt_as, decrypted
+
+    assert_equal VALUE, decrypted
   end
 
   def test_unsupported_cipher
-
     assert_raises PolarSSL::Cipher::UnsupportedCipher do
       PolarSSL::Cipher.new("meh")
     end
-
-  end
-  
-  def test_initialization_vector_not_a_string
-    cipher = PolarSSL::Cipher.new("AES-128-CTR")
-    
-    assert_raises TypeError do
-      cipher.reset(nil)
-    end
   end
 
   def test_unsupported_key
-
     assert_raises PolarSSL::Cipher::Error do
       cipher = PolarSSL::Cipher.new("AES-128-CTR")
       cipher.setkey("1234567890123456", 127, PolarSSL::Cipher::OPERATION_ENCRYPT)
     end
-
   end
-  
-  private
-  
-  def hex_to_bin(hex)
-    hex.scan(/../).map { |x| x.hex.chr }.join
-  end
-  
-  def bin_to_hex(data)
-    data.each_byte.map { |b| b.to_s(16).join }
-  end
-
-end
+end

data/test/test_helper.rb

@@ -1,2 +1,2 @@
 require 'minitest/autorun'
-require 'polarssl'
+require 'polarssl'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polarssl
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Michiel Sikkes
@@ -17,9 +17,9 @@ extensions:
 - ext/polarssl/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - COPYING
 - COPYING.LESSER
 - Gemfile
@@ -48,7 +48,6 @@ files:
 - test/entropy_test.rb
 - test/ssl_connection_test.rb
 - test/test_helper.rb
-- test/verify_minitest_test.rb
 homepage: http://github.com/michiels/polarssl-ruby
 licenses:
 - LGPL-3
@@ -59,18 +58,18 @@ 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:
 - libpolarssl
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Use the PolarSSL cryptographic and SSL library in Ruby.
@@ -79,4 +78,3 @@ test_files:
 - test/ctr_drbg_test.rb
 - test/entropy_test.rb
 - test/ssl_connection_test.rb
-- test/verify_minitest_test.rb

data/test/verify_minitest_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class TestVerifyMiniTest < MiniTest::Unit::TestCase
-
-  def test_truth
-    assert true
-  end
-
-end