1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/auth/NTLMScheme.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 655048 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-05-10 04:22:12 -0700 (Sat, 10 May 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.auth; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.Header; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpRequest; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AUTH; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthenticationException; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.Credentials; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.InvalidCredentialsException; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.MalformedChallengeException; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.NTCredentials; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.impl.auth.AuthSchemeBase; 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.message.BufferedHeader; 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.util.CharArrayBuffer; 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class NTLMScheme extends AuthSchemeBase { 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project enum State { 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project UNINITIATED, 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CHALLENGE_RECEIVED, 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project MSG_TYPE1_GENERATED, 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project MSG_TYPE2_RECEVIED, 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project MSG_TYPE3_GENERATED, 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project FAILED, 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final NTLMEngine engine; 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private State state; 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private String challenge; 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public NTLMScheme(final NTLMEngine engine) { 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (engine == null) { 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("NTLM engine may not be null"); 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.engine = engine; 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.UNINITIATED; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.challenge = null; 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String getSchemeName() { 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return "ntlm"; 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String getParameter(String name) { 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // String parameters not supported 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return null; 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String getRealm() { 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // NTLM does not support the concept of an authentication realm 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return null; 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isConnectionBased() { 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return true; 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected void parseChallenge( 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final CharArrayBuffer buffer, int pos, int len) throws MalformedChallengeException { 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String challenge = buffer.substringTrimmed(pos, len); 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (challenge.length() == 0) { 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.state == State.UNINITIATED) { 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.CHALLENGE_RECEIVED; 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.FAILED; 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.challenge = null; 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.MSG_TYPE2_RECEVIED; 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.challenge = challenge; 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public Header authenticate( 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final Credentials credentials, 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final HttpRequest request) throws AuthenticationException { 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project NTCredentials ntcredentials = null; 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials = (NTCredentials) credentials; 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (ClassCastException e) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new InvalidCredentialsException( 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "Credentials cannot be used for NTLM authentication: " 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project + credentials.getClass().getName()); 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String response = null; 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.state == State.CHALLENGE_RECEIVED || this.state == State.FAILED) { 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project response = this.engine.generateType1Msg( 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getDomain(), 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getWorkstation()); 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.MSG_TYPE1_GENERATED; 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else if (this.state == State.MSG_TYPE2_RECEVIED) { 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project response = this.engine.generateType3Msg( 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getUserName(), 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getPassword(), 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getDomain(), 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ntcredentials.getWorkstation(), 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.challenge); 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.state = State.MSG_TYPE3_GENERATED; 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new AuthenticationException("Unexpected state: " + this.state); 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer buffer = new CharArrayBuffer(32); 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (isProxy()) { 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(AUTH.PROXY_AUTH_RESP); 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(AUTH.WWW_AUTH_RESP); 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(": NTLM "); 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(response); 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new BufferedHeader(buffer); 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isComplete() { 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.state == State.MSG_TYPE3_GENERATED || this.state == State.FAILED; 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 150