mailcatcher-ng 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ce8da5001fe3dbf561a375431bda1fb4a1011dd09286307c05aa4ce0c206dd
-  data.tar.gz: 11727e123a3a6395ebf5ecf1eb93fc7258889f203260e2d6fbf9f3c3f67aaa43
+  metadata.gz: 71c31256fbd4bdc76749770fe321db1351839f23fd01d1ef2ab6f21382da774b
+  data.tar.gz: 7f77c22a8dd2e3b7cea54c6ec415af7f408ad39588e48772cffaec625dd8fd15
 SHA512:
-  metadata.gz: dfd03e9c5c8e77348c9853004afdd37d23d3c7c1c7ee6dad7e38a38943d7e8e3943be25379835429dcd027ecccf948ddde05b71227f3382fa78ac13fdeebf2fd
-  data.tar.gz: dd822cf0ca1c50a307bfb8001e20187690b8ce99a8b1ef0ef043c094b51682e90e103ece5bf4d1d278740ef020cecb77d4632ab165d290bb2a2169634dc4cafa
+  metadata.gz: 3e47f2938af045fd8da6b1e7eacb1a0552a5076bd5415c1079db271335271fc1299c3c47e3dfc78b9eaf1383699f339c1b7f674ff3169bdf65f270666c819255
+  data.tar.gz: c49f21a836aae6a35f84568997ddc29f4c619b3cebead68421a882b4ab3ff5ae4685f39e7a69a0473840d83831f88b55b01b4cbe0af5399981f04663319e65f5

data/lib/mail_catcher/mail.rb

@@ -36,6 +36,27 @@ module MailCatcher::Mail extend self
             FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE CASCADE
           )
         SQL
+        db.execute(<<-SQL)
+          CREATE TABLE smtp_transcript (
+            id INTEGER PRIMARY KEY ASC,
+            message_id INTEGER,
+            session_id TEXT NOT NULL,
+            client_ip TEXT,
+            client_port INTEGER,
+            server_ip TEXT,
+            server_port INTEGER,
+            tls_enabled INTEGER DEFAULT 0,
+            tls_protocol TEXT,
+            tls_cipher TEXT,
+            connection_started_at DATETIME,
+            connection_ended_at DATETIME,
+            entries TEXT NOT NULL,
+            created_at DATETIME DEFAULT CURRENT_DATETIME,
+            FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE CASCADE
+          )
+        SQL
+        db.execute("CREATE INDEX idx_smtp_transcript_message_id ON smtp_transcript(message_id)")
+        db.execute("CREATE INDEX idx_smtp_transcript_session_id ON smtp_transcript(session_id)")
         db.execute("PRAGMA foreign_keys = ON")
       end
     end
@@ -60,6 +81,8 @@ module MailCatcher::Mail extend self
       message = MailCatcher::Mail.message message_id
       MailCatcher::Bus.push(type: "add", message: message)
     end
+
+    message_id
   end
 
   def add_message_part(*args)
@@ -387,6 +410,66 @@ module MailCatcher::Mail extend self
     encryption_data
   end
 
+  def add_smtp_transcript(params)
+    @add_smtp_transcript_query ||= db.prepare(<<-SQL)
+      INSERT INTO smtp_transcript (
+        message_id, session_id, client_ip, client_port,
+        server_ip, server_port, tls_enabled, tls_protocol,
+        tls_cipher, connection_started_at, connection_ended_at,
+        entries, created_at
+      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, datetime('now'))
+    SQL
+
+    @add_smtp_transcript_query.execute(
+      params[:message_id],
+      params[:session_id],
+      params[:client_ip],
+      params[:client_port],
+      params[:server_ip],
+      params[:server_port],
+      params[:tls_enabled],
+      params[:tls_protocol],
+      params[:tls_cipher],
+      params[:connection_started_at]&.utc&.iso8601,
+      params[:connection_ended_at]&.utc&.iso8601,
+      JSON.generate(params[:entries])
+    )
+  end
+
+  def message_transcript(message_id)
+    @message_transcript_query ||= db.prepare(<<-SQL)
+      SELECT id, session_id, client_ip, client_port,
+             server_ip, server_port, tls_enabled, tls_protocol,
+             tls_cipher, connection_started_at, connection_ended_at,
+             entries, created_at
+      FROM smtp_transcript
+      WHERE message_id = ?
+      ORDER BY created_at DESC
+      LIMIT 1
+    SQL
+
+    row = @message_transcript_query.execute(message_id).next
+    return nil unless row
+
+    result = Hash[@message_transcript_query.columns.zip(row)]
+    result['entries'] = JSON.parse(result['entries']) if result['entries']
+    result['tls_enabled'] = result['tls_enabled'] == 1
+    result
+  end
+
+  def all_transcripts
+    @all_transcripts_query ||= db.prepare(<<-SQL)
+      SELECT id, message_id, session_id, client_ip,
+             connection_started_at, tls_enabled
+      FROM smtp_transcript
+      ORDER BY created_at DESC
+    SQL
+
+    @all_transcripts_query.execute.map do |row|
+      Hash[@all_transcripts_query.columns.zip(row)]
+    end
+  end
+
   private
 
   def parse_authentication_results(auth_header)

data/lib/mail_catcher/smtp.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "eventmachine"
+require "securerandom"
+require "socket"
 
 require "mail_catcher/mail"
 
@@ -11,16 +13,111 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
     @@active_connections
   end
 
+  def initialize(*args)
+    @transcript_entries = []
+    @session_id = SecureRandom.uuid
+    @connection_started_at = Time.now
+    @data_started = false
+    super
+  end
+
   def post_init
     @@active_connections += 1
+
+    # Get connection details
+    begin
+      peer_sockaddr = get_peername
+      if peer_sockaddr
+        port, client_ip = Socket.unpack_sockaddr_in(peer_sockaddr)
+        @client_ip = client_ip
+        @client_port = port
+      end
+    rescue => e
+      $stderr.puts "Error getting peer info: #{e.message}"
+    end
+
+    begin
+      local_sockaddr = get_sockname
+      if local_sockaddr
+        port, server_ip = Socket.unpack_sockaddr_in(local_sockaddr)
+        @server_ip = server_ip
+        @server_port = port
+      end
+    rescue => e
+      $stderr.puts "Error getting local info: #{e.message}"
+    end
+
+    log_transcript('connection', 'server', "Connection established from #{@client_ip}:#{@client_port}")
+
     super
   end
 
   def unbind
     @@active_connections -= 1
+
+    @connection_ended_at = Time.now
+    log_transcript('connection', 'server', "Connection closed")
+
+    # Save transcript even if no message was completed
+    save_transcript(nil) if @transcript_entries.any?
+
     super
   end
 
+  def log_transcript(type, direction, message)
+    @transcript_entries << {
+      timestamp: Time.now.utc.iso8601(3),
+      type: type,
+      direction: direction,
+      message: message
+    }
+  rescue => e
+    $stderr.puts "Error logging transcript: #{e.message}"
+  end
+
+  def save_transcript(message_id)
+    return if @transcript_entries.empty?
+
+    begin
+      tls_enabled = @tls_started ? 1 : 0
+      tls_protocol = nil
+      tls_cipher = nil
+
+      if @tls_started
+        begin
+          tls_protocol = get_cipher_protocol
+        rescue
+          # TLS info not available
+        end
+        begin
+          tls_cipher = get_cipher_name
+        rescue
+          # TLS info not available
+        end
+      end
+
+      MailCatcher::Mail.add_smtp_transcript(
+        message_id: message_id,
+        session_id: @session_id,
+        client_ip: @client_ip,
+        client_port: @client_port,
+        server_ip: @server_ip,
+        server_port: @server_port,
+        tls_enabled: tls_enabled,
+        tls_protocol: tls_protocol,
+        tls_cipher: tls_cipher,
+        connection_started_at: @connection_started_at,
+        connection_ended_at: @connection_ended_at || Time.now,
+        entries: @transcript_entries
+      )
+
+      @transcript_entries = []
+    rescue => e
+      $stderr.puts "Error saving SMTP transcript: #{e.message}"
+      $stderr.puts e.backtrace.join("\n")
+    end
+  end
+
   # We override EM's mail from processing to allow multiple mail-from commands
   # per [RFC 2821](https://tools.ietf.org/html/rfc2821#section-4.1.1.2)
   def process_mail_from sender
@@ -38,7 +135,11 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
   end
 
   def receive_reset
+    log_transcript('command', 'client', 'RSET')
+    log_transcript('response', 'server', '250 OK')
+
     @current_message = nil
+    @data_started = false
 
     true
   end
@@ -48,33 +149,46 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
     # SIZE: RFC 1870 - Message size extension
     # 8BITMIME: RFC 6152 - 8bit MIME transport
     # SMTPUTF8: RFC 6531 - UTF-8 support in SMTP
-    capabilities = super.to_a
-    capabilities << "8BITMIME"
-    capabilities << "SMTPUTF8"
-    capabilities
+    ["8BITMIME", "SMTPUTF8"]
   end
 
   def receive_sender(sender)
+    # Log the full MAIL FROM command with ESMTP parameters
+    log_transcript('command', 'client', "MAIL FROM:<#{sender}>")
+
     # EventMachine SMTP advertises size extensions [https://tools.ietf.org/html/rfc1870]
     # and other SMTP parameters via the MAIL FROM command
     # Strip potential " SIZE=..." and "BODY=..." suffixes from senders
-    sender = sender.gsub(/ (?:SIZE|BODY)=\S+/i, "")
+    sender_cleaned = sender.gsub(/ (?:SIZE|BODY)=\S+/i, "")
+
+    log_transcript('response', 'server', '250 OK')
 
-    current_message[:sender] = sender
+    current_message[:sender] = sender_cleaned
     # Store the original sender line to track if 8BIT was specified
-    current_message[:sender_line] = sender
+    current_message[:sender_line] = sender_cleaned
 
     true
   end
 
   def receive_recipient(recipient)
+    log_transcript('command', 'client', "RCPT TO:<#{recipient}>")
+
     current_message[:recipients] ||= []
     current_message[:recipients] << recipient
 
+    log_transcript('response', 'server', '250 OK')
+
     true
   end
 
   def receive_data_chunk(lines)
+    # Log DATA command on first chunk only
+    if !@data_started
+      @data_started = true
+      log_transcript('command', 'client', 'DATA')
+      log_transcript('response', 'server', '354 Start mail input; end with <CRLF>.<CRLF>')
+    end
+
     current_message[:source] ||= +""
 
     lines.each do |line|
@@ -85,28 +199,124 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
   end
 
   def receive_message
-    MailCatcher::Mail.add_message current_message
+    message_size = current_message[:source].length
+    log_transcript('data', 'client', "Message complete (#{message_size} bytes)")
+    log_transcript('response', 'server', '250 OK: Message accepted')
+
+    begin
+      message_id = MailCatcher::Mail.add_message current_message
+    rescue => e
+      $stderr.puts "Error in add_message: #{e.message}"
+      $stderr.puts e.backtrace.join("\n")
+      message_id = nil
+    end
+
     MailCatcher::Mail.delete_older_messages!
-    puts "==> SMTP: Received message from '#{current_message[:sender]}' (#{current_message[:source].length} bytes)"
+
+    # Save transcript linked to message
+    save_transcript(message_id)
+
     true
   rescue => exception
+    log_transcript('error', 'server', "Exception: #{exception.class} - #{exception.message}")
     MailCatcher.log_exception("Error receiving message", @current_message, exception)
+
+    # Save transcript even on error
+    save_transcript(nil)
+
     false
   ensure
     @current_message = nil
+    @data_started = false
+  end
+
+  # Override to log EHLO/HELO command
+  def receive_ehlo_domain(domain)
+    log_transcript('command', 'client', "EHLO #{domain}")
+
+    # Call parent to handle the EHLO response
+    result = super
+
+    # Log the capabilities after they're sent
+    capabilities = get_server_capabilities
+    capabilities_str = capabilities.map { |cap| "250-#{cap}" }.join("\r\n")
+    # Replace first 250- with 250 followed by a space
+    if capabilities_str.start_with?("250-")
+      capabilities_str = "250 " + capabilities_str[4..-1]
+    end
+    log_transcript('response', 'server', capabilities_str)
+
+    result
+  end
+
+  # Override to log STARTTLS command and TLS negotiation
+  def process_starttls
+    log_transcript('tls', 'client', 'STARTTLS')
+    result = super
+
+    # Log TLS info after negotiation
+    if @tls_started
+      begin
+        protocol = get_cipher_protocol
+        cipher = get_cipher_name
+        log_transcript('tls', 'server', "TLS negotiation completed (#{protocol}, #{cipher})")
+      rescue
+        log_transcript('tls', 'server', "TLS negotiation completed")
+      end
+    end
+
+    result
+  end
+
+  # Override to log AUTH attempts (without logging credentials)
+  def receive_plain_auth(user, password)
+    log_transcript('command', 'client', "AUTH PLAIN [credentials hidden]")
+    result = super
+
+    if result
+      log_transcript('response', 'server', '235 2.7.0 Authentication successful')
+    else
+      log_transcript('response', 'server', '535 5.7.8 Authentication credentials invalid')
+    end
+
+    result
+  end
+
+  # Override to log unknown/invalid commands
+  def process_unknown(command, data)
+    log_transcript('command', 'client', "#{command} #{data}".strip)
+    result = super
+
+    log_transcript('response', 'server', '500 5.5.1 Command not recognized')
+
+    result
   end
 end
 
 # Direct TLS (SMTPS) handler that starts TLS immediately on connection
 class MailCatcher::SmtpTls < MailCatcher::Smtp
   def post_init
-    # Increment connection count
+    # Increment connection count and set up connection info
     super
 
+    # Log immediate TLS (SMTPS on port 1465)
+    log_transcript('tls', 'server', 'Immediate TLS enabled (SMTPS)')
+
     # Start TLS immediately on connection for SMTPS (port 1465 behavior)
     # The @@parms hash with starttls_options is already set by configure_smtp_ssl!
     if defined?(@@parms) && @@parms[:starttls_options]
       start_tls(@@parms[:starttls_options])
+
+      # Log TLS details after negotiation
+      if @tls_started
+        begin
+          protocol = get_cipher_protocol
+          cipher = get_cipher_name
+          log_transcript('tls', 'server', "TLS negotiation completed (#{protocol}, #{cipher})")
+        rescue
+          # TLS info not available yet
+        end
+      end
     end
   end
 end

data/lib/mail_catcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailCatcher
-  VERSION = '1.2.0'
+  VERSION = '1.3.1'
 end

data/lib/mail_catcher/web/application.rb

@@ -161,7 +161,8 @@ module MailCatcher
             "formats" => [
               "source",
               ("html" if Mail.message_has_html? id),
-              ("plain" if Mail.message_has_plain? id)
+              ("plain" if Mail.message_has_plain? id),
+              ("transcript" if Mail.message_transcript(id))
             ].compact,
             "attachments" => Mail.message_attachments(id),
             "bimi_location" => Mail.message_bimi_location(id),
@@ -169,7 +170,7 @@ module MailCatcher
             "authentication_results" => Mail.message_authentication_results(id),
             "encryption_data" => Mail.message_encryption_data(id),
             "from_header" => Mail.message_from(id),
-            "to_header" => Mail.message_to(id),
+            "to_header" => Mail.message_to(id)
           }))
         else
           not_found
@@ -222,6 +223,26 @@ module MailCatcher
         end
       end
 
+      get "/messages/:id/transcript.json" do
+        id = params[:id].to_i
+        if transcript = Mail.message_transcript(id)
+          content_type :json
+          JSON.generate(transcript)
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id.transcript" do
+        id = params[:id].to_i
+        if transcript = Mail.message_transcript(id)
+          content_type :html, charset: "utf-8"
+          erb :transcript, locals: { transcript: transcript }
+        else
+          not_found
+        end
+      end
+
       get "/messages/:id/parts/:cid" do
         id = params[:id].to_i
         if part = Mail.message_part_cid(id, params[:cid])