rburgst/okhttp-digest

a digest authenticator for okhttp

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.rburgst:okhttp-digest:2.7'
	}

	dependencies {
		implementation("com.github.rburgst:okhttp-digest:2.7")
	}

	<dependency>
	    <groupId>com.github.rburgst</groupId>
	    <artifactId>okhttp-digest</artifactId>
	    <version>2.7</version>
	</dependency>


                            
    libraryDependencies += "com.github.rburgst" % "okhttp-digest" % "2.7"


                            
    :dependencies [[com.github.rburgst/okhttp-digest "2.7"]]

Readme

okhttp-digest

A digest authenticator for okhttp. Most of the code is ported from Apache Http Client.

Important

This artifact has moved from jcenter to maven central! The coordinates have changed from

com.burgstaller:okhttp-digest:<version> to io.github.rburgst:okhttp-digest:<version>

For more details, see #71.

Usage

final DigestAuthenticator authenticator = new DigestAuthenticator(new Credentials("username", "pass"));

final Map<String, CachingAuthenticator> authCache = new ConcurrentHashMap<>();
final OkHttpClient client = new OkHttpClient.Builder()
        .authenticator(new CachingAuthenticatorDecorator(authenticator, authCache))
        .addInterceptor(new AuthenticationCacheInterceptor(authCache))
        .build();

String url = "http://www.google.com";
Request request = new Request.Builder()
        .url(url)
        .get()
        .build();
Response response = client.newCall(request).execute();

If you want to support multiple authentication schemes (including auth caching) then this should work:

final OkHttpClient.Builder builder = new OkHttpClient.Builder();
final Map<String, CachingAuthenticator> authCache = new ConcurrentHashMap<>();

final Credentials credentials = new Credentials("username", "pass");
final BasicAuthenticator basicAuthenticator = new BasicAuthenticator(credentials);
final DigestAuthenticator digestAuthenticator = new DigestAuthenticator(credentials);

// note that all auth schemes should be registered as lowercase!
DispatchingAuthenticator authenticator = new DispatchingAuthenticator.Builder()
        .with("digest", digestAuthenticator)
        .with("basic", basicAuthenticator)
        .build();

final OkHttpClient client = builder
        .authenticator(new CachingAuthenticatorDecorator(authenticator, authCache))
        .addInterceptor(new AuthenticationCacheInterceptor(authCache, new DefaultRequestCacheKeyProvider()))
        .addNetworkInterceptor(logger)
        .build();

If you want to cache Proxy credentials, you need to add a NetworkInterceptor :

final OkHttpClient client = builder
        .authenticator(new CachingAuthenticatorDecorator(authenticator, authCache))
        .addNetworkInterceptor(new AuthenticationCacheInterceptor(authCache, new DefaultProxyCacheKeyProvider()))
        .addNetworkInterceptor(logger)
        .build();

You can also combine Proxy AND Web site Authentication :

final OkHttpClient client = builder
        .authenticator(new CachingAuthenticatorDecorator(authenticator, authCache))
        .addNetworkInterceptor(new AuthenticationCacheInterceptor(authCache,new DefaultProxyCacheKeyProvider()))
        .addInterceptor(new AuthenticationCacheInterceptor(authCache,new DefaultRequestCacheKeyProvider()))        
        .addNetworkInterceptor(logger)
        .build();

Use via gradle

implementation 'io.github.rburgst:okhttp-digest:3.1.1'