View Javadoc

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