blob: 1e172945c60eb7417c56096b4d83c27ad7c45717 (
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# OpenSSL
[](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
```
Alternatively, you can install the gem with `bundler`:
```ruby
# 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.
```ruby
require "openssl"
```
If you are using Ruby 2.3 (and not Bundler), you must activate the gem version
of openssl, instead of using the default gem packaged with the Ruby installation.
```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 our [CONTRIBURING.md] for instructions.
## Security
Security issues should be reported to ruby-core by following the process
described on ["Security at ruby-lang.org"](https://www.ruby-lang.org/en/security/).
[CONTRIBURING.md]: https://github.com/ruby/openssl/tree/master/CONTRIBURING.md
|
