summaryrefslogtreecommitdiff
path: root/lib/custodian/protocoltest/mx.rb
blob: cd5e58ea006de75f1fab7f561b189b9c1490b5fc (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
require 'custodian/settings'
require 'custodian/testfactory'

#
#  The MX (DNS + smtp) test.
#
#  This object is instantiated if the parser sees a line such as:
#
###
### bytemark.co.uk must run mx otherwise 'mail fail'.
###
#
#
module Custodian

  module ProtocolTest

    class MXTest < TestFactory


      #
      # Constructor
      #
      def initialize(line)

        # Save the line away
        @line = line

        # The main domain we're querying
        @host = line.split(/\s+/)[0]

      end



      #
      # Allow this test to be serialized.
      #
      def to_s
        @line
      end


      #
      # Run the test.
      #
      def run_test

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

        #
        # Get the timeout period.
        #
        settings = Custodian::Settings.instance
        period   = settings.timeout

        #
        #  The MX-hosts
        #
        mx = []

        #
        #  Lookup the MX record
        #
        begin
          timeout(period) do

            Resolv::DNS.open do |dns|
              ress = dns.getresources(@host, Resolv::DNS::Resource::IN::MX)
              ress.map { |r| mx.push(IPSocket.getaddress(r.exchange.to_s)) }
            end
          end
        rescue Timeout::Error => e
          @error = "Timed-out performing DNS lookups: #{e}"
          return Custodian::TestResult::TEST_FAILED
        end

        #
        # At this point we should have an array of IPv4 or IPv6 addresses.
        #
        # If that array is empty then there will be no incoming mail because
        # there are now working MX records in DNS - or because the domain
        # has expired, etc.
        #
        # So on that basis we must alert.
        #
        if  mx.empty?  then
          @error = "Failed to perform DNS lookup of MX record(s) for host #{@host}"
          return Custodian::TestResult::TEST_FAILED
        end


        #
        #  For each host we must make a connection.
        #
        #  We'll keep count of failures.
        #
        failed = 0
        passed = 0
        error  = ''

        mx.each do |backend|

          begin
            timeout(period) do
              begin
                socket = TCPSocket.new(backend, 25)
                read = socket.sysread(1024)

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

                if  read =~ /^220/
                  passed += 1
                else
                  failed += 1
                end
              rescue
                # Failure to connect.
                failed += 1
                error += "Error connecting to #{backend}:25. "
              end
            end
          rescue Timeout::Error => _ex
            # Timeout
            failed += 1
            error += "Timeout connecting to #{backend}:25. "
          end
        end

        #
        #  At this point we should have tested the things
        #
        if  failed > 0
          @error = "There are #{mx.size} hosts running as MX-servers for domain #{@host} - #{passed}:OK #{failed}:FAILED - #{error}"
          return Custodian::TestResult::TEST_FAILED
        else
          return Custodian::TestResult::TEST_PASSED
        end
      end




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




      register_test_type 'mx'




    end
  end
end