001    /*
002     * Copyright (C) 2012 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.auth;
021    
022    import org.crsh.plugin.PropertyDescriptor;
023    
024    public interface AuthenticationPlugin {
025    
026      /** The authentication plugin to use. */
027      PropertyDescriptor<String> AUTH = PropertyDescriptor.create("auth", (String)null, "The authentication plugin");
028    
029      /**
030       * The plugin that never authenticates, returns the name value <code>null</code>.
031       */
032      AuthenticationPlugin NULL = new AuthenticationPlugin() {
033        public String getName() {
034          return "null";
035        }
036        public boolean authenticate(String username, String password) throws Exception {
037          return false;
038        }
039      };
040    
041      /**
042       * Returns the authentication plugin name.
043       *
044       * @return the plugin name
045       */
046      String getName();
047    
048      /**
049       * Returns true if the user is authentified by its username and password.
050       *
051       * @param username the username
052       * @param password the password
053       * @return true if authentication succeeded
054       * @throws Exception any exception that would prevent authentication to happen
055       */
056      boolean authenticate(String username, String password) throws Exception;
057    }