RestTemplate with Digest Authentication – 采用Digest认证的RestTemplate

最后修改: 2013年 8月 4日


1. Overview


This article will show how to configure the Spring RestTemplate to consume a service secured with Digest Authentication.

本文将展示如何配置Spring RestTemplate,以消费使用Digest Authentication的服务

Similar to Basic Authentication, once Digest auth is set in the template, the client will be able to go through the necessary security steps and get the information needed for the Authorization header:

与基本认证类似,一旦在模板中设置了Digest auth,客户端将能够通过必要的安全步骤,获得Authorization头所需的信息。

Authorization: Digest 
    realm="Custom Realm Name",

With this data, the server can correctly authenticate the request and return the 200 OK response.

有了这些数据,服务器可以正确地验证请求并返回200 OK的响应。

2. Setup the RestTemplate


The RestTemplate needs to be declared as a bean in the Spring context – this is simple enough either in XML or plain Java, using the @Bean annotation:


import org.apache.http.HttpHost;
import com.baeldung.client.HttpComponentsClientHttpRequestFactoryDigestAuth;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

public class ClientConfig {

    public RestTemplate restTemplate() {
        HttpHost host = new HttpHost("localhost", 8080, "http");
        CloseableHttpClient client = HttpClientBuilder.create().
        HttpComponentsClientHttpRequestFactory requestFactory = 
          new HttpComponentsClientHttpRequestFactoryDigestAuth(host, client);

        return new RestTemplate(requestFactory);;
    private CredentialsProvider provider() {
        CredentialsProvider provider = new BasicCredentialsProvider();
        UsernamePasswordCredentials credentials = 
          new UsernamePasswordCredentials("user1", "user1Pass");
        provider.setCredentials(AuthScope.ANY, credentials);
        return provider;

Most of the configuration of the digest access mechanism is done in the custom implementation of the client http request factory injected into the template – HttpComponentsClientHttpRequestFactoryDigestAuth.

摘要访问机制的大部分配置是在注入模板的客户端http请求工厂的自定义实现中完成的 – HttpComponentsClientHttpRequestFactoryDigestAuth

Note that we are now pre-configuring the template with the credentials that have access to the secured API.


3. Configure Digest Authentication


We are going to leverage the support introduced in Spring 3.1 for the current HttpClient 4.x – namely the HttpComponentsClientHttpRequestFactory – by extending and configuring it.

我们将利用Spring 3.1中引入的对当前HttpClient 4.x的支持–即HttpComponentsClientHttpRequestFactory–通过扩展和配置它。

We’re mainly going to configure the HttpContext and hook up our custom logic for Digest Authentication:

我们主要是要配置HttpContext并为Digest Authentication挂上我们的自定义逻辑。

import org.apache.http.HttpHost;
import org.apache.http.client.AuthCache;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.impl.auth.DigestScheme;
import org.apache.http.impl.client.BasicAuthCache;
import org.apache.http.protocol.BasicHttpContext;
import org.apache.http.protocol.HttpContext;
import org.springframework.http.HttpMethod;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;

public class HttpComponentsClientHttpRequestFactoryDigestAuth 
  extends HttpComponentsClientHttpRequestFactory {

    HttpHost host;

    public HttpComponentsClientHttpRequestFactoryDigestAuth(HttpHost host, HttpClient httpClient) {
        super(httpClient); = host;

    protected HttpContext createHttpContext(HttpMethod httpMethod, URI uri) {
        return createHttpContext();

    private HttpContext createHttpContext() {
        // Create AuthCache instance
        AuthCache authCache = new BasicAuthCache();
        // Generate DIGEST scheme object, initialize it and add it to the local auth cache
        DigestScheme digestAuth = new DigestScheme();
        // If we already know the realm name
        digestAuth.overrideParamter("realm", "Custom Realm Name");
        authCache.put(host, digestAuth);

        // Add AuthCache to the execution context
        BasicHttpContext localcontext = new BasicHttpContext();
        localcontext.setAttribute(ClientContext.AUTH_CACHE, authCache);
        return localcontext;

Now, the RestTemplate can simply be injected and used in a test:


public void whenSecuredRestApiIsConsumed_then200OK() {
    String uri = "http://localhost:8080/spring-security-rest-digest-auth/api/foos/1";
    ResponseEntity<Foo> entity =, HttpMethod.GET, null, Foo.class);

To illustrate the full configuration process, this test also sets up the user credentials – user1 and user1Pass. This part should, of course, be done only once and outside the test itself.


4. Maven Dependencies


The required Maven Dependencies for the RestTemplate and the HttpClient library are:




5. Conclusion


This tutorial showed how to set up and configure the Rest Template so that it can consume an application secured with Digest authentication. The REST API itself needs to be configured with the digest security mechanism.

本教程展示了如何设置和配置Rest模板,以使其能够消费具有Digest认证的应用程序。REST API本身需要配置digest安全机制。

The implementation can be found in the example GitHub project – this is a Maven-based project, so it should be easy to import and run as it is.

该实现可以在GitHub 示例项目中找到–这是一个基于Maven的项目,所以应该很容易导入并按原样运行。