com.flyingspaniel.nava.net

Class JRFC2617

java.lang.Object

com.flyingspaniel.nava.net.JRFC2617

public class JRFC2617
extends Object

Java Class for doing RFC 2617 Digest Authentication. Can also fallback and do RFC 2069

See http://www.ietf.org/rfc/rfc2617.txt and http://en.wikipedia.org/wiki/Digest_access_authentication

Note Though the responses exactly match those in the Wikipedia article and thise generated by Chrome, I never got this to actually work on test servers such as httpbin.org. So I cannot guarantee that this will actually work in a real environment. Help!

Since:

Copyright (c) 2013 by Morgan Conrad Some ideas borrowed from https://gist.github.com/slightfoot/5624590

Author:

Morgan Conrad

See Also:

This software is released under the MIT License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JRFC2617.Key

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	crMap
static String	DIGEST
protected URL	failedURL
protected String	fullResponse
protected MessageDigest	messageDigest
protected int	nonceCount
protected Random	random

Constructor Summary

Constructors

Constructor and Description
JRFC2617(HttpURLConnection failedWith401) Alternative Constructor
JRFC2617(String challenge) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToConnection(URLConnection conn) Convenience method to put the repsonse in the connection
protected Map<String,String>	createChallengeMap(String challenge)
protected String	createCnonce() Create a cnonce.
protected MessageDigest	createMessageDigest(String algo)
protected String	createNonceCountString(int count)
String	createResponse(String username, String password, String cnonce, String method, String uri) Create the response credentials
HttpURLConnection	createRetryConnection(String username, String password) This method only works after the failedWith401 style constructor
String	encode16to32(byte[] digest) Represent the MD5 digest as Hex.
protected String	getChallenge(JRFC2617.Key key)
String	MD5(String... args) Makes the MD5 of arg[0]:arg[1]:arg[2]...
String	unq(String in) Unquote a String, removing leading and trailing "

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIGEST

public static final String DIGEST

See Also:

Constant Field Values

nonceCount

protected int nonceCount

crMap

protected final Map<String,String> crMap

messageDigest

protected final MessageDigest messageDigest

random

protected final Random random

fullResponse

protected String fullResponse

failedURL

protected URL failedURL

Constructor Detail

JRFC2617

public JRFC2617(String challenge)

Constructor

Parameters:

challenge - should begin with "Digest"

JRFC2617

public JRFC2617(HttpURLConnection failedWith401)

Alternative Constructor

Parameters:

failedWith401 - the connection that gave you a 401

Method Detail

createResponse

public String createResponse(String username,
                    String password,
                    String cnonce,
                    String method,
                    String uri)

Create the response credentials

Parameters:

username - non-null username

password - non-null password

cnonce - may be null, typical, in which case one will be created

method - non-null

uri - non-null

Returns:

the response, excluding the leading "Digest "

createRetryConnection

public HttpURLConnection createRetryConnection(String username,
                                      String password)
                                        throws IOException

This method only works after the failedWith401 style constructor

Parameters:

username -

password -

Returns:

a new HTTPConnection with the "Authorization" header set

Throws:

IOException

applyToConnection

public void applyToConnection(URLConnection conn)

Convenience method to put the repsonse in the connection

Parameters:

conn -

MD5

public String MD5(String... args)

Makes the MD5 of arg[0]:arg[1]:arg[2]...

Parameters:

args -

Returns:

unq

public String unq(String in)

Unquote a String, removing leading and trailing "

Parameters:

in -

Returns:

encode16to32

public String encode16to32(byte[] digest)

Represent the MD5 digest as Hex. See http://www.ietf.org/rfc/rfc2617.txt section 3.1.3

Parameters:

digest - 16 chars

Returns:

32 char String

createCnonce

protected String createCnonce()

Create a cnonce. Subclasses requireing more security may want to override

Returns:

createChallengeMap

protected Map<String,String> createChallengeMap(String challenge)

getChallenge

protected String getChallenge(JRFC2617.Key key)

createMessageDigest

protected MessageDigest createMessageDigest(String algo)

createNonceCountString

protected String createNonceCountString(int count)