/****************************************************************
* 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.protocols.smtp.core.fastfail;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.apache.james.protocols.smtp.SMTPSession;
import org.apache.james.protocols.smtp.hook.HookResult;
import org.apache.james.protocols.smtp.hook.HookReturnCode;
import org.apache.james.protocols.smtp.hook.RcptHook;
import org.apache.mailet.MailAddress;
/**
* This handler can be used for providing a spam trap. IPAddresses which send emails to the configured
* recipients will get blacklisted for the configured time.
*/
public class SpamTrapHandler implements RcptHook {
/** Map which hold blockedIps and blockTime in memory */
private Map<String,Long> blockedIps = new HashMap<String,Long>();
private Collection<String> spamTrapRecips = new ArrayList<String>();
/** Default blocktime 12 hours */
protected long blockTime = 4320000;
public void setSpamTrapRecipients(Collection<String> spamTrapRecips) {
this.spamTrapRecips = spamTrapRecips;
}
public void setBlockTime(long blockTime) {
this.blockTime = blockTime;
}
/**
* @see org.apache.james.protocols.smtp.hook.RcptHook#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 (isBlocked(session.getRemoteIPAddress(), session)) {
return new HookResult(HookReturnCode.DENY);
} else {
if (spamTrapRecips.contains(rcpt.toString().toLowerCase())){
addIp(session.getRemoteIPAddress(), session);
return new HookResult(HookReturnCode.DENY);
}
}
return new HookResult(HookReturnCode.DECLINED);
}
/**
* Check if ipAddress is in the blockList.
*
* @param ip ipAddress to check
* @param session not null
* @return true or false
*/
private boolean isBlocked(String ip, SMTPSession session) {
Long rawTime = blockedIps.get(ip);
if (rawTime != null) {
long blockTime = rawTime.longValue();
if (blockTime > System.currentTimeMillis()) {
session.getLogger().debug("BlockList contain Ip " + ip);
return true;
} else {
session.getLogger().debug("Remove ip " + ip + " from blockList");
synchronized(blockedIps) {
blockedIps.remove(ip);
}
}
}
return false;
}
/**
* Add ipaddress to blockList
*
* @param ip IpAddress to add
* @param session not null
*/
private void addIp(String ip, SMTPSession session) {
long bTime = System.currentTimeMillis() + blockTime;
session.getLogger().debug("Add ip " + ip + " for " + bTime + " to blockList");
synchronized(blockedIps) {
blockedIps.put(ip, Long.valueOf(bTime));
}
}
}