Class: EventMachine::EmailServer::SMTPServer

Inherits:
Connection
  • Object
show all
Defined in:
lib/eventmachine/email_server/smtp_server.rb

Constant Summary collapse

@@graylist =
nil
@@dnsbl_check =
nil
@@ratelimiter =
nil
@@reverse_ptr_check =
false
@@spf_check =
false
@@reject_filters =
Array.new
@@classifier =
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hostname, userstore, emailstore) ⇒ SMTPServer

Returns a new instance of SMTPServer.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/eventmachine/email_server/smtp_server.rb', line 77

def initialize(hostname, userstore, emailstore)
  @hostname = hostname
  @userstore = userstore
  @emailstore = emailstore
  @debug = false
  @data_mode = false
  @email_body = ""
  @ptr_ok = true
  @dnsbl_ok = true
  @rate_ok = true
  @gray_ok = true
  @spf_ok = true
  @reject_ok = true
  @classifier_ok = true
  @pending_checks = [:content]
end

Instance Attribute Details

#debugObject

Returns the value of attribute debug.



75
76
77
# File 'lib/eventmachine/email_server/smtp_server.rb', line 75

def debug
  @debug
end

Class Method Details

.classifier(classifier = nil) ⇒ Object



68
69
70
71
72
73
# File 'lib/eventmachine/email_server/smtp_server.rb', line 68

def self.classifier(classifier=nil)
  if not classifier.nil?
    @@classifier = classifier
  end
  @@classifier
end

.dnsbl_check(dnsbl_check = nil) ⇒ Object



40
41
42
43
44
45
# File 'lib/eventmachine/email_server/smtp_server.rb', line 40

def self.dnsbl_check(dnsbl_check=nil)
  if not dnsbl_check.nil?
    @@dnsbl_check = dnsbl_check
  end
  @@dnsbl_check
end

.graylist(graylist = nil) ⇒ Object



33
34
35
36
37
38
# File 'lib/eventmachine/email_server/smtp_server.rb', line 33

def self.graylist(graylist=nil)
  if graylist
    @@graylist = graylist
  end
  @@graylist
end

.ratelimiter(ratelimiter = nil) ⇒ Object



47
48
49
50
51
52
# File 'lib/eventmachine/email_server/smtp_server.rb', line 47

def self.ratelimiter(ratelimiter=nil)
  if ratelimiter
    @@ratelimiter = ratelimiter
  end
  @@ratelimiter
end

.reject_filters(filters = nil) ⇒ Object



54
55
56
57
58
59
# File 'lib/eventmachine/email_server/smtp_server.rb', line 54

def self.reject_filters(filters=nil)
  if filters
    @@reject_filters = filters
  end
  @@reject_filters
end

.resetObject



16
17
18
19
20
21
22
23
24
# File 'lib/eventmachine/email_server/smtp_server.rb', line 16

def self.reset
  @@graylist = nil
  @@dnsbl_check = nil
  @@ratelimiter = nil
  @@reverse_ptr_check = false
  @@spf_check = false
  @@reject_filters = Array.new
  @@classifier = nil
end

.reverse_ptr_check(ptr = nil) ⇒ Object



26
27
28
29
30
31
# File 'lib/eventmachine/email_server/smtp_server.rb', line 26

def self.reverse_ptr_check(ptr=nil)
  if not ptr.nil?
    @@reverse_ptr_check = ptr
  end
  @@reverse_ptr_check
end

.spf_check(spf = nil) ⇒ Object



61
62
63
64
65
66
# File 'lib/eventmachine/email_server/smtp_server.rb', line 61

def self.spf_check(spf=nil)
  if not spf.nil?
    @@spf_check = spf
  end
  @@spf_check
end

Instance Method Details

#check_classifierObject



158
159
160
161
162
163
164
# File 'lib/eventmachine/email_server/smtp_server.rb', line 158

def check_classifier
  if @@classifier
    if @@classifier.block?(@email_body)
      @classifier_ok = false
    end
  end
end

#check_dnsbl(ip) ⇒ Object



122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/eventmachine/email_server/smtp_server.rb', line 122

def check_dnsbl(ip)
  if @@dnsbl_check
    @dnsbl_ok = false
    @pending_checks << :dnsbl
    EventMachine::DNSBL::Client.check(ip) do |results|
      @dnsbl_ok = ! EventMachine::DNSBL::Client.blacklisted?(results)
      @pending_checks -= [:dnsbl]
      if @pending_checks.length == 0
        send_answer
      end
    end
  end
end

#check_gray(ip) ⇒ Object



142
143
144
145
146
147
# File 'lib/eventmachine/email_server/smtp_server.rb', line 142

def check_gray(ip)
  if @@graylist
    @gray_ok = @@graylist.has_key?(ip)
    @@graylist[ip] = true
  end
end

#check_ptr(helo, ip) ⇒ Object



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/eventmachine/email_server/smtp_server.rb', line 105

def check_ptr(helo, ip)
  if helo =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/ and helo == ip
    @ptr_ok = true
  elsif @@reverse_ptr_check
    @ptr_ok = false
    @pending_checks << :ptr
    d = EM::DNS::Resolver.resolve helo
    d.callback { |r|
      @ptr_ok = r.include?(ip)
      @pending_checks -= [:ptr]
      if @pending_checks.length == 0
        send_answer
      end
    }
  end
end

#check_ratelimit(ip) ⇒ Object



136
137
138
139
140
# File 'lib/eventmachine/email_server/smtp_server.rb', line 136

def check_ratelimit(ip)
  if @@ratelimiter
    @rate_ok = @@ratelimiter.use(ip)
  end
end

#check_rejectObject



149
150
151
152
153
154
155
156
# File 'lib/eventmachine/email_server/smtp_server.rb', line 149

def check_reject
  @@reject_filters.each do |filter|
    if filter.match(@email_body)
      @reject_ok = false
      return
    end
  end
end

#check_spf(helo, client_ip, identity) ⇒ Object



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
212
213
214
215
216
# File 'lib/eventmachine/email_server/smtp_server.rb', line 166

def check_spf(helo, client_ip, identity)
  if @@spf_check
    @spf_ok = false
    @pending_checks << :spf
    
    spf_dispatcher = EventMachine::ThreadedResource.new do
      spf_server = SPF::Server.new
    end

    pool = EM::Pool.new

    pool.add spf_dispatcher

    pool.perform do |dispatcher|
      completion = dispatcher.dispatch do |spf_server|
        if helo =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/ and helo == ip
          helo = nil
        end
        request = SPF::Request.new(
          versions:      [1, 2],             # optional
          scope:         'mfrom',            # or 'helo', 'pra'
          identity:      identity,
          ip_address:    client_ip,
          helo_identity: helo   # optional
        )

        result = spf_server.process(request)
      end
  
      completion.callback do |result|
        if result.code == :pass
          @spf_ok = true
        elsif result.code == :fail
          @spf_ok = false
        elsif result.code == :softfail
          @spf_ok = true
        elsif result.code == :neutral
          @spf_ok = true
        else
          @spf_ok = false
        end
        @pending_checks -= [:spf]
        if @pending_checks.length == 0
          send_answer
        end
      end
  
      completion
    end          
  end
end

#post_initObject



94
95
96
# File 'lib/eventmachine/email_server/smtp_server.rb', line 94

def post_init
  send "220 #{@hostname} ESMTP Service ready"
end

#process_line(line) ⇒ Object



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/eventmachine/email_server/smtp_server.rb', line 242

def process_line(line)
  if (@data_mode) && (line.chomp == '.')
    @data_mode = false
     check_reject
     check_classifier
     @pending_checks -= [:content]
     p @pending_checks if @debug
     if @pending_checks.length == 0
       send_answer
     end
  elsif @data_mode
    @email_body += line
  elsif (line =~ /^(HELO|EHLO) (.*)/)
     helo = $2.chomp.gsub(/^\[/,'').gsub(/\]$/,'')
     port, ip = Socket.unpack_sockaddr_in(get_peername)
     check_ptr(helo, ip)
     check_dnsbl(ip)
     check_gray(ip)
     check_ratelimit(ip)
     send("250 hello #{ip} (#{helo})")
  elsif (line =~ /^QUIT/)
     send("221 #{@hostname} ESMTP server closing connection")
     self.close_connection
  elsif (line =~ /^MAIL FROM\:/)
    @mail_from = (/^MAIL FROM\:\s*<(.+)>.*$/).match(line)[1]
     if @@spf_check
       port, ip = Socket.unpack_sockaddr_in(get_peername)
       check_spf(helo, ip, @mail_from)
     end
     send("250 OK")
  elsif (line =~ /^RCPT TO\:/)
    rcpt_to = (/^RCPT TO\:\s*<(.+)>.*$/).match(line)[1]
    if @userstore.user_by_emailaddress(rcpt_to.strip)
      @rcpt_to = rcpt_to
       send("250 OK")
     else
       send("550 No such user here")
     end
  elsif (line =~ /^DATA/)
    if @rcpt_to
      @data_mode = true
      @email_body = ''
      send("354 Enter message, ending with \".\" on a line by itself")
     else
       send("500 ERROR")
     end
  else
    send("500 ERROR")
  end
end

#receive_data(data) ⇒ Object



98
99
100
101
102
103
# File 'lib/eventmachine/email_server/smtp_server.rb', line 98

def receive_data(data)
  puts ">> #{data}" if @debug
  data.split(/\n/).each do |line|
    process_line(line+"\n")
  end
end

#saveObject



293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/eventmachine/email_server/smtp_server.rb', line 293

def save
  begin
    subject = @email_body.match(/Subject\:\s*(.*?)[\r\n]/i)[1]
    u = @userstore.user_by_emailaddress(@rcpt_to.strip)
  rescue Exception => err
    puts err if @debug
    return
  end
  if u and @mail_from and @rcpt_to
    subject ||= ''
     @emailstore << Email.new(nil, @mail_from, @rcpt_to, subject, @email_body, u.id)
  end
end

#send(msg) ⇒ Object



237
238
239
240
# File 'lib/eventmachine/email_server/smtp_server.rb', line 237

def send(msg)
  puts "<< #{msg}" if @debug
  send_data("#{msg}\r\n")
end

#send_answerObject



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/eventmachine/email_server/smtp_server.rb', line 218

def send_answer
  if @debug
    puts "ptr_ok        = #{@ptr_ok}"
    puts "rate_ok       = #{@rate_ok}"
    puts "gray_ok       = #{@gray_ok}"
    puts "reject_ok     = #{@reject_ok}"
    puts "dnsbl_ok      = #{@dnsbl_ok}"
    puts "spf_ok        = #{@spf_ok}"
    puts "classifier_ok = #{@classifier_ok}"
  end
  if @ptr_ok and @rate_ok and @gray_ok and @reject_ok and @dnsbl_ok and @spf_ok and @classifier_ok
    ans = "250 OK"
    save
  else
    ans = "451 Requested action aborted: local error in processing"
  end
  send(ans)
end