org.alfresco.jlan.server.auth.ntlm

Class NTLMMessage

java.lang.Object

org.alfresco.jlan.server.auth.ntlm.NTLMMessage

Direct Known Subclasses:

Type1NTLMMessage, Type2NTLMMessage, Type3NTLMMessage

public abstract class NTLMMessage
extends java.lang.Object

NTLM Message Types Base Class

Field Summary

Fields

Modifier and Type	Field and Description
static int	BufferHeaderLen
static int	OffsetSignature
static int	OffsetType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NTLMMessage() Default constructor
protected	NTLMMessage(byte[] buf, int offset, int len) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(byte[] buf, int offset, int len) Copy the NTLM blob data from the specified buffer
protected int	getByteOffset(int offset) Return the offset for a byte value
byte[]	getBytes() Return the NTLM message as a byte array
protected byte[]	getByteValue(int offset) Return a byte value that has a header
abstract int	getFlags() Return the message flags
protected int	getIntValue(int offset) Return an int/32bit value
int	getLength() Return the message length
protected byte[]	getRawBytes(int offset, int len) Return a block of byte data
protected java.lang.String	getRawString(int offset, int len, boolean isuni) Return a raw string
protected int	getShortValue(int offset) Return a short/16bit value
protected int	getStringAllocatedLength(int offset) Return the allocated length of a string
protected int	getStringLength(int offset) Return the length of a string
protected int	getStringOffset(int offset) Return the string data offset
protected java.lang.String	getStringValue(int offset, boolean isuni) Return a string value
boolean	hasFlag(int flag) Return the state of the specified flag
protected void	initializeHeader(int typ, int flags) Initialize the blob
int	isMessageType() Return the message type
static int	isNTLMType(byte[] buf) Validate and determine the NTLM message type
static int	isNTLMType(byte[] buf, int offset) Validate and determine the NTLM message type
protected int	setByteValue(int offset, byte[] byts, int dataOffset) Set a byte array value
protected abstract void	setFlags(int flags) Set the message flags
protected void	setIntValue(int offset, int val) Set an int/32bit value
protected void	setLength(int len) Set the message length
void	setMessageType(int typ) Set the message type
protected void	setRawBytes(int offset, byte[] byts) Set a raw byte value
protected void	setRawInts(int offset, int[] ints) Set raw int values
protected int	setRawString(int offset, java.lang.String str, boolean isuni) Pack a raw string
protected void	setShortValue(int offset, int sval) Set a short/16bit value
protected int	setStringValue(int offset, java.lang.String val, int strOffset, boolean isuni) Set a string value
protected void	zeroBytes(int offset, int len) Zero out an area of bytes

Methods inherited from class java.lang.Object

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

Field Detail

OffsetSignature

public static final int OffsetSignature

See Also:

Constant Field Values

OffsetType

public static final int OffsetType

See Also:

Constant Field Values

BufferHeaderLen

public static final int BufferHeaderLen

See Also:

Constant Field Values

Constructor Detail

NTLMMessage

protected NTLMMessage()

Default constructor

NTLMMessage

protected NTLMMessage(byte[] buf,
           int offset,
           int len)

Class constructor

Parameters:

buf - byte[]

offset - int

len - int

Method Detail

isMessageType

public final int isMessageType()

Return the message type

Returns:

int

getFlags

public abstract int getFlags()

Return the message flags

Returns:

int

hasFlag

public final boolean hasFlag(int flag)

Return the state of the specified flag

Parameters:

flag - int

Returns:

boolean

getLength

public int getLength()

Return the message length

Returns:

int

setMessageType

public final void setMessageType(int typ)

Set the message type

Parameters:

typ - int

copyFrom

public final void copyFrom(byte[] buf,
            int offset,
            int len)

Copy the NTLM blob data from the specified buffer

Parameters:

buf - byte[]

offset - int

len - int

getBytes

public final byte[] getBytes()

Return the NTLM message as a byte array

Returns:

byte[]

setFlags

protected abstract void setFlags(int flags)

Set the message flags

Parameters:

flags - int

initializeHeader

protected void initializeHeader(int typ,
                    int flags)

Initialize the blob

Parameters:

typ - int

flags - int

getShortValue

protected final int getShortValue(int offset)

Return a short/16bit value

Parameters:

offset - int

Returns:

int

getIntValue

protected final int getIntValue(int offset)

Return an int/32bit value

Parameters:

offset - int

Returns:

int

getByteOffset

protected final int getByteOffset(int offset)

Return the offset for a byte value

Parameters:

offset - int

Returns:

int

getByteValue

protected final byte[] getByteValue(int offset)

Return a byte value that has a header

Parameters:

offset - int

Returns:

byte[]

getRawBytes

protected final byte[] getRawBytes(int offset,
                 int len)

Return a block of byte data

Parameters:

offset - int

len - int

Returns:

byte[]

getStringLength

protected final int getStringLength(int offset)

Return the length of a string

Parameters:

offset - int

Returns:

int

getStringAllocatedLength

protected final int getStringAllocatedLength(int offset)

Return the allocated length of a string

Parameters:

offset - int

Returns:

int

getStringOffset

protected final int getStringOffset(int offset)

Return the string data offset

Parameters:

offset - int

Returns:

int

getStringValue

protected final java.lang.String getStringValue(int offset,
                              boolean isuni)

Return a string value

Parameters:

offset - int

isuni - boolean

Returns:

String

getRawString

protected final java.lang.String getRawString(int offset,
                            int len,
                            boolean isuni)

Return a raw string

Parameters:

offset - int

len - int

isuni - boolean

Returns:

String

setShortValue

protected final void setShortValue(int offset,
                 int sval)

Set a short/16bit value

Parameters:

offset - int

sval - int

setIntValue

protected final void setIntValue(int offset,
               int val)

Set an int/32bit value

Parameters:

offset - int

val - int

setRawBytes

protected final void setRawBytes(int offset,
               byte[] byts)

Set a raw byte value

Parameters:

offset - int

byts - byte[]

setRawInts

protected final void setRawInts(int offset,
              int[] ints)

Set raw int values

Parameters:

offset - int

ints - int[]

setRawString

protected final int setRawString(int offset,
               java.lang.String str,
               boolean isuni)

Pack a raw string

Parameters:

offset - int

str - String

isuni - boolean

Returns:

int

zeroBytes

protected final void zeroBytes(int offset,
             int len)

Zero out an area of bytes

Parameters:

offset - int

len - int

setByteValue

protected final int setByteValue(int offset,
               byte[] byts,
               int dataOffset)

Set a byte array value

Parameters:

offset - int

byts - byte[]

dataOffset - int

Returns:

int

setStringValue

protected final int setStringValue(int offset,
                 java.lang.String val,
                 int strOffset,
                 boolean isuni)

Set a string value

Parameters:

offset - int

val - String

strOffset - int

isuni - boolean

Returns:

int

setLength

protected final void setLength(int len)

Set the message length

Parameters:

len - int

isNTLMType

public static final int isNTLMType(byte[] buf)

Validate and determine the NTLM message type

Parameters:

buf - byte[]

Returns:

int

isNTLMType

public static final int isNTLMType(byte[] buf,
             int offset)

Validate and determine the NTLM message type

Parameters:

buf - byte[]

offset - int

Returns:

int