15Services: DSPAM: DSPAM Wizard1dspam.incDSPAM Setup WizardtrueThis wizard will guide you through the initial configuration of the DSPAM filter.Nextsubmit2dspam.incDSPAM Profile SelectiontrueDSPAM can be used in different network environment. Hence we are providing three distinct profiles to suit different DSPAM use cases. Please select a particular profile from the below profile selection.dspamprofileradioinstalledpackages->dspam->config->0->dspam-profile
<center>
<p>
When your mail server gets ready to deliver mail to a user's mailbox it calls
a delivery agent of some sort. On most UNIX systems, this is procmail, maildrop,
mail.local, or a similar tool. When used as a delivery proxy, the DSPAM agent
is called in place of your existing agent - or better put, it can masquerade
as the local delivery agent. DSPAM then processes the message and will call
the /real/ delivery agent to pass the good mail into the user's mailbox,
quarantining the bad mail. DSPAM can optionally tag and deliver both spam
and legitimate mail.
</p>
<p>
In the diagram below, MTA refers to Mail Transfer Agent, or your mail server
software: Postfix, Sendmail, Exim, etc. LDA refers to the Local Delivery
Agent: Procmail, Maildrop, etc..
</p>
</center>
lda<center><img src="/wizards/dspam-lda-proxy.png" alt="DSPAM acts as a LDA proxy" border="0" /></center>dspamprofileradioinstalledpackages->dspam->config->0->dspam-profile
<center>
If you don't want to tinker with your existing mail server setup, DSPAM can
be combined with one of a few open source programs designed to act as a POP3
proxy. This means spam is filtered whenever the user checks their mail,
rather than when it is delivered. The benefit to this is that you can set up
a small machine on your network that will connect to your existing mail server,
so no integration is needed. It also allows your users to arbitarily point their
mail client at it if they desire filtering. The drawback to this approach is
that the POP3 protocol has no way to tell the mail client that a message is
spam, and so the user will have to download the spam (tagged, of course).
</center>
pop<center><img src="/wizards/dspam-pop-proxy.png" alt="DSPAM will be invoked by a POP3 proxy" border="0" /></center>dspamprofileradioinstalledpackages->dspam->config->0->dspam-profile
<center>
Newer versions of DSPAM have seen features that allow it to function more
easily as an SMTP relay. An SMTP relay sits in front of your existing mail
server (requiring no integration). To use an SMTP relay, the MX records for
your domains are repointed to the relay machine running DSPAM. DSPAM then
relays the good (and optionally bad) mail to the existing SMTP server. This
allows you to use DSPAM with even a Windows-based destination mail server
as no integration is necessary. See doc/relay.txt for one example of how to
do this with Postfix.
</center>
smtp<center><img src="/wizards/dspam-smtp-relay.png" alt="DSPAM acts as a SMTP realy" border="0" /></center>Nextsubmit3dspam.incDatabase Settings
On this screen you will set the storage driver type that will be used to store
DSPAM tokens. After having completed this wizard you have to configure the
database that you did select herein.
storagedriverselectinstalledpackages->dspam->config->0->storage-driverSpecifies the storage driver backend (library) to use.mysqltoggleDBSettings();1msqlserverinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-serverEither a reference to a Unix domain socket or a reference to a specific host./tmp/mysql.sock^[a-z0-9.|/]+$Server name field is invalidmsqlportinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-portUse this variable if you are going to a MySQL server instance using TCP/IP instead of a socket connection.3306^[0-9]+$Port field is invalidmsqluserinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-userUsername, that will be used to connect to a MySQL server instance.dspammsqlpwdinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-passwordPassword, that will be used to connect to a MySQL server instance.dspammsqldbinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-databaseDatabase name, that contains DSPAM data.dspammsqlcompcheckboxinstalledpackages->dspam->config->0->dbsettings->0->mysql-compressIndicates whether communication data between DSPAM and MySQL should be compressed.onmsqlsuqtcheckboxinstalledpackages->dspam->config->0->dbsettings->0->mysql-squoteUse this if you have the 4.1 quote bug (see doc/mysql.txt).msqlccacheinputinstalledpackages->dspam->config->0->dbsettings->0->mysql-ccacheConection cache default set to 10.10^[0-9]+$Connection cache field is invalidmsqluidcheckboxinstalledpackages->dspam->config->0->dbsettings->0->mysql-uidInsert user id into the DSPAM signature.onsliteprinputinstalledpackages->dspam->config->0->dbsettings->0->sqlite-pragmaA particular SQLite pragma command to be used.pgserverinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-serverA reference to a specific host that is running a PostgreSQL instance.127.0.0.1^[a-z0-9.|-]+$Server name field is invalidpgportinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-portA number that represents the port a specific PostgreSQL instance is listening to.5432^[0-9]+$Port field is invalidpguserinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-userUsername, that will be used to connect to a PostgreSQL server instance.dspampgpwdinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-passwordPassword, that will be used to connect to a PostgreSQL server instance.dspampgdbinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-databaseDatabase name, that contains DSPAM data.dspampgccacheinputinstalledpackages->dspam->config->0->dbsettings->0->pgsql-ccacheConection cache default set to 3.3^[0-9]+$Connection cache field is invalidpguidcheckboxinstalledpackages->dspam->config->0->dbsettings->0->pgsql-uidInsert user id into the DSPAM signature.onoraserverinputinstalledpackages->dspam->config->0->dbsettings->0->ora-serverA reference to a specific host that is running an Oracle database instance.50"(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=127.0.0.1)(PORT=1521))(CONNECT_DATA=(SID=PROD)))"orauserinputinstalledpackages->dspam->config->0->dbsettings->0->ora-userUsername, that will be used to connect to a Oracle database server instance.dspamorapwdinputinstalledpackages->dspam->config->0->dbsettings->0->ora-passwordPassword, that will be used to connect to a Oracle database server instance.dspamoraschinputinstalledpackages->dspam->config->0->dbsettings->0->ora-schemaSchema name, that contains DSPAM data.dspamhsrmaxinputinstalledpackages->dspam->config->0->dbsettings->0->hash-rec-maxDefault number of records to create in the initial segment when building hash files.98317^[0-9]+$Default number of record field is invalidhsatexcheckboxinstalledpackages->dspam->config->0->dbsettings->0->hash-auto-exAutoextend hash databases when they fill up. This allows them to continue to train by adding extents (extensions) to the file.onhsmxexinputinstalledpackages->dspam->config->0->dbsettings->0->hash-max-extThe maximum number of extents that may be created in a single hash file.0^[0-9]+$Default number of record field is invalidhsexszinputinstalledpackages->dspam->config->0->dbsettings->0->hash-ext-sizeThe record size for newly created extents.49157^[0-9]+$Default number of record field is invalidhsmxseinputinstalledpackages->dspam->config->0->dbsettings->0->hash-max-seekThe maximum number of records to seek to insert a new record before failing or adding a new extent.100^[0-9]+$Default number of record field is invalidhsccusinputinstalledpackages->dspam->config->0->dbsettings->0->hash-co-userIf you are using a single, stateful hash database in daemon mode, specifying a concurrent user will cause the user to be permanently mapped into memory and shared via rwlocks.userhscocainputinstalledpackages->dspam->config->0->dbsettings->0->hash-co-cacheIf running in daemon mode, this is the max # of concurrent connections that will be supported.10^[0-9]+$Default number of record field is invalidNextsubmit4dspam.incDelivery Settings
On this page you will specify how DSPAM should deliver email messages to
their final destination. This could be either a local delivery method or
a TCP/IP based delivery method.
dagentSpecifies the local delivery agent DSPAM should call when delivering mail as a trusted user.selectinstalledpackages->dspam->config->0->tdelivery-agenttruedspamcUse <code>dspamc</code> instead of <code>dspam</code> to locally deliver mails from the MTA to the user's mailbox (this pulls in DSPAM client/server settings).checkboxinstalledpackages->dspam->config->0->thin-clienttruetcpipdelUse TCP/IP based delivery. This option needs to be ticked if you are going to deliver via LMTP or SMTP.checkboxinstalledpackages->dspam->config->0->tcpip-deliverydhost,dport,dident,delprotodhostinputfalseinstalledpackages->dspam->config->0->tcpip-delivery-hostAlternatively, you may wish to use SMTP or LMTP delivery to deliver your message to the mail server.^[a-z0-9.|-]+$Host name field is invaliddportinputinstalledpackages->dspam->config->0->tcpip-delivery-portPort number of a particular host.^[0-9]+$Port field is invaliddidentinputinstalledpackages->dspam->config->0->tcpip-delivery-identA particular identification string.delprotoA particular protocol typ. Either SMTP or LMTP.selectinstalledpackages->dspam->config->0->tcpip-delivery-protoonfailWhat to do if local delivery or quarantine should fail.selectinstalledpackages->dspam->config->0->delivery-onfailNextsubmit5dspam.inc DSPAM Debugging Options
Usually the DSPAM binary that ships with pfSense does not contain debugging symbols.
Hence it makes little sense to enable debugging options. If you are quite certain that
your DSPAM distribution comes with debugging enabled you may tweak the below debugging
options.
trueenabledbgEnable debugging.checkboxinstalledpackages->dspam->config->0->debug-enabledebug,doptdebuginputinstalledpackages->dspam->config->0->debug-whomEnables debugging for some or all users.doptinputinstalledpackages->dspam->config->0->debug-optionsOne or more of: process, classify, spam, fp, inoculation, corpusNextsubmit6dspam.incDSPAM Engine Settings
On this page you will find some specific options required to operate the DSPAM engine. Please
consult your <code>dspam.conf</code> for a detailed explanation of each option.
If you are unsure about the meaning of a particular option, please use the default values.
tmode
The default training mode to use for all operations, when one has not
been specified on the commandline or in the user's preferences (default: teft).
selectteftinstalledpackages->dspam->config->0->training-modetruetestcton
By default, dspam will retrain certain errors until the condition is
no longer met (default: enabled).
checkboxinstalledpackages->dspam->config->0->test-cond-trainingpvalue
Specify the technique used for calculating PValues, overriding any
defaults configured in the build (default: graham).
selectteftinstalledpackages->dspam->config->0->pvaluetrueipdriveon
Calculate odds-ratios for ham/spam, and add to X-DSPAM-Improbability
headers (default: disabled).
checkboxinstalledpackages->dspam->config->0->improbability-driveNextsubmit7dspam.incLDAP Settings
DSPAM comes with the ability to verify users agains user records stored within a LDAP directory.
If using this option, it would be for example possible to verify mail users against Windows
user entries stored within an Active Directory. Please consider this feature as somewhat experimental.
trueenableldapEnable checks against a LDAP directory.checkboxinstalledpackages->dspam->config->0->ldap-enableldapmode,ldaphost,ldapfilter,ldapbaseldapmode
Perform various LDAP functions depending on LDAPMode variable.
selectverifyinstalledpackages->dspam->config->0->ldap-modeldaphostinputinstalledpackages->dspam->config->0->ldap-hostHostname of the LDAP directory server.ldapfilterinputinstalledpackages->dspam->config->0->ldap-filterA specific query filter, that should be used while querying the LDAP server.ldapbaseinputinstalledpackages->dspam->config->0->ldap-baseA particular distinguish name from where to start LDAP queries.Nextsubmit8dspam.incMiscellaneous Settings
On this page we will give you an opertunity to fine-tune the DSPAM engine. As mentioned earlier,
if you are unsure about the meaning of a particular option, use its default value.
foattinputinstalledpackages->dspam->config->0->failover-attemptsA particular number of attempts (default: 1).trueenablesblEnable checks against a particular SBL host (default: disabled).checkboxinstalledpackages->dspam->config->0->sbl-enablesblhostsblhostinputinstalledpackages->dspam->config->0->sbl-hostA particular SBL hostname (default: none).30trueenablerblEnable RBL inoculation support (default: disabled).checkboxinstalledpackages->dspam->config->0->rbl-inoculatetrueenablenotiEnable the sending of notification emails to users (first message, quarantine full, etc. default: disabled).checkboxinstalledpackages->dspam->config->0->notification-emailNextsubmit9dspam.incMaintainance Settings
DSPAM stores token data etc. in some kind of a database (e.g. a RDBMS or flat files).
Over time, this token data may consume lots of space. Hence it makes sense to run
certain routines to clean up unused data.
psiginputinstalledpackages->dspam->config->0->purge-signaturesPurge stale signatures (default: 14).pneutinputinstalledpackages->dspam->config->0->purge-neutralPurge tokens with neutralish probabilities (default: 90).punuinputinstalledpackages->dspam->config->0->purge-unusedPurge unused tokens (default: 90).phapainputinstalledpackages->dspam->config->0->purge-hapaxes Purge tokens with less than 5 hits (hapaxes - default: 30).ponesinputinstalledpackages->dspam->config->0->purge-hits-1sPurge tokens with only 1 spam hit (default: 15).poneiinputinstalledpackages->dspam->config->0->purge-hits-1i Purge tokens with only 1 innocent hit (default: 15).Nextsubmit10dspam.incSystem Settings
This page contains additional settings related to the DSPAM system such as logging,
message processing behaviour et cetera.
locmxinputinstalledpackages->dspam->config->0->local-mx
Local Mail Exchangers: Used for source address tracking, tells DSPAM
which mail exchangers are local and therefore should be ignored in the
Received: header when tracking the source of an email. Note: you should
use the address of the host as appears between brackets [ ] in the
Received header (default: 127.0.0.1).
trueenablesyslEnable system logging (default: enabled).checkboxinstalledpackages->dspam->config->0->system-logtrueenableuselEnable per user logging (default: enabled).checkboxinstalledpackages->dspam->config->0->user-logoptinout
Opt: in or out; determines DSPAM's default filtering behavior (default: out).
selectoutinstalledpackages->dspam->config->0->filter-opttrueenableptohParse the To: headers of an incoming message. (default: disabled).checkboxinstalledpackages->dspam->config->0->parse-to-headerstrueenablecmopAutomatically change the class (to spam or innocent - default: disabled).checkboxinstalledpackages->dspam->config->0->change-mode-on-parsetrueenablecuopAutomatically change the username to match that specified in the To: header (default: enabled).checkboxinstalledpackages->dspam->config->0->change-user-on-parsemaxmsgsinputinstalledpackages->dspam->config->0->max-message-size
You may specify a maximum message size in bytes for DSPAM to process. (default: 307200).
trueprocbias
Bias causes the filter to lean more toward "innocent", and usually
greatly reduces false positives. It is the default behavior of most
Bayesian filters, including dspam (default: enabled).
checkboxinstalledpackages->dspam->config->0->processor-biasNextsubmit11dspam.incClamAV Engine Settings
DSPAM comes with an additional feature which allows to scan mail messages
for malicious code (i.e. virii). If you require messages not only to be
classified as Spam/Ham but additionally to be scanned for virii, enable
to appropriate option below.
trueenableclamEnable ClamAV Engine (default: disabled).checkboxinstalledpackages->dspam->config->0->clamav-enableclamport,clamhost,clamrespclamportinputinstalledpackages->dspam->config->0->clamav-portA number that specifies the port the ClamAV daemon is listening to (default: none).clamhostinputinstalledpackages->dspam->config->0->clamav-hostAn IP address that points to the host the ClamAV daemon is running on (default: none).clamrespThe action that should take place, if ClamAV reports a positive (default: none).selectacceptinstalledpackages->dspam->config->0->clamav-responseNextsubmit12dspam.incDSPAM Daemon Settings (Server)
DSPAM can be either invoked per message (i.e. a thread per message) or it
can be run as a daemon in the background. The latter option enables DSPAM
to maintain database connection pools which may increase overall performance.
Based on the profile, that you did choose initially, some of the below options
may be already set.
dsportinputinstalledpackages->dspam->config->0->dspam-server-portA number that specifies the port the DSPAM daemon is listening to (default: none).dsqsizeinputinstalledpackages->dspam->config->0->dspam-server-queue-sizeA number that specifies the server's queue size (default: none).dspidinputinstalledpackages->dspam->config->0->dspam-server-pid Keep this is sync with <code>/usr/local/etc/rc.d/dspam.rc</code> script (default: none).40dssmodeSpecifies the type of LMTP server to start. (default: none).selectautoinstalledpackages->dspam->config->0->dspam-server-modeserverparaminputinstalledpackages->dspam->config->0->dspam-server-paramsParameters which will be passed to the LMTP server (default: none).serveridinputinstalledpackages->dspam->config->0->dspam-server-idAn identification string which will be used to be passed to the LMTP server (default: none).serversockinputinstalledpackages->dspam->config->0->dspam-server-socketA local Unix domain socket (default: none).40Nextsubmit13dspam.incDSPAM Daemon Settings (Client)
If you did configure DSPAM to run in dspam mode, it is required to configure
client settings because DSPAM needs for example to authenticate against its
server counterpart.
trueenabledsclientRun DSPAM in client mode (default: disabled).checkboxinstalledpackages->dspam->config->0->dspam-client-enabledsclhost,dsclport,dsclidentdsclhostinputinstalledpackages->dspam->config->0->dspam-client-hostAn IP address or a Unix domain socket (default: none).dsclportinputinstalledpackages->dspam->config->0->dspam-client-portWill be only used if this client uses TCP/IP communication (default: none).dsclidentinputinstalledpackages->dspam->config->0->dspam-client-idA string that will be used to identify the client against a server. (default: none).40Nextsubmit14dspam.incReload configurationtrueClick 'Reload' to reload the DSPAM daemon with new changes.Reloadsubmit15dspam.incReload in progress
A reload is now in progress. Please wait.
<br /> <br />
The system will automatically try to access DSPAM settings in 120 page seconds.
<br /> <br />
You can click on the icon above to access the site more quickly.