Class: LogCourier::ServerTcp

Inherits:
Object
  • Object
show all
Defined in:
lib/log-courier/server_tcp.rb

Overview

TLS transport implementation for server

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ServerTcp

Create a new TLS transport endpoint



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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
 
# File 'lib/log-courier/server_tcp.rb', line 41

def initialize(options = {})
  @options = {
    logger:                nil,
    transport:             'tls',
    port:                  0,
    address:               '0.0.0.0',
    ssl_certificate:       nil,
    ssl_key:               nil,
    ssl_key_passphrase:    nil,
    ssl_verify:            false,
    ssl_verify_default_ca: false,
    ssl_verify_ca:         nil,
    max_packet_size:       10_485_760,
  }.merge!(options)

  @logger = @options[:logger]

  if @options[:transport] == 'tls'
    [:ssl_certificate, :ssl_key].each do |k|
      raise "[LogCourierServer] '#{k}' is required" if @options[k].nil?
    end

    if @options[:ssl_verify] and (!@options[:ssl_verify_default_ca] && @options[:ssl_verify_ca].nil?)
      raise '[LogCourierServer] Either \'ssl_verify_default_ca\' or \'ssl_verify_ca\' must be specified when ssl_verify is true'
    end
  end

  begin
    @tcp_server = ExtendedTCPServer.new(@options[:address], @options[:port])

    # Query the port in case the port number is '0'
    # TCPServer#addr == [ address_family, port, address, address ]
    @port = @tcp_server.addr[1]

    if @options[:transport] == 'tls'
      ssl = OpenSSL::SSL::SSLContext.new
      ssl.cert = OpenSSL::X509::Certificate.new(File.read(@options[:ssl_certificate]))
      ssl.key = OpenSSL::PKey::RSA.new(File.read(@options[:ssl_key]), @options[:ssl_key_passphrase])

      if @options[:ssl_verify]
        cert_store = OpenSSL::X509::Store.new

        # Load the system default certificate path to the store
        cert_store.set_default_paths if @options[:ssl_verify_default_ca]

        if File.directory?(@options[:ssl_verify_ca])
          cert_store.add_path(@options[:ssl_verify_ca])
        else
          cert_store.add_file(@options[:ssl_verify_ca])
        end

        ssl.cert_store = cert_store

        ssl.verify_mode = OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
      end

      @server = OpenSSL::SSL::SSLServer.new(@tcp_server, ssl)
    else
      @server = @tcp_server
    end

    if @options[:port] == 0
      @logger.warn '[LogCourierServer] Transport ' + @options[:transport] + ' is listening on ephemeral port ' + @port.to_s unless @logger.nil?
    end
  rescue => e
    raise "[LogCourierServer] Failed to initialise: #{e}"
  end
end

Instance Attribute Details

#port ⇒ Object (readonly)

Returns the value of attribute port.



38
39
40
 
# File 'lib/log-courier/server_tcp.rb', line 38

def port
  @port
end

Instance Method Details

#run(&block) ⇒ Object

def initialize



110
111
112
113
114
115
116
117
118
119
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
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/log-courier/server_tcp.rb', line 110

def run(&block)
  client_threads = {}

  loop do
    # This means ssl accepting is single-threaded.
    begin
      client = @server.accept
    rescue EOFError, OpenSSL::SSL::SSLError, IOError => e
      # Handshake failure or other issue
      peer = Thread.current['LogCourierPeer'] || 'unknown'
      @logger.warn "[LogCourierServer] Connection from #{peer} failed to initialise: #{e}" unless @logger.nil?
      client.close rescue nil
      next
    end

    peer = Thread.current['LogCourierPeer'] || 'unknown'

    @logger.info "[LogCourierServer] New connection from #{peer}" unless @logger.nil?

    # Clear up finished threads
    client_threads.delete_if do |_, thr|
      !thr.alive?
    end

    # Start a new connection thread
    client_threads[client] = Thread.new(client, peer) do |client_copy, peer_copy|
      ConnectionTcp.new(@logger, client_copy, peer_copy, @options).run(&block)
    end
  end
rescue ShutdownSignal
  # Capture shutting down signal
  0
rescue StandardError, NativeException => e
  # Some other unknown problem
  @logger.warn("[LogCourierServer] Unknown error: #{e}") unless @logger.nil?
  @logger.warn("[LogCourierServer] #{e.backtrace}: #{e.message} (#{e.class})") unless @logger.nil?
  raise e
ensure
  # Raise shutdown in all client threads and join then
  client_threads.each do |_, thr|
    thr.raise ShutdownSignal
  end

  client_threads.each(&:join)

  @tcp_server.close
end