puma 5.5.2 → 6.3.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of puma might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/History.md +336 -3
- data/README.md +61 -16
- data/bin/puma-wild +1 -1
- data/docs/architecture.md +4 -4
- data/docs/compile_options.md +34 -0
- data/docs/fork_worker.md +1 -3
- data/docs/nginx.md +1 -1
- data/docs/signals.md +1 -0
- data/docs/systemd.md +1 -2
- data/docs/testing_benchmarks_local_files.md +150 -0
- data/docs/testing_test_rackup_ci_files.md +36 -0
- data/ext/puma_http11/extconf.rb +28 -14
- data/ext/puma_http11/http11_parser.c +1 -1
- data/ext/puma_http11/http11_parser.h +1 -1
- data/ext/puma_http11/http11_parser.java.rl +2 -2
- data/ext/puma_http11/http11_parser.rl +2 -2
- data/ext/puma_http11/http11_parser_common.rl +2 -2
- data/ext/puma_http11/mini_ssl.c +135 -23
- data/ext/puma_http11/org/jruby/puma/Http11.java +3 -3
- data/ext/puma_http11/org/jruby/puma/Http11Parser.java +1 -1
- data/ext/puma_http11/org/jruby/puma/MiniSSL.java +188 -102
- data/ext/puma_http11/puma_http11.c +18 -10
- data/lib/puma/app/status.rb +7 -4
- data/lib/puma/binder.rb +62 -51
- data/lib/puma/cli.rb +19 -20
- data/lib/puma/client.rb +108 -26
- data/lib/puma/cluster/worker.rb +23 -16
- data/lib/puma/cluster/worker_handle.rb +8 -1
- data/lib/puma/cluster.rb +62 -41
- data/lib/puma/commonlogger.rb +21 -14
- data/lib/puma/configuration.rb +76 -55
- data/lib/puma/const.rb +133 -97
- data/lib/puma/control_cli.rb +21 -18
- data/lib/puma/detect.rb +12 -2
- data/lib/puma/dsl.rb +270 -55
- data/lib/puma/error_logger.rb +18 -9
- data/lib/puma/events.rb +6 -126
- data/lib/puma/io_buffer.rb +39 -4
- data/lib/puma/jruby_restart.rb +2 -1
- data/lib/puma/launcher/bundle_pruner.rb +104 -0
- data/lib/puma/launcher.rb +114 -175
- data/lib/puma/log_writer.rb +147 -0
- data/lib/puma/minissl/context_builder.rb +30 -16
- data/lib/puma/minissl.rb +126 -17
- data/lib/puma/null_io.rb +5 -0
- data/lib/puma/plugin/systemd.rb +90 -0
- data/lib/puma/plugin/tmp_restart.rb +1 -1
- data/lib/puma/plugin.rb +1 -1
- data/lib/puma/rack/builder.rb +6 -6
- data/lib/puma/rack_default.rb +19 -4
- data/lib/puma/reactor.rb +19 -10
- data/lib/puma/request.rb +365 -161
- data/lib/puma/runner.rb +55 -22
- data/lib/puma/sd_notify.rb +149 -0
- data/lib/puma/server.rb +91 -94
- data/lib/puma/single.rb +13 -11
- data/lib/puma/state_file.rb +39 -7
- data/lib/puma/thread_pool.rb +25 -21
- data/lib/puma/util.rb +12 -14
- data/lib/puma.rb +12 -11
- data/lib/rack/handler/puma.rb +113 -86
- data/tools/Dockerfile +1 -1
- metadata +11 -6
- data/lib/puma/queue_close.rb +0 -26
- data/lib/puma/systemd.rb +0 -46
data/docs/nginx.md
CHANGED
data/docs/signals.md
CHANGED
@@ -42,6 +42,7 @@ Puma cluster responds to these signals:
|
|
42
42
|
- `INT ` equivalent of sending Ctrl-C to cluster. Puma will attempt to finish then exit.
|
43
43
|
- `CHLD`
|
44
44
|
- `URG ` refork workers in phases from worker 0 if `fork_workers` option is enabled.
|
45
|
+
- `INFO` print backtraces of all puma threads
|
45
46
|
|
46
47
|
## Callbacks order in case of different signals
|
47
48
|
|
data/docs/systemd.md
CHANGED
@@ -24,8 +24,7 @@ After=network.target
|
|
24
24
|
|
25
25
|
[Service]
|
26
26
|
# Puma supports systemd's `Type=notify` and watchdog service
|
27
|
-
# monitoring,
|
28
|
-
# as of Puma 5.1 or later.
|
27
|
+
# monitoring, as of Puma 5.1 or later.
|
29
28
|
# On earlier versions of Puma or JRuby, change this to `Type=simple` and remove
|
30
29
|
# the `WatchdogSec` line.
|
31
30
|
Type=notify
|
@@ -0,0 +1,150 @@
|
|
1
|
+
# Testing - benchmark/local files
|
2
|
+
|
3
|
+
These files generate data that shows request-per-second (RPS), etc. Typically, files are in
|
4
|
+
pairs, a shell script and a Ruby script. The shell script starts the server, then runs the
|
5
|
+
Ruby file, which starts client request stream(s), then collects and logs metrics.
|
6
|
+
|
7
|
+
## response_time_wrk.sh
|
8
|
+
|
9
|
+
This uses [wrk] for generating data. One or more wrk runs are performed. Summarizes RPS and
|
10
|
+
wrk latency times. The default for the `-b` argument runs 28 different client request streams,
|
11
|
+
and takes a bit over 5 minutes. See 'Request Stream Configuration' below for `-b` argument
|
12
|
+
description.
|
13
|
+
|
14
|
+
<details>
|
15
|
+
<summary>Summary output for<br/><code>benchmarks/local/response_time_wrk.sh -w2 -t5:5 -s tcp6</code>:</summary>
|
16
|
+
|
17
|
+
```
|
18
|
+
Type req/sec 50% 75% 90% 99% 100% Resp Size
|
19
|
+
───────────────────────────────────────────────────────────────── 1kB
|
20
|
+
array 13710 0.74 2.52 5.23 7.76 37.45 1024
|
21
|
+
chunk 13502 0.76 2.55 5.28 7.84 11.23 1042
|
22
|
+
string 13794 0.74 2.51 5.20 7.75 14.07 1024
|
23
|
+
io 9615 1.16 3.45 7.13 10.57 15.75 1024
|
24
|
+
───────────────────────────────────────────────────────────────── 10kB
|
25
|
+
array 13458 0.76 2.57 5.31 7.93 13.94 10239
|
26
|
+
chunk 13066 0.78 2.64 5.46 8.18 38.48 10320
|
27
|
+
string 13500 0.76 2.55 5.29 7.88 11.42 10240
|
28
|
+
io 9293 1.18 3.59 7.39 10.94 16.99 10240
|
29
|
+
───────────────────────────────────────────────────────────────── 100kB
|
30
|
+
array 11315 0.96 3.06 6.33 9.49 17.69 102424
|
31
|
+
chunk 9916 1.10 3.48 7.20 10.73 15.14 103075
|
32
|
+
string 10948 1.00 3.17 6.57 9.83 17.88 102378
|
33
|
+
io 8901 1.21 3.72 7.48 11.27 59.98 102407
|
34
|
+
───────────────────────────────────────────────────────────────── 256kB
|
35
|
+
array 9217 1.15 3.82 7.88 11.74 17.12 262212
|
36
|
+
chunk 7339 1.45 4.76 9.81 14.63 22.70 264007
|
37
|
+
string 8574 1.19 3.81 7.73 11.21 15.80 262147
|
38
|
+
io 8911 1.19 3.80 7.55 15.25 60.01 262183
|
39
|
+
───────────────────────────────────────────────────────────────── 512kB
|
40
|
+
array 6951 1.49 5.03 10.28 15.90 25.08 524378
|
41
|
+
chunk 5234 2.03 6.56 13.57 20.46 32.15 527862
|
42
|
+
string 6438 1.55 5.04 10.12 16.28 72.87 524275
|
43
|
+
io 8533 1.15 4.62 8.79 48.15 70.51 524327
|
44
|
+
───────────────────────────────────────────────────────────────── 1024kB
|
45
|
+
array 4122 1.80 15.59 41.87 67.79 121.00 1048565
|
46
|
+
chunk 3158 2.82 15.22 31.00 71.39 99.90 1055654
|
47
|
+
string 4710 2.24 6.66 13.65 20.38 70.44 1048575
|
48
|
+
io 8355 1.23 3.95 7.94 14.08 68.54 1048498
|
49
|
+
───────────────────────────────────────────────────────────────── 2048kB
|
50
|
+
array 2454 4.12 14.02 27.70 43.48 88.89 2097415
|
51
|
+
chunk 1743 6.26 17.65 36.98 55.78 92.10 2111358
|
52
|
+
string 2479 4.38 12.52 25.65 38.44 95.62 2097502
|
53
|
+
io 8264 1.25 3.83 7.76 11.73 65.69 2097090
|
54
|
+
|
55
|
+
Body ────────── req/sec ────────── ─────── req 50% times ───────
|
56
|
+
KB array chunk string io array chunk string io
|
57
|
+
1 13710 13502 13794 9615 0.745 0.757 0.741 1.160
|
58
|
+
10 13458 13066 13500 9293 0.760 0.784 0.759 1.180
|
59
|
+
100 11315 9916 10948 8901 0.960 1.100 1.000 1.210
|
60
|
+
256 9217 7339 8574 8911 1.150 1.450 1.190 1.190
|
61
|
+
512 6951 5234 6438 8533 1.490 2.030 1.550 1.150
|
62
|
+
1024 4122 3158 4710 8355 1.800 2.820 2.240 1.230
|
63
|
+
2048 2454 1743 2479 8264 4.120 6.260 4.380 1.250
|
64
|
+
─────────────────────────────────────────────────────────────────────
|
65
|
+
wrk -t8 -c16 -d10s
|
66
|
+
benchmarks/local/response_time_wrk.sh -w2 -t5:5 -s tcp6 -Y
|
67
|
+
Server cluster mode -w2 -t5:5, bind: tcp6
|
68
|
+
Puma repo branch 00-response-refactor
|
69
|
+
ruby 3.2.0dev (2022-06-14T01:21:55Z master 048f14221c) +YJIT [x86_64-linux]
|
70
|
+
|
71
|
+
[2136] - Gracefully shutting down workers...
|
72
|
+
[2136] === puma shutdown: 2022-06-13 21:16:13 -0500 ===
|
73
|
+
[2136] - Goodbye!
|
74
|
+
|
75
|
+
5:15 Total Time
|
76
|
+
```
|
77
|
+
</details><br/>
|
78
|
+
|
79
|
+
## bench_base.sh, bench_base.rb
|
80
|
+
|
81
|
+
These two files setup parameters for the Puma server, which is normally started in a shell
|
82
|
+
script. It then starts a Ruby file (a subclass of BenchBase), passing arguments to it. The
|
83
|
+
Ruby file is normally used to generate a client request stream(s).
|
84
|
+
|
85
|
+
### Puma Configuration
|
86
|
+
|
87
|
+
The following arguments are used for the Puma server:
|
88
|
+
|
89
|
+
* **`-C`** - configuration file
|
90
|
+
* **`-d`** - app delay
|
91
|
+
* **`-r`** - rackup file, often defaults to test/rackup/ci_select.ru
|
92
|
+
* **`-s`** - bind socket type, default is tcp/tcp4, also tcp6, ssl/ssl4, ssl6, unix, or aunix
|
93
|
+
(unix & abstract unix are not available with wrk).
|
94
|
+
* **`-t`** - threads, expressed as '5:5', same as Puma --thread
|
95
|
+
* **`-w`** - workers, same as Puma --worker
|
96
|
+
* **`-Y`** - enable Ruby YJIT
|
97
|
+
|
98
|
+
### Request Stream Configuration
|
99
|
+
|
100
|
+
The following arguments are used for request streams:
|
101
|
+
|
102
|
+
* **`-b`** - response body configuration. Body type options are a array, c chunked, s string,
|
103
|
+
and i for File/IO. None or any combination can be specified, they should start the option.
|
104
|
+
Then, any combination of comma separated integers can be used for the response body size
|
105
|
+
in kB. The string 'ac50,100' would create four runs, 50kb array, 50kB chunked, 100kB array,
|
106
|
+
and 100kB chunked. See 'Testing - test/rackup/ci-*.ru files' for more info.
|
107
|
+
* **`-c`** - connections per client request stream thread, defaults to 2 for wrk.
|
108
|
+
* **`-D`** - duration of client request stream in seconds.
|
109
|
+
* **`-T`** - number of threads in the client request stream. For wrk, this defaults to
|
110
|
+
80% of Puma workers * max_threads.
|
111
|
+
|
112
|
+
### Notes - Configuration
|
113
|
+
|
114
|
+
The above lists script arguments.
|
115
|
+
|
116
|
+
`bench_base.sh` contains most server defaults. Many can be set via ENV variables.
|
117
|
+
|
118
|
+
`bench_base.rb` contains the client request stream defaults. The default value for
|
119
|
+
`-b` is `acsi1,10,100,256,512,1024,2048`, which is a 4 x 7 matrix, and hence, runs
|
120
|
+
28 jobs. Also, the i body type (File/IO) generates files, they are placed in the
|
121
|
+
`"#{Dir.tmpdir}/.puma_response_body_io"` directory, which is created.
|
122
|
+
|
123
|
+
### Notes - wrk
|
124
|
+
|
125
|
+
The shell scripts use `-T` for wrk's thread count, since `-t` is used for Puma
|
126
|
+
server threads. Regarding the `-c` argument, wrk has an interesting behavior.
|
127
|
+
The total number of connections is set by `(connections/threads).to_i`. The scripts
|
128
|
+
here use `-c` as connections per thread. Hence, using `-T4 -c2` will yield a total
|
129
|
+
of eight wrk connections, two per thread. The equivalent wrk arguments would be `-t4 -c8`.
|
130
|
+
|
131
|
+
Puma can only process so many requests, and requests will queue in the backlog
|
132
|
+
until Puma can respond to them. With wrk, if the number of total connections is
|
133
|
+
too high, one will see the upper latency times increase, pushing into the lower
|
134
|
+
latency times as the connections are increased. The default values for wrk's
|
135
|
+
threads and connections were chosen to minimize requests' time in the backlog.
|
136
|
+
|
137
|
+
An example with four wrk runs using `-b s10`. Notice that `req/sec` varies by
|
138
|
+
less than 1%, but the `75%` times increase by an order of magnitude:
|
139
|
+
```
|
140
|
+
req/sec 50% 75% 90% 99% 100% Resp Size wrk cmd line
|
141
|
+
─────────────────────────────────────────────────────────────────────────────
|
142
|
+
13597 0.755 2.550 5.260 7.800 13.310 12040 wrk -t8 -c16 -d10
|
143
|
+
13549 0.793 4.430 8.140 11.220 16.600 12002 wrk -t10 -c20 -d10
|
144
|
+
13570 1.040 25.790 40.010 49.070 58.300 11982 wrk -t8 -c64 -d10
|
145
|
+
13684 1.050 25.820 40.080 49.160 66.190 12033 wrk -t16 -c64 -d10
|
146
|
+
```
|
147
|
+
Finally, wrk's output may cause rounding errors, so the response body size calculation is
|
148
|
+
imprecise.
|
149
|
+
|
150
|
+
[wrk]: <https://github.com/ioquatix/wrk>
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# Testing - test/rackup/ci-*.ru files
|
2
|
+
|
3
|
+
## Overview
|
4
|
+
|
5
|
+
Puma should efficiently handle a variety of response bodies, varying both by size
|
6
|
+
and by the type of object used for the body.
|
7
|
+
|
8
|
+
Five rackup files are located in 'test/rackup' that can be used. All have their
|
9
|
+
request body size (in kB) set via `Body-Conf` header or with `ENV['CI_BODY_CONF']`.
|
10
|
+
Additionally, the ci_select.ru file can have it's body type set via a starting
|
11
|
+
character.
|
12
|
+
|
13
|
+
* **ci_array.ru** - body is an `Array` of 1kB strings. `Content-Length` is not set.
|
14
|
+
* **ci_chunked.ru** - body is an `Enumerator` of 1kB strings. `Content-Length` is not set.
|
15
|
+
* **ci_io.ru** - body is a File/IO object. `Content-Length` is set.
|
16
|
+
* **ci_string.ru** - body is a single string. `Content-Length` is set.
|
17
|
+
* **ci_select.ru** - can be any of the above.
|
18
|
+
|
19
|
+
All responses have 25 headers, total length approx 1kB. ci_array.ru and ci_chunked.ru
|
20
|
+
contain 1kB items.
|
21
|
+
|
22
|
+
All can be delayed by a float value (seconds) specified by the `Dly` header
|
23
|
+
|
24
|
+
Note that rhe `Body-Conf` header takes precedence, and `ENV['CI_BODY_CONF']` is
|
25
|
+
only read on load.
|
26
|
+
|
27
|
+
## ci_select.ru
|
28
|
+
|
29
|
+
The ci_select.ru file allows a starting character to specify the body type in the
|
30
|
+
`Body-Conf` header or with `ENV['CI_BODY_CONF']`.
|
31
|
+
* **a** - array of strings
|
32
|
+
* **c** - chunked (enum)
|
33
|
+
* **s** - single string
|
34
|
+
* **i** - File/IO
|
35
|
+
|
36
|
+
A value of `a100` would return a body as an array of 100 1kB strings.
|
data/ext/puma_http11/extconf.rb
CHANGED
@@ -2,18 +2,22 @@ require 'mkmf'
|
|
2
2
|
|
3
3
|
dir_config("puma_http11")
|
4
4
|
|
5
|
-
if $mingw
|
5
|
+
if $mingw
|
6
6
|
append_cflags '-fstack-protector-strong -D_FORTIFY_SOURCE=2'
|
7
7
|
append_ldflags '-fstack-protector-strong -l:libssp.a'
|
8
8
|
have_library 'ssp'
|
9
9
|
end
|
10
10
|
|
11
|
-
unless ENV["
|
12
|
-
|
11
|
+
unless ENV["PUMA_DISABLE_SSL"]
|
12
|
+
# don't use pkg_config('openssl') if '--with-openssl-dir' is used
|
13
|
+
has_openssl_dir = dir_config('openssl').any?
|
14
|
+
found_pkg_config = !has_openssl_dir && pkg_config('openssl')
|
13
15
|
|
14
|
-
found_ssl = if
|
16
|
+
found_ssl = if !$mingw && found_pkg_config
|
15
17
|
puts 'using OpenSSL pkgconfig (openssl.pc)'
|
16
18
|
true
|
19
|
+
elsif have_library('libcrypto', 'BIO_read') && have_library('libssl', 'SSL_CTX_new')
|
20
|
+
true
|
17
21
|
elsif %w'crypto libeay32'.find {|crypto| have_library(crypto, 'BIO_read')} &&
|
18
22
|
%w'ssl ssleay32'.find {|ssl| have_library(ssl, 'SSL_CTX_new')}
|
19
23
|
true
|
@@ -26,18 +30,25 @@ unless ENV["DISABLE_SSL"]
|
|
26
30
|
have_header "openssl/bio.h"
|
27
31
|
|
28
32
|
# below is yes for 1.0.2 & later
|
29
|
-
have_func
|
33
|
+
have_func "DTLS_method" , "openssl/ssl.h"
|
34
|
+
have_func "SSL_CTX_set_session_cache_mode(NULL, 0)", "openssl/ssl.h"
|
30
35
|
|
31
36
|
# below are yes for 1.1.0 & later
|
32
|
-
have_func
|
33
|
-
have_func
|
37
|
+
have_func "TLS_server_method" , "openssl/ssl.h"
|
38
|
+
have_func "SSL_CTX_set_min_proto_version(NULL, 0)" , "openssl/ssl.h"
|
39
|
+
|
40
|
+
have_func "X509_STORE_up_ref"
|
41
|
+
have_func "SSL_CTX_set_ecdh_auto(NULL, 0)" , "openssl/ssl.h"
|
42
|
+
|
43
|
+
# below exists in 1.1.0 and later, but isn't documented until 3.0.0
|
44
|
+
have_func "SSL_CTX_set_dh_auto(NULL, 0)" , "openssl/ssl.h"
|
34
45
|
|
35
|
-
|
36
|
-
have_func
|
46
|
+
# below is yes for 3.0.0 & later
|
47
|
+
have_func "SSL_get1_peer_certificate" , "openssl/ssl.h"
|
37
48
|
|
38
49
|
# Random.bytes available in Ruby 2.5 and later, Random::DEFAULT deprecated in 3.0
|
39
50
|
if Random.respond_to?(:bytes)
|
40
|
-
$defs.push
|
51
|
+
$defs.push "-DHAVE_RANDOM_BYTES"
|
41
52
|
puts "checking for Random.bytes... yes"
|
42
53
|
else
|
43
54
|
puts "checking for Random.bytes... no"
|
@@ -45,14 +56,17 @@ unless ENV["DISABLE_SSL"]
|
|
45
56
|
end
|
46
57
|
end
|
47
58
|
|
48
|
-
if ENV["
|
59
|
+
if ENV["PUMA_MAKE_WARNINGS_INTO_ERRORS"]
|
49
60
|
# Make all warnings into errors
|
50
61
|
# Except `implicit-fallthrough` since most failures comes from ragel state machine generated code
|
51
|
-
if respond_to?
|
52
|
-
append_cflags
|
62
|
+
if respond_to?(:append_cflags, true) # Ruby 2.5 and later
|
63
|
+
append_cflags(config_string('WERRORFLAG') || '-Werror')
|
53
64
|
append_cflags '-Wno-implicit-fallthrough'
|
54
65
|
else
|
55
|
-
|
66
|
+
# flag may not exist on some platforms, -Werror may not be defined on some platforms, but
|
67
|
+
# works with all in current CI
|
68
|
+
$CFLAGS << " #{config_string('WERRORFLAG') || '-Werror'}"
|
69
|
+
$CFLAGS << ' -Wno-implicit-fallthrough'
|
56
70
|
end
|
57
71
|
end
|
58
72
|
|
@@ -39,8 +39,8 @@ public class Http11Parser {
|
|
39
39
|
Http11.query_string(runtime, parser.data, parser.buffer, parser.query_start, fpc-parser.query_start);
|
40
40
|
}
|
41
41
|
|
42
|
-
action
|
43
|
-
Http11.
|
42
|
+
action server_protocol {
|
43
|
+
Http11.server_protocol(runtime, parser.data, parser.buffer, parser.mark, fpc-parser.mark);
|
44
44
|
}
|
45
45
|
|
46
46
|
action request_path {
|
@@ -62,8 +62,8 @@ static void snake_upcase_char(char *c)
|
|
62
62
|
parser->query_string(parser, PTR_TO(query_start), LEN(query_start, fpc));
|
63
63
|
}
|
64
64
|
|
65
|
-
action
|
66
|
-
parser->
|
65
|
+
action server_protocol {
|
66
|
+
parser->server_protocol(parser, PTR_TO(mark), LEN(mark, fpc));
|
67
67
|
}
|
68
68
|
|
69
69
|
action request_path {
|
@@ -38,8 +38,8 @@
|
|
38
38
|
Method = ( upper | digit | safe ){1,20} >mark %request_method;
|
39
39
|
|
40
40
|
http_number = ( digit+ "." digit+ ) ;
|
41
|
-
|
42
|
-
Request_Line = ( Method " " Request_URI ("#" Fragment){0,1} " "
|
41
|
+
Server_Protocol = ( "HTTP/" http_number ) >mark %server_protocol ;
|
42
|
+
Request_Line = ( Method " " Request_URI ("#" Fragment){0,1} " " Server_Protocol CRLF ) ;
|
43
43
|
|
44
44
|
field_name = ( token -- ":" )+ >start_field $snake_upcase_field %write_field;
|
45
45
|
|
data/ext/puma_http11/mini_ssl.c
CHANGED
@@ -30,6 +30,12 @@ typedef struct {
|
|
30
30
|
|
31
31
|
VALUE eError;
|
32
32
|
|
33
|
+
NORETURN(void raise_file_error(const char* caller, const char *filename));
|
34
|
+
|
35
|
+
void raise_file_error(const char* caller, const char *filename) {
|
36
|
+
rb_raise(eError, "%s: error in file '%s': %s", caller, filename, ERR_error_string(ERR_get_error(), NULL));
|
37
|
+
}
|
38
|
+
|
33
39
|
void engine_free(void *ptr) {
|
34
40
|
ms_conn *conn = ptr;
|
35
41
|
ms_cert_buf* cert_buf = (ms_cert_buf*)SSL_get_app_data(conn->ssl);
|
@@ -49,7 +55,8 @@ const rb_data_type_t engine_data_type = {
|
|
49
55
|
0, 0, RUBY_TYPED_FREE_IMMEDIATELY,
|
50
56
|
};
|
51
57
|
|
52
|
-
|
58
|
+
#ifndef HAVE_SSL_CTX_SET_DH_AUTO
|
59
|
+
DH *get_dh2048(void) {
|
53
60
|
/* `openssl dhparam -C 2048`
|
54
61
|
* -----BEGIN DH PARAMETERS-----
|
55
62
|
* MIIBCAKCAQEAjmh1uQHdTfxOyxEbKAV30fUfzqMDF/ChPzjfyzl2jcrqQMhrk76o
|
@@ -91,13 +98,13 @@ DH *get_dh2048() {
|
|
91
98
|
static unsigned char dh2048_g[] = { 0x02 };
|
92
99
|
|
93
100
|
DH *dh;
|
94
|
-
#if !(OPENSSL_VERSION_NUMBER < 0x10100005L
|
101
|
+
#if !(OPENSSL_VERSION_NUMBER < 0x10100005L)
|
95
102
|
BIGNUM *p, *g;
|
96
103
|
#endif
|
97
104
|
|
98
105
|
dh = DH_new();
|
99
106
|
|
100
|
-
#if OPENSSL_VERSION_NUMBER < 0x10100005L
|
107
|
+
#if OPENSSL_VERSION_NUMBER < 0x10100005L
|
101
108
|
dh->p = BN_bin2bn(dh2048_p, sizeof(dh2048_p), NULL);
|
102
109
|
dh->g = BN_bin2bn(dh2048_g, sizeof(dh2048_g), NULL);
|
103
110
|
|
@@ -119,6 +126,7 @@ DH *get_dh2048() {
|
|
119
126
|
|
120
127
|
return dh;
|
121
128
|
}
|
129
|
+
#endif
|
122
130
|
|
123
131
|
static void
|
124
132
|
sslctx_free(void *ptr) {
|
@@ -177,6 +185,18 @@ static int engine_verify_callback(int preverify_ok, X509_STORE_CTX* ctx) {
|
|
177
185
|
return preverify_ok;
|
178
186
|
}
|
179
187
|
|
188
|
+
static int password_callback(char *buf, int size, int rwflag, void *userdata) {
|
189
|
+
const char *password = (const char *) userdata;
|
190
|
+
size_t len = strlen(password);
|
191
|
+
|
192
|
+
if (len > (size_t) size) {
|
193
|
+
return 0;
|
194
|
+
}
|
195
|
+
|
196
|
+
memcpy(buf, password, len);
|
197
|
+
return (int) len;
|
198
|
+
}
|
199
|
+
|
180
200
|
static VALUE
|
181
201
|
sslctx_alloc(VALUE klass) {
|
182
202
|
SSL_CTX *ctx;
|
@@ -202,29 +222,43 @@ sslctx_alloc(VALUE klass) {
|
|
202
222
|
VALUE
|
203
223
|
sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
204
224
|
SSL_CTX* ctx;
|
205
|
-
|
225
|
+
int ssl_options;
|
226
|
+
VALUE key, cert, ca, verify_mode, ssl_cipher_filter, no_tlsv1, no_tlsv1_1,
|
227
|
+
verification_flags, session_id_bytes, cert_pem, key_pem, key_password_command, key_password;
|
228
|
+
BIO *bio;
|
229
|
+
X509 *x509;
|
230
|
+
EVP_PKEY *pkey;
|
231
|
+
pem_password_cb *password_cb = NULL;
|
232
|
+
const char *password = NULL;
|
206
233
|
#ifdef HAVE_SSL_CTX_SET_MIN_PROTO_VERSION
|
207
234
|
int min;
|
208
235
|
#endif
|
209
|
-
|
210
|
-
VALUE key, cert, ca, verify_mode, ssl_cipher_filter, no_tlsv1, no_tlsv1_1,
|
211
|
-
verification_flags, session_id_bytes;
|
236
|
+
#ifndef HAVE_SSL_CTX_SET_DH_AUTO
|
212
237
|
DH *dh;
|
213
|
-
|
238
|
+
#endif
|
214
239
|
#if OPENSSL_VERSION_NUMBER < 0x10002000L
|
215
240
|
EC_KEY *ecdh;
|
216
241
|
#endif
|
242
|
+
#ifdef HAVE_SSL_CTX_SET_SESSION_CACHE_MODE
|
243
|
+
VALUE reuse, reuse_cache_size, reuse_timeout;
|
217
244
|
|
218
|
-
|
245
|
+
reuse = rb_funcall(mini_ssl_ctx, rb_intern_const("reuse"), 0);
|
246
|
+
reuse_cache_size = rb_funcall(mini_ssl_ctx, rb_intern_const("reuse_cache_size"), 0);
|
247
|
+
reuse_timeout = rb_funcall(mini_ssl_ctx, rb_intern_const("reuse_timeout"), 0);
|
248
|
+
#endif
|
219
249
|
|
220
250
|
key = rb_funcall(mini_ssl_ctx, rb_intern_const("key"), 0);
|
221
|
-
|
251
|
+
|
252
|
+
key_password_command = rb_funcall(mini_ssl_ctx, rb_intern_const("key_password_command"), 0);
|
222
253
|
|
223
254
|
cert = rb_funcall(mini_ssl_ctx, rb_intern_const("cert"), 0);
|
224
|
-
StringValue(cert);
|
225
255
|
|
226
256
|
ca = rb_funcall(mini_ssl_ctx, rb_intern_const("ca"), 0);
|
227
257
|
|
258
|
+
cert_pem = rb_funcall(mini_ssl_ctx, rb_intern_const("cert_pem"), 0);
|
259
|
+
|
260
|
+
key_pem = rb_funcall(mini_ssl_ctx, rb_intern_const("key_pem"), 0);
|
261
|
+
|
228
262
|
verify_mode = rb_funcall(mini_ssl_ctx, rb_intern_const("verify_mode"), 0);
|
229
263
|
|
230
264
|
ssl_cipher_filter = rb_funcall(mini_ssl_ctx, rb_intern_const("ssl_cipher_filter"), 0);
|
@@ -233,8 +267,61 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
233
267
|
|
234
268
|
no_tlsv1_1 = rb_funcall(mini_ssl_ctx, rb_intern_const("no_tlsv1_1"), 0);
|
235
269
|
|
236
|
-
|
237
|
-
|
270
|
+
TypedData_Get_Struct(self, SSL_CTX, &sslctx_type, ctx);
|
271
|
+
|
272
|
+
if (!NIL_P(cert)) {
|
273
|
+
StringValue(cert);
|
274
|
+
|
275
|
+
if (SSL_CTX_use_certificate_chain_file(ctx, RSTRING_PTR(cert)) != 1) {
|
276
|
+
raise_file_error("SSL_CTX_use_certificate_chain_file", RSTRING_PTR(cert));
|
277
|
+
}
|
278
|
+
}
|
279
|
+
|
280
|
+
if (!NIL_P(key_password_command)) {
|
281
|
+
key_password = rb_funcall(mini_ssl_ctx, rb_intern_const("key_password"), 0);
|
282
|
+
|
283
|
+
if (!NIL_P(key_password)) {
|
284
|
+
StringValue(key_password);
|
285
|
+
password_cb = password_callback;
|
286
|
+
password = RSTRING_PTR(key_password);
|
287
|
+
SSL_CTX_set_default_passwd_cb(ctx, password_cb);
|
288
|
+
SSL_CTX_set_default_passwd_cb_userdata(ctx, (void *) password);
|
289
|
+
}
|
290
|
+
}
|
291
|
+
|
292
|
+
if (!NIL_P(key)) {
|
293
|
+
StringValue(key);
|
294
|
+
|
295
|
+
if (SSL_CTX_use_PrivateKey_file(ctx, RSTRING_PTR(key), SSL_FILETYPE_PEM) != 1) {
|
296
|
+
raise_file_error("SSL_CTX_use_PrivateKey_file", RSTRING_PTR(key));
|
297
|
+
}
|
298
|
+
}
|
299
|
+
|
300
|
+
if (!NIL_P(cert_pem)) {
|
301
|
+
bio = BIO_new(BIO_s_mem());
|
302
|
+
BIO_puts(bio, RSTRING_PTR(cert_pem));
|
303
|
+
x509 = PEM_read_bio_X509(bio, NULL, NULL, NULL);
|
304
|
+
|
305
|
+
if (SSL_CTX_use_certificate(ctx, x509) != 1) {
|
306
|
+
BIO_free(bio);
|
307
|
+
raise_file_error("SSL_CTX_use_certificate", RSTRING_PTR(cert_pem));
|
308
|
+
}
|
309
|
+
X509_free(x509);
|
310
|
+
BIO_free(bio);
|
311
|
+
}
|
312
|
+
|
313
|
+
if (!NIL_P(key_pem)) {
|
314
|
+
bio = BIO_new(BIO_s_mem());
|
315
|
+
BIO_puts(bio, RSTRING_PTR(key_pem));
|
316
|
+
pkey = PEM_read_bio_PrivateKey(bio, NULL, password_cb, (void *) password);
|
317
|
+
|
318
|
+
if (SSL_CTX_use_PrivateKey(ctx, pkey) != 1) {
|
319
|
+
BIO_free(bio);
|
320
|
+
raise_file_error("SSL_CTX_use_PrivateKey", RSTRING_PTR(key_pem));
|
321
|
+
}
|
322
|
+
EVP_PKEY_free(pkey);
|
323
|
+
BIO_free(bio);
|
324
|
+
}
|
238
325
|
|
239
326
|
verification_flags = rb_funcall(mini_ssl_ctx, rb_intern_const("verification_flags"), 0);
|
240
327
|
|
@@ -246,7 +333,9 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
246
333
|
|
247
334
|
if (!NIL_P(ca)) {
|
248
335
|
StringValue(ca);
|
249
|
-
SSL_CTX_load_verify_locations(ctx, RSTRING_PTR(ca), NULL)
|
336
|
+
if (SSL_CTX_load_verify_locations(ctx, RSTRING_PTR(ca), NULL) != 1) {
|
337
|
+
raise_file_error("SSL_CTX_load_verify_locations", RSTRING_PTR(ca));
|
338
|
+
}
|
250
339
|
}
|
251
340
|
|
252
341
|
ssl_options = SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_SINGLE_ECDH_USE | SSL_OP_NO_COMPRESSION;
|
@@ -264,8 +353,6 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
264
353
|
|
265
354
|
SSL_CTX_set_min_proto_version(ctx, min);
|
266
355
|
|
267
|
-
SSL_CTX_set_options(ctx, ssl_options);
|
268
|
-
|
269
356
|
#else
|
270
357
|
/* As of 1.0.2f, SSL_OP_SINGLE_DH_USE key use is always on */
|
271
358
|
ssl_options |= SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_SINGLE_DH_USE;
|
@@ -276,10 +363,23 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
276
363
|
if(RTEST(no_tlsv1_1)) {
|
277
364
|
ssl_options |= SSL_OP_NO_TLSv1 | SSL_OP_NO_TLSv1_1;
|
278
365
|
}
|
279
|
-
SSL_CTX_set_options(ctx, ssl_options);
|
280
366
|
#endif
|
281
367
|
|
282
|
-
|
368
|
+
#ifdef HAVE_SSL_CTX_SET_SESSION_CACHE_MODE
|
369
|
+
if (!NIL_P(reuse)) {
|
370
|
+
SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER);
|
371
|
+
if (!NIL_P(reuse_cache_size)) {
|
372
|
+
SSL_CTX_sess_set_cache_size(ctx, NUM2INT(reuse_cache_size));
|
373
|
+
}
|
374
|
+
if (!NIL_P(reuse_timeout)) {
|
375
|
+
SSL_CTX_set_timeout(ctx, NUM2INT(reuse_timeout));
|
376
|
+
}
|
377
|
+
} else {
|
378
|
+
SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
|
379
|
+
}
|
380
|
+
#endif
|
381
|
+
|
382
|
+
SSL_CTX_set_options(ctx, ssl_options);
|
283
383
|
|
284
384
|
if (!NIL_P(ssl_cipher_filter)) {
|
285
385
|
StringValue(ssl_cipher_filter);
|
@@ -289,12 +389,8 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
289
389
|
SSL_CTX_set_cipher_list(ctx, "HIGH:!aNULL@STRENGTH");
|
290
390
|
}
|
291
391
|
|
292
|
-
dh = get_dh2048();
|
293
|
-
SSL_CTX_set_tmp_dh(ctx, dh);
|
294
|
-
|
295
392
|
#if OPENSSL_VERSION_NUMBER < 0x10002000L
|
296
|
-
// Remove this case if OpenSSL 1.0.1 (now EOL) support is no
|
297
|
-
// longer needed.
|
393
|
+
// Remove this case if OpenSSL 1.0.1 (now EOL) support is no longer needed.
|
298
394
|
ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
|
299
395
|
if (ecdh) {
|
300
396
|
SSL_CTX_set_tmp_ecdh(ctx, ecdh);
|
@@ -325,6 +421,15 @@ sslctx_initialize(VALUE self, VALUE mini_ssl_ctx) {
|
|
325
421
|
SSL_MAX_SSL_SESSION_ID_LENGTH);
|
326
422
|
|
327
423
|
// printf("\ninitialize end security_level %d\n", SSL_CTX_get_security_level(ctx));
|
424
|
+
|
425
|
+
#ifdef HAVE_SSL_CTX_SET_DH_AUTO
|
426
|
+
// https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_dh_auto.html
|
427
|
+
SSL_CTX_set_dh_auto(ctx, 1);
|
428
|
+
#else
|
429
|
+
dh = get_dh2048();
|
430
|
+
SSL_CTX_set_tmp_dh(ctx, dh);
|
431
|
+
#endif
|
432
|
+
|
328
433
|
rb_obj_freeze(self);
|
329
434
|
return self;
|
330
435
|
}
|
@@ -523,7 +628,11 @@ VALUE engine_peercert(VALUE self) {
|
|
523
628
|
|
524
629
|
TypedData_Get_Struct(self, ms_conn, &engine_data_type, conn);
|
525
630
|
|
631
|
+
#ifdef HAVE_SSL_GET1_PEER_CERTIFICATE
|
632
|
+
cert = SSL_get1_peer_certificate(conn->ssl);
|
633
|
+
#else
|
526
634
|
cert = SSL_get_peer_certificate(conn->ssl);
|
635
|
+
#endif
|
527
636
|
if(!cert) {
|
528
637
|
/*
|
529
638
|
* See if there was a failed certificate associated with this client.
|
@@ -580,7 +689,10 @@ void Init_mini_ssl(VALUE puma) {
|
|
580
689
|
ERR_load_crypto_strings();
|
581
690
|
|
582
691
|
mod = rb_define_module_under(puma, "MiniSSL");
|
692
|
+
|
583
693
|
eng = rb_define_class_under(mod, "Engine", rb_cObject);
|
694
|
+
rb_undef_alloc_func(eng);
|
695
|
+
|
584
696
|
sslctx = rb_define_class_under(mod, "SSLContext", rb_cObject);
|
585
697
|
rb_define_alloc_func(sslctx, sslctx_alloc);
|
586
698
|
rb_define_method(sslctx, "initialize", sslctx_initialize, 1);
|
@@ -46,7 +46,7 @@ public class Http11 extends RubyObject {
|
|
46
46
|
public static final ByteList FRAGMENT_BYTELIST = new ByteList(ByteList.plain("FRAGMENT"));
|
47
47
|
public static final ByteList REQUEST_PATH_BYTELIST = new ByteList(ByteList.plain("REQUEST_PATH"));
|
48
48
|
public static final ByteList QUERY_STRING_BYTELIST = new ByteList(ByteList.plain("QUERY_STRING"));
|
49
|
-
public static final ByteList
|
49
|
+
public static final ByteList SERVER_PROTOCOL_BYTELIST = new ByteList(ByteList.plain("SERVER_PROTOCOL"));
|
50
50
|
|
51
51
|
private static ObjectAllocator ALLOCATOR = new ObjectAllocator() {
|
52
52
|
public IRubyObject allocate(Ruby runtime, RubyClass klass) {
|
@@ -153,9 +153,9 @@ public class Http11 extends RubyObject {
|
|
153
153
|
req.fastASet(RubyString.newStringShared(runtime, QUERY_STRING_BYTELIST),val);
|
154
154
|
}
|
155
155
|
|
156
|
-
public static void
|
156
|
+
public static void server_protocol(Ruby runtime, RubyHash req, ByteList buffer, int at, int length) {
|
157
157
|
RubyString val = RubyString.newString(runtime,new ByteList(buffer,at,length));
|
158
|
-
req.fastASet(RubyString.newStringShared(runtime,
|
158
|
+
req.fastASet(RubyString.newStringShared(runtime, SERVER_PROTOCOL_BYTELIST),val);
|
159
159
|
}
|
160
160
|
|
161
161
|
public void header_done(Ruby runtime, RubyHash req, ByteList buffer, int at, int length) {
|
@@ -383,7 +383,7 @@ case 1:
|
|
383
383
|
case 11:
|
384
384
|
// line 42 "ext/puma_http11/http11_parser.java.rl"
|
385
385
|
{
|
386
|
-
Http11.
|
386
|
+
Http11.server_protocol(runtime, parser.data, parser.buffer, parser.mark, p-parser.mark);
|
387
387
|
}
|
388
388
|
break;
|
389
389
|
case 12:
|