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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
require 'custodian/settings'
require 'custodian/testfactory'
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.
#
module Custodian
module ProtocolTest
class TCPTest < TestFactory
#
# The input line from which we were constructed.
#
attr_reader :line
#
# The host to test against.
#
attr_reader :host
#
# The port to connect to.
#
attr_reader :port
#
# Is this test inverted?
#
attr_reader :inverted
#
# 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 line
#
@line = line
#
# Save the host
#
@host = line.split( /\s+/)[0]
#
# Is this test inverted?
#
if ( line =~ /must\s+not\s+run\s+/ )
@inverted = true
else
@inverted = false
end
#
# 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
#
# Allow this test to be serialized.
#
def to_s
return( @line )
end
#
# Run the test.
#
def run_test
# reset the error, in case we were previously executed.
@error = nil
return( run_test_internal( @host, @port, @banner, ( ! @banner.nil? ) ) )
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, do_read = false )
#
# Get the timeout period for this test.
#
settings = Custodian::Settings.instance()
period = settings.timeout()
begin
timeout(period) do
begin
socket = TCPSocket.new( host, port )
# read a banner from the remote server, if we're supposed to.
read = nil
read = socket.sysread(1024) if ( do_read )
# 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? ) && ( banner.match(read) ) )
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
end
end
|
