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.



4
5
6
7
8
 
# File 'lib/puma/minissl.rb', line 4

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

Instance Method Details

#close ⇒ Object 



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

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.
    while should_drop_bytes?
      return if read_and_drop(1) == :timeout
    end
  rescue IOError, SystemCallError
    Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
    # nothing
  ensure
    @socket.close
  end
end

#engine_read_all ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/puma/minissl.rb', line 31

def engine_read_all
  output = @engine.read
  while output and additional_output = @engine.read
    output << additional_output
  end
  output
end

#flush ⇒ Object 



95
96
97
 
# File 'lib/puma/minissl.rb', line 95

def flush
  @socket.flush
end

#peeraddr ⇒ Object 



128
129
130
 
# File 'lib/puma/minissl.rb', line 128

def peeraddr
  @socket.peeraddr
end

#peercert ⇒ Object 



132
133
134
135
136
137
138
139
 
# File 'lib/puma/minissl.rb', line 132

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 



99
100
101
102
103
104
105
106
 
# File 'lib/puma/minissl.rb', line 99

def read_and_drop(timeout = 1)
  return :timeout unless IO.select([@socket], nil, nil, timeout)
  read_nonblock(1024)
  :drop
rescue Errno::EAGAIN
  # do nothing
  :eagain
end

#read_nonblock(size, *_) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/puma/minissl.rb', line 39

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)

    @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 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/puma/minissl.rb', line 14

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) 


108
109
110
 
# File 'lib/puma/minissl.rb', line 108

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

#to_io ⇒ Object 



10
11
12
 
# File 'lib/puma/minissl.rb', line 10

def to_io
  @socket
end

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/puma/minissl.rb', line 59

def write(data)
  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.



91
92
93
 
# File 'lib/puma/minissl.rb', line 91

def write_nonblock(data, *_)
  write data
end