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/client/AbstractAuthenticationHandler.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 673450 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-07-02 10:35:05 -0700 (Wed, 02 Jul 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with 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, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.client; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Arrays; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.HashMap; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.List; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Locale; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Map; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.logging.Log; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.logging.LogFactory; 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.FormattedHeader; 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.Header; 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpResponse; 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthScheme; 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthSchemeRegistry; 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthenticationException; 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.MalformedChallengeException; 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.client.AuthenticationHandler; 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.client.protocol.ClientContext; 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HTTP; 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HttpContext; 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.util.CharArrayBuffer; 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic abstract class AbstractAuthenticationHandler implements AuthenticationHandler { 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final Log log = LogFactory.getLog(getClass()); 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private static final List<String> DEFAULT_SCHEME_PRIORITY = Arrays.asList(new String[] { 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "ntlm", 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "digest", 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "basic" 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project }); 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public AbstractAuthenticationHandler() { 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected Map<String, Header> parseChallenges( 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final Header[] headers) throws MalformedChallengeException { 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Map<String, Header> map = new HashMap<String, Header>(headers.length); 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (Header header : headers) { 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer buffer; 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int pos; 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (header instanceof FormattedHeader) { 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer = ((FormattedHeader) header).getBuffer(); 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos = ((FormattedHeader) header).getValuePos(); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String s = header.getValue(); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (s == null) { 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedChallengeException("Header value is null"); 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer = new CharArrayBuffer(s.length()); 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(s); 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos = 0; 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (pos < buffer.length() && HTTP.isWhitespace(buffer.charAt(pos))) { 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos++; 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int beginIndex = pos; 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (pos < buffer.length() && !HTTP.isWhitespace(buffer.charAt(pos))) { 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project pos++; 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int endIndex = pos; 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String s = buffer.substring(beginIndex, endIndex); 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project map.put(s.toLowerCase(Locale.ENGLISH), header); 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return map; 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected List<String> getAuthPreferences() { 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return DEFAULT_SCHEME_PRIORITY; 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public AuthScheme selectScheme( 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final Map<String, Header> challenges, 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final HttpResponse response, 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final HttpContext context) throws AuthenticationException { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project AuthSchemeRegistry registry = (AuthSchemeRegistry) context.getAttribute( 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ClientContext.AUTHSCHEME_REGISTRY); 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (registry == null) { 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalStateException("AuthScheme registry not set in HTTP context"); 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project List<?> authPrefs = (List<?>) context.getAttribute( 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ClientContext.AUTH_SCHEME_PREF); 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (authPrefs == null) { 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project authPrefs = getAuthPreferences(); 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.log.isDebugEnabled()) { 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.log.debug("Authentication schemes in the order of preference: " 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project + authPrefs); 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project AuthScheme authScheme = null; 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (int i = 0; i < authPrefs.size(); i++) { 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String id = (String) authPrefs.get(i); 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header challenge = challenges.get(id.toLowerCase(Locale.ENGLISH)); 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (challenge != null) { 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.log.isDebugEnabled()) { 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.log.debug(id + " authentication scheme selected"); 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project authScheme = registry.getAuthScheme(id, response.getParams()); 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project break; 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (IllegalStateException e) { 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.log.isWarnEnabled()) { 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.log.warn("Authentication scheme " + id + " not supported"); 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Try again 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.log.isDebugEnabled()) { 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.log.debug("Challenge for " + id + " authentication scheme not available"); 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Try again 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (authScheme == null) { 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // If none selected, something is wrong 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new AuthenticationException( 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "Unable to respond to any of these challenges: " 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project + challenges); 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return authScheme; 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 166