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