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