haraka 0.0.33 → 3.3.1

package/contrib/Haraka.cf

@@ -0,0 +1,6 @@
+loadplugin Mail::SpamAssassin::Plugin::Haraka	Haraka.pm
+
+ifplugin Mail::SpamAssassin::Plugin::Haraka
+    header   __HARAKA		eval:get_haraka_uuid()
+endif
+

package/contrib/Haraka.pm

@@ -0,0 +1,35 @@
+package Mail::SpamAssassin::Plugin::Haraka;
+my $VERSION = 0.1;
+
+use warnings;
+use strict;
+use Mail::SpamAssassin::Plugin;
+use vars qw(@ISA);
+@ISA = qw(Mail::SpamAssassin::Plugin);
+
+sub dbg {
+    Mail::SpamAssassin::Plugin::dbg ("Haraka: @_");
+}
+
+sub new {
+    my ($class, $mailsa) = @_;
+    $class = ref($class) || $class;
+    my $self = $class->SUPER::new($mailsa);
+    bless ($self, $class);
+    $self->register_eval_rule("get_haraka_uuid");
+}
+
+sub get_haraka_uuid {
+    my ($self, $pms) = @_;
+
+    # Add last external IP
+    my $le = $pms->get_tag('LASTEXTERNALIP');
+    if(defined($le) && $le) {
+        $pms->set_spamd_result_item( sub { return "last-external=$le"; } );
+    }
+    my $header = $pms->get("X-Haraka-UUID");
+    if(defined($header) && $header) {
+        $pms->set_spamd_result_item( sub { return "haraka-uuid=$header"; } );
+    }
+    return 0;
+}

package/contrib/bad_smtp_server.pl

@@ -0,0 +1,25 @@
+#!/usr/bin/perl
+
+use warnings;
+use strict;
+
+use IO::Socket;
+
+my $server = IO::Socket::INET->new(Listen => 5, LocalPort => 2525, Proto => "tcp");
+$server || die $!;
+
+while (my $client = $server->accept()) {
+    print "Got connection\n";
+    $client->print("220 hostname\r\n");
+    my $helo = <$client>;
+    $client->print("250 hi\r\n");
+    my $mail = <$client>;
+    $client->print("250 ok\r\n");
+    my $rcpt = <$client>;
+    $client->print("250 ok\r\n");
+    my $data = <$client>;
+    $client->print("354 ok\r\n");
+    my $line = <$client>;
+    $client->close();
+    print "Closed client\n";
+}

package/contrib/bsd-rc.d/haraka

@@ -0,0 +1,63 @@
+#!/bin/sh
+# USAGE: rename this as 'haraka' and drop it in /usr/local/etc/rc.d
+#        tested on FreeBSD. Should work on NetBSD and Dragonfly
+
+# PROVIDE: haraka
+# REQUIRE: NETWORKING ldconfig
+# KEYWORD: shutdown
+
+PATH="$PATH:/usr/local/bin"
+
+. /etc/rc.subr
+
+name="haraka"
+rcvar="haraka_enable"
+
+command="/usr/local/bin/haraka"
+pidfile="/var/run/${name}.pid"
+
+haraka_flags=${haraka_flags:="-c /data"}
+
+start_cmd="start"
+status_cmd="status"
+stop_cmd="stop"
+
+load_rc_config $name
+
+start()
+{
+    /usr/local/bin/node /usr/local/bin/haraka $haraka_flags
+}
+
+status()
+{
+   if [ -f $pidfile ];
+   then
+       LPID=`cat $pidfile`
+       LPROC=`/bin/ps -p $PID`
+       if [ -n $LPROC ];
+       then
+           echo "$name is running as $LPID"
+       else
+           echo "$name is not running"
+       fi
+    else
+        echo "$name is not running"
+    fi 
+}
+
+stop()
+{
+   if [ -f $pidfile ];
+   then
+       kill `cat $pidfile`
+       if [ -f $pidfile ];
+       then
+           rm $pidfile
+       fi
+   else
+       echo "no PID file!"
+   fi
+}
+
+run_rc_command "$1"

package/contrib/debian-init.d/haraka

@@ -0,0 +1,87 @@
+#!/bin/sh
+### BEGIN INIT INFO
+# Provides:          haraka
+# Required-Start:    $local_fs $remote_fs $network $syslog $named
+# Required-Stop:     $local_fs $remote_fs $network $syslog $named
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# X-Interactive:     true
+# Short-Description: Start/stop haraka SMTP server
+### END INIT INFO
+# Thx to author of http://www.thegeekstuff.com/2012/03/lsbinit-script/
+
+
+DAEMON="/usr/local/bin/haraka"
+NAME="haraka"
+APP_DIR="/etc/haraka"
+CONFIG="$APP_DIR/config/smtp.ini"
+MAX_OPEN_FILES=65535
+EXEC_OPTS="-c $APP_DIR"
+PIDFILE="/var/run/$NAME/smtp.pid"
+
+. /lib/lsb/init-functions
+
+
+case "$1" in
+ start)
+  # Checked the PID file exists and check the actual status of process
+  if [ -e $PIDFILE ]; then
+   status_of_proc -p $PIDFILE $DAEMON "$NAME process" && status="0" || status="$?"
+   # If the status is SUCCESS then don't need to start again.
+   if [ $status = "0" ]; then
+    exit # Exit
+   fi
+  fi
+  # Start the daemon.
+  log_daemon_msg "Starting the process" "$NAME"
+  # Start the daemon with the help of start-stop-daemon
+  # Log the message appropriately
+  if start-stop-daemon --start --oknodo --pidfile $PIDFILE --exec $DAEMON -- $EXEC_OPTS; then
+   log_end_msg 0
+  else
+   log_end_msg 1
+  fi
+  ;;
+ stop)
+  # Stop the daemon.
+  if [ -e $PIDFILE ]; then
+   status_of_proc -p $PIDFILE $DAEMON "Stoppping the $NAME process" && status="0" || status="$?"
+   if [ "$status" = 0 ]; then
+    start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE
+    /bin/rm -rf $PIDFILE
+   fi
+  else
+   log_daemon_msg "$NAME process is not running"
+   log_end_msg 0
+  fi
+  ;;
+ restart)
+  # Restart the daemon.
+  $0 stop && sleep 2 && $0 start
+  ;;
+ status)
+  # Check the status of the process.
+  if [ -e $PIDFILE ]; then
+   status_of_proc -p $PIDFILE $DAEMON "$NAME process" && exit 0 || exit $?
+  else
+   log_daemon_msg "$NAME Process is not running"
+   log_end_msg 0
+  fi
+  ;;
+ reload)
+  # Reload the process. Basically sending some signal to a daemon to reload
+  # it configurations.
+  if [ -e $PIDFILE ]; then
+   start-stop-daemon --stop --oknodo --signal 1 --quiet --pidfile $PIDFILE --name $NAME
+   log_success_msg "$NAME process reloaded successfully"
+  else
+   log_failure_msg "$PIDFILE does not exists"
+  fi
+  ;;
+ *)
+  # For invalid arguments, print the usage message.
+  echo "Usage: $0 {start|stop|restart|reload|status}"
+  exit 2
+  ;;
+esac
+exit $?

package/contrib/haraka.init

@@ -0,0 +1,96 @@
+#!/bin/sh
+#
+# Haraka
+#
+# chkconfig:   2345 80 30
+# description: Node.js Mail Server
+#
+
+# Source function library.
+. /etc/rc.d/init.d/functions
+
+exec="/usr/local/bin/haraka"
+prog="haraka"
+config="/etc/haraka/config/smtp.ini"
+
+[ -e /etc/sysconfig/$prog ] && . /etc/sysconfig/$prog
+
+[ -z "$max_open_files" ] && max_open_files=65535
+
+lockfile=/var/lock/subsys/$prog
+
+start() {
+    [ -x $exec ] || exit 5
+    [ -f $config ] || exit 6
+    echo -n $"Starting $prog: "
+    ulimit -n $max_open_files
+    daemon "$exec -c /etc/haraka 2>&1 >> /var/log/haraka.log"
+    retval=$?
+    echo
+    [ $retval -eq 0 ] && touch $lockfile
+    return $retval
+}
+
+stop() {
+    echo -n $"Stopping $prog: "
+    killproc $prog
+    retval=$?
+    echo
+    rm -f $lockfile
+    return $retval
+}
+
+restart() {
+    stop
+    start
+}
+
+reload() {
+    restart
+}
+
+force_reload() {
+    restart
+}
+
+rh_status() {
+    # run checks to determine if the service is running or use generic status
+    status $prog
+}
+
+rh_status_q() {
+    rh_status >/dev/null 2>&1
+}
+
+
+case "$1" in
+    start)
+        rh_status_q && exit 0
+        $1
+        ;;
+    stop)
+        rh_status_q || exit 0
+        $1
+        ;;
+    restart)
+        $1
+        ;;
+    reload)
+        rh_status_q || exit 7
+        $1
+        ;;
+    force-reload)
+        force_reload
+        ;;
+    status)
+        rh_status
+        ;;
+    condrestart|try-restart)
+        rh_status_q || exit 0
+        restart
+        ;;
+    *)
+        echo $"Usage: $0 {start|stop|status|restart|condrestart|try-restart|reload|force-reload}"
+        exit 2
+esac
+exit $?

package/contrib/haraka.service

@@ -0,0 +1,23 @@
+#
+# systemd service file for Haraka
+#
+# Ensure that `daemonize` in `smtp.ini` is set to `false` (which is the default value).
+#
+# Put this file in /etc/systemd/system,  modify the paths to suit, then run:
+# sudo systemctl enable haraka
+# sudo systemctl start haraka
+#
+
+[Unit]
+Description=Haraka MTA
+After=syslog.target network.target remote-fs.target nss-lookup.target
+
+[Service]
+Type=simple
+PIDFile=/var/run/haraka.pid
+ExecStart=/usr/bin/haraka -c /path/to/your/config
+KillMode=process
+PrivateTmp=true
+
+[Install]
+WantedBy=multi-user.target

package/contrib/plugin2npm.sh

@@ -0,0 +1,81 @@
+#!/bin/sh
+
+usage()
+{
+    echo "$0 \$plugin_name"
+    exit
+}
+
+if [ -z "$1" ]; then
+    usage
+fi
+
+export GITHUB_ORG="haraka"
+export PLUGIN_NAME="haraka-plugin-$1"
+export PLUGIN_REPO="../$PLUGIN_NAME"
+export GIT_CMD="git -C $PLUGIN_REPO"
+
+if [ -d "$PLUGIN_REPO" ]; then
+    echo "repo exists at $PLUGIN_REPO"
+else
+    git clone git@github.com:haraka/haraka-plugin-template.git "$PLUGIN_REPO" || exit
+    $GIT_CMD remote rm origin || exit
+    $GIT_CMD remote add origin "git@github.com:$GITHUB_ORG/$PLUGIN_NAME.git" || exit
+fi
+
+if grep template "$PLUGIN_REPO/README.md"; then
+    echo "redressing as $PLUGIN_NAME"
+    sed -i '' -e "s/template/${1}/g" "$PLUGIN_REPO/README.md"
+
+    sed -i '' \
+        -e "s/template/${1}/g" \
+        -e "s/template\.ini/$1.ini/" \
+        "$PLUGIN_REPO/test/index.js"
+
+    sed -i '' -e "s/template/${1}/g" "$PLUGIN_REPO/package.json"
+
+    sed -i '' \
+        -e "s/_template/_${1}/g" \
+        -e "s/template\.ini/$1.ini/" \
+        "$PLUGIN_REPO/index.js"
+
+    $GIT_CMD mv config/template.ini "config/$1.ini"
+
+    $GIT_CMD add package.json README.md index.js test config
+    $GIT_CMD commit -m "publish $1 as NPM module"
+
+    $GIT_CMD rm redress.sh
+fi
+
+if [ -f "docs/plugins/$1.md" ]; then
+    echo "copying docs/plugin/$1.md to $PLUGIN_REPO/README.md"
+    head -n8 "$PLUGIN_REPO/README.md" > foo.md
+    cat "docs/plugins/$1.md" >> foo.md
+    tail -n14 "$PLUGIN_REPO/README.md" >> foo.md
+    mv foo.md "$PLUGIN_REPO/README.md"
+    git rm "docs/plugins/$1.md" || exit
+fi
+
+if [ -f "config/$1.ini" ]; then
+    echo "copying $1.ini"
+    cp "config/$1.ini" "$PLUGIN_REPO/config/$1.ini"
+    git rm "config/$1.ini"
+    $GIT_CMD add "config/$1.ini"
+fi
+
+if [ -f "plugins/$1.js" ]; then
+    echo "copying plugins/$1.js"
+    cp "plugins/$1.js" "$PLUGIN_REPO/index.js"
+    tee "plugins/$1.js" <<DEPRECATED
+exports.register = function () {
+    this.logerror('This plugin has moved. See https://github.com/haraka/haraka-plugin-$1');
+}
+DEPRECATED
+    $GIT_CMD add index.js
+fi
+
+if [ -f "test/plugins/$1.js" ]; then
+    echo "copying test/plugins/$1.js"
+    cp "test/plugins/$1.js" "$PLUGIN_REPO/test/index.js"
+    git rm "test/plugins/$1.js"
+fi

package/contrib/ubuntu-upstart/haraka.conf

@@ -0,0 +1,27 @@
+# haraka - nodejs email server
+#
+# Ubuntu Upstart script (place in /etc/init and run "initctl start haraka")
+# (Assumes running w/the daemonize plugin)
+#
+# Contributed by "David Weekly" <david@weekly.org>
+#
+
+description	  "Haraka Email Server"
+
+start on (local-filesystems and net-device-up IFACE=eth0)
+stop  on shutdown
+
+respawn
+respawn limit 10 5
+umask 022
+limit nofile 65535 65535
+
+console none
+
+pre-start script
+    test -x /usr/local/bin/haraka || { stop; exit 0; }
+    test -c /dev/null || { stop; exit 0; }
+end script
+
+expect fork
+exec /usr/local/bin/haraka -c /etc/haraka

package/docs/Body.md

@@ -0,0 +1 @@
+moved to [Body](https://github.com/haraka/email-message#body)

package/docs/Config.md

@@ -0,0 +1 @@
+This documentation has moved to [haraka-config](https://github.com/haraka/haraka-config).

package/docs/Connection.md

@@ -0,0 +1,153 @@
+# Connection Object
+
+For each connection to Haraka there is one connection object. It is the first argument passed to almost every plugin hook and is the primary context object plugins use to inspect and act on the SMTP session.
+
+## Properties
+
+### connection.uuid
+
+A unique UUID for this connection. Used as the connection identifier in logs and inherited by `transaction.uuid`.
+
+### connection.remote
+
+Information about the host connecting to Haraka.
+
+- `ip` — remote IP address
+- `port` — remote TCP port
+- `host` — reverse DNS of the remote IP (populated by the `connect.rdns_access` / `connect` hooks)
+- `info` — free-form descriptor (e.g. populated by FCrDNS)
+- `closed` — `true` once the remote end has dropped the connection
+- `is_private` — `true` if the remote IP is in a private range (RFC 1918, loopback, link-local, etc.)
+- `is_local` — `true` if the remote IP is localhost / loopback
+
+### connection.local
+
+Information about the Haraka server endpoint handling this connection.
+
+- `ip` — the IP of the Haraka server, as reported by the OS
+- `port` — the port number handling the connection
+- `host` — the primary host name of the Haraka server
+- `info` — `Haraka` (with `/<version>` appended when `headers.show_version` is enabled in `connection.ini`)
+
+### connection.hello
+
+The greeting given by the client.
+
+- `verb` — `EHLO` or `HELO`, whichever the client used
+- `host` — the hostname argument
+
+### connection.tls
+
+State of the TLS layer on this connection.
+
+- `enabled` — `true` once STARTTLS has been negotiated (or the listener is `smtps`)
+- `advertised` — `true` if Haraka advertised STARTTLS in the EHLO response
+- `verified` — `true` if the peer certificate validated against the configured CAs
+- `cipher` — the negotiated cipher object (`name`, `version`, …)
+- `verifyError` — the verification error, if any
+- `peerCertificate` — the parsed peer certificate (when client certs are used)
+
+### connection.proxy
+
+Proxy-protocol state, set when the connection arrived via HAProxy (see [HAProxy.md](HAProxy.md)).
+
+- `allowed` — `true` if the remote IP is in the `haproxy.hosts` allow-list
+- `ip` — the proxy server's IP (the real client IP appears in `connection.remote.ip` once PROXY is parsed)
+- `type` — currently `null` or `'haproxy'`
+
+### connection.notes
+
+A plain object that persists for the lifetime of the connection. Use it to share state between plugin hooks. For structured per-test results prefer `connection.results`. See also [haraka-notes](https://github.com/haraka/haraka-notes).
+
+### connection.results
+
+Structured store for plugin results. See [haraka-results](https://github.com/haraka/haraka-results).
+
+### connection.transaction
+
+The current `Transaction` object. Valid between `MAIL FROM` and the end of `queue` / `RSET` (or until `MAIL FROM` is rejected). See [Transaction.md](Transaction.md).
+
+### connection.relaying
+
+Boolean. `true` if this connection is allowed to relay (i.e. deliver mail outbound). Normally set by an auth plugin or an IP allow-list. Reading or writing this property transparently routes through the current transaction when one exists, so the flag survives across multiple messages in a single connection only when set on the connection.
+
+### connection.capabilities
+
+Array of ESMTP capabilities advertised in the EHLO response (e.g. `['PIPELINING', '8BITMIME', 'SIZE 0', 'STARTTLS', 'AUTH PLAIN LOGIN']`). Plugins may push additional capability strings during the `capabilities` hook.
+
+### connection.esmtp
+
+`true` if the client used `EHLO` (as opposed to `HELO`).
+
+### connection.pipelining
+
+`true` once Haraka has advertised, and the client has used, SMTP pipelining.
+
+### connection.early_talker
+
+`true` if the client sent data before Haraka issued its banner — a
+common spam-bot signal.
+
+### connection.tran_count
+
+Number of transactions completed on this connection.
+
+### connection.rcpt_count / connection.msg_count
+
+Per-disposition counters (`accept`, `tempfail`, `reject`) tracking
+recipients and full messages on this connection.
+
+### connection.start_time
+
+Connection start time, in epoch milliseconds (`Date.now()`).
+
+### connection.last_response
+
+The last SMTP response line Haraka sent to the client.
+
+### connection.last_reject
+
+The text of the last rejection issued to this client (used by
+`max_unrecognized_commands` and similar throttling plugins).
+
+### connection.errors
+
+Count of protocol errors on this connection.
+
+### connection.current_line
+
+Low-level. The current line as sent by the remote end, verbatim. Useful
+for botnet fingerprinting.
+
+### connection.state
+
+The connection's protocol state — one of the values in `haraka-constants`'s `connection.state` table (`PAUSE`, `CMD`, `LOOP`, `DATA`, `DISCONNECTING`, `DISCONNECTED`).
+
+## Methods
+
+### connection.respond(code, msg, cb)
+
+Send an SMTP response to the client. `code` is the numeric SMTP code, `msg` is the human-readable text (a string or an array of strings for a multi-line response). The callback fires when the response has been written.
+
+### connection.disconnect()
+
+Close the connection after running the `disconnect` hook.
+
+### connection.reset_transaction(cb)
+
+Tear down the current transaction (equivalent to `RSET`) and invoke `cb` when complete.
+
+### connection.set(path, value)
+
+Assign a nested property safely, e.g. `connection.set('remote.host', 'mx.example.com')`. Setting `remote.ip`
+automatically recomputes `remote.is_private` / `remote.is_local`.
+
+### connection.get(path)
+
+Read a nested property, returning `undefined` if any segment is missing.
+
+### connection.loginfo / lognotice / logwarn / logerror / logdebug / logcrit / logalert / logemerg / logprotocol / logdata
+
+Log at the named level. Each takes either `(msg)` or `(plugin, msg, data)`.
+
+See [Logging.md](Logging.md).