vodmr-0.13000750 001764 000000 00000000000 10305066554 012741 5ustar00jameswheel000000 000000 vodmr-0.13/odmrd000755 001764 001751 00000106107 10165020433 014214 0ustar00jamesjamesX000000 000000 #!/usr/bin/perl -wT use strict; # Pick up any modules you need from http://search.cpan.org/ use Socket; use MIME::Base64; use Mail::Header; use CDB_File; use vpopmail; use Digest::HMAC_MD5 qw(hmac_md5_hex); # You'll need Sys::Syslog for logging to syslog. # # Copyright (c) 2002-2004 James Raftery . All rights reserved. # This program is free software; you can redistribute it and/or # modify it under the same terms as Perl itself. # Please submit bug reports, patches and comments to the author. # Latest information at http://romana.now.ie/#vodmr # # $Id: odmrd,v 1.55 2004/12/30 15:39:07 james Exp $ # # This program is an RFC 2645 On-Demand Mail Relay (ODMR) / # Authenticated TURN (ATRN) server for vpopmail/vchkpw mail servers # running qmail. # # For this program to work, you require; # 1. A working vpopmail/vchkpw + qmail setup # 2. Perl with the modules listed above # 3. Maildir mailboxes # 4. A UCSPI-TCP server; tcpserver is ideal or inetd / xinetd # # Read INSTALL for how to enable ODMR for a domain. Start this # program with a -D flag for truck loads of debugging output in # your logs. Be aware that -D will log shared secrets. # # 5.6.1 warns for these subs without a forward declaration. sub logging ($); sub clientloop (); sub serverloop (); use vars qw($state %smtp @authuser $secretfield $opt_D $err %qmailconf $require_flag $qmail); # # VERIFY AND/OR MODIFY THESE VALUES! # (but don't change their order) # # qmail's installation directory. ``/var/qmail'' is usual. qmail's # control directory is expected to be $qmail/control and qmail-inject # is expected to be in $qmail/bin. # $qmail = "/var/qmail"; # # ``syslog'' logs messages into syslog, ``stderr'' logs to stderr. If # you are running under [x]inetd you almost certainly want to log to # syslog. If you're using cyclog/multilog then use stderr. ``none'' # discards all log messages. # logging ("stderr"); # # Set to ``passwd'' to use the literal contents of the password field # from the password database as the clear text secret. ``gecos'' means # use the gecos (comment) field as the secret. ``clear_text'' will use # vpopmail's clear text field as the secret. Confused? See the FAQ and # the note in INSTALL. # $secretfield = "gecos"; # # The name of the vpopmail flag you wish to use to enable/disable ODMR # for a mailbox. The flag you choose here must be set on a mailbox to # make it available over ODMR. If you have easily guessable gecos fields # you should be very wary of disabling this feature. # Available flags are: V_USER0 V_USER1 V_USER2 V_USER3. "none" removes # the requirement for a flag to be set. # $require_flag = "V_USER2"; # # You're done. No more to edit past here. # ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### %smtp = ( GREET => 220, QUIT => 221, AUTHSUCCEED => 235, OK => 250, CHALLENGE => 334, SENDDATA => 354, TIMEOUT => 421, MBXUNAVAIL => 450, TEMPFAIL => 451, NOMAIL => 453, UNRECOG => 500, SYNTAX => 501, UNIMP => 502, CMDORDER => 503, HUHAUTH => 504, NEEDAUTH => 530, BADAUTH => 535, ); # # Server mode. # $SIG{ALRM} = \&servertimeout; # Server mode timeout handler subroutine. $state = 0; # Connection established, alarm 600; # server started. &$err("main: serverloop()") if $opt_D; serverloop(); exit 13 unless $state == 10; # Something went wrong. # # Client mode. # $SIG{ALRM} = \&clienttimeout; # Client mode timeout handler subroutine. $state = 11; # Changed to client mode. alarm 600; &$err("main: clientloop()") if $opt_D; clientloop(); exit 9 unless $state == 15; # Something went wrong. # # Finish. # exit 0; ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### sub serverloop () { my %verbs = ( # Minimal required command set. EHLO => \&ehlo, AUTH => \&auth, ATRN => \&atrn, QUIT => \&quit, ); &$err("serverloop: starting ODMR server, banner()") if $opt_D; banner(); # Meet'n'greet. my($cmd, @params); while (defined($_ = stdin())) { # ODMR server loop. unless (length($_)) { unimp(); next; } $_ = printable($_); ($cmd, @params) = split; $cmd =~ tr/a-z/A-Z/; unless (defined $verbs{$cmd}) { unimp(); next; } &{$verbs{$cmd}}(\@params); last if $state == 10; } continue { alarm 600; } return 1; } sub clientloop () { # foreach message # open, find recipient # mail from, rcpt to # data, code == 250? # remove message # rset &$err("clientloop: starting SMTP client, clientgreet()") if $opt_D; unless (clientgreet()) { # Banner-> EHLO-> reply or QUIT. clientquit(); exit 10; } $state = 12; alarm 120; &$err("clientloop: msg_list() for $authuser[1]") if $opt_D; my($msg, @msgs); @msgs = msg_list(); # @msgs is list, $msgs[1] is list ref. if (shift(@msgs) == -1) { # msg_list() encountered an error &$err("clientloop: failure accessing mailbox: $authuser[1]"); $state = 15; # We're done. clientquit(); exit 12; } # @msgs was shift'd -- $msgs[0] is now a list ref. my($rp, $dt, @r, @bounces); while ($msg = shift(@{$msgs[0]})) { # SMTP client loop. Uses # a continue block! $state = 13; alarm 600; # msg_list() has verified that each is a readable file &$err("clientloop: open($msg)") if $opt_D; unless (open(F, $msg)) { &$err("clientloop: open($msg): $!"); warn_skipping($msg); next; } my $header = new Mail::Header \*F; close F or &$err("clientloop: close($msg): $!"); $rp = $header->get("Return-Path"); unless ($rp) { &$err("clientloop: Return-Path is missing"); warn_skipping($msg); next; } $dt = $header->get("Delivered-To"); unless ($dt) { &$err("clientloop: Delivered-To is missing"); warn_skipping($msg); next; } undef $header; chomp($rp, $dt); $dt = "<" . $dt . ">"; # Don't need to use &printable() on these. &isemail() # will flag any problems. $rp = substr($rp, 0, 1023); $dt = substr($dt, 0, 1023); unless ($rp = isemail($rp)) { &$err("clientloop: Return-Path is bad"); warn_skipping($msg); next; } unless ($dt = isemail($dt)) { &$err("clientloop: Delivered-To is bad"); warn_skipping($msg); next; } &$err("clientloop: rp: $rp dt: $dt") if $opt_D; # # Convert ``testing.now.ie-james@testing.now.ie'' to # ``james@testing.now.ie''. # $dt =~ s/^<\Q$authuser[1]\E-/ $qmailconf{odmrlifetime}) { push(@bounces, [$msg, $rp, $dt, "__AGE__"]); } } @r = (); alarm 600; last unless rset(); # If RSET fails, we can't send # any more messages. &$err("clientloop: rset() done") if $opt_D; } clientquit(); alarm 600; bounce(\@bounces) if @bounces; # bounces, bounces! $state = 15; # We're done. return 1; } sub atrn ($) { if ($state < 2) { # No EHLO received. needehlo(); return 0; } if ($state < 7) { # Not authenticated. needauth(); return 0; } if ($state >= 9) { # Duplicate command. dup(); return 0; } &$err("atrn: @{$_[0]}") if $opt_D; my $foo = scalar @{$_[0]}; # $foo == number of parameters. if ($foo > 1) { # ``ATRN foo.ie, bar.com ...'' &$err("atrn: request refused: multiple domains"); atrnfail(); return 0; } elsif ($foo == 0) { # ``ATRN'' - get domain from $foo = $authuser[1]; # authenticated user. } elsif ($foo == 1) { # ``ATRN bing.ie'' $foo = shift(@{$_[0]}); # One parameter - use that. } else { syntax(); $state = 7; return 0; } $state = 8; # ATRN received. alarm 600; &$err("atrn: domain: $foo") if $opt_D; # Check user is authenticated for domain if (has_access($foo)) { $state = 9; } else { &$err("atrn: request refused: $foo"); atrnfail(); return 0; } # # Check for mail. has_access() has verified that # $foo == $authuser[1] by this point. # &$err("atrn: has_mail()") if $opt_D; $foo = has_mail(); # Reuse $foo to store number of messages. if ($foo > 0) { &$err("atrn: $authuser[1]: $foo msgs, reversing connection"); put("$smtp{OK} OK now reversing the connection."); $state = 10; return 1; } elsif ($foo == 0) { &$err("atrn: $authuser[1]: no mail"); put("$smtp{NOMAIL} You have no mail."); $state = 7; return 1; } # else has_mail() encountered an error &$err("atrn: $authuser[1]: failure accessing mailbox"); put("$smtp{TEMPFAIL} Temporary failure accessing mailbox."); $state = 7; return 0; } sub auth ($) { if ($state < 2) { # No EHLO received. needehlo(); return 0; } if ($state >= 7 ) { # Already authenticated. dup(); return 0; } if (!@{$_[0]}) { # Missing mechanism parameter. syntax(); return 0; } &$err("auth: scheme: " . @{$_[0]}[0]) if $opt_D; if (@{$_[0]}[0] !~ /^CRAM-MD5$/i) { # We only know CRAM-MD5. &$err("auth: unrecognised auth type") if $opt_D; put("$smtp{HUHAUTH} Unrecognised authentication type."); return 0; } if (@{$_[0]}[1]) { # Extraneous parameter(s). &$err("auth: auth failed, initial response supplied"); authfail(); return 0; } $state = 3; # AUTH command received. # See the note in &logging() about srand()! # Make challenge my $challenge = "<" . $$ . "." . time() . "." . rand(10) . "@" . $qmailconf{me} . ">"; &$err("auth: challenge: $challenge") if $opt_D; # Base64 encode challenge chomp(my $encchallenge = encode_base64($challenge, "")); &$err("auth: encchallenge: $encchallenge") if $opt_D; # Send encoded challenge put("$smtp{CHALLENGE} $encchallenge"); $state = 4; # Challenge sent, alarm 600; # awaiting response. my($response, $user); $response = stdin(); unless (length($response)) { put("$smtp{SYNTAX} Challenge response expected."); &$err("auth: empty response"); # Decrease state $state = 2; # EHLO responded to, return 0; # awaiting AUTH. } $response = printable($response); $state = 5; # Response received. &$err("auth: encresponse: $response") if $opt_D; quit() if $response =~ /^QUIT$/i; if ($response eq "*") { # RFC2554, section 4 put("$smtp{SYNTAX} Authentication exchange cancelled."); &$err("auth: auth exchange cancelled"); # Decrease state $state = 2; # EHLO responded to, return 0; # awaiting AUTH. } unless (length($response) % 4 == 0) { &$err("auth: auth failed, length"); b64fail(); # EHLO responded to, return 0; # awaiting AUTH. } chomp($response = decode_base64($response)); $response = printable($response); &$err("auth: response: $response") if $opt_D; unless ($response) { &$err("auth: auth failed, decode"); b64fail(); # EHLO responded to, return 0; # awaiting AUTH. } ($user, $response) = split(" ", $response, 2); unless ($response and $user) { &$err("auth: auth failed, response"); authfail(); # EHLO responded to, return 0; # awaiting AUTH. } &$err("auth: user: $user digest: $response") if $opt_D; # MUST empty @authuser if auth. fails. @authuser = split(/@/, $user, 2); unless ($authuser[0] and $authuser[1] and $authuser[1] = isdomain($authuser[1])) { &$err("auth: auth failed, isdomain()"); authfail(); @authuser = (); # EHLO responded to, return 0; # awaiting AUTH. } my($secret, $mdir) = cdb_auth(); unless ($secret and $mdir) { # We fail on empty secrets &$err("auth: auth failed, secret: $user"); authfail(); @authuser = (); # EHLO responded to, return 0; # awaiting AUTH. } &$err("auth: user: $user secret: $secret") if $opt_D; my $digest = hmac_md5_hex($challenge, $secret); $state = 6; # Digest calculated. &$err("auth: server digest: $digest") if $opt_D; &$err("auth: client digest: $response") if $opt_D; unless ($digest and $response and $digest eq $response) { &$err("auth: auth failed, digest: $user"); authfail(); @authuser = (); # EHLO responded to, return 0; # awaiting AUTH. } put("$smtp{AUTHSUCCEED} Authentication successful."); &$err("auth: auth successful: $user"); $state = 7; # Authenticated. return 1; } sub ehlo ($) { # We 503 repeated EHLOs; we don't have RSET so RFC2821, 4.1.4 # doesn't really apply to us. if ($state > 0) { dup(); return 0; } # RFC2821, 4.1.1.1 contradicts itself. We allow exactly 1 arg. if (scalar @{$_[0]} != 1) { syntax(); return 0; } $state = 1; # EHLO received. &$err("ehlo: from: ".@{$_[0]}[0]); put("$smtp{OK}-$qmailconf{smtpgreeting}"); put("$smtp{OK}-ATRN"); put("$smtp{OK} AUTH CRAM-MD5"); $state = 2; # EHLO responded to. } sub quit ($) { # RFC2821, 4.3.2. Don't know if I like this idea. if ($_[0] and @{$_[0]}) { syntax(); return 0; } put("$smtp{QUIT} Goodbye."); &$err("quit: clean exit") if $opt_D; exit 0; } sub clientgreet () { # Wait for ``220 ...'' from the other side. &$err("clientgreet: smtp_read() for banner") if $opt_D; alarm 600; my($status, $msg) = smtp_read(); unless ($status == $smtp{GREET}) { &$err("clientgreet: greeting failed: status: $status: $msg"); return 0; } &$err("clientgreet: banner: $msg") if $opt_D; &$err("clientgreet: EHLO $qmailconf{helohost}") if $opt_D; put("EHLO $qmailconf{helohost}"); alarm 600; ($status, $msg) = smtp_read(); if ($status == $smtp{OK}) { &$err("clientgreet: ehlo success: $msg") if $opt_D; return 1; } # If EHLO was rejected, try HELO. if ($status == $smtp{UNRECOG} or # EHLO unrecognised $status == $smtp{SYNTAX} or $status == $smtp{UNIMP}) { &$err("clientgreet: HELO $qmailconf{helohost}") if $opt_D; put("HELO $qmailconf{helohost}"); # Try HELO alarm 600; ($status, $msg) = smtp_read(); if ($status == $smtp{OK}) { &$err("clientgreet: helo success: $msg") if $opt_D; return 1; } } &$err("clientgreet: EHLO/HELO failed: status: $status: $msg"); return 0; } sub data ($) { # # return 0 for failure # return 1 for success # If second element is set, failure is permanent # my $file = shift || ""; # # Send file; bare LFs? # qmail-smtpd wouldn't have accepted the message if it had # bare LFs, unless you used that patch. If you did, you're on # your own. We try open() now so we don't send DATA and then # find out, oops, we can't access the message. # &$err("data: open($file)") if $opt_D; unless (open(MSG, $file)) { &$err("data: open($file): $!"); return(0, ""); } &$err("data: DATA") if $opt_D; put("DATA"); alarm 600; my($status, $msg) = smtp_read(); unless ($status == $smtp{SENDDATA}) { &$err("data: DATA rejected: status: $status: $msg"); close MSG or &$err("data: close($file): $!"); return(0, "Connected to $qmailconf{remotehost} but failed on DATA command.\nRemote host said: $status $msg") if $status =~ /^5/; return(0, ""); } # # Add our received header line. Reuse $status. See # http://cr.yp.to/immhf/token.html and # http://cr.yp.to/immhf/envelope.html # gmtime() gives: Thu Jul 4 20:52:28 2002 # my @t = split(" ", gmtime()); $status = "Received: by $qmailconf{me} with ODMR (ATRN); " . "$t[0], $t[2] $t[1] $t[4] $t[3] -0000"; &$err("data: $status") if $opt_D; put($status); # # We need to mask the first Delivered-To line in case the # receiving end wants to add an identical Delivered-To -- which # might cause it to think the message is looping. The drawback # to this is that the receiving end might be correct. # We're not going to try loop detection here. Let the real # MTAs do that. # We also drop Return-Path: header lines. # # djb's encoding: http://cr.yp.to/smtp/message.html # my $dtseen = 0; while () { # Encode and send header if (/\015\012/) { # RFC2821 2.3.7 / RFC2822 2.3 &$err("data: cannot encode message header, CRLF line $."); warn_skipping($file); close MSG or &$err("data: close($file): $!"); # We must barf, as the other side won't react # to commands. exit 5; } next if /^Return-Path\s*:/i; chomp; if (!$dtseen and /^Delivered-To\s*:/i) { put("X-ODMR-" . $_); $dtseen = 1; next; } if (/^\s*$/) { # End of header put($_); last; } s/^\./../; put($_); alarm 600; } while () { # Encode and send body if (/\015\012/) { # RFC2821 2.3.7 / RFC2822 2.3 &$err("data: cannot encode message body, CRLF line $."); warn_skipping($file); close MSG or &$err("data: close($file): $!"); exit 5; } chomp; s/^\./../; put($_); alarm 600; } # ``If the client encounters a message I/O error, it closes the # connection immediately, without sending a final dot and # without sending a QUIT request.'' Hrm. close MSG or &$err("data: close($file): $!"); alarm 1200; put("."); ($status, $msg) = smtp_read(); if ($status == $smtp{OK}) { &$err("data: message accepted: $msg"); &$err("data: success: $msg") if $opt_D; return (1, ""); } # else &$err("data: message rejected: status: $status: $msg"); return(0, "Connected to $qmailconf{remotehost} but failed after I sent the message.\nRemote host said: $status $msg") if $status =~ /^5/; return(0, ""); } sub mailfrom_rcptto ($$) { # # return 1 for success - continue to DATA # return 0 for failure # If second element is defined, failure is permanent # my $sender = shift || ""; my $recipient = shift || ""; unless ($sender) { &$err("mailfrom_rcptto: missing sender"); return(0, ""); } unless ($recipient) { &$err("mailfrom_rcptto: missing recipient"); return(0, ""); } if ($opt_D) { &$err("mailfrom_rcptto: MF: $sender RT: $recipient"); &$err("mailfrom_rcptto: MAIL FROM:$sender"); } put("MAIL FROM:$sender"); alarm 600; my($status, $msg) = smtp_read(); unless ($status == $smtp{OK}) { &$err("mailfrom_rcptto: MAIL FROM rejected: status: $status: $msg"); return(0, "Connected to $qmailconf{remotehost} but sender was rejected.\nRemote host said: $status $msg") if $status =~ /^5/; return(0, ""); } &$err("mailfrom_rcptto: RCPT TO:$recipient") if $opt_D; put("RCPT TO:$recipient"); alarm 600; ($status, $msg) = smtp_read(); unless ($status == $smtp{OK}) { &$err("mailfrom_rcptto: RCPT TO rejected: status: $status: $msg"); return(0, "$qmailconf{remotehost} does not like recipient.\nRemote host said: $status $msg") if $status =~ /^5/; return(0, ""); } &$err("mailfrom_rcptto: success: $msg") if $opt_D; return(1, ""); } sub rset () { &$err("rset: RSET") if $opt_D; put("RSET"); alarm 600; my($status, $msg) = smtp_read(); unless ($status == $smtp{OK}) { &$err("rset: RSET failed: status: $status: $msg"); return 0; } &$err("rset: success: $msg") if $opt_D; return 1; } sub clientquit () { &$err("clientquit: QUIT") if $opt_D; put("QUIT"); return 1; } sub bounce ($) { my($rp,$txt,$sep,$file,$bouncerecipient,$origrecipient,$reason); my $mta = "| $qmail/bin/qmail-inject -h"; # # $_[0] == ref. to @bounces # @bounces is a list of list refs. # $state = 14; foreach (@{$_[0]}) { alarm 600; # $_ is a list ref! $file = shift(@{$_}) || ""; $bouncerecipient = shift(@{$_}) || ""; $origrecipient = shift(@{$_}) || ""; $reason = shift(@{$_}) || ""; &$err("bounce: file: $file") if $opt_D; # # (Case 1) Normal bounce message. # Original message: # MAIL FROM: RCPT TO: # if it bounces causes a bounce addressed as # MAIL FROM:<> RCPT TO: # # (Case 2) Double bounce -- e.g. the above bounce bounces # Original message: # MAIL FROM:<> RCPT TO: # if it bounces causes a bounce addressed as # MAIL FROM:<#@[]> RCPT TO: # # (Case 3) Triple bounce -- a double bounce bounces! # Original message: # MAIL FROM:<#@[]> RCPT TO: # if it bounces, it's thrown away. # if ($bouncerecipient eq "<>") { # Case 2 $rp = "<#@[]>"; $bouncerecipient = "<".$qmailconf{doublebounceto}."@". $qmailconf{doublebouncehost}.">"; $txt = "I tried to deliver a bounce message to " . "this address, but the bounce bounced!"; $sep = "--- Below this line is the original bounce."; &$err("bounce: double: $bouncerecipient") if $opt_D; } elsif ($bouncerecipient eq "<#@[]>") { # Case 3 (qmail should not have delivered this to # the ODMR mailbox, but just in case) &$err("bounce: triple: discarded") if $opt_D; remove($file); next; } elsif ($bouncerecipient) { # Case 1 $rp = "<>"; $txt = "I'm afraid I wasn't able to deliver your " . "message to the following address.\nThis " . "is a permanent error; I've given up. " . "Sorry it didn't work out."; $sep = "--- Below this line is a copy of the message."; } else { &$err("bounce: no bounce recipient"); warn_skipping($file); next; } unless ($origrecipient) { &$err("bounce: no original recipient"); warn_skipping($file); next; } unless ($origrecipient = isemail($origrecipient)) { &$err("bounce: bad original recipient"); warn_skipping($file); next; } unless ($bouncerecipient = isemail($bouncerecipient)) { &$err("bounce: bad bounce recipient"); warn_skipping($file); next; } #$mta = ">> /tmp/bouncemail"; # Debug if (!$reason) { # Should we barf if !$reason? $reason = "This message cannot be delivered. A " . "specific reason was not given."; } elsif ($reason eq "__AGE__") { $reason = "This message is too old. Giving up."; } # Change $bouncerecipient to (2)822 form, strip the <>'s. $bouncerecipient =~ s/^$//; &$err("bounce: open($file)") if $opt_D; unless (open(MSG, $file)) { &$err("bounce: open($file): $!"); warn_skipping($file); next; } &$err("bounce: open($mta)") if $opt_D; unless (open(MTA, $mta)) { &$err("bounce: open($mta): $!"); close MSG or &$err("bounce: close($file): $!"); warn_skipping($file); next; } # $mta should add Date and Message-ID header lines. Should # also set envelope sender from Return-Path: and recipient # from To: print MTA "Return-Path: $rp\n"; print MTA "From: $qmailconf{bouncefrom}\@$qmailconf{bouncehost}\n"; print MTA "To: $bouncerecipient\n"; print MTA "Subject: failure notice\n\n"; print MTA "Hi. This is the odmrd program at $qmailconf{me}.\n"; print MTA "$txt\n\n"; print MTA "$origrecipient:\n"; print MTA "$reason\n\n"; print MTA "$sep\n\n"; # don't mess with newlines; qmail-inject will deal print MTA while ; close MSG or &$err("bounce: close($file): $!"); alarm 600; unless (close MTA) { &$err("bounce: close($mta): $!: ".($? >> 8)); next; } remove($file); } return 1; } sub smtp_read () { my($status, $msg) = (0, ""); while (defined($_ = stdin())) { #last unless length($_); $_ = printable($_); # # $1 == whole line # $2 == status code # $4 == continuation marker # $5 == rest of line / status message # unless (/^((\d\d\d)(([ -])(.*))?)$/) { &$err("smtp_read: $state junk: $_"); last; } &$err("smtp_read: $1") if $opt_D; # # Retain code from first line. If you change status code # during a multiline response, you can sod off. # $status = $2 unless $status; $msg .= " $5" if $5; # Don't let a bongo server feed us endless crap. last if (($4 and $4 eq " ") or ($2 and !$4 and !$5) or $. > 150); } $msg =~ s/^\s+//; $msg =~ s/\s+$//; # Strip whitespace $msg =~ s/\s+/ /g; # and condense &$err("smtp_read: return: status: $status") if $opt_D; return($status, $msg); } sub remove ($) { my $file = shift || ""; &$err("remove: unlink($file)") if $opt_D; if (unlink $file) { &$err("remove: success") if $opt_D; return 1; } # else &$err("remove: unlink($file): $!: duplicate deliveries likely"); return 0; } sub stdin () { local $/ = "\015\012" unless $qmailconf{remotehost} eq "tty"; defined(local $_ = ) or return undef; $_ = substr($_, 0, 511); s/\015\012//gs; s/\0//gs; # s/\015?\012/\n/g; #chomp; s/^\s+//; s/\s+$//; return $_; } sub has_access ($) { return($_[0] and $authuser[1] eq $_[0]); } sub has_mail () { &$err("has_mail: $authuser[1]") if $opt_D; my @msgs = msg_list(); # @msgs is list, $msgs[1] is list ref. my $sum = shift(@msgs); &$err("has_mail: sum is $sum") if $opt_D; return $sum; } sub msg_list () { # # msg_list returns a two element list on success; # element 0: number of valid message files # element 1: ref. to a list of full pathnames of said files # N.B. we indicate error by returning -1 not zero. Zero == zero # messages. # my($dir, $fileref); if ($opt_D) { &$err("msg_list: user: @authuser"); &$err("msg_list: maildir()"); } if ($dir = maildir()) { my @f = dir_scan($dir . "cur"); return -1 unless shift(@f); $fileref = $f[0]; @f = dir_scan($dir . "new"); return -1 unless shift(@f); push(@{$fileref}, @{$f[0]}); } else { &$err("msg_list: return -1") if $opt_D; return -1; } &$err("msg_list: return: @{$fileref}") if $opt_D; return(scalar(@{$fileref}), $fileref); } sub dir_scan ($) { # returns: (1,$listref) on success, (0) on failure my $dir = shift || ""; my @files; &$err("dir_scan: $dir") if $opt_D; unless (opendir(D, $dir)) { &$err("dir_scan: opendir($dir): $!"); return 0; } # # Thread started on the qmail list From: Sam Varshavchik # , Date: Mon, 13 Jan 2003 18:45:49 -0500 # Message-ID: # is noted. We don't move from new to cur so we're safe. # my $f; foreach $f (grep { /^[^.]/ } readdir D) { if ($f =~ m#^([^/]+)$#) { $f = $1; # untaint } else { next; } unless (stat("$dir/$f")) { &$err("dir_scan: stat($dir/$f): $!"); warn_skipping("$dir/$f"); next; } # # We insist that messages are: # 1. regular files # 2. apparently readable by us # 3. not empty # unless (-f _ and -r _ and -s _) { &$err("dir_scan: unuseable file: $dir/$f"); warn_skipping("$dir/$f"); next; } push(@files, "$dir/$f"); } closedir D or &$err("dir_scan: closedir($dir): $!"); &$err("dir_scan: return: @files") if $opt_D; return(1, \@files); } sub cdb_auth () { # returns: ($secret,$mdir) on success, () on failure &$err("cdb_auth: user: @authuser") if $opt_D; my %masks = ( V_USER0 => 0x080, #00000000 10000000 128 V_USER1 => 0x100, #00000001 00000000 256 V_USER2 => 0x200, #00000010 00000000 512 V_USER3 => 0x400, #00000100 00000000 1024 ); my $vpw = vauth_getpw($authuser[0], $authuser[1]); unless ($vpw and $vpw->{pw_dir}) { &$err("cdb_auth: vauth_getpw failed: @authuser"); return (); } # Still need direct CDB access to work around vpopmail.pm # shortcomings: pw_gid and pw_clear_text my $cdb = $vpw->{pw_dir} . "/../vpasswd.cdb"; &$err("cdb_auth: cdb: $cdb") if $opt_D; unless (stat($cdb)) { &$err("cdb_auth: stat($cdb): $!"); return(); } unless (-f _ and -r _) { &$err("cdb_auth: unuseable file: $cdb"); return(); } my %db; unless (tie(%db, 'CDB_File', $cdb)) { &$err("cdb_auth: cannot tie $cdb"); return(); } my @dbent = split(/:/, $db{$authuser[0]}); untie %db; return() unless @dbent; if ($opt_D) { &$err("cdb_auth: user: @authuser: " . join(",", @dbent)); &$err("cdb_auth: require_flag: $require_flag"); } if ($require_flag ne "none") { if (!defined $masks{$require_flag}) { &$err("cdb_auth: @authuser: unknown require_flag"); return(); } if (!($dbent[2] & $masks{$require_flag})) { &$err("cdb_auth: @authuser: access is disabled"); return(); } } &$err("cdb_auth: secretfield: $secretfield") if $opt_D; local $secretfield = "pw_" . $secretfield; if ($secretfield eq "pw_clear_text" and $dbent[6]) { return($dbent[6], $vpw->{pw_dir}); } elsif ($vpw->{$secretfield}) { return($vpw->{$secretfield}, $vpw->{pw_dir}); } else { &$err("cdb_auth: no secret in '$secretfield'"); return(); } } sub maildir () { &$err("maildir: user: @authuser") if $opt_D; my($secret,$mdir) = cdb_auth(); if ($mdir and $mdir =~ m#^([a-z0-9_./-]+)$#i) { $mdir = $1; $mdir .= "/Maildir"; if (-d $mdir) { &$err("maildir: return: $mdir") if $opt_D; return $mdir . "/"; } } # else &$err("maildir: bad: $mdir: $!") if $opt_D; return 0; } sub qmail_config () { # Same defaults as qmail 1.03. Comments are not permitted in # any of these files. Ref. qmail-control(5). %qmailconf = ( bouncefrom => "MAILER-DAEMON", bouncehost => "__ME__", doublebouncehost => "__ME__", doublebounceto => "postmaster", helohost => "__ME__", me => "", odmrlifetime => 1209600, remotehost => "remote host", smtpgreeting => "__ME__", ); my $f; foreach $f (grep { stat("$qmail/control/$_") and -f _ and -s _ } keys %qmailconf) { # If we can't open(), we'll just use the default unless (open(F, "$qmail/control/$f")) { &$err("qmail_config: open($qmail/control/$f): $!"); warn_skipping("$qmail/control/$f"); next; } chomp($_ = ); close F or &$err("qmail_config: close($qmail/control/$f): $!"); s/^\s+//; s/\s+$//; $qmailconf{$f} = $_; } # Fill in values that default to `me' if they haven't been set foreach (grep { $qmailconf{$_} eq "__ME__" } keys %qmailconf) { $qmailconf{$_} = $qmailconf{me}; } return 1; } sub logging ($) { # Clean up environment. Precautionary. $opt_D = 1 if ($ENV{DEBUG} or ($ARGV[0] and $ARGV[0] eq "-D")); %ENV = (); chdir "/" or die "ERROR: cannot chdir to /\n"; select STDERR; $| = 1; # Disable buffering. select STDOUT; $| = 1; # Suck in the odmrd and qmail config. files qmail_config(); if (-t STDIN) { $qmailconf{remotehost} = "tty"; } else { my @sin = sockaddr_in(getpeername(STDIN)); $qmailconf{remotehost} = printable(inet_ntoa($sin[1])) if $sin[1]; } # # Previously &err checked a global flag ($usesyslog) each # time it was called. Instead, we check what logging is requested # only once, at startup, and make $err a reference to the # appropriate subroutine. # if ($_[0] and $_[0] eq "syslog") { require Sys::Syslog; import Sys::Syslog qw(:DEFAULT setlogsock); # # Work around some Sys::Syslog annoyance. It wants # Sys::Hostname::hostname to lookup this host's name. # Sys::Hostname does such annonying things as run # external commands (`hostname 2>/dev/null`) which is # annoying, and also fails (empty environment?). We # stop this by setting the variable it wants from here. # $Sys::Syslog::host = $qmailconf{me}; # Twice to $Sys::Syslog::host = $qmailconf{me}; # shut -w up. # Try for Unix domain socket in preference to datagrams. if (setlogsock("unix") or setlogsock("inet")) { openlog("odmrd: ", "pid", "mail"); $err = \&log_to_syslog; } else { # If can't use syslog, we gotta log somewhere. $err = \&log_to_stderr; &$err("WARNING: cannot log to syslog"); } } elsif ($_[0] and $_[0] eq "none") { $err = sub { return }; } else { # # We don't actually care. If you don't ask for syslog # or none, you get stderr. # $err = \&log_to_stderr; } die "ERROR: logging() failed to create ref.\n" unless ref($err) eq "CODE"; &$err("logging: RCS " . qq$Revision: 1.55 $) if $opt_D; $SIG{HUP} = 'IGNORE'; $SIG{TERM} = sub { exit 4 }; $SIG{USR1} = \&sig_debug; $SIG{USR2} = \&sig_nodebug; &$err("SECURITY WARNING: $0 running as root!") if ($> == 0 or $< == 0); # ``me'' is special unless ($qmailconf{me} =~ /[\w\.]+/) { &$err("ERROR: What's my name? (check control/me)"); exit 11; } if ($opt_D) { foreach (keys %qmailconf) { &$err("qmail_config: $_: $qmailconf{$_}"); } } # # I don't want to run external programs, so seeding with # ps or netstat output isn't an option. Besides, this isn't # exactly required -- we're trying to make the challenge # slightly more unpredictable. Note that we expose the value # of $$ in the challenge string so it's not much use here. The # value of $^T used here can be guessed by taking the time() # in the challenge and subtracting the approx. no. of seconds # since startup. control/me's mtime should be non-obvious to # non-local users, though it is unlikely to change over time. # srand($^T ^ (stat("$qmail/control/me"))[9]); return 1; } sub isemail ($) { # # sub to check that an email address is valid to use in an # envelope: ``'' # Must also allow bounces: ``<>'' and ``<#@[]>'' # No whitespace allowed in local part -- might cause problems # my $e = shift || ""; &$err("isemail: $e") if $opt_D; if ($e =~ /^\s*(<[^><@\s]+@([a-z\d\-]+\.)+[a-z]{2,6}>)\s*$/i) { $e = $1; } elsif ($e =~ /^(<>)$/) { $e = $1; } elsif ($e =~ /^(<#@\[]>)$/) { $e = $1; } elsif ($e =~ /^()$/i) { # RFC2821 3.6/4.5.1 says OK $e = $1; } else { $e = undef; } return $e; } sub isdomain ($) { # Alternative: /^\s*([a-z0-9-]+\.[a-z0-9-]+)\s*$/i my $d = shift || ""; &$err("isdomain: $d") if $opt_D; if ($d =~ /^\s*(([a-z\d\-]+\.)+[a-z]{2,6})\s*$/i) { $d = $1; } elsif ($d =~ /^\s*(localhost)\s*$/i) { $d = $1; } else { $d = undef; } return $d; } sub printable ($) { # # Replace non-printable characters with an underscore. # [^ a-zA-Z0-9)(}{><:;,\.\\|\/\?_=+`\!"\$\%^\&*\@'\]\[#~-] # $_ = shift || ""; tr/ -~/_/cs; # see isprint(3) return $_; } sub warn_skipping ($) { my $f = shift || "unknown"; &$err("WARNING: skipping file $f"); } sub sig_debug () { &$err("debugging enabled by signal"); $opt_D = 1; $SIG{USR1} = \&sig_debug; } sub sig_nodebug () { &$err("debugging disabled by signal"); $opt_D = 0; $SIG{USR2} = \&sig_nodebug; } sub close_all_fh () { close MTA if *MTA{IO}; close MSG if *MSG{IO}; close F if *F{IO}; closedir D if *D{IO}; close STDIN if *STDIN{IO}; close STDOUT if *STDOUT{IO}; close STDERR if *STDERR{IO}; } sub servertimeout () { # Timeout handler for server mode put("$smtp{TIMEOUT} Timeout exceeded ($state)."); &$err("servertimeout: state $state"); exit 2; } sub clienttimeout () { # Timeout handler for client mode; log it and fall over. &$err("clienttimeout: state $state"); exit 2; } sub banner () { put("$smtp{GREET} $qmailconf{smtpgreeting} ESMTP") } sub dup () { put("$smtp{CMDORDER} Duplicate in state $state.") } sub needehlo () { put("$smtp{CMDORDER} EHLO required.") } sub syntax () { put("$smtp{SYNTAX} Syntax error.") } sub needauth () { sleep 1; put("$smtp{NEEDAUTH} Authentication required.") } sub unimp () { sleep 1; put("$smtp{UNRECOG} Command not recognised.") } sub b64fail () { sleep 1; put("$smtp{SYNTAX} Cannot decode BASE64 response."); $state = 2 } sub authfail () { sleep 3; put("$smtp{BADAUTH} Authentication failed."); $state = 2 } sub atrnfail () { sleep 3; put("$smtp{MBXUNAVAIL} ATRN request refused."); $state = 7 } sub put ($) { print $_[0], "\015\012" } # # Each of the functions that take input have already substr'd # external data, but let's be very careful with logging. # sub log_to_syslog ($) { my $msg = substr($_[0], 0, 1023); syslog("info", "%s", $msg); } sub log_to_stderr ($) { my $msg = substr($_[0], 0, 1023); print STDERR "odmrd: $$ " . $msg . "\n"; } END { # flush anything that's left close_all_fh(); } __END__ $Id: odmrd,v 1.55 2004/12/30 15:39:07 james Exp $ vodmr-0.13/INSTALL000644 001764 001751 00000020055 10305066414 014214 0ustar00jamesjamesX000000 000000 This program is an RFC 2645 On-Demand Mail Relay (ODMR) / Authenticated TURN (ATRN) server for vpopmail/vchkpw mail servers running qmail. $Id: INSTALL,v 1.21 2005/08/30 14:28:28 james Exp $ REQUIREMENTS For this program to work, you require; 1. A working vpopmail/vchkpw + qmail setup 2. Perl 5 with MIME::Base64, Mail::Header, CDB_File, vpopmail and Digest::HMAC_MD5 modules 3. Maildir mailboxes 4. A UCSPI-TCP server (tcpserver is ideal) or inetd / xinetd vpopmail is available from http://www.inter7.com/vpopmail/ tcpserver is available from http://cr.yp.to/ucspi-tcp.html Pick up any modules you need from http://search.cpan.org/ Latest information at http://romana.now.ie/#vodmr ## ## ## Upgraders, be sure to check the CHANGES section of README for ## ## potential problems or incompatible changes between releases ## ## ## INSTALLATION (Steps preceeded by ``%'' should be done as a normal user, those preceeded by ``#'' as root) 1. Download and install the perl modules listed above. If you are to use MySQL, Oracle, LDAP, etc (i.e. not vpasswd.cdb) authentication please consult FAQ entry no. 18 for important information. 2. Determine the uid and gid of your vpopmail user. This is usually ``vpopmail''. % id vpopmail uid=89(vpopmail) gid=89(vchkpw) groups=89(vchkpw) On my machine, the uid is 89 and the gid is 89. Substitute your own values below. 3. Edit the odmrd program and give correct values to $qmail, logging(), $secretfield and $require_flag. Look for ``VERIFY AND/OR MODIFY THESE VALUES!'' around line 50. Check the path to your perl interpreter on line 1. It's set to /usr/bin/perl by default. % vi odmrd 4. Copy the odmrd program to an appropriate directory. This example uses /usr/local/sbin. If you choose another directory substitute that in all cases below. # cp -i odmrd /usr/local/sbin # chown root /usr/local/sbin/odmrd # chmod 755 /usr/local/sbin/odmrd 5. Verify your qmail configuration files, and create ODMR-specific ones if necessary. odmrd uses the following qmail control files and will use the same default values as qmail-1.03 if they are not present. Similarly, ``me'' is _required_. odmrlifetime is the length of time, in seconds, a message may remain undelivered in an ODMR mailbox before being rejected. It defaults to two weeks. Set it to zero for messages to remain forever. See qmail-control(5) for more information. bouncefrom bouncehost doublebouncehost doublebounceto helohost me odmrlifetime smtpgreeting Comments are not permitted in any of these control files. 6. Decide which connection manager you will use; tcpserver, inetd or xinetd. a. tcpserver Start tcpserver on the ODMR port (366) running as the vpopmail user. If tcpserver is not in your $PATH specify its full pathname. # sh -c 'tcpserver -vHPR -u 89 -g 89 0 366 \ /usr/local/sbin/odmrd >>/var/log/odmr.log 2>&1 &' Add the tcpserver invocation to your boot scripts to start odmrd at boot time. See FAQ for how to log stderr using cyclog/multilog and how to apply resource limits to restrict memory usage. b. inetd Add an entry for odmrd to the inetd configuration file, usually /etc/inetd.conf # vi /etc/inetd.conf Add a line similar to odmr stream tcp nowait vpopmail /usr/local/sbin/odmrd This assumes your /etc/services has an entry for ``odmr'' as 366/tcp and vpopmail is the name of your vpopmail user. Then signal inetd to reread its configuration file. # kill -HUP See your inetd.conf(5) man page for local information. inetd will probably discard logs sent to STDERR -- double check that the logging() configuration statement is set appropriately. c. xinetd Add an entry for odmrd to the xinetd configuration file, usually /etc/xinetd.conf # vi /etc/xinetd.conf Add a section similar to service odmr { socket_type = stream protocol = tcp wait = no server = /usr/local/sbin/odmrd user = vpopmail } If your system uses separate files in /etc/xinetd.d, create a new file called /etc/xinetd.d/odmr instead and put the service clause in it. This assumes your /etc/services has an entry for ``odmr'' as 366/tcp and vpopmail is the name of your vpopmail user. Then signal xinetd to reread its configuration file(s). # kill -HUP See your xinetd.conf(5) man page for local information. xinetd will probably discard logs sent to STDERR -- double check that the logging() configuration statement is set appropriately. CONFIGURING ODMR FOR A DOMAIN To setup ODMR for example.org, do 1. Setup example.org under vpopmail, set a postmaster mailbox password and have postmaster@example.org receive all mail for example.org. The password you set here is used for normal vpopmail authentication; qmailadmin, Courier imap/pop, etc. Perform EITHER a. OR b., choosing the appropriate one for your version of vpopmail; a. For users of vpopmail 5.3.20 or later # vadddomain -e postmaster example.org Password b. For users of vpopmail 5.3.19 or earlier # vadddomain example.org Password Edit ~vpopmail/domains/example.org/.qmail-default and replace ``bounce-no-mailbox'' with the path to the postmaster's directory. e.g. | /home/vpopmail/bin/vdelivermail '' /home/vpopmail/domains/example.org/postmaster 2. Set the shared secret for postmaster@example.org in clear text by setting a comment and enable ODMR service for the mailbox by setting the V_USER2 flag (V_USER2 is the default - you can use any of V_USER{0,1,2,3} for this purpose). # vmoduser -2 -c ODMR_Password postmaster@example.org DO NOT, I repeat, DO NOT use a colon in the secret string. EVER. You might want to disable webmail/pop/imap/etc access for this mailbox to ensure its mail is always collected over ODMR. See the vmoduser man page for more information. 3. Tell your customer to configure their ODMR / ATRN client to authenticate with username ``postmaster@example.org'' and the secret you set in step 2. Tell them that if they want to use a POP or IMAP client to use the password you set in step 1. You're done. ADVANCED INSTALLATION TOPICS Access control tcpserver can allow or deny connections based on source IP address. See http://cr.yp.to/ucspi-tcp/tcprules.html for more information and the sample-odmrd.rules file supplied with vodmr. Your inetd or xinetd may offer similar features. I'm afraid you'll have to review your system's documentation to discover the magic incantations. Selective debugging odmrd will print truck loads of debugging if started with a -D flag. This is useful during initial installation but is impractical in a production environment, not least because -D logs shared secrets. If you wish to use debugging to investigate a particular problem you could stop tcpserver and restart it with a -D on the odmrd command line. This has three disadvantages; - you must stop the service, if only briefly - you get debugging output from all sessions - you must stop the service again to remove the -D flag You do, however, have alternatives that may be more suitable. odmrd will enable debugging output if a ``DEBUG'' variable is set in its environment. Using tcpserver's environment control abilities you can enable debugging for a particular IP address (or range of addresses) without any interruption to service. For example, 127.0.0.1:allow,DEBUG="yes" :allow compiled with tcprules will allow connections from anywhere and enable debugging output for connections from loopback only. The SIGUSR1 signal enables debugging and the SIGUSR2 signal disables it. You can send these signals to an active odmrd (not tcpserver!) process to change its debugging status while it's running. $Id: INSTALL,v 1.21 2005/08/30 14:28:28 james Exp $ vodmr-0.13/FAQ000644 001764 001751 00000024170 10162035044 013513 0ustar00jamesjamesX000000 000000 Frequently Asked Questions. Please send additions, comments, etc to Latest information at http://romana.now.ie/#vodmr $Id: FAQ,v 1.21 2004/12/21 14:58:44 james Exp $ 1. Command not found errors on startup. Is odmrd in the $PATH of the user starting it? If you used a full pathname, it is correct? The odmrd program ships with its perl interpreter set to /usr/bin/perl. If your perl binary is in some other location edit the first line of odmrd to specify the correct location of perl on your system. 2. Debugging output. odmrd is capable of generating a large amount of debugging information. Your options for enabling/disabling debugging are: - a -D flag on the command line starts odmrd with debugging on. - if $DEBUG is set in odmrd's environment at startup, debugging is enabled. - sending a USR1 signal to a running odmrd enables debugging. - sending a USR2 signal to a running odmrd disables debugging. 3. Control files. odmrd makes use of a number of qmail control files. Set $qmail in odmrd to reflect qmail's installation directory. $qmail/control, and the files within, must be readable by the user odmrd runs as. odmrd uses the following qmail control files: - bouncefrom - bouncehost - doublebouncehost - doublebounceto - helohost - me - smtpgreeting Each has the same meaning and default value as in qmail-control(5). odmrd uses the following control file which is not used by qmail: - odmrlifetime control/odmrlifetime is similar to control/queuelifetime for qmail. It specifies the maximum length of time, in seconds, a message may remain undeliverable. It defaults to 1209600 (two weeks). Set it to zero for messages to remain forever. 4. Messages older than odmrlifetime are still in mailboxes. Each message will always be permitted one delivery attempt. If a message is in a mailbox and a user requests an ATRN, one delivery will be tried regardless of age. If the delivery is unsuccessful the message's age is checked and it will be bounced if it's too old. Also, remember that messages are only checked when a user logs in and asks for ATRN. If they never login, messages will remain in the mailbox. Be sure to set quotas if that matters to you. 5. Received header added by odmrd looks wrong. -0000 is a time zone specification showing that the timestamp added is in Greenwich Mean Time (GMT). Tracking messages that use varying local time zones is difficult. odmrd timestamps in GMT. 6. What does the number in ``Timeout exceeded (4)'' mean? The number is the state odmrd was in when the timeout occurred. The states are outlined in INTERNALS. 7. odmrd says there's no mail in a mailbox. You disagree. This could be for any number of reasons. Here's some things to look into: - Was the mail delivered to a mailbox or is it in qmail's queue? Check qmail's logs. - Was it delivered to the correct mailbox? Check qmail's logs. - Are you logging in as the correct user -- one who has access to that mailbox? - Is that user set as the catch-all for the ODMR domain? - Is there _really_ mail there? Look in the appropriate maildir for message files. 8. How do I extend the life of a message in a mailbox? It's about to expire but I want it to be retried for longer. Use the touch(1) command to change the modification date of the message file. odmrd will bounce a message that was modified more than ``odmrlifetime'' seconds ago. You can use touch to change the modification date to something more recent. How recent depends on how long you want the message to persist. 9. Authentication failed. This could be for any number of reasons. Here's some things to look into: - Usernames and passwords are case-sensitive for authentication, even if they're not case sensitive when used as an email address. Are you using the right combination of upper and lower case? - If you are using the gecos field to store secrets, is the secret present and correct? Do not use colons in the secret! - If you are using the clear text field to store secrets, is the secret present and correct? Do not use colons in the secret! - If you are using the password field to store secrets, is the secret present and correct? Do not use colons in the secret! - Blank/empty secrets never authenticate. Set a real secret. - Is $secretfield set to correctly reflect your choice of storing the secret in the gecos, clear text or password field? - Have you enabled ODMR service for the mailbox? Use the vuserinfo command to check. It will say 'user flag 2 is set' if ODMR service is enabled. Use the vmoduser command to set it if necessary. See no. 17 below. - Are you using the correct flag? Verify the $require_flag variable against the output of the vuserinfo command. See no. 17 below. 10. ATRN request refused. The ATRN command sent by the ODMR client program requested mail for a domain to which the logged in user does not have access or requested mail for more than one domain. 11. How to use fetchmail. An example fetchmail invocation might be: fetchmail -p ODMR -S localhost -u postmaster@foo.ie \ --fetchdomains foo.ie odmrserver.isp.net That says: - Use ODMR - Give messages to the SMTP server on ``localhost'' - Login as ``postmaster@foo.ie'' - Request the email for ``foo.ie'' - The ODMR server is called ``odmrserver.isp.net'' See the fetchmail(1) man page for full instructions. 12. Your logs are full of ``Permission denied'' messages and nothing's working! odmrd needs to run as your vpopmail user -- this is usually ``vpopmail''. Make sure you have started tcpserver with the proper UID and GID or check the user specified in your [x]inetd.conf. Don't run odmrd as root. It doesn't need it. It'll log a warning if you do. 13. ``Can't locate .pm in @INC ...'' errors at startup. Either the perl module named in the error isn't installed in your system or perl can't find it in the places it thinks it should look (the error will list those places). So, if it's missing, install it. Otherwise you can add a ``use lib'' statement to odmrd to tell perl to look for modules in non-standard places. See the @INC entry in the perlvar(1) man page. Pick up any modules you need from http://search.cpan.org/ 14. Can qmailadmin be used to setup and maintain an ODMR domain? Yes, absolutely. With qmailadmin you can create a mailbox and set it to be the catch-all mailbox for the domain. Set the mailbox ``Real name'' to the secret you want to use for for gecos authentication or use its clear-text support. See http://www.inter7.com/qmailadmin/ for information about qmailadmin. The patch available from http://romana.now.ie/#qmailadmin-flags adds the ability for qmailadmin 1.0.15 or earlier to view and modify mailbox flags. qmailadmin 1.0.16 or later incorporates that patch. 15. Logging into syslog doesn't seem to be working. Have you set logging ("syslog"); in odmrd? If so, odmrd will attempt to log messages using the mail facility and info priority (a.k.a ``mail.info''). Ensure your syslogd selects these messages and logs them somewhere useful. Your syslogd configuration file, usually /etc/syslog.conf, should have a line something like mail.* /var/log/maillog Check your syslog/syslog.conf man page for exactly how to select and save mail.info messages on your system. 16. Resource limits. To run odmrd with resource limits run it under softlimit in a similar way to: softlimit -m 5000000 \ tcpserver -vHPR -u 89 -g 89 0 366 \ /usr/local/sbin/odmrd >>/var/log/odmr.log 2>&1 & You may need to increase the 5000000 (5MB) to accomodate the legitimate memory needs of tcpserver+perl on your particular system. The softlimit program is part of Dan J. Bernstein's daemontools package; http://cr.yp.to/daemontools.html Remember: the figure is a limit. odmrd will probably never use all of the amount allotted to it. 17. Disabling mailbox flags or using one other than V_USER2. Set the $require_flags variable in odmrd to the name of the flag you want to use -- V_USER{0,1,2,3} are available -- or set it to ``none'' to remove the need for a flag to be present. Be very careful about disabling the flag requirement. At least one mail control system built on vpopmail sets the gecos field to the name of the mailbox. In that environment it's trivial to know that foo@example.org's gecos (and, hence, shared secret) is ``foo''. Other gecos data is likely to be easily guessable also. 18. Authentication from MySQL, Oracle, LDAP, etc (i.e. not vpasswd.cdb) There is a limitation in the vpopmail.pm perl module. Essentially, it doesn't provide a calling program with all the fields from the user's passwd entry. It doesn't give the program a way to get at the GID or clear_text_passwd fields. The vodmr workaround for those limitations falls down when non-CDB authentication enters the fray. If you're looking for non-CDB authentication you should do two things. - Apply this patch to the vpopmail.pm sources and rebuild and reinstall the module: http://romana.now.ie/software/p5vpopmail-vauth_getpw.xtrafields.patch This fixes the root cause, and gives vpopmail.pm its missing abilities. - Apply this patch to vodmr (to 0.12): http://romana.now.ie/software/vodmr-0.12-with.fixed.p5vpopmail-patch This removes the workaround for the vpopmail.pm limitations (which are no longer present thanks to the patch above). The fix for vpopmail.pm has been submitted to its author but until he rolls a new release the patch above will be neccessary to use non-CDB authentication. To be added: svscan/supervise cyclog/multilog -x flag to tcpserver $Id: FAQ,v 1.21 2004/12/21 14:58:44 james Exp $ vodmr-0.13/FILES000644 001764 001751 00000000477 07532700166 013765 0ustar00jamesjamesX000000 000000 README : Introduction INSTALL : Installation and setup instructions FAQ : Frequently asked questions (and their answers) odmrd : ODMR/ATRN server program sample-odmrd.rules : Example tcpserver rules INTERNALS : Misc. notes about the bowels of odmrd TODO : Things to be done or considered FILES : This list vodmr-0.13/sample-odmrd.rules000644 001764 001751 00000001003 07532676353 016634 0ustar00jamesjamesX000000 000000 # # Sample tcpserver rules for vodmr's odmrd program. # See http://cr.yp.to/ucspi-tcp/tcprules.html for more information. # # $Id: sample-odmrd.rules,v 1.3 2002/08/27 13:21:47 james Exp $ # # Enable debugging for a single host. 192.168.15.3:allow,DEBUG="yes" # # Enable debugging for a network, 172.17.0.0/16 in this case. 172.17.:allow,DEBUG="yes" # # Block connections from a nuisance host (192.168.79.120) and # network (10.133.204.0/23). 192.168.79.120:deny 10.133.204-205.:deny # # Allow everyone else. :allow vodmr-0.13/TODO000644 001764 001751 00000001606 10077002053 013647 0ustar00jamesjamesX000000 000000 TODO $Id: TODO,v 1.20 2004/07/19 17:26:03 james Exp $ Keep overall error count and bail after too many errors? Pipelining in client mode (if server supports)? Support for limiting usage per unit time? ESMTP SIZE; http://cr.yp.to/smtp/size.html ? Extended status codes? RFC2034/RFC1893 Make %smtp into a hash of lists? Standardise debug log messages Remove CDB_File module. Gah - vpopmail.pm doesn't give uid, gid or clear passwd. Patches supplied to Sean. Hassle him to integrate and release so I can drop the requirement for CDB_File and the redundant functionality it brings. maildir(5) says we should scan Maildir/tmp for stale data - bother? exit 0 for EOF in &serverloop()? Verify that the Delivered-To returned by header->get ends in $authuser[1]? Mail::Header _might_ give us the wrong header (or the right header mightn't be present). xinetd on RedHat9 sends STDERR to the client. vodmr-0.13/INTERNALS000644 001764 001751 00000010623 07655753666 014477 0ustar00jamesjamesX000000 000000 This program is an RFC 2645 On-Demand Mail Relay (ODMR) / Authenticated TURN (ATRN) server for vpopmail/vchkpw mail servers running qmail. $Id: INTERNALS,v 1.16 2003/05/06 15:41:42 james Exp $ INTERNAL STATES A scalar called ``$state'' keeps track of the internal state. When a user completes an action which changes the internal state a new value is assigned to $state. $state is tested at certain points to ensure a requested action is appropriate. The possible states are listed below. Server states 0. Connection established, server started. >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Initial state. 1. EHLO command received. 2. EHLO responded to, awaiting AUTH. Further EHLO's reject 503. 3. AUTH command received, and good to proceed to CRAM. 4. Challenge sent, awaiting response. 5. Response received. 6. Digest calculated. 7. Authenticated. Further AUTH's reject 503. Awaiting ATRN. >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Authenticated state. 8. ATRN received. (will check mailboxes) 9. User is permitted access to requested mailboxes. 10. Mailbox contains mail. 11. Changed to client mode. >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Reversed state. 12. SMTP client session started. 13. Sending messages. 14. Sending bounces. 15. Finished sending. END TESTING Tested with Perl: v5.005_03 i386-freebsd (FreeBSD 4.5 and 4.7) v5.6.1 sun4-solaris (Solaris 8 sparc) and RH 7.3 GNU/Linux ODMR clients: fetchmail 5.9.0 5.9.11 5.9.13 6.1.0 XATRN 1.2.2 SMTP servers (in reversed state): qmail-smtpd 1.03 sendmail 8.9.3 8.11.3 8.12.3 MDaemon 5.0.7 New releases are routinely tested with fuzz: bender[524,odmrd]$ fuzz -r 3000 /usr/bin/perl -Tw /home/james/cvs/odmrd/odmrd Testing /usr/bin/perl done -- No faults found. SIGNALS SIGALRM is used internally to timeout certain activities. Stray ALRMs will cause some very strange behaviour! (It'll immediately timeout whatever activity is underway) SIGHUP is caught and ignored. SIGTERM causes the program to exit. SIGUSR1 enables debugging output. SIGUSR2 disables debugging output. The effect of other signals is undetermined - that'll depend on how your perl interpreter reacts to the signal on your platform. WHEN IS A PASSWORD NOT A PASSWORD? When it's a shared secret. Why is that important? Because the ODMR protocol requires shared secrets. odmrd cannot make use of the regular vpopmail "password" as such passwords are not actually stored in the vpopmail authentication database. Instead, a one-way hash of the password is all that's saved. There is no feasible way, given the password hash, to recover the password. Instead, when you login vpopmail hashes the password you supply and compares the results of its hash with the hash stored in the authentication database. If they match, you must have supplied the correct password. The drawback to this is that you must send your clear text password over the network, from the client to the server. ODMR requires the use of shared secrets, their advantage being that the secret itself is never transmitted over the network. However for the system to work the server (in this case, vodmr) needs to have a record of your actual secret somewhere in the authentication database. vodmr can look for that value in either the password field, the gecos field or the clear_text_passwd field. The literal contents of whichever of these fields that you elect to use is taken as the secret. STRING SIZE LIMITS Envelope sender/recipients: 1024 characters Responses from remote SMTP servers/clients: 512 characters Log messages: 1024 characters EXIT CODES 0: clean exit 2: timeout 4: SIGTERM caught 5: message could not be encoded for SMTP 9: abnormal exit from clientloop() subroutine 10: client mode greeting failed 11: control/me is inaccessable/empty or otherwise borked 12: mailbox inaccessible. 13: abnormal exit from serverloop() subroutine RELATED RFCS 1123: Requirements for Internet Hosts -- Application and Support 1869: SMTP Service Extensions 2195: IMAP/POP AUTHorize Extension for Simple Challenge/Response 2222: Simple Authentication and Security Layer (SASL) 2554: SMTP Service Extension for Authentication (SMTP AUTH) 2645: On-Demand Mail Relay (ODMR) / Authenticated TURN (ATRN) 2821: Simple Mail Transfer Protocol 2920: SMTP Service Extension for Command Pipelining REFERENCE http://cr.yp.to/smtp.html http://cr.yp.to/immhf.html $Id: INTERNALS,v 1.16 2003/05/06 15:41:42 james Exp $ vodmr-0.13/README000644 001764 001751 00000011453 10074620174 014047 0ustar00jamesjamesX000000 000000 This program is an RFC 2645 On-Demand Mail Relay (ODMR) / Authenticated TURN (ATRN) server for vpopmail/vchkpw mail servers running qmail. $Id: README,v 1.15 2004/07/12 23:36:28 james Exp $ REQUIREMENTS For this program to work, you require; 1. A working vpopmail/vchkpw + qmail setup 2. Perl 5 with MIME::Base64, Mail::Header, CDB_File, vpopmail and Digest::HMAC_MD5 modules 3. Maildir mailboxes 4. A UCSPI-TCP server (tcpserver is ideal) or inetd / xinetd vpopmail is available from http://www.inter7.com/vpopmail/ tcpserver is available from http://cr.yp.to/ucspi-tcp.html Pick up any modules you need from http://search.cpan.org/ Latest information at http://romana.now.ie/#vodmr Read INSTALL for installation instructions and how to setup ODMR for a domain. The outline steps are: 1. Create a vpopmail domain in whatever way you usually do. 2. Set a mailbox (postmaster is a good choice) to receive all mail for the domain. 3. Set the comment for the mailbox to be the shared secret and enable ODMR service by setting a mailbox flag. INTRODUCTION vodmr is an On-Demand Mail Relay (ODMR) / Authenticated TURN (ATRN) / RFC2645 server for vpopmail/vchkpw mail servers. Some things to note; Requires vpopmail (and qmail) Uses comment, clear text or password field for passwords Compatible with qmailadmin Minimal implementation Message bouncing Connection filtering with tcpserver A customer makes a connection to the ODMR provider, authenticates using a challenge-response method and requests its mail. The roles of client and server are then reversed and normal SMTP proceeds over the same connection. In this way a network administrator does not need to allow inbound traffic for email delivery. Once the ODMR authentication is completed, SMTP runs on the session that was initiated from the customer system. The ODMR server, odmrd, is explicitly not a long running daemon. A copy of odmrd is started to service a new connection and the process exits when the session finishes. tcpserver/inetd manage the networking elements. odmrd deals only with stdin, stdout and stderr. odmrd does not need to run as root, so don't! Run it as your vpopmail user. (It'll complain if you do run it as root) CHANGES (Potential problems or incompatible changes between releases) 0.11: Requires vpopmail.pm perl module. Supports native clear-text password field. Configuration variables have changed: $vpopmail is gone and $usegecos is replaced by $secretfield to select secret from clear_text, gecos or passwd field. 0.10: A V_USER flag must be set on a mailbox to enable ODMR service from it. The default is to require V_USER2. Use 'vmoduser -2 ...' to accomplish this. If you are upgrading from a previous release you must set V_USER2 on your ODMR mailboxes. You can remove this requirement by setting the $require_flag variable to ``none'' but I strongly recommend against it. It's just too easy to leave mailboxes with guessable gecos values. PROBLEM REPORTING The vodmr mailing list is . To subscribe send a blank email to and confirm the confirmation request you will be sent. To unsubscribe from the list send a blank email to and confirm the confirmation request you will be sent. If you want to report a problem, submit a patch or a comment please email . Please review first the FAQ, INSTALL and other documentation at http://romana.now.ie/#vodmr for any recent updates that may be relevant to your problem. Please include as much information about your problem as you can. Some things which are especially useful are - what version of vodmr and perl you are using (``perl -v'') - name and version of your ODMR client; fetchmail, XATRN, etc - odmrd's debugging output. Note this will include shared secrets. I'm not interested in reading your email but somebody who might intercept your message to me might be. (And let's face it, you have no reason to trust me either). You should remove or obscure secrets (and _just_ the secrets) if this is a concern. Remember -- I can't see your computer and I didn't see what you tried to do. You'll have to tell me! There are two fine essays on the topics of bug reporting and requesting help available on the web. I strongly suggest you invest a little time to read them. They're entertaining _and_ educational! How to Report Bugs Effectively, by Simon Tatham: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How To Ask Questions The Smart Way, by Eric Steven Raymond: http://www.tuxedo.org/~esr/faqs/smart-questions.html THANKS A thank you to people who've helped out; Tiarnan DeBurca - documentation proof read Giovanni Panozzo - tested vodmr with his client program (XATRN) $Id: README,v 1.15 2004/07/12 23:36:28 james Exp $