module OpenSSL::Buffering

Included modules:: Enumerable

OpenSSL IO buffering mix-in module.

This module allows an OpenSSL::SSL::SSLSocket to behave like an IO.

You typically won't use this module directly, you can see it implemented in OpenSSL::SSL::SSLSocket.

Constants

BLOCK_SIZE: Default size to read from or write to the SSLSocket for buffer operations.

Attributes

sync[RW]

The “sync mode” of the SSLSocket.

See IO#sync for full details.

Public Class Methods

new(*) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 39
def initialize(*)
  super
  @eof = false
  @rbuffer = ""
  @sync = @io.sync
end

Creates an instance of OpenSSL's buffering IO module.

Calls superclass method

Public Instance Methods

<<(s) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 385
def << (s)
  do_write(s)
  self
end

Writes s to the stream. s will be converted to a String using String#to_s.

close() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 448
def close
  flush rescue nil
  sysclose
end

Closes the SSLSocket and flushes any unwritten data.

each(eol=$/) { |line| ... } Show source

# File ext/openssl/lib/openssl/buffering.rb, line 223
def each(eol=$/)
  while line = self.gets(eol)
    yield line
  end
end

Executes the block for every line in the stream where lines are separated by eol.

See also gets

Also aliased as: each_line

each_byte() { |byte| ... } Show source

# File ext/openssl/lib/openssl/buffering.rb, line 264
def each_byte # :yields: byte
  while c = getc
    yield(c.ord)
  end
end

Calls the given block once for each byte in the stream.

each_line(eol=$/)

Alias for: each

eof()

Alias for: eof?

eof?() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 295
def eof?
  fill_rbuff if !@eof && @rbuffer.empty?
  @eof && @rbuffer.empty?
end

Returns true if the stream is at file which means there is no more data to be read.

Also aliased as: eof

flush() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 436
def flush
  osync = @sync
  @sync = true
  do_write ""
  return self
ensure
  @sync = osync
end

Flushes buffered data to the SSLSocket.

getc() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 257
def getc
  read(1)
end

Reads one character from the stream. Returns nil if called at end of file.

gets(eol=$/, limit=nil) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 199
def gets(eol=$/, limit=nil)
  idx = @rbuffer.index(eol)
  until @eof
    break if idx
    fill_rbuff
    idx = @rbuffer.index(eol)
  end
  if eol.is_a?(Regexp)
    size = idx ? idx+$&.size : nil
  else
    size = idx ? idx+eol.size : nil
  end
  if size && limit && limit >= 0
    size = [size, limit].min
  end
  consume_rbuff(size)
end

Reads the next “line+ from the stream. Lines are separated by eol. If limit is provided the result will not be longer than the given number of bytes.

eol may be a String or Regexp.

Unlike IO#gets the line read will not be assigned to +$_+.

Unlike IO#gets the separator must be provided if a limit is provided.

print(*args) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 415
def print(*args)
  s = ""
  args.each{ |arg| s << arg.to_s }
  do_write(s)
  nil
end

Writes args to the stream.

See IO#print for full details.

printf(s, *args) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 428
def printf(s, *args)
  do_write(s % args)
  nil
end

Formats and writes to the stream converting parameters under control of the format string.

See Kernel#sprintf for format string details.

puts(*args) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 395
def puts(*args)
  s = ""
  if args.empty?
    s << "\n"
  end
  args.each{|arg|
    s << arg.to_s
    if $/ && /\n\z/ !~ s
      s << "\n"
    end
  }
  do_write(s)
  nil
end

Writes args to the stream along with a record separator.

See IO#puts for full details.

read(size=nil, buf=nil) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 86
def read(size=nil, buf=nil)
  if size == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  until @eof
    break if size && size <= @rbuffer.size
    fill_rbuff
  end
  ret = consume_rbuff(size) || ""
  if buf
    buf.replace(ret)
    ret = buf
  end
  (size && ret.empty?) ? nil : ret
end

Reads size bytes from the stream. If buf is provided it must reference a string which will receive the data.

See IO#read for full details.

read_nonblock(maxlen, buf=nil, exception: true) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 167
def read_nonblock(maxlen, buf=nil, exception: true)
  if maxlen == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  if @rbuffer.empty?
    return sysread_nonblock(maxlen, buf, exception: exception)
  end
  ret = consume_rbuff(maxlen)
  if buf
    buf.replace(ret)
    ret = buf
  end
  raise EOFError if ret.empty?
  ret
end

Reads at most maxlen bytes in the non-blocking manner.

When no data can be read without blocking it raises OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.

IO::WaitReadable means SSL needs to read internally so #read_nonblock should be called again when the underlying IO is readable.

IO::WaitWritable means SSL needs to write internally so #read_nonblock should be called again after the underlying IO is writable.

#read_nonblock needs two rescue clause as follows:

# emulates blocking read (readpartial).
begin
  result = ssl.read_nonblock(maxlen)
rescue IO::WaitReadable
  IO.select([io])
  retry
rescue IO::WaitWritable
  IO.select(nil, [io])
  retry
end

Note that one reason that #read_nonblock writes to the underlying IO is when the peer requests a new TLS/SSL handshake. See openssl the FAQ for more details. www.openssl.org/support/faq.html

readchar() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 274
def readchar
  raise EOFError if eof?
  getc
end

Reads a one-character string from the stream. Raises an EOFError at end of file.

readline(eol=$/) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 248
def readline(eol=$/)
  raise EOFError if eof?
  gets(eol)
end

Reads a line from the stream which is separated by eol.

Raises EOFError if at end of file.

readlines(eol=$/) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 235
def readlines(eol=$/)
  ary = []
  while line = self.gets(eol)
    ary << line
  end
  ary
end

Reads lines from the stream which are separated by eol.

See also gets

readpartial(maxlen, buf=nil) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 113
def readpartial(maxlen, buf=nil)
  if maxlen == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  if @rbuffer.empty?
    begin
      return sysread(maxlen, buf)
    rescue Errno::EAGAIN
      retry
    end
  end
  ret = consume_rbuff(maxlen)
  if buf
    buf.replace(ret)
    ret = buf
  end
  raise EOFError if ret.empty?
  ret
end

Reads at most maxlen bytes from the stream. If buf is provided it must reference a string which will receive the data.

See IO#readpartial for full details.

ungetc(c) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 287
def ungetc(c)
  @rbuffer[0,0] = c.chr
end

Pushes character c back onto the stream such that a subsequent buffered character read will return it.

Unlike IO#getc multiple bytes may be pushed back onto the stream.

Has no effect on unbuffered reads (such as sysread).

write(s) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 338
def write(s)
  do_write(s)
  s.bytesize
end

Writes s to the stream. If the argument is not a string it will be converted using String#to_s. Returns the number of bytes written.

write_nonblock(s, exception: true) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 376
def write_nonblock(s, exception: true)
  flush
  syswrite_nonblock(s, exception: exception)
end

Writes str in the non-blocking manner.

If there is buffered data, it is flushed first. This may block.

#write_nonblock returns number of bytes written to the SSL connection.

When no data can be written without blocking it raises OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.

IO::WaitReadable means SSL needs to read internally so #write_nonblock should be called again after the underlying IO is readable.

IO::WaitWritable means SSL needs to write internally so #write_nonblock should be called again after underlying IO is writable.

So #write_nonblock needs two rescue clause as follows.

# emulates blocking write.
begin
  result = ssl.write_nonblock(str)
rescue IO::WaitReadable
  IO.select([io])
  retry
rescue IO::WaitWritable
  IO.select(nil, [io])
  retry
end

Note that one reason that #write_nonblock reads from the underlying IO is when the peer requests a new TLS/SSL handshake. See the openssl FAQ for more details. www.openssl.org/support/faq.html

Private Instance Methods

consume_rbuff(size=nil) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 67
def consume_rbuff(size=nil)
  if @rbuffer.empty?
    nil
  else
    size = @rbuffer.size unless size
    ret = @rbuffer[0, size]
    @rbuffer[0, size] = ""
    ret
  end
end

Consumes size bytes from the buffer

do_write(s) Show source

# File ext/openssl/lib/openssl/buffering.rb, line 310
def do_write(s)
  @wbuffer = "" unless defined? @wbuffer
  @wbuffer << s
  @wbuffer.force_encoding(Encoding::BINARY)
  @sync ||= false
  if @sync or @wbuffer.size > BLOCK_SIZE or idx = @wbuffer.rindex($/)
    remain = idx ? idx + $/.size : @wbuffer.length
    nwritten = 0
    while remain > 0
      str = @wbuffer[nwritten,remain]
      begin
        nwrote = syswrite(str)
      rescue Errno::EAGAIN
        retry
      end
      remain -= nwrote
      nwritten += nwrote
    end
    @wbuffer[0,nwritten] = ""
  end
end

Writes s to the buffer. When the buffer is full or sync is true the buffer is flushed to the underlying socket.

fill_rbuff() Show source

# File ext/openssl/lib/openssl/buffering.rb, line 54
def fill_rbuff
  begin
    @rbuffer << self.sysread(BLOCK_SIZE)
  rescue Errno::EAGAIN
    retry
  rescue EOFError
    @eof = true
  end
end

Fills the buffer from the underlying SSLSocket

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.