SimpleAuth.java

/**
 * Copyright 2009, Frederic Bregier, and individual contributors by the @author tags. See the
 * COPYRIGHT.txt in the distribution for a full listing of individual contributors.
 * 
 * This is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation; either version 3.0 of the
 * License, or (at your option) any later version.
 * 
 * This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with this
 * software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.waarp.gateway.ftp.file;

import org.waarp.common.logging.WaarpLogger;
import org.waarp.common.logging.WaarpLoggerFactory;
import org.waarp.gateway.kernel.exec.AbstractExecutor.CommandExecutor;

/**
 * Simple Authentication based on a previously load XML file.
 * 
 * @author Frederic Bregier
 * 
 */
public class SimpleAuth {
    /**
     * Internal Logger
     */
    private static final WaarpLogger logger = WaarpLoggerFactory
            .getLogger(SimpleAuth.class);

    /**
     * User name
     */
    private String user = null;

    /**
     * Password
     */
    private String password = null;

    /**
     * Multiple accounts
     */
    private String[] accounts = null;

    /**
     * Is the current user an administrator (which can shutdown or change bandwidth limitation)
     */
    private boolean isAdmin = false;
    /**
     * Specific Store command for this user
     */
    private String storCmd = null;
    /**
     * Specific Store command delay for this user
     */
    private long storDelay = 0;
    /**
     * Specific Retrieve command for this user
     */
    private String retrCmd = null;
    /**
     * Specific Retrieve command delay for this user
     */
    private long retrDelay = 0;

    private CommandExecutor commandExecutor = null;

    /**
     * @param user
     * @param password
     * @param accounts
     * @param storCmd
     * @param storDelay
     * @param retrCmd
     * @param retrDelay
     */
    public SimpleAuth(String user, String password, String[] accounts,
            String storCmd, long storDelay, String retrCmd, long retrDelay) {
        this.setUser(user);
        this.setPassword(password);
        this.setAccounts(accounts);
        this.setStorCmd(storCmd);
        this.setStorDelay(storDelay);
        this.setRetrCmd(retrCmd);
        this.setRetrDelay(retrDelay);
        this.setCommandExecutor(new CommandExecutor(retrCmd, retrDelay, storCmd, storDelay));
        logger.info("Executor for " + user + " configured as [RETR: " +
                getCommandExecutor().getRetrType() + ":" + getCommandExecutor().pretrCMD + ":" + getCommandExecutor().pretrDelay + ":" +
                getCommandExecutor().pretrRefused +
                "] [STOR: " + getCommandExecutor().getStorType() + ":" + getCommandExecutor().pstorCMD + ":" +
                getCommandExecutor().pstorDelay + ":" + getCommandExecutor().pstorRefused + "]");
    }

    /**
     * Is the given password a valid one
     * 
     * @param newpassword
     * @return True if the password is valid (or any password is valid)
     */
    public boolean isPasswordValid(String newpassword) {
        if (getPassword() == null) {
            return true;
        }
        if (newpassword == null) {
            return false;
        }
        return getPassword().equals(newpassword);
    }

    /**
     * Is the given account a valid one
     * 
     * @param account
     * @return True if the account is valid (or any account is valid)
     */
    public boolean isAccountValid(String account) {
        if (getAccounts() == null) {
            logger.debug("No account needed");
            return true;
        }
        if (account == null) {
            logger.debug("No account given");
            return false;
        }
        for (String acct : getAccounts()) {
            if (acct.equals(account)) {
                logger.debug("Account found");
                return true;
            }
        }
        logger.debug("No account found");
        return false;
    }

    /**
     * 
     * @param isAdmin
     *            True if the user should be an administrator
     */
    public void setAdmin(boolean isAdmin) {
        this.isAdmin = isAdmin;
    }

    /**
     * @return the user
     */
    public String getUser() {
        return user;
    }

    /**
     * @param user the user to set
     */
    private void setUser(String user) {
        this.user = user;
    }

    /**
     * @return the password
     */
    public String getPassword() {
        return password;
    }

    /**
     * @param password the password to set
     */
    private void setPassword(String password) {
        this.password = password;
    }

    /**
     * @return the accounts
     */
    public String[] getAccounts() {
        return accounts;
    }

    /**
     * @param accounts the accounts to set
     */
    private void setAccounts(String[] accounts) {
        this.accounts = accounts;
    }

    /**
     * @return the isAdmin
     */
    public boolean isAdmin() {
        return isAdmin;
    }

    /**
     * @return the storCmd
     */
    public String getStorCmd() {
        return storCmd;
    }

    /**
     * @param storCmd the storCmd to set
     */
    private void setStorCmd(String storCmd) {
        this.storCmd = storCmd;
    }

    /**
     * @return the storDelay
     */
    public long getStorDelay() {
        return storDelay;
    }

    /**
     * @param storDelay the storDelay to set
     */
    private void setStorDelay(long storDelay) {
        this.storDelay = storDelay;
    }

    /**
     * @return the retrCmd
     */
    public String getRetrCmd() {
        return retrCmd;
    }

    /**
     * @param retrCmd the retrCmd to set
     */
    private void setRetrCmd(String retrCmd) {
        this.retrCmd = retrCmd;
    }

    /**
     * @return the retrDelay
     */
    public long getRetrDelay() {
        return retrDelay;
    }

    /**
     * @param retrDelay the retrDelay to set
     */
    private void setRetrDelay(long retrDelay) {
        this.retrDelay = retrDelay;
    }

    /**
     * @return the commandExecutor
     */
    public CommandExecutor getCommandExecutor() {
        return commandExecutor;
    }

    /**
     * @param commandExecutor the commandExecutor to set
     */
    private void setCommandExecutor(CommandExecutor commandExecutor) {
        this.commandExecutor = commandExecutor;
    }
}