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.hc.client5.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 * @deprecated Do not use. the NTLM authentication scheme is no longer supported
37 */
38 @Deprecated
39 public interface NTLMEngine {
40
41 /**
42 * Generates a Type1 message given the domain and workstation.
43 *
44 * @param domain Optional Windows domain name. Can be {@code null}.
45 * @param workstation Optional Windows workstation name. Can be
46 * {@code null}.
47 * @return Type1 message
48 * @throws NTLMEngineException
49 */
50 String generateType1Msg(
51 String domain,
52 String workstation) throws NTLMEngineException;
53
54 /**
55 * Generates a Type3 message given the user credentials and the
56 * authentication challenge.
57 *
58 * @param username Windows user name
59 * @param password Password
60 * @param domain Windows domain name
61 * @param workstation Windows workstation name
62 * @param challenge Type2 challenge.
63 * @return Type3 response.
64 * @throws NTLMEngineException
65 */
66 String generateType3Msg(
67 String username,
68 char[] password,
69 String domain,
70 String workstation,
71 String challenge) throws NTLMEngineException;
72
73 }