/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you under the Apache License, Version 2.0 (the *
* "License"); you may not use this file except in compliance *
* with the License. You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, *
* software distributed under the License is distributed on an *
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
****************************************************************/
package org.apache.james.smtpserver.fastfail;
import java.io.File;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import javax.sql.DataSource;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.HierarchicalConfiguration;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.james.dnsservice.api.DNSService;
import org.apache.james.lifecycle.Configurable;
import org.apache.james.lifecycle.LogEnabled;
import org.apache.james.protocols.smtp.SMTPSession;
import org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler;
import org.apache.james.protocols.smtp.hook.HookResult;
import org.apache.james.protocols.smtp.hook.HookReturnCode;
import org.apache.james.services.FileSystem;
import org.apache.james.util.TimeConverter;
import org.apache.james.util.netmatcher.NetMatcher;
import org.apache.james.util.sql.JDBCUtil;
import org.apache.james.util.sql.SqlResources;
import org.apache.mailet.MailAddress;
/**
* GreylistHandler which can be used to activate Greylisting
*/
public class JDBCGreylistHandler extends AbstractGreylistHandler implements LogEnabled, Configurable{
/** This log is the fall back shared by all instances */
private static final Log FALLBACK_LOG = LogFactory.getLog(JDBCGreylistHandler.class);
/** Non context specific log should only be used when no context specific log is available */
private Log serviceLog = FALLBACK_LOG;
private DataSource datasource = null;
private FileSystem fileSystem = null;
private String selectQuery;
private String insertQuery;
private String deleteQuery;
private String deleteAutoWhiteListQuery;
private String updateQuery;
/**
* Contains all of the sql strings for this component.
*/
private SqlResources sqlQueries = new SqlResources();
/**
* The sqlFileUrl
*/
private String sqlFileUrl;
/**
* Holds value of property sqlParameters.
*/
private Map<String, String> sqlParameters = new HashMap<String, String>();
private DNSService dnsService;
private NetMatcher wNetworks;
/**
* Gets the file system service.
* @return the fileSystem
*/
public final FileSystem getFileSystem() {
return fileSystem;
}
/**
* Sets the filesystem service
*
* @param system The filesystem service
*/
@Resource(name="filesystem")
public void setFileSystem(FileSystem system) {
this.fileSystem = system;
}
/**
* Set the datasources.
*
* @param datasources
* The datasources
*/
@Resource(name="datasource")
public void setDataSource(DataSource datasource) {
this.datasource = datasource;
}
/**
* Set the sqlFileUrl to use for getting the sqlRessource.xml file
*
* @param sqlFileUrl
* The fileUrl
*/
public void setSqlFileUrl(String sqlFileUrl) {
this.sqlFileUrl = sqlFileUrl;
}
/**
* Setup the temporary blocking time
*
* @param tempBlockTime
* The temporary blocking time
*/
public void setTempBlockTime(String tempBlockTime) {
setTempBlockTime(TimeConverter.getMilliSeconds(tempBlockTime));
}
/**
* Setup the autowhitelist lifetime for which we should whitelist a triplet.
* After this lifetime the record will be deleted
*
* @param autoWhiteListLifeTime
* The lifeTime
*/
public void setAutoWhiteListLifeTime(String autoWhiteListLifeTime) {
setAutoWhiteListLifeTime(TimeConverter.getMilliSeconds(autoWhiteListLifeTime));
}
/**
* Set up the liftime of only once seen triplet. After this liftime the
* record will be deleted
*
* @param unseenLifeTime
* The lifetime
*/
public void setUnseenLifeTime(String unseenLifeTime) {
setUnseenLifeTime(TimeConverter.getMilliSeconds(unseenLifeTime));
}
@Resource(name="dnsservice")
public final void setDNSService(DNSService dnsService) {
this.dnsService = dnsService;
}
public void setWhiteListedNetworks(NetMatcher wNetworks) {
this.wNetworks = wNetworks;
}
protected NetMatcher getWhiteListedNetworks() {
return wNetworks;
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#configure(org.apache.commons.configuration.Configuration)
*/
public void configure(HierarchicalConfiguration handlerConfiguration) throws ConfigurationException {
try {
setTempBlockTime(handlerConfiguration.getString("tempBlockTime"));
} catch (NumberFormatException e) {
throw new ConfigurationException(e.getMessage());
}
try {
setAutoWhiteListLifeTime(handlerConfiguration.getString("autoWhiteListLifeTime"));
} catch (NumberFormatException e) {
throw new ConfigurationException(e.getMessage());
}
try {
setUnseenLifeTime(handlerConfiguration.getString("unseenLifeTime"));
} catch (NumberFormatException e) {
throw new ConfigurationException(e.getMessage());
}
String nets = handlerConfiguration.getString("whitelistedNetworks");
if (nets != null) {
String[] whitelistArray = nets.split(",");
List<String> wList = new ArrayList<String>(whitelistArray.length);
for (int i = 0 ; i< whitelistArray.length; i++) {
wList.add(whitelistArray[i].trim());
}
setWhiteListedNetworks( new NetMatcher(wList ,dnsService));
serviceLog.info("Whitelisted addresses: " + getWhiteListedNetworks().toString());
}
// Get the SQL file location
String sFile = handlerConfiguration.getString("sqlFile",null);
if (sFile != null) {
setSqlFileUrl(sFile);
if (!sqlFileUrl.startsWith("file://") && !sqlFileUrl.startsWith("classpath:")) {
throw new ConfigurationException(
"Malformed sqlFile - Must be of the format \"file://<filename>\".");
}
} else {
throw new ConfigurationException("sqlFile is not configured");
}
}
@PostConstruct
public void init() throws Exception {
try {
initSqlQueries(datasource.getConnection(), sqlFileUrl);
// create table if not exist
createTable("greyListTableName", "createGreyListTable");
} catch (Exception e) {
throw new RuntimeException("Unable to init datasource", e);
}
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#getGreyListData(java.lang.String, java.lang.String, java.lang.String)
*/
protected Iterator<String> getGreyListData(String ipAddress,
String sender, String recip) throws SQLException {
Collection<String> data = new ArrayList<String>(2);
PreparedStatement mappingStmt = null;
Connection conn = datasource.getConnection();
try {
mappingStmt = conn.prepareStatement(selectQuery);
ResultSet mappingRS = null;
try {
mappingStmt.setString(1, ipAddress);
mappingStmt.setString(2, sender);
mappingStmt.setString(3, recip);
mappingRS = mappingStmt.executeQuery();
if (mappingRS.next()) {
data.add(String.valueOf(mappingRS.getTimestamp(1).getTime()));
data.add(String.valueOf(mappingRS.getInt(2)));
}
} finally {
theJDBCUtil.closeJDBCResultSet(mappingRS);
}
} finally {
theJDBCUtil.closeJDBCStatement(mappingStmt);
theJDBCUtil.closeJDBCConnection(conn);
}
return data.iterator();
}
/**
* (non-Javadoc)
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#insertTriplet(java.lang.String, java.lang.String, java.lang.String, int, long)
*/
protected void insertTriplet(String ipAddress,
String sender, String recip, int count, long createTime)
throws SQLException {
Connection conn = datasource.getConnection();
PreparedStatement mappingStmt = null;
try {
mappingStmt = conn.prepareStatement(insertQuery);
mappingStmt.setString(1, ipAddress);
mappingStmt.setString(2, sender);
mappingStmt.setString(3, recip);
mappingStmt.setInt(4, count);
mappingStmt.setTimestamp(5, new Timestamp(createTime));
mappingStmt.executeUpdate();
} finally {
theJDBCUtil.closeJDBCStatement(mappingStmt);
theJDBCUtil.closeJDBCConnection(conn);
}
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#updateTriplet(java.lang.String, java.lang.String, java.lang.String, int, long)
*/
protected void updateTriplet(String ipAddress,
String sender, String recip, int count, long time)
throws SQLException {
Connection conn = datasource.getConnection();
PreparedStatement mappingStmt = null;
try {
mappingStmt = conn.prepareStatement(updateQuery);
mappingStmt.setTimestamp(1, new Timestamp(time));
mappingStmt.setInt(2, (count + 1));
mappingStmt.setString(3, ipAddress);
mappingStmt.setString(4, sender);
mappingStmt.setString(5, recip);
mappingStmt.executeUpdate();
} finally {
theJDBCUtil.closeJDBCStatement(mappingStmt);
theJDBCUtil.closeJDBCConnection(conn);
}
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#cleanupAutoWhiteListGreyList(long)
*/
protected void cleanupAutoWhiteListGreyList(long time)
throws SQLException {
PreparedStatement mappingStmt = null;
Connection conn = datasource.getConnection();
try {
mappingStmt = conn.prepareStatement(deleteAutoWhiteListQuery);
mappingStmt.setTimestamp(1, new Timestamp(time));
mappingStmt.executeUpdate();
} finally {
theJDBCUtil.closeJDBCStatement(mappingStmt);
theJDBCUtil.closeJDBCConnection(conn);
}
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#cleanupGreyList(long)
*/
protected void cleanupGreyList(long time)
throws SQLException {
Connection conn = datasource.getConnection();
PreparedStatement mappingStmt = null;
try {
mappingStmt = conn.prepareStatement(deleteQuery);
mappingStmt.setTimestamp(1, new Timestamp(time));
mappingStmt.executeUpdate();
} finally {
theJDBCUtil.closeJDBCStatement(mappingStmt);
theJDBCUtil.closeJDBCConnection(conn);
}
}
/**
* The JDBCUtil helper class
*/
private final JDBCUtil theJDBCUtil = new JDBCUtil() {
protected void delegatedLog(String logString) {
serviceLog.debug("JDBCVirtualUserTable: " + logString);
}
};
/**
* Initializes the sql query environment from the SqlResources file. Will
* look for conf/sqlResources.xml.
*
* @param conn
* The connection for accessing the database
* @param sqlFileUrl
* The url which we use to get the sql file
* @throws Exception
* If any error occurs
*/
private void initSqlQueries(Connection conn, String sqlFileUrl)
throws Exception {
try {
File sqlFile = null;
try {
sqlFile = fileSystem.getFile(sqlFileUrl);
sqlFileUrl = null;
} catch (Exception e) {
serviceLog.fatal(e.getMessage(), e);
throw e;
}
sqlQueries.init(sqlFile.getCanonicalFile(), "GreyList", conn, sqlParameters);
selectQuery = sqlQueries.getSqlString("selectQuery", true);
insertQuery = sqlQueries.getSqlString("insertQuery", true);
deleteQuery = sqlQueries.getSqlString("deleteQuery", true);
deleteAutoWhiteListQuery = sqlQueries.getSqlString("deleteAutoWhitelistQuery", true);
updateQuery = sqlQueries.getSqlString("updateQuery", true);
} finally {
theJDBCUtil.closeJDBCConnection(conn);
}
}
/**
* Create the table if not exists.
*
* @param conn
* The connection
* @param tableNameSqlStringName
* The tableSqlname
* @param createSqlStringName
* The createSqlname
* @return true or false
* @throws SQLException
*/
private boolean createTable(String tableNameSqlStringName,
String createSqlStringName) throws SQLException {
Connection conn = datasource.getConnection();
String tableName = sqlQueries.getSqlString(tableNameSqlStringName, true);
DatabaseMetaData dbMetaData = conn.getMetaData();
// Try UPPER, lower, and MixedCase, to see if the table is there.
if (theJDBCUtil.tableExists(dbMetaData, tableName)) {
return false;
}
PreparedStatement createStatement = null;
try {
createStatement = conn.prepareStatement(sqlQueries.getSqlString(createSqlStringName, true));
createStatement.execute();
StringBuilder logBuffer = null;
logBuffer = new StringBuilder(64).append("Created table '").append(tableName)
.append("' using sqlResources string '")
.append(createSqlStringName).append("'.");
serviceLog.info(logBuffer.toString());
} finally {
theJDBCUtil.closeJDBCStatement(createStatement);
}
return true;
}
/**
* @see org.apache.james.protocols.smtp.core.fastfail.AbstractGreylistHandler#doRcpt(org.apache.james.protocols.smtp.SMTPSession, org.apache.mailet.MailAddress, org.apache.mailet.MailAddress)
*/
public HookResult doRcpt(SMTPSession session, MailAddress sender, MailAddress rcpt) {
if ((wNetworks == null) || (!wNetworks.matchInetNetwork(session.getRemoteIPAddress()))) {
return super.doRcpt(session, sender, rcpt);
} else {
session.getLogger().info("IpAddress " + session.getRemoteIPAddress() + " is whitelisted. Skip greylisting.");
}
return new HookResult(HookReturnCode.DECLINED);
}
/**
* @see org.apache.james.lifecycle.LogEnabled#setLog(org.apache.commons.logging.Log)
*/
public void setLog(Log log) {
this.serviceLog = log;
}
}