software.amazon.msk.auth.iam.internals

Class IAMSaslClient

java.lang.Object

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

All Implemented Interfaces:

javax.security.sasl.SaslClient

public class IAMSaslClient
extends java.lang.Object
implements javax.security.sasl.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 and Description
static class	IAMSaslClient.ClassLoaderAwareIAMSaslClientFactory
static class	IAMSaslClient.IAMSaslClientFactory

Constructor Summary

Constructors

Constructor and Description
IAMSaslClient(@NonNull java.lang.String mechanism, @NonNull javax.security.auth.callback.CallbackHandler cbh, @NonNull java.lang.String serverName, @NonNull software.amazon.msk.auth.iam.internals.SignedPayloadGenerator payloadGenerator)

Method Summary

Modifier and Type	Method and Description
void	dispose()
byte[]	evaluateChallenge(byte[] challenge)
java.lang.String	getMechanismName()
static java.lang.String	getMechanismNameForClassLoader(java.lang.ClassLoader classLoader)
java.lang.Object	getNegotiatedProperty(java.lang.String propName)
java.lang.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 Detail

IAMSaslClient

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

Method Detail

getMechanismName

public java.lang.String getMechanismName()

Specified by:

getMechanismName in interface javax.security.sasl.SaslClient

hasInitialResponse

public boolean hasInitialResponse()

Specified by:

hasInitialResponse in interface javax.security.sasl.SaslClient

evaluateChallenge

public byte[] evaluateChallenge(byte[] challenge)
                         throws javax.security.sasl.SaslException

Specified by:

evaluateChallenge in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

isComplete

public boolean isComplete()

Specified by:

isComplete in interface javax.security.sasl.SaslClient

unwrap

public byte[] unwrap(byte[] incoming,
                     int offset,
                     int len)
              throws javax.security.sasl.SaslException

Specified by:

unwrap in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

wrap

public byte[] wrap(byte[] outgoing,
                   int offset,
                   int len)
            throws javax.security.sasl.SaslException

Specified by:

wrap in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

getNegotiatedProperty

public java.lang.Object getNegotiatedProperty(java.lang.String propName)

Specified by:

getNegotiatedProperty in interface javax.security.sasl.SaslClient

dispose

public void dispose()
             throws javax.security.sasl.SaslException

Specified by:

dispose in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

getResponseRequestId

public java.lang.String getResponseRequestId()

getMechanismNameForClassLoader

public static java.lang.String getMechanismNameForClassLoader(java.lang.ClassLoader classLoader)