summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 97dd3e556b158353d5fe2f483635430d05a5e36f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# OpenSSL

[![Build Status](https://travis-ci.org/ruby/openssl.svg?branch=master)](https://travis-ci.org/ruby/openssl)

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

## Installation

The openssl gem is available at [rubygems.org](https://rubygems.org/gems/openssl).
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
```

## Usage

After you install it, you can require "openssl" in your application.

```ruby
require "openssl"
```

If you are using Ruby 2.3, you may need to tell RubyGems to prefer the gem
version of openssl.

```ruby
gem "openssl"
require "openssl"
```

See the documentation on OpenSSL for more usage,
and the official [OpenSSL library](http://www.openssl.org/).

## Getting Started

1. `$ gem install rake-compiler test-unit`
2. `$ rake compile`
3. `$ rake test`

## Contributing

Please read CONTRIBURING.md for instructions.

## Security

Security issues should be reported following the process described in the
[Security page on ruby-lang.org](https://www.ruby-lang.org/en/security/).