NTLMEngine.java revision 069490a5ca2fd1988d29daf45d892f47ad665115 
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/auth/NTLMEngine.java $
3 * $Revision: 659788 $
4 * $Date: 2008-05-24 03:42:23 -0700 (Sat, 24 May 2008) $
5 *
6 * ====================================================================
7 *
8 *  Licensed to the Apache Software Foundation (ASF) under one or more
9 *  contributor license agreements.  See the NOTICE file distributed with
10 *  this work for additional information regarding copyright ownership.
11 *  The ASF licenses this file to You under the Apache License, Version 2.0
12 *  (the "License"); you may not use this file except in compliance with
13 *  the License.  You may obtain a copy of the License at
14 *
15 *      http://www.apache.org/licenses/LICENSE-2.0
16 *
17 *  Unless required by applicable law or agreed to in writing, software
18 *  distributed under the License is distributed on an "AS IS" BASIS,
19 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 *  See the License for the specific language governing permissions and
21 *  limitations under the License.
22 * ====================================================================
23 *
24 * This software consists of voluntary contributions made by many
25 * individuals on behalf of the Apache Software Foundation.  For more
26 * information on the Apache Software Foundation, please see
27 * <http://www.apache.org/>.
28 *
29 */
30
31package org.apache.http.impl.auth;
32
33/**
34 * Abstract NTLM authentication engine. The engine can be used to
35 * generate Type1 messages and Type3 messages in response to a
36 * Type2 challenge.
37 * <p/>
38 * For details see <a href="http://davenport.sourceforge.net/ntlm.html">this resource</a>
39 *
40 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
41*/
42public interface NTLMEngine {
43
44    /**
45     * Generates a Type1 message given the domain and workstation.
46     *
47     * @param domain Optional Windows domain name. Can be <code>null</code>.
48     * @param workstation Optional Windows workstation name. Can be
49     *  <code>null</code>.
50     * @return Type1 message
51     * @throws NTLMEngineException
52     */
53    String generateType1Msg(
54            String domain,
55            String workstation) throws NTLMEngineException;
56
57    /**
58     * Generates a Type3 message given the user credentials and the
59     * authentication challenge.
60     *
61     * @param username Windows user name
62     * @param password Password
63     * @param domain Windows domain name
64     * @param workstation Windows workstation name
65     * @param challenge Type2 challenge.
66     * @return Type3 response.
67     * @throws NTLMEngineException
68     */
69    String generateType3Msg(
70            String username,
71            String password,
72            String domain,
73            String workstation,
74            String challenge) throws NTLMEngineException;
75
76}
77