|
1 /* |
|
2 * ==================================================================== |
|
3 * |
|
4 * Licensed to the Apache Software Foundation (ASF) under one or more |
|
5 * contributor license agreements. See the NOTICE file distributed with |
|
6 * this work for additional information regarding copyright ownership. |
|
7 * The ASF licenses this file to You under the Apache License, Version 2.0 |
|
8 * (the "License"); you may not use this file except in compliance with |
|
9 * 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, software |
|
14 * distributed under the License is distributed on an "AS IS" BASIS, |
|
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
16 * See the License for the specific language governing permissions and |
|
17 * limitations under the License. |
|
18 * ==================================================================== |
|
19 * |
|
20 * This software consists of voluntary contributions made by many |
|
21 * individuals on behalf of the Apache Software Foundation. For more |
|
22 * information on the Apache Software Foundation, please see |
|
23 * <http://www.apache.org/>. |
|
24 * |
|
25 */ |
|
26 |
|
27 package ch.boye.httpclientandroidlib.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</code>. |
|
42 * @param workstation Optional Windows workstation name. Can be |
|
43 * <code>null</code>. |
|
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 } |