polarssl 0.0.2

data/COPYING.LESSER

@@ -0,0 +1,171 @@
+*Please note*:
+PolarSSL itself is released as GPL or a Commercial License.
+You will need to take this into account when using PolarSSL and this Ruby extension in your
+own software.
+
+======
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem "rake-compiler"
+gem "sdoc", require: false

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.8.0)
+    rake (10.0.4)
+    rake-compiler (0.9.1)
+      rake
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sdoc (0.3.20)
+      json (>= 1.1.3)
+      rdoc (~> 3.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rake-compiler
+  sdoc

data/RDOC_MAIN.rdoc

@@ -0,0 +1,33 @@
+= Using PolarSSL
+
+== Setting up an SSL Connection
+
+  require 'polarssl'
+
+  socket = TCPSocket.new('polarssl.org', 443)
+
+  entropy = PolarSSL::Entropy.new
+  ctr_drbg = PolarSSL::CtrDrbg.new(entropy)
+  ssl = PolarSSL::SSL.new
+
+  ssl.set_endpoint(PolarSSL::SSL::SSL_IS_CLIENT)
+  ssl.set_authmode(PolarSSL::SSL::SSL_VERIFY_NONE)
+  ssl.set_rng(ctr_drbg)
+
+  ssl.set_socket(socket)
+
+  ssl.handshake
+
+  ssl.write("GET / HTTP/1.0\r\nHost: polarssl.org\r\n\r\n")
+
+  while chunk = ssl.read(1024)
+    response << chunk
+  end
+
+  puts response
+
+  ssl.close_notify
+
+  socket.close
+
+  ssl.close

data/README.md

@@ -0,0 +1,111 @@
+PolarSSL for Ruby
+=================
+
+* API documentation: http://michiels.github.io/polarssl-ruby/doc
+
+## Description
+
+With PolarSSL for Ruby, you can use SSL and cryptography functionality from PolarSSL in your Ruby programs.
+
+## Features
+
+* Set up encrypted SSL connections.
+
+## Installation
+
+```
+gem install polarssl
+```
+
+## Usage
+
+This gem provides a pretty low level interface to the native PolarSSL C library.
+The core API aims to reflect the PolarSSL library as much as possible. See the
+[full API documentation](http://michiels.github.io/polarssl-ruby/doc/) for all classes and methods.
+
+```ruby
+require 'polarssl'
+
+socket = TCPSocket.new('polarssl', 443)
+
+entropy = PolarSSL::Entropy.new
+ctr_drbg = PolarSSL::CtrDrbg.new(entropy)
+
+ssl = PolarSSL::SSL.new
+ssl.set_endpoint(PolarSSL::SSL::SSL_IS_CLIENT)
+ssl.set_authmode(PolarSSL::SSL::SSL_VERIFY_NONE)
+ssl.set_rng(ctr_drbg)
+ssl.set_socket(socket)
+
+ssl.handshake
+
+ssl.write("GET / HTTP/1.0\r\nHost: polarssl.org\r\n\r\n")
+
+while chunk = ssl.read(1024)
+  response << chunk
+end
+
+puts response
+
+ssl.close_notify
+
+socket.close
+
+ssl.close
+```
+
+## Contributing
+
+Install PolarSSL from source via https://polarssl.org/download or install it using your operating system. For example:
+
+On Ubuntu:
+
+```
+sudo apt-get install libpolarssl-dev
+```
+
+On Mac OS X with [Homebrew](http://mxcl.github.io/homebrew/):
+
+```
+brew install polarssl
+```
+
+The following steps and commands are followed during development:
+
+1. A branch is created.
+2. Tests are created in `test/` before code is written and ran with `rake test`. This rake task takes care of compiling the binary and executing the tests.
+3. Code is written.
+4. A pull request is created.
+5. CI runs and verifies passing tests of the Pull Request.
+6. The pull request is merged in.
+7. Repeat.
+
+Tools used when developing:
+
+* Travis CI (http://travis-ci.org)
+* MiniTest (built into Ruby 1.9 or newer)
+* GitHub
+
+## License
+
+*Please note*: PolarSSL itself is released as GPL or a Commercial License.
+You will need to take this into account when using PolarSSL and this Ruby extension in your
+own software.
+
+```
+polar-ssl-ruby - A Ruby extension for using PolarSSL.
+Copyright (C) 2013  Michiel Sikkes
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+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/Rakefile

@@ -0,0 +1,37 @@
+require 'rake/testtask'
+require 'rake/extensiontask'
+require 'rake/clean'
+require 'sdoc'
+
+NAME = "polarssl"
+DLEXT = RbConfig::CONFIG['DLEXT']
+
+CLEAN.include("ext/**/*{.o,.log,.#{DLEXT}}")
+CLEAN.include("ext/**/Makefile")
+CLEAN.include("doc/**")
+CLOBBER.include("lib/**/*.#{DLEXT}")
+
+Rake::TestTask.new do |t|
+  t.libs << "polarssl"
+  t.pattern = "test/*_test.rb"
+end
+
+task test: :compile
+
+RDOC_FILES = FileList["RDOC_MAIN.rdoc", "ext/polarssl/*.c", "lib/**/*.rb"]
+
+RDoc::Task.new do |rd|
+  rd.rdoc_dir = "doc"
+  rd.main = "RDOC_MAIN.rdoc"
+  rd.title = "PolarSSL Ruby API"
+  rd.rdoc_files.include(RDOC_FILES)
+  rd.options << '-e' << 'UTF-8'
+  rd.options << '-f' << 'sdoc'
+  rd.options << '-T' << 'sdoc'
+end
+
+Rake::ExtensionTask.new "polarssl" do |ext|
+  ext.lib_dir = "lib/polarssl"
+end
+
+task default: :test

data/ext/polarssl/ctr_drbg.c

@@ -0,0 +1,80 @@
+/*
+ *  Wrapping code for the PolarSSL::CtrDrbg class.
+ *
+ *  Copyright (C) 2013  Michiel Sikkes
+ *
+ *  This file is part of polarssl-ruby (http://github.com/michiels/polarssl-ruby)
+ *
+ *  All rights reserved.
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Lesser General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  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/>.
+ */
+
+#include "polarssl.h"
+#include "polarssl/ctr_drbg.h"
+#include "polarssl/entropy.h"
+
+static VALUE e_EntropySourceFailed;
+
+static VALUE R_ctr_drbg_allocate();
+static VALUE R_ctr_drbg_initialize();
+static VALUE R_ctr_drbg_self_test();
+
+void Init_ctr_drbg()
+{
+  VALUE cCtrDrbg = rb_define_class_under( rb_mPolarSSL, "CtrDrbg", rb_cObject );
+
+  rb_define_singleton_method( cCtrDrbg, "self_test", R_ctr_drbg_self_test, 0 );
+
+  rb_define_alloc_func( cCtrDrbg, R_ctr_drbg_allocate );
+  rb_define_method( cCtrDrbg, "initialize", R_ctr_drbg_initialize, 1 );
+}
+
+static VALUE R_ctr_drbg_allocate( VALUE klass )
+{
+  ctr_drbg_context *ctr_drbg;
+
+  return Data_Make_Struct( klass, ctr_drbg_context, 0, -1, ctr_drbg );
+}
+
+static VALUE R_ctr_drbg_initialize( VALUE self, VALUE entropy )
+{
+  entropy_context *entropy_p;
+  ctr_drbg_context *ctr_drbg;
+  int ret;
+
+  Data_Get_Struct( self, ctr_drbg_context, ctr_drbg );
+  Data_Get_Struct( entropy, entropy_context, entropy_p );
+
+  ret = ctr_drbg_init( ctr_drbg, entropy_func, entropy_p, NULL, 0 );
+
+  if( ret == POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED )
+    rb_raise( e_EntropySourceFailed, "Could not initialize entropy source" );
+
+  return self;
+}
+
+static VALUE R_ctr_drbg_self_test( VALUE klass )
+{
+  VALUE ret;
+
+  if ( ctr_drbg_self_test( 1 ) == 0 )
+  {
+    ret = Qtrue;
+  } else {
+    ret = Qfalse;
+  }
+
+  return ret;
+}