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/AuthSchemeBase.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 653867 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-05-06 11:17:29 -0700 (Tue, 06 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.FormattedHeader; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.Header; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AUTH; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthScheme; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.MalformedChallengeException; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HTTP; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.util.CharArrayBuffer; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Abstract authentication scheme class that serves as a basis 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * for all authentication schemes supported by HttpClient. This class 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * defines the generic way of parsing an authentication challenge. It 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * does not make any assumptions regarding the format of the challenge 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * nor does it impose any specific way of responding to that challenge. 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project*/ 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic abstract class AuthSchemeBase implements AuthScheme { 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Flag whether authenticating against a proxy. 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private boolean proxy; 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public AuthSchemeBase() { 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Processes the given challenge token. Some authentication schemes 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * may involve multiple challenge-response exchanges. Such schemes must be able 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to maintain the state information when dealing with sequential challenges 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param header the challenge header 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws MalformedChallengeException is thrown if the authentication challenge 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is malformed 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void processChallenge(final Header header) throws MalformedChallengeException { 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (header == null) { 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Header may not be null"); 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String authheader = header.getName(); 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (authheader.equalsIgnoreCase(AUTH.WWW_AUTH)) { 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.proxy = false; 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else if (authheader.equalsIgnoreCase(AUTH.PROXY_AUTH)) { 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.proxy = true; 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedChallengeException("Unexpected header name: " + authheader); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer buffer; 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int pos; 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (header instanceof FormattedHeader) { 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer = ((FormattedHeader) header).getBuffer(); 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos = ((FormattedHeader) header).getValuePos(); 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String s = header.getValue(); 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (s == null) { 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedChallengeException("Header value is null"); 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer = new CharArrayBuffer(s.length()); 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(s); 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos = 0; 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (pos < buffer.length() && HTTP.isWhitespace(buffer.charAt(pos))) { 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos++; 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int beginIndex = pos; 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (pos < buffer.length() && !HTTP.isWhitespace(buffer.charAt(pos))) { 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos++; 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int endIndex = pos; 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String s = buffer.substring(beginIndex, endIndex); 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!s.equalsIgnoreCase(getSchemeName())) { 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedChallengeException("Invalid scheme identifier: " + s); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project parseChallenge(buffer, pos, buffer.length()); 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected abstract void parseChallenge( 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer buffer, int pos, int len) throws MalformedChallengeException; 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns <code>true</code> if authenticating against a proxy, <code>false</code> 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * otherwise. 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <code>true</code> if authenticating against a proxy, <code>false</code> 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * otherwise 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isProxy() { 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.proxy; 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 129