Базовая аутентификация Apache HttpClient

1. Обзор

В этом руководстве показано, как настроить обычную аутентификацию на Apache HttpClient .

Если вы хотите копнуть глубже и узнать о других интересных вещах, которые можно делать с помощью HttpClient, — перейдите к основному руководству по HttpClient .

2. Базовая аутентификация с помощью API

Начнем со стандартного способа настройки базовой аутентификации на HttpClient — через CredentialsProvider :

CredentialsProvider provider = new BasicCredentialsProvider();
UsernamePasswordCredentials credentials
 = new UsernamePasswordCredentials("user1", "user1Pass");
provider.setCredentials(AuthScope.ANY, credentials);
 
HttpClient client = HttpClientBuilder.create()
  .setDefaultCredentialsProvider(provider)
  .build();

HttpResponse response = client.execute(
  new HttpGet(URL_SECURED_BY_BASIC_AUTHENTICATION));
int statusCode = response.getStatusLine()
  .getStatusCode();
 
assertThat(statusCode, equalTo(HttpStatus.SC_OK));

Как мы видим, создать клиент с поставщиком учетных данных для настройки базовой аутентификации несложно.

Теперь, чтобы понять, что на самом деле делает HttpClient за кулисами, нам нужно посмотреть журналы:

# ... request is sent with no credentials
[main] DEBUG ... - Authentication required
[main] DEBUG ... - localhost:8080 requested authentication
[main] DEBUG ... - Authentication schemes in the order of preference: 
  [negotiate, Kerberos, NTLM, Digest, Basic]
[main] DEBUG ... - Challenge for negotiate authentication scheme not available
[main] DEBUG ... - Challenge for Kerberos authentication scheme not available
[main] DEBUG ... - Challenge for NTLM authentication scheme not available
[main] DEBUG ... - Challenge for Digest authentication scheme not available
[main] DEBUG ... - Selected authentication options: [BASIC]
# ... the request is sent again - with credentials

Вся связь между клиентом и сервером теперь ясна :

• Клиент отправляет HTTP-запрос без учетных данных
• Сервер отправляет обратно вызов
• Клиент согласовывает и определяет правильную схему аутентификации
• Клиент отправляет второй запрос , на этот раз с учетными данными

3. Упреждающая базовая аутентификация

По умолчанию HttpClient не выполняет упреждающую аутентификацию. Вместо этого это должно быть явное решение, принятое клиентом.

Во- первых, нам нужно создать HttpContext — предварительно заполнив его кешем аутентификации с предварительно выбранным правильным типом схемы аутентификации. Это будет означать, что согласование из предыдущего примера больше не нужно — уже выбрана Basic Authentication :

HttpHost targetHost = new HttpHost("localhost", 8082, "http");
CredentialsProvider credsProvider = new BasicCredentialsProvider();
credsProvider.setCredentials(AuthScope.ANY, 
  new UsernamePasswordCredentials(DEFAULT_USER, DEFAULT_PASS));

AuthCache authCache = new BasicAuthCache();
authCache.put(targetHost, new BasicScheme());

// Add AuthCache to the execution context
HttpClientContext context = HttpClientContext.create();
context.setCredentialsProvider(credsProvider);
context.setAuthCache(authCache);

Теперь мы можем использовать клиент с новым контекстом и отправить запрос предварительной аутентификации :

HttpClient client = HttpClientBuilder.create().build();
response = client.execute(
  new HttpGet(URL_SECURED_BY_BASIC_AUTHENTICATION), context);

int statusCode = response.getStatusLine().getStatusCode();
assertThat(statusCode, equalTo(HttpStatus.SC_OK));

Смотрим логи:

[main] DEBUG ... - Re-using cached 'basic' auth scheme for http://localhost:8082
[main] DEBUG ... - Executing request GET /spring-security-rest-basic-auth/api/foos/1 HTTP/1.1
[main] DEBUG ... >> GET /spring-security-rest-basic-auth/api/foos/1 HTTP/1.1
[main] DEBUG ... >> Host: localhost:8082
[main] DEBUG ... >> Authorization: Basic dXNlcjE6dXNlcjFQYXNz
[main] DEBUG ... << HTTP/1.1 200 OK
[main] DEBUG ... - Authentication succeeded

Все выглядит нормально:

• предварительно выбрана схема «Базовая аутентификация»
• Запрос отправляется с заголовком Authorization
• Сервер отвечает 200 OK
• Аутентификация прошла успешно

4. Базовая аутентификация с необработанными HTTP-заголовками

Упреждающая базовая аутентификация в основном означает предварительную отправку заголовка авторизации .

Итак, вместо того, чтобы выполнять довольно сложный предыдущий пример для его настройки, мы можем взять под контроль этот заголовок и создать его вручную :

HttpGet request = new HttpGet(URL_SECURED_BY_BASIC_AUTHENTICATION);
String auth = DEFAULT_USER + ":" + DEFAULT_PASS;
byte[] encodedAuth = Base64.encodeBase64(
  auth.getBytes(StandardCharsets.ISO_8859_1));
String authHeader = "Basic " + new String(encodedAuth);
request.setHeader(HttpHeaders.AUTHORIZATION, authHeader);

HttpClient client = HttpClientBuilder.create().build();
HttpResponse response = client.execute(request);

int statusCode = response.getStatusLine().getStatusCode();
assertThat(statusCode, equalTo(HttpStatus.SC_OK));

Давайте удостоверимся, что это работает правильно:

[main] DEBUG ... - Auth cache not set in the context
[main] DEBUG ... - Opening connection {}->http://localhost:8080
[main] DEBUG ... - Connecting to localhost/127.0.0.1:8080
[main] DEBUG ... - Executing request GET /spring-security-rest-basic-auth/api/foos/1 HTTP/1.1
[main] DEBUG ... - Proxy auth state: UNCHALLENGED
[main] DEBUG ... - http-outgoing-0 >> GET /spring-security-rest-basic-auth/api/foos/1 HTTP/1.1
[main] DEBUG ... - http-outgoing-0 >> Authorization: Basic dXNlcjE6dXNlcjFQYXNz
[main] DEBUG ... - http-outgoing-0 << HTTP/1.1 200 OK

Итак, несмотря на отсутствие кеша аутентификации, Basic Authentication все равно работает корректно и мы получаем 200 OK.

5. Вывод

В этой статье показаны различные способы настройки и использования базовой проверки подлинности с помощью Apache HttpClient.

Как всегда, код, представленный в этой статье, доступен на Github . Это проект на основе Maven, поэтому его легко импортировать и запускать как есть.