michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.auth;
michael@0: 
michael@0: /**
michael@0:  * Abstract NTLM authentication engine. The engine can be used to
michael@0:  * generate Type1 messages and Type3 messages in response to a
michael@0:  * Type2 challenge.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface NTLMEngine {
michael@0: 
michael@0:     /**
michael@0:      * Generates a Type1 message given the domain and workstation.
michael@0:      *
michael@0:      * @param domain Optional Windows domain name. Can be <code>null</code>.
michael@0:      * @param workstation Optional Windows workstation name. Can be
michael@0:      *  <code>null</code>.
michael@0:      * @return Type1 message
michael@0:      * @throws NTLMEngineException
michael@0:      */
michael@0:     String generateType1Msg(
michael@0:             String domain,
michael@0:             String workstation) throws NTLMEngineException;
michael@0: 
michael@0:     /**
michael@0:      * Generates a Type3 message given the user credentials and the
michael@0:      * authentication challenge.
michael@0:      *
michael@0:      * @param username Windows user name
michael@0:      * @param password Password
michael@0:      * @param domain Windows domain name
michael@0:      * @param workstation Windows workstation name
michael@0:      * @param challenge Type2 challenge.
michael@0:      * @return Type3 response.
michael@0:      * @throws NTLMEngineException
michael@0:      */
michael@0:     String generateType3Msg(
michael@0:             String username,
michael@0:             String password,
michael@0:             String domain,
michael@0:             String workstation,
michael@0:             String challenge) throws NTLMEngineException;
michael@0: 
michael@0: }