Wed, 31 Dec 2014 07:22:50 +0100
Correct previous dual key logic pending first delivery installment.
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 | import ch.boye.httpclientandroidlib.annotation.NotThreadSafe; |
michael@0 | 30 | |
michael@0 | 31 | import ch.boye.httpclientandroidlib.FormattedHeader; |
michael@0 | 32 | import ch.boye.httpclientandroidlib.Header; |
michael@0 | 33 | import ch.boye.httpclientandroidlib.HttpRequest; |
michael@0 | 34 | import ch.boye.httpclientandroidlib.auth.AUTH; |
michael@0 | 35 | import ch.boye.httpclientandroidlib.auth.AuthenticationException; |
michael@0 | 36 | import ch.boye.httpclientandroidlib.auth.ContextAwareAuthScheme; |
michael@0 | 37 | import ch.boye.httpclientandroidlib.auth.Credentials; |
michael@0 | 38 | import ch.boye.httpclientandroidlib.auth.MalformedChallengeException; |
michael@0 | 39 | import ch.boye.httpclientandroidlib.protocol.HTTP; |
michael@0 | 40 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
michael@0 | 41 | import ch.boye.httpclientandroidlib.util.CharArrayBuffer; |
michael@0 | 42 | |
michael@0 | 43 | /** |
michael@0 | 44 | * Abstract authentication scheme class that serves as a basis |
michael@0 | 45 | * for all authentication schemes supported by HttpClient. This class |
michael@0 | 46 | * defines the generic way of parsing an authentication challenge. It |
michael@0 | 47 | * does not make any assumptions regarding the format of the challenge |
michael@0 | 48 | * nor does it impose any specific way of responding to that challenge. |
michael@0 | 49 | * |
michael@0 | 50 | * |
michael@0 | 51 | * @since 4.0 |
michael@0 | 52 | */ |
michael@0 | 53 | @NotThreadSafe // proxy |
michael@0 | 54 | public abstract class AuthSchemeBase implements ContextAwareAuthScheme { |
michael@0 | 55 | |
michael@0 | 56 | /** |
michael@0 | 57 | * Flag whether authenticating against a proxy. |
michael@0 | 58 | */ |
michael@0 | 59 | private boolean proxy; |
michael@0 | 60 | |
michael@0 | 61 | public AuthSchemeBase() { |
michael@0 | 62 | super(); |
michael@0 | 63 | } |
michael@0 | 64 | |
michael@0 | 65 | /** |
michael@0 | 66 | * Processes the given challenge token. Some authentication schemes |
michael@0 | 67 | * may involve multiple challenge-response exchanges. Such schemes must be able |
michael@0 | 68 | * to maintain the state information when dealing with sequential challenges |
michael@0 | 69 | * |
michael@0 | 70 | * @param header the challenge header |
michael@0 | 71 | * |
michael@0 | 72 | * @throws MalformedChallengeException is thrown if the authentication challenge |
michael@0 | 73 | * is malformed |
michael@0 | 74 | */ |
michael@0 | 75 | public void processChallenge(final Header header) throws MalformedChallengeException { |
michael@0 | 76 | if (header == null) { |
michael@0 | 77 | throw new IllegalArgumentException("Header may not be null"); |
michael@0 | 78 | } |
michael@0 | 79 | String authheader = header.getName(); |
michael@0 | 80 | if (authheader.equalsIgnoreCase(AUTH.WWW_AUTH)) { |
michael@0 | 81 | this.proxy = false; |
michael@0 | 82 | } else if (authheader.equalsIgnoreCase(AUTH.PROXY_AUTH)) { |
michael@0 | 83 | this.proxy = true; |
michael@0 | 84 | } else { |
michael@0 | 85 | throw new MalformedChallengeException("Unexpected header name: " + authheader); |
michael@0 | 86 | } |
michael@0 | 87 | |
michael@0 | 88 | CharArrayBuffer buffer; |
michael@0 | 89 | int pos; |
michael@0 | 90 | if (header instanceof FormattedHeader) { |
michael@0 | 91 | buffer = ((FormattedHeader) header).getBuffer(); |
michael@0 | 92 | pos = ((FormattedHeader) header).getValuePos(); |
michael@0 | 93 | } else { |
michael@0 | 94 | String s = header.getValue(); |
michael@0 | 95 | if (s == null) { |
michael@0 | 96 | throw new MalformedChallengeException("Header value is null"); |
michael@0 | 97 | } |
michael@0 | 98 | buffer = new CharArrayBuffer(s.length()); |
michael@0 | 99 | buffer.append(s); |
michael@0 | 100 | pos = 0; |
michael@0 | 101 | } |
michael@0 | 102 | while (pos < buffer.length() && HTTP.isWhitespace(buffer.charAt(pos))) { |
michael@0 | 103 | pos++; |
michael@0 | 104 | } |
michael@0 | 105 | int beginIndex = pos; |
michael@0 | 106 | while (pos < buffer.length() && !HTTP.isWhitespace(buffer.charAt(pos))) { |
michael@0 | 107 | pos++; |
michael@0 | 108 | } |
michael@0 | 109 | int endIndex = pos; |
michael@0 | 110 | String s = buffer.substring(beginIndex, endIndex); |
michael@0 | 111 | if (!s.equalsIgnoreCase(getSchemeName())) { |
michael@0 | 112 | throw new MalformedChallengeException("Invalid scheme identifier: " + s); |
michael@0 | 113 | } |
michael@0 | 114 | |
michael@0 | 115 | parseChallenge(buffer, pos, buffer.length()); |
michael@0 | 116 | } |
michael@0 | 117 | |
michael@0 | 118 | |
michael@0 | 119 | @SuppressWarnings("deprecation") |
michael@0 | 120 | public Header authenticate( |
michael@0 | 121 | final Credentials credentials, |
michael@0 | 122 | final HttpRequest request, |
michael@0 | 123 | final HttpContext context) throws AuthenticationException { |
michael@0 | 124 | return authenticate(credentials, request); |
michael@0 | 125 | } |
michael@0 | 126 | |
michael@0 | 127 | protected abstract void parseChallenge( |
michael@0 | 128 | CharArrayBuffer buffer, int beginIndex, int endIndex) throws MalformedChallengeException; |
michael@0 | 129 | |
michael@0 | 130 | /** |
michael@0 | 131 | * Returns <code>true</code> if authenticating against a proxy, <code>false</code> |
michael@0 | 132 | * otherwise. |
michael@0 | 133 | * |
michael@0 | 134 | * @return <code>true</code> if authenticating against a proxy, <code>false</code> |
michael@0 | 135 | * otherwise |
michael@0 | 136 | */ |
michael@0 | 137 | public boolean isProxy() { |
michael@0 | 138 | return this.proxy; |
michael@0 | 139 | } |
michael@0 | 140 | |
michael@0 | 141 | @Override |
michael@0 | 142 | public String toString() { |
michael@0 | 143 | return getSchemeName(); |
michael@0 | 144 | } |
michael@0 | 145 | |
michael@0 | 146 | } |