Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.ning.http.client.Realm Maven / Gradle / Ivy
/*
* Copyright 2010 Ning, Inc.
*
* Ning licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
*/
package com.ning.http.client;
import static com.ning.http.util.MiscUtils.isNonEmpty;
import static java.nio.charset.StandardCharsets.*;
import com.ning.http.client.uri.Uri;
import com.ning.http.util.AuthenticatorUtils;
import com.ning.http.util.StringUtils;
import java.nio.charset.Charset;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.concurrent.ThreadLocalRandom;
/**
* This class is required when authentication is needed. The class support DIGEST and BASIC.
*/
public class Realm {
private static final String EMPTY_ENTITY_MD5 = "d41d8cd98f00b204e9800998ecf8427e";
private static final String DEFAULT_NC = "00000001";
private final String principal;
private final String password;
private final AuthScheme scheme;
private final String realmName;
private final String nonce;
private final String algorithm;
private final String response;
private final String opaque;
private final String qop;
private final String nc;
private final String cnonce;
private final Uri uri;
private final String methodName;
private final boolean usePreemptiveAuth;
private final Charset charset;
private final String ntlmHost;
private final boolean useAbsoluteURI;
private final boolean omitQuery;
private final boolean targetProxy;
private final String ntlmDomain;
public enum AuthScheme {
DIGEST,
BASIC,
NTLM,
SPNEGO,
KERBEROS,
NONE
}
private Realm(AuthScheme scheme,
String principal,
String password,
String realmName,
String nonce,
String algorithm,
String response,
String qop,
String nc,
String cnonce,
Uri uri,
String method,
boolean usePreemptiveAuth,
String ntlmDomain,
Charset charset,
String ntlmHost,
String opaque,
boolean useAbsoluteURI,
boolean omitQuery,
boolean targetProxy) {
this.principal = principal;
this.password = password;
this.scheme = scheme;
this.realmName = realmName;
this.nonce = nonce;
this.algorithm = algorithm;
this.response = response;
this.opaque = opaque;
this.qop = qop;
this.nc = nc;
this.cnonce = cnonce;
this.uri = uri;
this.methodName = method;
this.usePreemptiveAuth = usePreemptiveAuth;
this.ntlmDomain = ntlmDomain;
this.charset = charset;
this.ntlmHost = ntlmHost;
this.useAbsoluteURI = useAbsoluteURI;
this.omitQuery = omitQuery;
this.targetProxy = targetProxy;
}
public String getPrincipal() {
return principal;
}
public String getPassword() {
return password;
}
public AuthScheme getScheme() {
return scheme;
}
public String getRealmName() {
return realmName;
}
public String getNonce() {
return nonce;
}
public String getAlgorithm() {
return algorithm;
}
public String getResponse() {
return response;
}
public String getOpaque() {
return opaque;
}
public String getQop() {
return qop;
}
public String getNc() {
return nc;
}
public String getCnonce() {
return cnonce;
}
public Uri getUri() {
return uri;
}
public Charset getCharset() {
return charset;
}
public String getMethodName() {
return methodName;
}
/**
* Return true is preemptive authentication is enabled
*
* @return true is preemptive authentication is enabled
*/
public boolean getUsePreemptiveAuth() {
return usePreemptiveAuth;
}
/**
* Return the NTLM domain to use. This value should map the JDK
*
* @return the NTLM domain
*/
public String getNtlmDomain() {
return ntlmDomain;
}
/**
* Return the NTLM host.
*
* @return the NTLM host
*/
public String getNtlmHost() {
return ntlmHost;
}
public boolean isUseAbsoluteURI() {
return useAbsoluteURI;
}
public boolean isOmitQuery() {
return omitQuery;
}
public boolean isTargetProxy() {
return targetProxy;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Realm realm = (Realm) o;
if (algorithm != null ? !algorithm.equals(realm.algorithm) : realm.algorithm != null) return false;
if (cnonce != null ? !cnonce.equals(realm.cnonce) : realm.cnonce != null) return false;
if (nc != null ? !nc.equals(realm.nc) : realm.nc != null) return false;
if (nonce != null ? !nonce.equals(realm.nonce) : realm.nonce != null) return false;
if (password != null ? !password.equals(realm.password) : realm.password != null) return false;
if (principal != null ? !principal.equals(realm.principal) : realm.principal != null) return false;
if (qop != null ? !qop.equals(realm.qop) : realm.qop != null) return false;
if (realmName != null ? !realmName.equals(realm.realmName) : realm.realmName != null) return false;
if (response != null ? !response.equals(realm.response) : realm.response != null) return false;
if (scheme != realm.scheme) return false;
if (uri != null ? !uri.equals(realm.uri) : realm.uri != null) return false;
if (useAbsoluteURI != !realm.useAbsoluteURI) return false;
if (omitQuery != !realm.omitQuery) return false;
return true;
}
@Override
public String toString() {
return "Realm{" +
"principal='" + principal + '\'' +
", password='" + password + '\'' +
", scheme=" + scheme +
", realmName='" + realmName + '\'' +
", nonce='" + nonce + '\'' +
", algorithm='" + algorithm + '\'' +
", response='" + response + '\'' +
", qop='" + qop + '\'' +
", nc='" + nc + '\'' +
", cnonce='" + cnonce + '\'' +
", uri='" + uri + '\'' +
", methodName='" + methodName + '\'' +
", useAbsoluteURI='" + useAbsoluteURI + '\'' +
", omitQuery='" + omitQuery + '\'' +
'}';
}
@Override
public int hashCode() {
int result = principal != null ? principal.hashCode() : 0;
result = 31 * result + (password != null ? password.hashCode() : 0);
result = 31 * result + (scheme != null ? scheme.hashCode() : 0);
result = 31 * result + (realmName != null ? realmName.hashCode() : 0);
result = 31 * result + (nonce != null ? nonce.hashCode() : 0);
result = 31 * result + (algorithm != null ? algorithm.hashCode() : 0);
result = 31 * result + (response != null ? response.hashCode() : 0);
result = 31 * result + (qop != null ? qop.hashCode() : 0);
result = 31 * result + (nc != null ? nc.hashCode() : 0);
result = 31 * result + (cnonce != null ? cnonce.hashCode() : 0);
result = 31 * result + (uri != null ? uri.hashCode() : 0);
return result;
}
/**
* A builder for {@link Realm}
*/
public static class RealmBuilder {
//
// Portions of code (newCnonce, newResponse) are highly inspired be Jetty 6 BasicAuthentication.java class.
// This code is already Apache licenced.
//
private String principal;
private String password;
private AuthScheme scheme = AuthScheme.NONE;
private String realmName;
private String nonce;
private String algorithm;
private String response;
private String opaque;
private String qop;
private String nc = DEFAULT_NC;
private String cnonce;
private Uri uri;
private String methodName = "GET";
private boolean usePreemptive = false;
private String ntlmDomain = System.getProperty("http.auth.ntlm.domain", "");
private Charset charset = UTF_8;
private String ntlmHost = "localhost";
private boolean useAbsoluteURI = false;
private boolean omitQuery = false;
private boolean targetProxy = false;
private static final ThreadLocal digestThreadLocal = new ThreadLocal() {
@Override
protected MessageDigest initialValue() {
try {
return MessageDigest.getInstance("MD5");
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}
}
};
public String getNtlmDomain() {
return ntlmDomain;
}
public RealmBuilder setNtlmDomain(String ntlmDomain) {
this.ntlmDomain = ntlmDomain;
return this;
}
public String getNtlmHost() {
return ntlmHost;
}
public RealmBuilder setNtlmHost(String host) {
this.ntlmHost = host;
return this;
}
public String getPrincipal() {
return principal;
}
public RealmBuilder setPrincipal(String principal) {
this.principal = principal;
return this;
}
public String getPassword() {
return password;
}
public RealmBuilder setPassword(String password) {
this.password = password;
return this;
}
public AuthScheme getScheme() {
return scheme;
}
public RealmBuilder setScheme(AuthScheme scheme) {
this.scheme = scheme;
return this;
}
public String getRealmName() {
return realmName;
}
public RealmBuilder setRealmName(String realmName) {
this.realmName = realmName;
return this;
}
public String getNonce() {
return nonce;
}
public RealmBuilder setNonce(String nonce) {
this.nonce = nonce;
return this;
}
public String getAlgorithm() {
return algorithm;
}
public RealmBuilder setAlgorithm(String algorithm) {
this.algorithm = algorithm;
return this;
}
public String getResponse() {
return response;
}
public RealmBuilder setResponse(String response) {
this.response = response;
return this;
}
public String getOpaque() {
return this.opaque;
}
public RealmBuilder setOpaque(String opaque) {
this.opaque = opaque;
return this;
}
public String getQop() {
return qop;
}
public RealmBuilder setQop(String qop) {
if (isNonEmpty(qop)) {
this.qop = qop;
}
return this;
}
public String getNc() {
return nc;
}
public RealmBuilder setNc(String nc) {
this.nc = nc;
return this;
}
public Uri getUri() {
return uri;
}
public RealmBuilder setUri(Uri uri) {
this.uri = uri;
return this;
}
public String getMethodName() {
return methodName;
}
public RealmBuilder setMethodName(String methodName) {
this.methodName = methodName;
return this;
}
public boolean getUsePreemptiveAuth() {
return usePreemptive;
}
public RealmBuilder setUsePreemptiveAuth(boolean usePreemptiveAuth) {
this.usePreemptive = usePreemptiveAuth;
return this;
}
public boolean isUseAbsoluteURI() {
return useAbsoluteURI;
}
public RealmBuilder setUseAbsoluteURI(boolean useAbsoluteURI) {
this.useAbsoluteURI = useAbsoluteURI;
return this;
}
public boolean isOmitQuery() {
return omitQuery;
}
public RealmBuilder setOmitQuery(boolean omitQuery) {
this.omitQuery = omitQuery;
return this;
}
public boolean isTargetProxy() {
return targetProxy;
}
public RealmBuilder setTargetProxy(boolean targetProxy) {
this.targetProxy = targetProxy;
return this;
}
private String parseRawQop(String rawQop) {
String[] rawServerSupportedQops = rawQop.split(",");
String[] serverSupportedQops = new String[rawServerSupportedQops.length];
for (int i = 0; i < rawServerSupportedQops.length; i++) {
serverSupportedQops[i] = rawServerSupportedQops[i].trim();
}
// prefer auth over auth-int
for (String rawServerSupportedQop: serverSupportedQops) {
if (rawServerSupportedQop.equals("auth"))
return rawServerSupportedQop;
}
for (String rawServerSupportedQop: serverSupportedQops) {
if (rawServerSupportedQop.equals("auth-int"))
return rawServerSupportedQop;
}
return null;
}
public RealmBuilder parseWWWAuthenticateHeader(String headerLine) {
setRealmName(match(headerLine, "realm"));
setNonce(match(headerLine, "nonce"));
String algorithm = match(headerLine, "algorithm");
if (isNonEmpty(algorithm)) {
setAlgorithm(algorithm);
}
setOpaque(match(headerLine, "opaque"));
String rawQop = match(headerLine, "qop");
if (rawQop != null) {
setQop(parseRawQop(rawQop));
}
if (isNonEmpty(getNonce())) {
setScheme(AuthScheme.DIGEST);
} else {
setScheme(AuthScheme.BASIC);
}
return this;
}
public RealmBuilder parseProxyAuthenticateHeader(String headerLine) {
setRealmName(match(headerLine, "realm"));
setNonce(match(headerLine, "nonce"));
setOpaque(match(headerLine, "opaque"));
String algorithm = match(headerLine, "algorithm");
if (isNonEmpty(algorithm)) {
setAlgorithm(algorithm);
}
setQop(match(headerLine, "qop"));
if (isNonEmpty(getNonce())) {
setScheme(AuthScheme.DIGEST);
} else {
setScheme(AuthScheme.BASIC);
}
setTargetProxy(true);
return this;
}
public RealmBuilder clone(Realm clone) {
return setRealmName(clone.getRealmName())//
.setAlgorithm(clone.getAlgorithm())//
.setMethodName(clone.getMethodName())//
.setNc(clone.getNc())//
.setNonce(clone.getNonce())//
.setPassword(clone.getPassword())//
.setPrincipal(clone.getPrincipal())//
.setCharset(clone.getCharset())//
.setOpaque(clone.getOpaque())//
.setQop(clone.getQop())//
.setScheme(clone.getScheme())//
.setUri(clone.getUri())//
.setUsePreemptiveAuth(clone.getUsePreemptiveAuth())//
.setNtlmDomain(clone.getNtlmDomain())//
.setNtlmHost(clone.getNtlmHost())//
.setUseAbsoluteURI(clone.isUseAbsoluteURI())//
.setOmitQuery(clone.isOmitQuery())//
.setTargetProxy(clone.isTargetProxy());
}
private void newCnonce(MessageDigest md) {
byte[] b = new byte[8];
ThreadLocalRandom.current().nextBytes(b);
b = md.digest(b);
cnonce = toHexString(b);
}
/**
* TODO: A Pattern/Matcher may be better.
*/
private String match(String headerLine, String token) {
if (headerLine == null) {
return null;
}
int match = headerLine.indexOf(token);
if (match <= 0) return null;
// = to skip
match += token.length() + 1;
int traillingComa = headerLine.indexOf(",", match);
String value = headerLine.substring(match, traillingComa > 0 ? traillingComa : headerLine.length());
value = value.endsWith("\"") ? value.substring(0, value.length() - 1) : value;
return value.startsWith("\"") ? value.substring(1) : value;
}
public Charset getCharset() {
return charset;
}
public RealmBuilder setCharset(Charset charset) {
this.charset = charset;
return this;
}
private byte[] md5FromRecycledStringBuilder(StringBuilder sb, MessageDigest md) {
md.update(StringUtils.charSequence2ByteBuffer(sb, ISO_8859_1));
sb.setLength(0);
return md.digest();
}
private byte[] secretDigest(StringBuilder sb, MessageDigest md) {
sb.append(principal).append(':').append(realmName).append(':').append(password);
byte[] ha1 = md5FromRecycledStringBuilder(sb, md);
if (algorithm == null || algorithm.equals("MD5")) {
return ha1;
} else if ("MD5-sess".equals(algorithm)) {
appendBase16(sb, ha1);
sb.append(':').append(nonce).append(':').append(cnonce);
return md5FromRecycledStringBuilder(sb, md);
}
throw new UnsupportedOperationException("Digest algorithm not supported: " + algorithm);
}
private byte[] dataDigest(StringBuilder sb, String digestUri, MessageDigest md) {
sb.append(methodName).append(':').append(digestUri);
if ("auth-int".equals(qop)) {
sb.append(':').append(EMPTY_ENTITY_MD5);
} else if (qop != null && !qop.equals("auth")) {
throw new UnsupportedOperationException("Digest qop not supported: " + qop);
}
return md5FromRecycledStringBuilder(sb, md);
}
private void appendDataBase(StringBuilder sb) {
sb.append(':').append(nonce).append(':');
if ("auth".equals(qop) || "auth-int".equals(qop)) {
sb.append(nc).append(':').append(cnonce).append(':').append(qop).append(':');
}
}
private void newResponse(MessageDigest md) {
// BEWARE: compute first as it used the cached StringBuilder
String digestUri = AuthenticatorUtils.computeRealmURI(uri, useAbsoluteURI, omitQuery);
StringBuilder sb = StringUtils.stringBuilder();
// WARNING: DON'T MOVE, BUFFER IS RECYCLED!!!!
byte[] secretDigest = secretDigest(sb, md);
byte[] dataDigest = dataDigest(sb, digestUri, md);
appendBase16(sb, secretDigest);
appendDataBase(sb);
appendBase16(sb, dataDigest);
byte[] responseDigest = md5FromRecycledStringBuilder(sb, md);
response = toHexString(responseDigest);
}
private static String toHexString(byte[] data) {
StringBuilder sb = StringUtils.stringBuilder();
appendBase16(sb, data);
String hex = sb.toString();
sb.setLength(0);
return hex;
}
private static final char[] HEXADECIMAL = {
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd',
'e', 'f'
};
private static void appendBase16(StringBuilder buf, byte[] bytes) {
for (int i = 0; i < bytes.length; i++) {
final int low = (bytes[i] & 0x0f);
final int high = ((bytes[i] & 0xf0) >> 4);
buf.append(HEXADECIMAL[high]);
buf.append(HEXADECIMAL[low]);
}
}
/**
* Build a {@link Realm}
*
* @return a {@link Realm}
*/
public Realm build() {
// Avoid generating
if (isNonEmpty(nonce)) {
MessageDigest md = digestThreadLocal.get();
newCnonce(md);
newResponse(md);
}
return new Realm(scheme,
principal,
password,
realmName,
nonce,
algorithm,
response,
qop,
nc,
cnonce,
uri,
methodName,
usePreemptive,
ntlmDomain,
charset,
ntlmHost,
opaque,
useAbsoluteURI,
omitQuery,
targetProxy);
}
}
}
