OpenSSL for Ruby

OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the OpenSSL library.

Installation

The openssl gem is available at rubygems.org. You can install with:

gem install openssl

You may need to specify the path where OpenSSL is installed.

gem install openssl -- --with-openssl-dir=/opt/openssl

Alternatively, you can install the gem with bundler:

# Gemfile
gem 'openssl'
# or specify git master
gem 'openssl', github: 'ruby/openssl'

After doing bundle install, you should have the gem installed in your bundle.

Usage

Once installed, you can require “openssl” in your application.

require "openssl"

NOTE: If you are using Ruby 2.3 (and not Bundler), you must activate the gem version of openssl, otherwise the default gem packaged with the Ruby installation will be used:

gem "openssl"
require "openssl"

Documentation

See ruby.github.io/openssl/.

Contributing

Please read our CONTRIBUTING.md for instructions.

Security

Security issues should be reported to ruby-core by following the process described on “Security at ruby-lang.org”.