io.servicetalk.http.utils.auth

Class BasicAuthHttpServiceFilter.Builder<UserInfo>

Object

BasicAuthHttpServiceFilter.Builder<UserInfo>

Type Parameters:

UserInfo - a type for authenticated user info object

Enclosing class:

BasicAuthHttpServiceFilter<UserInfo>

public static final class BasicAuthHttpServiceFilter.Builder<UserInfo>
extends Object

A builder for an StreamingHttpServiceFilter, which filters HTTP requests using RFC7617: The 'Basic' HTTP Authentication Scheme.

Constructor Summary

Constructors

Constructor and Description
Builder(BasicAuthHttpServiceFilter.CredentialsVerifier<UserInfo> credentialsVerifier, String realm) Creates a new builder for an StreamingHttpServiceFilter, which filters HTTP requests using RFC7617: The 'Basic' HTTP Authentication Scheme.

Method Summary

Modifier and Type	Method and Description
StreamingHttpServiceFilterFactory	buildProxy() Creates a new instance for proxy service.
StreamingHttpServiceFilterFactory	buildServer() Creates a new instance for non-proxy service.
BasicAuthHttpServiceFilter.Builder<UserInfo>	setCharsetUtf8(boolean utf8) Sets an advice for a user agent to use UTF-8 charset when it generates user-id:password pair.
BasicAuthHttpServiceFilter.Builder<UserInfo>	userInfoAsyncContextKey(ContextMap.Key<UserInfo> userInfoAsyncContextKey) Sets a key to store a user info object of authenticated user in AsyncContext.
BasicAuthHttpServiceFilter.Builder<UserInfo>	userInfoRequestContextKey(ContextMap.Key<UserInfo> userInfoRequestContextKey) Sets a key to store a user info object of authenticated user in request context.

Methods inherited from class Object

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

Constructor Detail

Builder

public Builder(BasicAuthHttpServiceFilter.CredentialsVerifier<UserInfo> credentialsVerifier,
               String realm)

Creates a new builder for an StreamingHttpServiceFilter, which filters HTTP requests using RFC7617: The 'Basic' HTTP Authentication Scheme.

It accepts credentials as user-id:password pairs, encoded using Base64 for Authorization or Proxy-Authorization header values. Use of the format user:password in the userinfo field is deprecated by RFC3986.

User info object of authenticated user can be stored in AsyncContext if ContextMap.Key is configured via userInfoAsyncContextKey(ContextMap.Key) or request context if ContextMap.Key is configured via userInfoRequestContextKey(ContextMap.Key). The same key can be reused for both context storages.

Note: This scheme is not considered to be a secure method of user authentication unless used in conjunction with some external secure system such as TLS (Transport Layer Security, [RFC5246]), as the user-id and password are passed over the network as cleartext.

Parameters:

credentialsVerifier - a BasicAuthHttpServiceFilter.CredentialsVerifier for user-id and passwords pair

realm - a protection space (realm)

Method Detail

userInfoAsyncContextKey

public BasicAuthHttpServiceFilter.Builder<UserInfo> userInfoAsyncContextKey(ContextMap.Key<UserInfo> userInfoAsyncContextKey)

Sets a key to store a user info object of authenticated user in AsyncContext.

Parameters:

userInfoAsyncContextKey - a key to store a user info object in AsyncContext

Returns:

this

userInfoRequestContextKey

public BasicAuthHttpServiceFilter.Builder<UserInfo> userInfoRequestContextKey(ContextMap.Key<UserInfo> userInfoRequestContextKey)

Sets a key to store a user info object of authenticated user in request context.

Parameters:

userInfoRequestContextKey - a key to store a user info object in request context

Returns:

this

setCharsetUtf8

public BasicAuthHttpServiceFilter.Builder<UserInfo> setCharsetUtf8(boolean utf8)

Sets an advice for a user agent to use UTF-8 charset when it generates user-id:password pair.

It will result in adding an optional charset="UTF-8" parameter for an authenticate header.

Parameters:

utf8 - if true, an optional charset="UTF-8" parameter will be added for an authenticate header

Returns:

this

buildServer

public StreamingHttpServiceFilterFactory buildServer()

Creates a new instance for non-proxy service.

It will use the following constants to handle authentication:

Response status code, authenticate and authorization headers for non-proxy Basic auth

Response status code	401 (Unauthorized)
Authenticate header	WWW-Authenticate
Authorization header	Authorization

Returns:

a new BasicAuthHttpServiceFilter.Builder

buildProxy

public StreamingHttpServiceFilterFactory buildProxy()

Creates a new instance for proxy service.

It will use the following constants to handle authentication:

Response status code, authenticate and authorization headers for proxy Basic auth

Response status code	407 (Proxy Authentication Required)
Authenticate header	Proxy-Authenticate
Authorization header	Proxy-Authorization

Returns:

a new StreamingHttpServiceFilterFactory