Class: Puma::MiniSSL::Socket

Inherits:
Object
  • Object
show all
Defined in:
lib/puma/minissl.rb

Instance Method Summary collapse

Constructor Details

#initialize(socket, engine) ⇒ Socket

Returns a new instance of Socket.


20
21
22
23
24
# File 'lib/puma/minissl.rb', line 20

def initialize(socket, engine)
  @socket = socket
  @engine = engine
  @peercert = nil
end

Instance Method Details

#closeObject


170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/puma/minissl.rb', line 170

def close
  begin
    # Read any drop any partially initialized sockets and any received bytes during shutdown.
    # Don't let this socket hold this loop forever.
    # If it can't send more packets within 1s, then give up.
    return if [:timeout, :eof].include?(read_and_drop(1)) while should_drop_bytes?
  rescue IOError, SystemCallError
    Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
    # nothing
  ensure
    @socket.close
  end
end

#closed?Boolean

Returns:

  • (Boolean)

30
31
32
# File 'lib/puma/minissl.rb', line 30

def closed?
  @socket.closed?
end

#engine_read_allObject


69
70
71
72
73
74
75
76
# File 'lib/puma/minissl.rb', line 69

def engine_read_all
  output = @engine.read
  raise SSLError.exception "HTTP connection?" if bad_tlsv1_3?
  while output and additional_output = @engine.read
    output << additional_output
  end
  output
end

#flushObject


150
151
152
# File 'lib/puma/minissl.rb', line 150

def flush
  @socket.flush
end

#peeraddrObject


184
185
186
# File 'lib/puma/minissl.rb', line 184

def peeraddr
  @socket.peeraddr
end

#peercertObject


188
189
190
191
192
193
194
195
# File 'lib/puma/minissl.rb', line 188

def peercert
  return @peercert if @peercert

  raw = @engine.peercert
  return nil unless raw

  @peercert = OpenSSL::X509::Certificate.new raw
end

#read_and_drop(timeout = 1) ⇒ Object


154
155
156
157
158
159
160
161
162
163
164
# File 'lib/puma/minissl.rb', line 154

def read_and_drop(timeout = 1)
  return :timeout unless IO.select([@socket], nil, nil, timeout)
  case @socket.read_nonblock(1024, exception: false)
  when nil
    :eof
  when :wait_readable
    :eagain
  else
    :drop
  end
end

#read_nonblock(size, *_) ⇒ Object


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/puma/minissl.rb', line 78

def read_nonblock(size, *_)
  # *_ is to deal with keyword args that were added
  # at some point (and being used in the wild)
  while true
    output = engine_read_all
    return output if output

    data = @socket.read_nonblock(size, exception: false)
    if data == :wait_readable || data == :wait_writable
      # It would make more sense to let @socket.read_nonblock raise
      # EAGAIN if necessary but it seems like it'll misbehave on Windows.
      # I don't have a Windows machine to debug this so I can't explain
      # exactly whats happening in that OS. Please let me know if you
      # find out!
      #
      # In the meantime, we can emulate the correct behavior by
      # capturing :wait_readable & :wait_writable and raising EAGAIN
      # ourselves.
      raise IO::EAGAINWaitReadable
    elsif data.nil?
      return nil
    end

    @engine.inject(data)
    output = engine_read_all

    return output if output

    while neg_data = @engine.extract
      @socket.write neg_data
    end
  end
end

#readpartial(size) ⇒ Object


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/puma/minissl.rb', line 52

def readpartial(size)
  while true
    output = @engine.read
    return output if output

    data = @socket.readpartial(size)
    @engine.inject(data)
    output = @engine.read

    return output if output

    while neg_data = @engine.extract
      @socket.write neg_data
    end
  end
end

#should_drop_bytes?Boolean

Returns:

  • (Boolean)

166
167
168
# File 'lib/puma/minissl.rb', line 166

def should_drop_bytes?
  @engine.init? || !@engine.shutdown
end

#ssl_version_stateObject

returns a two element array first is protocol version (SSL_get_version) second is 'handshake' state (SSL_state_string)

used for dropping tcp connections to ssl see OpenSSL ssl/ssl_stat.c SSL_state_string for info


41
42
43
# File 'lib/puma/minissl.rb', line 41

def ssl_version_state
  IS_JRUBY ? [nil, nil] : @engine.ssl_vers_st
end

#to_ioObject


26
27
28
# File 'lib/puma/minissl.rb', line 26

def to_io
  @socket
end

#write(data) ⇒ Object Also known as: syswrite, <<


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/puma/minissl.rb', line 112

def write(data)
  return 0 if data.empty?

  need = data.bytesize

  while true
    wrote = @engine.write data
    enc = @engine.extract

    while enc
      @socket.write enc
      enc = @engine.extract
    end

    need -= wrote

    return data.bytesize if need == 0

    data = data[wrote..-1]
  end
end

#write_nonblock(data, *_) ⇒ Object

This is a temporary fix to deal with websockets code using write_nonblock. The problem with implementing it properly is that it means we'd have to have the ability to rewind an engine because after we write+extract, the socket write_nonblock call might raise an exception and later code would pass the same data in, but the engine would think it had already written the data in. So for the time being (and since write blocking is quite rare), go ahead and actually block in write_nonblock.


146
147
148
# File 'lib/puma/minissl.rb', line 146

def write_nonblock(data, *_)
  write data
end