io.rsocket.metadata.security

Class AuthMetadataFlyweight

java.lang.Object

io.rsocket.metadata.security.AuthMetadataFlyweight

public class AuthMetadataFlyweight
extends Object

Method Summary

Modifier and Type	Method and Description
static char[]	decodeBearerTokenAsCharArray(ByteBuf bearerAuthMetadata) Read all the remaining bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length
static CharSequence	decodeCustomAuthType(ByteBuf metadata) Read up to 129 bytes from the given metadata in order to get the custom Auth Type
static ByteBuf	decodePassword(ByteBuf simpleAuthMetadata) Read all the remaining bytes from the given ByteBuf which represents user's password
static char[]	decodePasswordAsCharArray(ByteBuf simpleAuthMetadata) Read all the remaining bytes from the given ByteBuf which represents user's password
static ByteBuf	decodePayload(ByteBuf metadata) Read all remaining bytes from the given ByteBuf and return sliced representation of a payload
static ByteBuf	decodeUsername(ByteBuf simpleAuthMetadata) Read up to 257 bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length
static char[]	decodeUsernameAsCharArray(ByteBuf simpleAuthMetadata) Read up to 257 bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length
static WellKnownAuthType	decodeWellKnownAuthType(ByteBuf metadata) Read first byte from the given metadata and tries to convert it's value to WellKnownAuthType.
static ByteBuf	encodeBearerMetadata(ByteBufAllocator allocator, char[] token) Encode a Authentication CompositeMetadata payload using Bearer Authentication format
static ByteBuf	encodeMetadata(ByteBufAllocator allocator, String customAuthType, ByteBuf metadata) Encode a Authentication CompositeMetadata payload using custom authentication type
static ByteBuf	encodeMetadata(ByteBufAllocator allocator, WellKnownAuthType authType, ByteBuf metadata) Encode a Authentication CompositeMetadata payload using custom authentication type
static ByteBuf	encodeMetadataWithCompression(ByteBufAllocator allocator, String authType, ByteBuf metadata) Encode a new Authentication Metadata payload information, first verifying if the passed String matches a WellKnownAuthType (in which case it will be encoded in a compressed fashion using the mime id of that type).
static ByteBuf	encodeSimpleMetadata(ByteBufAllocator allocator, char[] username, char[] password) Encode a Authentication CompositeMetadata payload using Simple Authentication format
static boolean	isWellKnownAuthType(ByteBuf metadata) Get the first byte from a ByteBuf and check whether it is length or WellKnownAuthType.

Methods inherited from class java.lang.Object

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

Method Detail

encodeMetadata

public static ByteBuf encodeMetadata(ByteBufAllocator allocator,
                                     String customAuthType,
                                     ByteBuf metadata)

Encode a Authentication CompositeMetadata payload using custom authentication type

Parameters:

allocator - the ByteBufAllocator to use to create intermediate buffers as needed.

customAuthType - the custom mime type to encode.

metadata - the metadata value to encode.

Throws:

IllegalArgumentException - in case of customAuthType is non US_ASCII string or empty string or its length is greater than 128 bytes

encodeMetadata

public static ByteBuf encodeMetadata(ByteBufAllocator allocator,
                                     WellKnownAuthType authType,
                                     ByteBuf metadata)

Encode a Authentication CompositeMetadata payload using custom authentication type

Parameters:

allocator - the ByteBufAllocator to create intermediate buffers as needed.

authType - the well-known mime type to encode.

metadata - the metadata value to encode.

Throws:

IllegalArgumentException - in case of authType is WellKnownAuthType.UNPARSEABLE_AUTH_TYPE or WellKnownAuthType.UNKNOWN_RESERVED_AUTH_TYPE

encodeSimpleMetadata

public static ByteBuf encodeSimpleMetadata(ByteBufAllocator allocator,
                                           char[] username,
                                           char[] password)

Encode a Authentication CompositeMetadata payload using Simple Authentication format

Parameters:

allocator - the ByteBufAllocator to use to create intermediate buffers as needed.

username - the char sequence which represents user name.

password - the char sequence which represents user password.

Throws:

IllegalArgumentException - if the username length is greater than 255

encodeBearerMetadata

public static ByteBuf encodeBearerMetadata(ByteBufAllocator allocator,
                                           char[] token)

Encode a Authentication CompositeMetadata payload using Bearer Authentication format

Parameters:

allocator - the ByteBufAllocator to use to create intermediate buffers as needed.

token - the char sequence which represents BEARER token.

encodeMetadataWithCompression

public static ByteBuf encodeMetadataWithCompression(ByteBufAllocator allocator,
                                                    String authType,
                                                    ByteBuf metadata)

Encode a new Authentication Metadata payload information, first verifying if the passed String matches a WellKnownAuthType (in which case it will be encoded in a compressed fashion using the mime id of that type).

Prefer using encodeMetadata(ByteBufAllocator, String, ByteBuf) if you already know that the mime type is not a WellKnownAuthType.

Parameters:

allocator - the ByteBufAllocator to use to create intermediate buffers as needed.

authType - the mime type to encode, as a String. well known mime types are compressed.

metadata - the metadata value to encode.

See Also:

encodeMetadata(ByteBufAllocator, WellKnownAuthType, ByteBuf), encodeMetadata(ByteBufAllocator, String, ByteBuf)

isWellKnownAuthType

public static boolean isWellKnownAuthType(ByteBuf metadata)

Get the first byte from a ByteBuf and check whether it is length or WellKnownAuthType. Assuming said buffer properly contains such a byte

Parameters:

metadata - byteBuf used to get information from

decodeWellKnownAuthType

public static WellKnownAuthType decodeWellKnownAuthType(ByteBuf metadata)

Read first byte from the given metadata and tries to convert it's value to WellKnownAuthType.

Parameters:

metadata - given metadata buffer to read from

Returns:

Return on of the know Auth types or WellKnownAuthType.UNPARSEABLE_AUTH_TYPE if field's value is length or unknown auth type

Throws:

IllegalStateException - if not enough readable bytes in the given ByteBuf

decodeCustomAuthType

public static CharSequence decodeCustomAuthType(ByteBuf metadata)

Read up to 129 bytes from the given metadata in order to get the custom Auth Type

Parameters:

metadata -

Returns:

decodePayload

public static ByteBuf decodePayload(ByteBuf metadata)

Read all remaining bytes from the given ByteBuf and return sliced representation of a payload

Parameters:

metadata - metadata to get payload from. Please note, the metadata#readIndex should be set to the beginning of the payload bytes

Returns:

sliced ByteBuf or Unpooled.EMPTY_BUFFER if no bytes readable in the given one

decodeUsername

public static ByteBuf decodeUsername(ByteBuf simpleAuthMetadata)

Read up to 257 bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length

Parameters:

simpleAuthMetadata - the given metadata to read username from. Please note, the simpleAuthMetadata#readIndex should be set to the username length byte

Returns:

sliced ByteBuf or Unpooled.EMPTY_BUFFER if username length is zero

decodePassword

public static ByteBuf decodePassword(ByteBuf simpleAuthMetadata)

Read all the remaining bytes from the given ByteBuf which represents user's password

Parameters:

simpleAuthMetadata - the given metadata to read password from. Please note, the simpleAuthMetadata#readIndex should be set to the beginning of the password bytes

Returns:

sliced ByteBuf or Unpooled.EMPTY_BUFFER if password length is zero

decodeUsernameAsCharArray

public static char[] decodeUsernameAsCharArray(ByteBuf simpleAuthMetadata)

Read up to 257 bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length

Parameters:

simpleAuthMetadata - the given metadata to read username from. Please note, the simpleAuthMetadata#readIndex should be set to the username length byte

Returns:

char[] which represents UTF-8 username

decodePasswordAsCharArray

public static char[] decodePasswordAsCharArray(ByteBuf simpleAuthMetadata)

Read all the remaining bytes from the given ByteBuf which represents user's password

Parameters:

simpleAuthMetadata - the given metadata to read username from. Please note, the simpleAuthMetadata#readIndex should be set to the beginning of the password bytes

Returns:

char[] which represents UTF-8 password

decodeBearerTokenAsCharArray

public static char[] decodeBearerTokenAsCharArray(ByteBuf bearerAuthMetadata)

Read all the remaining bytes from the given ByteBuf where the first byte is username length and the subsequent number of bytes equal to decoded length

Parameters:

bearerAuthMetadata - the given metadata to read username from. Please note, the simpleAuthMetadata#readIndex should be set to the beginning of the password bytes

Returns:

char[] which represents UTF-8 password