- API documentation: http://michiels.github.io/polarssl-ruby/doc
- RubyGems.org: http://rubygems.org/gems/polarssl
PolarSSL/mbed TLS version | Gem version |
---|---|
<= 1.2.x | 0.0.7 |
>= 1.3.0 and < 1.3.10 | 1.0.1 |
>= 1.3.10 | 1.0.2 |
With PolarSSL for Ruby, you can use SSL and cryptography functionality from PolarSSL in your Ruby programs.
- Encrypt/decrypt data.
- Set up encrypted SSL connections.
PolarSSL is cryptographically signed. To be sure the gem you install hasn't been tampered with:
Add my public key as a trusted certificate:
gem cert --add <(curl -Ls https://raw.github.com/michiels/polarssl-ruby/master/certs/michiels.pem)
Then install the gem:
gem install polarssl -P HighSecurity
The -P HighSecurity
will verify signed gems.
Or in your Gemfile:
gem "polarssl", "~> 1.0.2"
And install using:
bundle install --trust-policy HighSecurity
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 for all classes and methods.
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
The PolarSSL::Cipher
class lets you encrypt data with a wide range of
encryption standards like AES, Blowfish and DES.
This sample encrypts a given plaintext with AES128 in CTR mode:
require 'polarssl'
require 'base64'
cipher = PolarSSL::Cipher.new("AES-128-CTR")
my_iv = SecureRandom.random_bytes(16)
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
encoded_encrypted_data = Base64.encode64(encrypted_data)
encoded_iv = Base64.encode64(my_iv)
See the documentation for the Cipher
class in the API documentation
for all the available options.
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:
brew install polarssl
The following steps and commands are followed during development:
- A branch is created.
- Tests are created in
test/
before code is written and ran withrake test
. This rake task takes care of compiling the binary and executing the tests. - Code is written.
- A pull request is created.
- CI runs and verifies passing tests of the Pull Request.
- The pull request is merged in.
- Repeat.
Tools used when developing:
- Travis CI (http://travis-ci.org)
- MiniTest (built into Ruby 1.9 or newer)
- GitHub
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/>.