Class: Puma::Binder

Inherits:
Object
  • Object
show all
Includes:
Const
Defined in:
lib/puma/binder.rb

Constant Summary collapse

RACK_VERSION = 
[1,6].freeze

Constants included from Const

Const::BANNED_HEADER_KEY, Const::CGI_VER, Const::CHUNKED, Const::CHUNK_SIZE, Const::CLOSE, Const::CLOSE_CHUNKED, Const::CODE_NAME, Const::COLON, Const::CONNECTION_CLOSE, Const::CONNECTION_KEEP_ALIVE, Const::CONTENT_LENGTH, Const::CONTENT_LENGTH2, Const::CONTENT_LENGTH_S, Const::CONTINUE, Const::DQUOTE, Const::EARLY_HINTS, Const::ERROR_RESPONSE, Const::GATEWAY_INTERFACE, Const::HALT_COMMAND, Const::HEAD, Const::HIJACK, Const::HIJACK_IO, Const::HIJACK_P, Const::HTTP, Const::HTTPS, Const::HTTPS_KEY, Const::HTTP_10_200, Const::HTTP_11, Const::HTTP_11_100, Const::HTTP_11_200, Const::HTTP_CONNECTION, Const::HTTP_EXPECT, Const::HTTP_HEADER_DELIMITER, Const::HTTP_HOST, Const::HTTP_VERSION, Const::HTTP_X_FORWARDED_FOR, Const::HTTP_X_FORWARDED_PROTO, Const::HTTP_X_FORWARDED_SCHEME, Const::HTTP_X_FORWARDED_SSL, Const::IANA_HTTP_METHODS, Const::ILLEGAL_HEADER_KEY_REGEX, Const::ILLEGAL_HEADER_VALUE_REGEX, Const::KEEP_ALIVE, Const::LINE_END, Const::LOCALHOST, Const::LOCALHOST_IPV4, Const::LOCALHOST_IPV6, Const::MAX_BODY, Const::MAX_HEADER, Const::NEWLINE, Const::PATH_INFO, Const::PORT_443, Const::PORT_80, Const::PROXY_PROTOCOL_V1_REGEX, Const::PUMA_CONFIG, Const::PUMA_PEERCERT, Const::PUMA_SERVER_STRING, Const::PUMA_SOCKET, Const::PUMA_TMP_BASE, Const::PUMA_VERSION, Const::QUERY_STRING, Const::RACK_AFTER_REPLY, Const::RACK_INPUT, Const::RACK_RESPONSE_FINISHED, Const::RACK_URL_SCHEME, Const::REMOTE_ADDR, Const::REQUEST_METHOD, Const::REQUEST_PATH, Const::REQUEST_URI, Const::RESTART_COMMAND, Const::SERVER_NAME, Const::SERVER_PORT, Const::SERVER_PROTOCOL, Const::SERVER_SOFTWARE, Const::STOP_COMMAND, Const::SUPPORTED_HTTP_METHODS, Const::TRANSFER_ENCODING, Const::TRANSFER_ENCODING2, Const::TRANSFER_ENCODING_CHUNKED, Const::UNMASKABLE_HEADERS, Const::UNSPECIFIED_IPV4, Const::UNSPECIFIED_IPV6, Const::WRITE_TIMEOUT

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log_writer, options, env: ENV) ⇒ Binder

Returns a new instance of Binder.



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
 
# File 'lib/puma/binder.rb', line 21

def initialize(log_writer, options, env: ENV)
  @log_writer = log_writer
  @options = options
  @listeners = []
  @inherited_fds = {}
  @activated_sockets = {}
  @unix_paths = []
  @env = env

  @proto_env = {
    "rack.version".freeze => RACK_VERSION,
    "rack.errors".freeze => log_writer.stderr,
    "rack.multithread".freeze => options[:max_threads] > 1,
    "rack.multiprocess".freeze => options[:workers] >= 1,
    "rack.run_once".freeze => false,
    RACK_URL_SCHEME => options[:rack_url_scheme],
    "SCRIPT_NAME".freeze => env['SCRIPT_NAME'] || "",

    # I'd like to set a default CONTENT_TYPE here but some things
    # depend on their not being a default set and inferring
    # it from the content. And so if i set it here, it won't
    # infer properly.

    "QUERY_STRING".freeze => "",
    SERVER_SOFTWARE => PUMA_SERVER_STRING,
    GATEWAY_INTERFACE => CGI_VER,

    RACK_AFTER_REPLY => nil,
    RACK_RESPONSE_FINISHED => nil,
  }

  @envs = {}
  @ios = []
end

Instance Attribute Details

#activated_sockets ⇒ Object (readonly)

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def activated_sockets
  @activated_sockets
end

#connected_ports ⇒ Object (readonly)

Version:

  • 5.0.0



74
75
76
 
# File 'lib/puma/binder.rb', line 74

def connected_ports
  t = ios.map { |io| io.addr[1] }; t.uniq!; t
end

#envs ⇒ Object (readonly)

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def envs
  @envs
end

#inherited_fds ⇒ Object (readonly)

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def inherited_fds
  @inherited_fds
end

#ios ⇒ Object

Returns the value of attribute ios.



56
57
58
 
# File 'lib/puma/binder.rb', line 56

def ios
  @ios
end

#listeners ⇒ Object

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def listeners
  @listeners
end

#proto_env ⇒ Object (readonly)

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def proto_env
  @proto_env
end

#unix_paths ⇒ Object (readonly)

Version:

  • 5.0.0



59
60
61
 
# File 'lib/puma/binder.rb', line 59

def unix_paths
  @unix_paths
end

Instance Method Details

#add_ssl_listener(host, port, ctx, optimize_for_latency = true, backlog = 1024) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/puma/binder.rb', line 363

def add_ssl_listener(host, port, ctx,
                     optimize_for_latency=true, backlog=1024)

  raise "Puma compiled without SSL support" unless HAS_SSL
  # Puma will try to use local authority context if context is supplied nil
  ctx ||= localhost_authority_context

  if host == "localhost"
    loopback_addresses.each do |addr|
      add_ssl_listener addr, port, ctx, optimize_for_latency, backlog
    end
    return
  end

  host = host[1..-2] if host&.start_with? '['
  s = TCPServer.new(host, port)
  if optimize_for_latency
    s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  end
  s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
  s.listen backlog

  ssl = MiniSSL::Server.new s, ctx
  env = @proto_env.dup
  env[HTTPS_KEY] = HTTPS
  @envs[ssl] = env

  @ios << ssl
  s
end

#add_tcp_listener(host, port, optimize_for_latency = true, backlog = 1024) ⇒ Object

Tell the server to listen on host host, port port. If optimize_for_latency is true (the default) then clients connecting will be optimized for latency over throughput.

backlog indicates how many unaccepted connections the kernel should allow to accumulate before returning connection refused.



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/puma/binder.rb', line 335

def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024)
  if host == "localhost"
    loopback_addresses.each do |addr|
      add_tcp_listener addr, port, optimize_for_latency, backlog
    end
    return
  end

  host = host[1..-2] if host&.start_with? '['
  tcp_server = TCPServer.new(host, port)

  if optimize_for_latency
    tcp_server.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  end
  tcp_server.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
  tcp_server.listen backlog

  @ios << tcp_server
  tcp_server
end

#add_unix_listener(path, umask = nil, mode = nil, backlog = 1024) ⇒ Object

Tell the server to listen on path as a UNIX domain socket.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/puma/binder.rb', line 414

def add_unix_listener(path, umask=nil, mode=nil, backlog=1024)
  # Let anyone connect by default
  umask ||= 0

  begin
    old_mask = File.umask(umask)

    if File.exist? path
      begin
        old = UNIXSocket.new path
      rescue SystemCallError, IOError
        File.unlink path
      else
        old.close
        raise "There is already a server bound to: #{path}"
      end
    end
    s = UNIXServer.new path.sub(/\A@/, "\0") # check for abstract UNIXSocket
    s.listen backlog
    @ios << s
  ensure
    File.umask old_mask
  end

  if mode
    File.chmod mode, path
  end

  env = @proto_env.dup
  env[REMOTE_ADDR] = "127.0.0.1"
  @envs[s] = env

  s
end

#before_parse(&block) ⇒ Object 



147
148
149
150
151
 
# File 'lib/puma/binder.rb', line 147

def before_parse(&block)
  @before_parse ||= []
  @before_parse << block if block
  @before_parse
end

#close ⇒ Object 



68
69
70
 
# File 'lib/puma/binder.rb', line 68

def close
  @ios.each { |i| i.close }
end

#close_listeners ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/puma/binder.rb', line 461

def close_listeners
  @listeners.each do |l, io|
    begin
      io.close unless io.closed?
      uri = URI.parse l
      next unless uri.scheme == 'unix'
      unix_path = "#{uri.host}#{uri.path}"
      File.unlink unix_path if @unix_paths.include?(unix_path) && File.exist?(unix_path)
    rescue Errno::EBADF
    end
  end
end

#create_activated_fds(env_hash) ⇒ Object

systemd socket activation. LISTEN_FDS = number of listening sockets. e.g. 2 means accept on 2 sockets w/descriptors 3 and 4. LISTEN_PID = PID of the service process, aka us

See Also:

Version:

  • 5.0.0



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/puma/binder.rb', line 92

def create_activated_fds(env_hash)
  @log_writer.debug "ENV['LISTEN_FDS'] #{@env['LISTEN_FDS'].inspect}  env_hash['LISTEN_PID'] #{env_hash['LISTEN_PID'].inspect}"
  return [] unless env_hash['LISTEN_FDS'] && env_hash['LISTEN_PID'].to_i == $$
  env_hash['LISTEN_FDS'].to_i.times do |index|
    sock = TCPServer.for_fd(socket_activation_fd(index))
    key = begin # Try to parse as a path
      [:unix, Socket.unpack_sockaddr_un(sock.getsockname)]
    rescue ArgumentError # Try to parse as a port/ip
      port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
      addr = "[#{addr}]" if addr&.include? ':'
      [:tcp, addr, port]
    end
    @activated_sockets[key] = sock
    @log_writer.debug "Registered #{key.join ':'} for activation from LISTEN_FDS"
  end
  ["LISTEN_FDS", "LISTEN_PID"] # Signal to remove these keys from ENV
end

#create_inherited_fds(env_hash) ⇒ Object

Version:

  • 5.0.0



79
80
81
82
83
84
 
# File 'lib/puma/binder.rb', line 79

def create_inherited_fds(env_hash)
  env_hash.select {|k,v| k =~ /PUMA_INHERIT_\d+/}.each do |_k, v|
    fd, url = v.split(":", 2)
    @inherited_fds[url] = fd.to_i
  end.keys # pass keys back for removal
end

#env(sock) ⇒ Object 



64
65
66
 
# File 'lib/puma/binder.rb', line 64

def env(sock)
  @envs.fetch(sock, @proto_env)
end

#inherit_ssl_listener(fd, ctx) ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/puma/binder.rb', line 394

def inherit_ssl_listener(fd, ctx)
  raise "Puma compiled without SSL support" unless HAS_SSL
  # Puma will try to use local authority context if context is supplied nil
  ctx ||= localhost_authority_context

  s = fd.kind_of?(::TCPServer) ? fd : ::TCPServer.for_fd(fd)

  ssl = MiniSSL::Server.new(s, ctx)

  env = @proto_env.dup
  env[HTTPS_KEY] = HTTPS
  @envs[ssl] = env

  @ios << ssl

  s
end

#inherit_tcp_listener(host, port, fd) ⇒ Object 



356
357
358
359
360
361
 
# File 'lib/puma/binder.rb', line 356

def inherit_tcp_listener(host, port, fd)
  s = fd.kind_of?(::TCPServer) ? fd : ::TCPServer.for_fd(fd)

  @ios << s
  s
end

#inherit_unix_listener(path, fd) ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/puma/binder.rb', line 449

def inherit_unix_listener(path, fd)
  s = fd.kind_of?(::TCPServer) ? fd : ::UNIXServer.for_fd(fd)

  @ios << s

  env = @proto_env.dup
  env[REMOTE_ADDR] = "127.0.0.1"
  @envs[s] = env

  s
end

#localhost_authority ⇒ Object 



312
313
314
 
# File 'lib/puma/binder.rb', line 312

def localhost_authority
  @localhost_authority ||= Localhost::Authority.fetch if defined?(Localhost::Authority) && !Puma::IS_JRUBY
end

#localhost_authority_context ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/puma/binder.rb', line 316

def localhost_authority_context
  return unless localhost_authority

  key_path, crt_path = if [:key_path, :certificate_path].all? { |m| localhost_authority.respond_to?(m) }
    [localhost_authority.key_path, localhost_authority.certificate_path]
  else
    local_certificates_path = File.expand_path("~/.localhost")
    [File.join(local_certificates_path, "localhost.key"), File.join(local_certificates_path, "localhost.crt")]
  end
  MiniSSL::ContextBuilder.new({ "key" => key_path, "cert" => crt_path }, @log_writer).context
end

#parse(binds, log_writer = nil, log_msg = 'Listening') ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/puma/binder.rb', line 153

def parse(binds, log_writer = nil, log_msg = 'Listening')
  before_parse.each(&:call)
  log_writer ||= @log_writer
  binds.each do |str|
    uri = URI.parse str
    case uri.scheme
    when "tcp"
      if fd = @inherited_fds.delete(str)
        io = inherit_tcp_listener uri.host, uri.port, fd
        log_writer.log "* Inherited #{str}"
      elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
        io = inherit_tcp_listener uri.host, uri.port, sock
        log_writer.log "* Activated #{str}"
      else
        ios_len = @ios.length
        params = Util.parse_query uri.query

        low_latency = params.key?('low_latency') && params['low_latency'] != 'false'
        backlog = params.fetch('backlog', 1024).to_i

        io = add_tcp_listener uri.host, uri.port, low_latency, backlog

        @ios[ios_len..-1].each do |i|
          addr = loc_addr_str i
          log_writer.log "* #{log_msg} on http://#{addr}"
        end
      end

      @listeners << [str, io] if io
    when "unix"
      path = "#{uri.host}#{uri.path}".gsub("%20", " ")
      abstract = false
      if str.start_with? 'unix://@'
        raise "OS does not support abstract UNIXSockets" unless Puma.abstract_unix_socket?
        abstract = true
        path = "@#{path}"
      end

      if fd = @inherited_fds.delete(str)
        @unix_paths << path unless abstract || File.exist?(path)
        io = inherit_unix_listener path, fd
        log_writer.log "* Inherited #{str}"
      elsif sock = @activated_sockets.delete([ :unix, path ]) ||
          !abstract && @activated_sockets.delete([ :unix, File.realdirpath(path) ])
        @unix_paths << path unless abstract || File.exist?(path)
        io = inherit_unix_listener path, sock
        log_writer.log "* Activated #{str}"
      else
        umask = nil
        mode = nil
        backlog = 1024

        if uri.query
          params = Util.parse_query uri.query
          if u = params['umask']
            # Use Integer() to respect the 0 prefix as octal
            umask = Integer(u)
          end

          if u = params['mode']
            mode = Integer('0'+u)
          end

          if u = params['backlog']
            backlog = Integer(u)
          end
        end

        @unix_paths << path unless abstract || File.exist?(path)
        io = add_unix_listener path, umask, mode, backlog
        log_writer.log "* #{log_msg} on #{str}"
      end

      @listeners << [str, io]
    when "ssl"
      cert_key = %w[cert key]

      raise "Puma compiled without SSL support" unless HAS_SSL

      params = Util.parse_query uri.query

      # If key and certs are not defined and localhost gem is required.
      # localhost gem will be used for self signed
      # Load localhost authority if not loaded.
      # Ruby 3 `values_at` accepts an array, earlier do not
      if params.values_at(*cert_key).all? { |v| v.to_s.empty? }
        ctx = localhost_authority && localhost_authority_context
      end

      ctx ||=
        begin
          # Extract cert_pem and key_pem from options[:store] if present
          cert_key.each do |v|
            if params[v]&.start_with?('store:')
              index = Integer(params.delete(v).split('store:').last)
              params["#{v}_pem"] = @options[:store][index]
            end
          end
          MiniSSL::ContextBuilder.new(params, @log_writer).context
        end

      if fd = @inherited_fds.delete(str)
        log_writer.log "* Inherited #{str}"
        io = inherit_ssl_listener fd, ctx
      elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
        io = inherit_ssl_listener sock, ctx
        log_writer.log "* Activated #{str}"
      else
        ios_len = @ios.length
        backlog = params.fetch('backlog', 1024).to_i
        low_latency = params['low_latency'] != 'false'
        io = add_ssl_listener uri.host, uri.port, ctx, low_latency, backlog

        @ios[ios_len..-1].each do |i|
          addr = loc_addr_str i
          log_writer.log "* #{log_msg} on ssl://#{addr}?#{uri.query}"
        end
      end

      @listeners << [str, io] if io
    else
      log_writer.error "Invalid URI: #{str}"
    end
  end

  # If we inherited fds but didn't use them (because of a
  # configuration change), then be sure to close them.
  @inherited_fds.each do |str, fd|
    log_writer.log "* Closing unused inherited connection: #{str}"

    begin
      IO.for_fd(fd).close
    rescue SystemCallError
    end

    # We have to unlink a unix socket path that's not being used
    uri = URI.parse str
    if uri.scheme == "unix"
      path = "#{uri.host}#{uri.path}"
      File.unlink path
    end
  end

  # Also close any unused activated sockets
  unless @activated_sockets.empty?
    fds = @ios.map(&:to_i)
    @activated_sockets.each do |key, sock|
      next if fds.include? sock.to_i
      log_writer.log "* Closing unused activated socket: #{key.first}://#{key[1..-1].join ':'}"
      begin
        sock.close
      rescue SystemCallError
      end
      # We have to unlink a unix socket path that's not being used
      File.unlink key[1] if key.first == :unix
    end
  end
end

#redirects_for_restart ⇒ Object 



474
475
476
477
478
 
# File 'lib/puma/binder.rb', line 474

def redirects_for_restart
  redirects = @listeners.map { |a| [a[1].to_i, a[1].to_i] }.to_h
  redirects[:close_others] = true
  redirects
end

#redirects_for_restart_env ⇒ Object

Version:

  • 5.0.0



481
482
483
484
485
 
# File 'lib/puma/binder.rb', line 481

def redirects_for_restart_env
  @listeners.each_with_object({}).with_index do |(listen, memo), i|
    memo["PUMA_INHERIT_#{i}"] = "#{listen[1].to_i}:#{listen[0]}"
  end
end

#synthesize_binds_from_activated_fs(binds, only_matching) ⇒ Object

Synthesize binds from systemd socket activation

When systemd socket activation is enabled, it can be tedious to keep the binds in sync. This method can synthesize any binds based on the received activated sockets. Any existing matching binds will be respected.

When only_matching is true in, all binds that do not match an activated socket is removed in place.

It’s a noop if no activated sockets were received.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/puma/binder.rb', line 120

def synthesize_binds_from_activated_fs(binds, only_matching)
  return binds unless activated_sockets.any?

  activated_binds = []

  activated_sockets.keys.each do |proto, addr, port|
    if port
      tcp_url = "#{proto}://#{addr}:#{port}"
      ssl_url = "ssl://#{addr}:#{port}"
      ssl_url_prefix = "#{ssl_url}?"

      existing = binds.find { |bind| bind == tcp_url || bind == ssl_url || bind.start_with?(ssl_url_prefix) }

      activated_binds << (existing || tcp_url)
    else
      # TODO: can there be a SSL bind without a port?
      activated_binds << "#{proto}://#{addr}"
    end
  end

  if only_matching
    activated_binds
  else
    binds | activated_binds
  end
end