mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/protocol/RequestAuthCache.java@b8a032363ba2 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/protocol/RequestAuthCache.java
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
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 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with 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, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.client.protocol; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | |
| michael@0 | 32 | import ch.boye.httpclientandroidlib.androidextra.HttpClientAndroidLog; |
| michael@0 | 33 | /* LogFactory removed by HttpClient for Android script. */ |
| michael@0 | 34 | import ch.boye.httpclientandroidlib.HttpException; |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.HttpHost; |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.HttpRequest; |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.HttpRequestInterceptor; |
| michael@0 | 38 | import ch.boye.httpclientandroidlib.annotation.Immutable; |
| michael@0 | 39 | import ch.boye.httpclientandroidlib.auth.AuthScheme; |
| michael@0 | 40 | import ch.boye.httpclientandroidlib.auth.AuthScope; |
| michael@0 | 41 | import ch.boye.httpclientandroidlib.auth.AuthState; |
| michael@0 | 42 | import ch.boye.httpclientandroidlib.auth.Credentials; |
| michael@0 | 43 | import ch.boye.httpclientandroidlib.client.AuthCache; |
| michael@0 | 44 | import ch.boye.httpclientandroidlib.client.CredentialsProvider; |
| michael@0 | 45 | import ch.boye.httpclientandroidlib.protocol.ExecutionContext; |
| michael@0 | 46 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Request interceptor that can preemptively authenticate against known hosts, |
| michael@0 | 50 | * if there is a cached {@link AuthScheme} instance in the local |
| michael@0 | 51 | * {@link AuthCache} associated with the given target or proxy host. |
| michael@0 | 52 | * |
| michael@0 | 53 | * @since 4.1 |
| michael@0 | 54 | */ |
| michael@0 | 55 | @Immutable |
| michael@0 | 56 | public class RequestAuthCache implements HttpRequestInterceptor { |
| michael@0 | 57 | |
| michael@0 | 58 | public HttpClientAndroidLog log = new HttpClientAndroidLog(getClass()); |
| michael@0 | 59 | |
| michael@0 | 60 | public RequestAuthCache() { |
| michael@0 | 61 | super(); |
| michael@0 | 62 | } |
| michael@0 | 63 | |
| michael@0 | 64 | public void process(final HttpRequest request, final HttpContext context) |
| michael@0 | 65 | throws HttpException, IOException { |
| michael@0 | 66 | if (request == null) { |
| michael@0 | 67 | throw new IllegalArgumentException("HTTP request may not be null"); |
| michael@0 | 68 | } |
| michael@0 | 69 | if (context == null) { |
| michael@0 | 70 | throw new IllegalArgumentException("HTTP context may not be null"); |
| michael@0 | 71 | } |
| michael@0 | 72 | |
| michael@0 | 73 | AuthCache authCache = (AuthCache) context.getAttribute(ClientContext.AUTH_CACHE); |
| michael@0 | 74 | if (authCache == null) { |
| michael@0 | 75 | this.log.debug("Auth cache not set in the context"); |
| michael@0 | 76 | return; |
| michael@0 | 77 | } |
| michael@0 | 78 | |
| michael@0 | 79 | CredentialsProvider credsProvider = (CredentialsProvider) context.getAttribute( |
| michael@0 | 80 | ClientContext.CREDS_PROVIDER); |
| michael@0 | 81 | if (credsProvider == null) { |
| michael@0 | 82 | this.log.debug("Credentials provider not set in the context"); |
| michael@0 | 83 | return; |
| michael@0 | 84 | } |
| michael@0 | 85 | |
| michael@0 | 86 | HttpHost target = (HttpHost) context.getAttribute(ExecutionContext.HTTP_TARGET_HOST); |
| michael@0 | 87 | AuthState targetState = (AuthState) context.getAttribute(ClientContext.TARGET_AUTH_STATE); |
| michael@0 | 88 | if (target != null && targetState != null && targetState.getAuthScheme() == null) { |
| michael@0 | 89 | AuthScheme authScheme = authCache.get(target); |
| michael@0 | 90 | if (authScheme != null) { |
| michael@0 | 91 | doPreemptiveAuth(target, authScheme, targetState, credsProvider); |
| michael@0 | 92 | } |
| michael@0 | 93 | } |
| michael@0 | 94 | |
| michael@0 | 95 | HttpHost proxy = (HttpHost) context.getAttribute(ExecutionContext.HTTP_PROXY_HOST); |
| michael@0 | 96 | AuthState proxyState = (AuthState) context.getAttribute(ClientContext.PROXY_AUTH_STATE); |
| michael@0 | 97 | if (proxy != null && proxyState != null && proxyState.getAuthScheme() == null) { |
| michael@0 | 98 | AuthScheme authScheme = authCache.get(proxy); |
| michael@0 | 99 | if (authScheme != null) { |
| michael@0 | 100 | doPreemptiveAuth(proxy, authScheme, proxyState, credsProvider); |
| michael@0 | 101 | } |
| michael@0 | 102 | } |
| michael@0 | 103 | } |
| michael@0 | 104 | |
| michael@0 | 105 | private void doPreemptiveAuth( |
| michael@0 | 106 | final HttpHost host, |
| michael@0 | 107 | final AuthScheme authScheme, |
| michael@0 | 108 | final AuthState authState, |
| michael@0 | 109 | final CredentialsProvider credsProvider) { |
| michael@0 | 110 | String schemeName = authScheme.getSchemeName(); |
| michael@0 | 111 | if (this.log.isDebugEnabled()) { |
| michael@0 | 112 | this.log.debug("Re-using cached '" + schemeName + "' auth scheme for " + host); |
| michael@0 | 113 | } |
| michael@0 | 114 | |
| michael@0 | 115 | AuthScope authScope = new AuthScope(host.getHostName(), host.getPort(), |
| michael@0 | 116 | AuthScope.ANY_REALM, schemeName); |
| michael@0 | 117 | Credentials creds = credsProvider.getCredentials(authScope); |
| michael@0 | 118 | |
| michael@0 | 119 | if (creds != null) { |
| michael@0 | 120 | authState.setAuthScheme(authScheme); |
| michael@0 | 121 | authState.setCredentials(creds); |
| michael@0 | 122 | } else { |
| michael@0 | 123 | this.log.debug("No credentials for preemptive authentication"); |
| michael@0 | 124 | } |
| michael@0 | 125 | } |
| michael@0 | 126 | |
| michael@0 | 127 | } |
