blob: a23135ee4183800ca63369aa4d4921c4ce623d7d (
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
|
# OpenSSL for Ruby
[](https://github.com/ruby/openssl/actions?workflow=CI)
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', git: 'https://github.com/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"
```
**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:
```ruby
gem "openssl"
require "openssl"
```
## Documentation
See https://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"](https://www.ruby-lang.org/en/security/).
[CONTRIBUTING.md]: https://github.com/ruby/openssl/tree/master/CONTRIBUTING.md
|
