summaryrefslogtreecommitdiff
path: root/lib/custodian/protocoltest/tcp.rb
blob: 5f29b7f9664c8b2c9fa8cee19a77e6ce807b996a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
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
109
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
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
require 'socket'
require 'timeout'


#
#  The TCP-protocol test.
#
#  This object is instantiated if the parser sees a line such as:
#
###
### foo.vm.bytemark.co.uk must run tcp on 22 with banner 'ssh' otherwise 'ssh fail'.
###
#
#  The specification of the port is mandatory, the banner is optional.
#
class TCPTest < ProtocolTest


  #
  # The host to test against.
  #
  attr_reader :host


  #
  # The port to connect to.
  #
  attr_reader :port


  #
  #  The banner to look for, may be nil.
  #
  attr_reader :banner




  #
  # Constructor
  #
  # Ensure we received a port to run the TCP-test against.
  #
  def initialize( line )

    #
    # Save the host
    #
    @host  = line.split( /\s+/)[0]

    #
    # Save the port
    #
    if ( line =~ /on\s+([0-9]+)/ )
      @port = $1.dup
    else
      @port = nil
    end

    #
    # Save the optional banner.
    #
    if ( line =~ /with\s+banner\s+'([^']+)'/ )
      @banner = $1.dup
    else
      @banner = nil
    end

    @error = nil

    if ( @port.nil? )
      raise ArgumentError, "Missing port to test against"
    end
  end




  #
  # Helper for development.
  #
  def to_s
    "tcp-test of #{@host}:#{@port} looking for banner '#{@banner}'."
  end




  #
  # Convert this class to JSON such that it may be serialized.
  #
  def to_json
    hash = {
            :test_type   => 'tcp',
            :test_target => @host,
            :test_port   => @port,
            :banner      => @banner
    }
    hash.to_json
  end




  #
  # Run the TCP-protocol test.
  #
  def run_test

    # reset the error, in case we were previously executed.
    @error = nil

    return( run_test_internal( @host, @port, @banner ) )
  end




  #
  # Run the connection test - optionally matching against the banner.
  #
  # If the banner is nil then we're merely testing we can connect and
  # send the string "quit".
  #
  #
  def run_test_internal( host, port, banner = nil )
    begin
      timeout(30) do
        begin
          socket = TCPSocket.new( host, port )
          socket.puts( "QUIT")

          # read a banner from the remote server
          read = socket.gets(nil)

          # trim to a sane length & strip newlines.
          read = read[0,255] unless ( read.nil? )
          read.gsub!(/[\n\r]/, "") unless ( read.nil? )

          socket.close()

          if ( banner.nil? )
            @error = nil
            return true
          else
            # test for banner
            if ( ( !read.nil? ) && ( read =~ /#{banner}/i ) )
              return true
            end

            @error = "We expected a banner matching '#{banner}' but we got '#{read}'"
            return false
          end
        rescue
          @error = "Exception connecting to host #{host}:#{port} - #{$!}"
          return false
        end
      end
    rescue Timeout::Error => e
      @error = "TIMEOUT: #{e}"
      return false
    end
    @error = "Misc failure"
    return false
  end




  #
  # If the test fails then report the error.
  #
  def error
    @error
  end




  register_test_type "tcp"




end