Package software.amazon.msk.auth.iam.internals

Class IAMSaslClient

java.lang.Object

software.amazon.msk.auth.iam.internals.IAMSaslClient

All Implemented Interfaces:

SaslClient

public class IAMSaslClient
extends Object
implements SaslClient

The IAMSaslClient is used to provide SASL integration with AWS IAM. It has an initial response, so it starts out in the state SEND_CLIENT_FIRST_MESSAGE. The initial response sent to the server contains an authentication payload. The authentication payload consists of a json object that includes a signature signed by the client's credentials. The exact details of the authentication payload can be seen in AWS4SignedPayloadGenerator. The credentials used to sign the payload are fetched by invoking the IAMClientCallbackHandler. After sending the authentication payload, the client transitions to state RECEIVE_SENDER_RESPONSE. Once it receives a successful response from the server, the client transitions to the state completed. A failure at any intermediate step transitions the client to a FAILED state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IAMSaslClient.ClassLoaderAwareIAMSaslClientFactory
static class	IAMSaslClient.IAMSaslClientFactory

Constructor Summary

Constructors

Constructor	Description
IAMSaslClient(@NonNull String mechanism, @NonNull CallbackHandler cbh, @NonNull String serverName, @NonNull software.amazon.msk.auth.iam.internals.SignedPayloadGenerator payloadGenerator)

Method Summary

Modifier and Type	Method	Description
void	dispose()
byte[]	evaluateChallenge(byte[] challenge)
String	getMechanismName()
static String	getMechanismNameForClassLoader(ClassLoader classLoader)
Object	getNegotiatedProperty(String propName)
String	getResponseRequestId()
boolean	hasInitialResponse()
boolean	isComplete()
byte[]	unwrap(byte[] incoming, int offset, int len)
byte[]	wrap(byte[] outgoing, int offset, int len)

Methods inherited from class java.lang.Object

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

Constructor Details

IAMSaslClient

public IAMSaslClient(@NonNull
 @NonNull String mechanism,
 @NonNull
 @NonNull CallbackHandler cbh,
 @NonNull
 @NonNull String serverName,
 @NonNull
 @NonNull software.amazon.msk.auth.iam.internals.SignedPayloadGenerator payloadGenerator)

Method Details

getMechanismName

public String getMechanismName()

Specified by:

getMechanismName in interface SaslClient

hasInitialResponse

public boolean hasInitialResponse()

Specified by:

hasInitialResponse in interface SaslClient

evaluateChallenge

public byte[] evaluateChallenge(byte[] challenge)
                         throws SaslException

Specified by:

evaluateChallenge in interface SaslClient

Throws:

SaslException

isComplete

public boolean isComplete()

Specified by:

isComplete in interface SaslClient

unwrap

public byte[] unwrap(byte[] incoming,
 int offset,
 int len)
              throws SaslException

Specified by:

unwrap in interface SaslClient

Throws:

SaslException

wrap

public byte[] wrap(byte[] outgoing,
 int offset,
 int len)
            throws SaslException

Specified by:

wrap in interface SaslClient

Throws:

SaslException

getNegotiatedProperty

public Object getNegotiatedProperty(String propName)

Specified by:

getNegotiatedProperty in interface SaslClient

dispose

public void dispose()
             throws SaslException

Specified by:

dispose in interface SaslClient

Throws:

SaslException

getResponseRequestId

public String getResponseRequestId()

getMechanismNameForClassLoader

public static String getMechanismNameForClassLoader(ClassLoader classLoader)