net.devh.boot.grpc.client.security

Class AuthenticatingClientInterceptors

java.lang.Object

net.devh.boot.grpc.client.security.AuthenticatingClientInterceptors

Deprecated.

Use the CallCredentialsHelper or create the CallCredentials and StubTransformers yourself.

@Deprecated
public final class AuthenticatingClientInterceptors
extends Object

Helper class that can be used to create CallCredentials and the necessary ClientInterceptors.

This class can be used like this:

 @Bean
 CallCredentials grpcCallCredentials() {
     // Note: This method uses experimental grpc-java-API features.
     return CallCredentialsHelper.basicAuthCallCredentials("foo", "bar");
     // return CallCredentialsHelper.requirePrivacy(...); // Always a good idea
 }

 @Bean
 ClientInterceptor grpcCallCredentialsInterceptor() {
     return AuthenticatingClientInterceptors.callCredentialsInterceptor(grpcCallCredentials());
 }
 

Note: You don't need extra call credentials if you authenticate yourself via certificates.

• If you only need a single CallCredentials for all clients, then you can register it globally.

   @Bean
   public GlobalClientInterceptorConfigurer basicAuthInterceptorConfigurer() {
       return registry -> registry.addClientInterceptors(grpcCallCredentialsInterceptor());
   }
   

• If you need different authenticating client interceptors, then you can use the GrpcClient.interceptorNames() field to add a bean by name.

   @GrpcClient(value = "testChannel", interceptorNames = "grpcCallCredentialsInterceptorForTest")
   private Channel testChannel;
   

Method Summary

Modifier and Type	Method and Description
static ClientInterceptor	basicAuthInterceptor(String username, String password) Deprecated. Use the (potentially) more secure CallCredentials.
static ClientInterceptor	bearerAuth(String token) Deprecated. Use StubTransformers to set the credentials directly on AbstractStubs.
static ClientInterceptor	callCredentialsInterceptor(CallCredentials callCredentials) Deprecated. Use StubTransformers to set the credentials directly on AbstractStubs.

Methods inherited from class java.lang.Object

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

Method Detail

basicAuthInterceptor

@Deprecated
public static ClientInterceptor basicAuthInterceptor(String username,
                                                                 String password)

Deprecated. Use the (potentially) more secure CallCredentials.

Creates a new ClientInterceptor that adds the given username and passwords as basic auth to all requests. The header will be encoded with UTF_8.

Parameters:

username - The username to use.

password - The password to use.

Returns:

The newly created basic auth interceptor.

See Also:

CallCredentialsHelper.encodeBasicAuth(String, String)

callCredentialsInterceptor

@Deprecated
public static ClientInterceptor callCredentialsInterceptor(CallCredentials callCredentials)

Deprecated. Use StubTransformers to set the credentials directly on AbstractStubs.

Creates a new ClientInterceptor that will attach the given call credentials to the given call. This is an alternative to manually configuring the stubs using AbstractStub.withCallCredentials(CallCredentials).

Parameters:

callCredentials - The call credentials to attach.

Returns:

The newly created client credentials interceptor.

See Also:

Basic-Auth

bearerAuth

@Deprecated
public static ClientInterceptor bearerAuth(String token)

Deprecated. Use StubTransformers to set the credentials directly on AbstractStubs.

Creates a new ClientInterceptor that adds the given bearer token as Bearer Authentication to all requests. The header will be encoded with UTF_8.

Parameters:

token - the bearer token

Returns:

The newly created basic auth interceptor.