Module jcifs

Package org.codelibs.jcifs.smb.internal.smb2.session

Class Smb2SessionSetupResponse

java.lang.Object

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Response

org.codelibs.jcifs.smb.internal.smb2.session.Smb2SessionSetupResponse

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockResponse, Message, Response

public class Smb2SessionSetupResponse
extends ServerMessageBlock2Response

SMB2 Session Setup response message. This response contains the server's authentication challenge or confirms successful session establishment.

Author:

mbechler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SMB2_SESSION_FLAG_ENCRYPT_DATA	Session flag indicating data encryption is required for this session
static final int	SMB2_SESSION_FLAGS_IS_GUEST	Session flag indicating this is a guest session
static final int	SMB2_SESSION_FLAGS_IS_NULL	Session flag indicating this is a null/anonymous session

Fields inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

SMB2_CANCEL, SMB2_CHANGE_NOTIFY, SMB2_CLOSE, SMB2_CREATE, SMB2_ECHO, SMB2_FLAGS_ASYNC_COMMAND, SMB2_FLAGS_DFS_OPERATIONS, SMB2_FLAGS_PRIORITY_MASK, SMB2_FLAGS_RELATED_OPERATIONS, SMB2_FLAGS_REPLAY_OPERATION, SMB2_FLAGS_SERVER_TO_REDIR, SMB2_FLAGS_SIGNED, SMB2_FLUSH, SMB2_IOCTL, SMB2_LOCK, SMB2_LOGOFF, SMB2_NEGOTIATE, SMB2_OPLOCK_BREAK, SMB2_QUERY_DIRECTORY, SMB2_QUERY_INFO, SMB2_READ, SMB2_SESSION_SETUP, SMB2_SET_INFO, SMB2_TREE_CONNECT, SMB2_TREE_DISCONNECT, SMB2_WRITE

Constructor Summary

Constructors

Constructor	Description
Smb2SessionSetupResponse(Configuration config)	Constructs a SMB2 session setup response with the specified configuration

Method Summary

Modifier and Type	Method	Description
byte[]	getBlob()	Gets the security blob from the session setup response
int	getSessionFlags()	Gets the session flags from the response
protected boolean	isErrorResponseStatus()	Checks if this message has an error status.
boolean	isLoggedInAsGuest()	Checks whether the session is either anonymous or a guest session
void	prepare(CommonServerMessageBlockRequest next)	Prepares this response for the next request.
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body from the wire format.
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the message body to the wire format.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Response

clearReceived, error, exception, getErrorCode, getException, getExpiration, getGrantedCredits, getNextResponse, haveResponse, isAsyncHandled, isError, isReceived, isSigned, isVerifyFailed, received, reset, setAsyncHandled, setExpiration, verifySignature

Methods inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

addFlags, chain, clearFlags, decode, decode, encode, equals, getAsyncId, getCommand, getConfig, getCredit, getCreditCharge, getDigest, getErrorContextCount, getErrorData, getFlags, getHeaderStart, getLength, getMid, getNext, getNextCommandOffset, getRawPayload, getResponse, getSessionId, getStatus, getTreeId, hashCode, isAsync, isRetainPayload, pad8, readErrorResponse, readHeaderWireFormat, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, setResponse, setSessionId, setTreeId, setUid, size8, size8, toString, writeHeaderWireFormat

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlock

decode, encode, getCommand, getDigest, getMid, getResponse, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlockResponse

isAsync

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Message

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Response

getMid, setMid

Field Details

SMB2_SESSION_FLAGS_IS_GUEST

public static final int SMB2_SESSION_FLAGS_IS_GUEST

Session flag indicating this is a guest session

See Also:

• Constant Field Values

SMB2_SESSION_FLAGS_IS_NULL

public static final int SMB2_SESSION_FLAGS_IS_NULL

Session flag indicating this is a null/anonymous session

See Also:

• Constant Field Values

SMB2_SESSION_FLAG_ENCRYPT_DATA

public static final int SMB2_SESSION_FLAG_ENCRYPT_DATA

Session flag indicating data encryption is required for this session

See Also:

• Constant Field Values

Constructor Details

Smb2SessionSetupResponse

public Smb2SessionSetupResponse(Configuration config)

Constructs a SMB2 session setup response with the specified configuration

Parameters:

config - the configuration to use for this response

Method Details

prepare

public void prepare(CommonServerMessageBlockRequest next)

Prepares this response for the next request.

Specified by:

prepare in interface CommonServerMessageBlockResponse

Overrides:

prepare in class ServerMessageBlock2Response

Parameters:

next - the next request to prepare for

See Also:

• ServerMessageBlock2Response.prepare(org.codelibs.jcifs.smb.internal.CommonServerMessageBlockRequest)

isErrorResponseStatus

protected boolean isErrorResponseStatus()

Checks if this message has an error status.

Overrides:

isErrorResponseStatus in class ServerMessageBlock2

Returns:

true if the message has an error status

See Also:

• ServerMessageBlock2.isErrorResponseStatus()

writeBytesWireFormat

protected int writeBytesWireFormat(byte[] dst,
 int dstIndex)

Writes the message body to the wire format.

Specified by:

writeBytesWireFormat in class ServerMessageBlock2

Parameters:

dst - the destination buffer

dstIndex - the starting position in the buffer

Returns:

number of bytes written

See Also:

• ServerMessageBlock2.writeBytesWireFormat(byte[], int)

readBytesWireFormat

protected int readBytesWireFormat(byte[] buffer,
 int bufferIndex)
                           throws SMBProtocolDecodingException

Reads the message body from the wire format.

Specified by:

readBytesWireFormat in class ServerMessageBlock2

Parameters:

buffer - the buffer to read from

bufferIndex - the starting position in the buffer

Returns:

number of bytes read

Throws:

SMBProtocolDecodingException - if the response data is malformed

See Also:

• ServerMessageBlock2.readBytesWireFormat(byte[], int)

isLoggedInAsGuest

public boolean isLoggedInAsGuest()

Checks whether the session is either anonymous or a guest session

Returns:

whether the session is either anonymous or a guest session

getSessionFlags

public int getSessionFlags()

Gets the session flags from the response

Returns:

the sessionFlags

getBlob

public byte[] getBlob()

Gets the security blob from the session setup response

Returns:

security blob