001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.server.ldap.handlers.bind.ntlm;
021    
022    import org.apache.mina.core.session.IoSession;
023    
024    
025    /**
026     * An NTLM authentication service provider.  Multiple providers may be
027     * utilized to conduct the NTLM negotiation over various protocols or by
028     * calling native SSPI interfaces.
029     *
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     * @version $Rev$
032     */
033    public interface NtlmProvider
034    {
035        /**
036         * Handles a Type 1 NTLM response from the client to generate an NTLM
037         * Type 2 challenge message.
038         *
039         * @param session the MINA IoSession to store any state to be thread safe
040         * @param type1reponse the Type 1 NTLM response from client
041         * @return the NTLM Type 2 message with the challenge
042         */
043        byte[] generateChallenge( IoSession session, byte[] type1reponse ) throws Exception;
044    
045    
046        /**
047         * Handles a Type 3 NTLM response from the client.
048         *
049         * @param session the MINA IoSession to store any state to be thread safe
050         * @param type3response the Type 3 NTLM response from the client
051         * @return the result of the authentication from the server
052         */
053        boolean authenticate( IoSession session, byte[] type3response ) throws Exception;
054    }