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    import java.util.Collections;
025    import java.util.List;
026    
027    /**
028     * The authentication plugin.
029     *
030     * @param <C> the credential parameter type
031     */
032    public interface AuthenticationPlugin<C> {
033    
034      /** The authentication plugin to use. */
035      PropertyDescriptor<List> AUTH = PropertyDescriptor.create("auth", Collections.emptyList(), "The authentication plugin");
036    
037      /**
038       * The plugin that never authenticates, returns the name value <code>null</code>.
039       */
040      AuthenticationPlugin<Object> NULL = new AuthenticationPlugin<Object>() {
041        public Class<Object> getCredentialType() {
042          return Object.class;
043        }
044        public String getName() {
045          return "null";
046        }
047        public boolean authenticate(String username, Object password) throws Exception {
048          return false;
049        }
050      };
051    
052      /**
053       * Returns the authentication plugin name.
054       *
055       * @return the plugin name
056       */
057      String getName();
058    
059      /**
060       * Returns the credential type.
061       *
062       * @return the credential type
063       */
064      Class<C> getCredentialType();
065    
066      /**
067       * Returns true if the user is authentified by its username and credential.
068       *
069       * @param username the username
070       * @param credential the credential
071       * @return true if authentication succeeded
072       * @throws Exception any exception that would prevent authentication to happen
073       */
074      boolean authenticate(String username, C credential) throws Exception;
075    }