Module jcifs

Package org.codelibs.jcifs.smb.internal.smb1.com

Class SmbComNegotiateResponse

java.lang.Object

org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

org.codelibs.jcifs.smb.internal.smb1.com.SmbComNegotiateResponse

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, RequestWithPath, SmbNegotiationResponse, Message, Request, Response

public class SmbComNegotiateResponse
extends ServerMessageBlock
implements SmbNegotiationResponse

SMB1 Negotiate Protocol Response message. This response contains information about the server's capabilities, security mode, and supported protocol version.

Field Summary

Fields inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

batchLevel, byteCount, digest, errorCode, flags2, headerStart, length, mid, path, pid, SMB_COM_CHECK_DIRECTORY, SMB_COM_CLOSE, SMB_COM_CREATE_DIRECTORY, SMB_COM_DELETE, SMB_COM_DELETE_DIRECTORY, SMB_COM_ECHO, SMB_COM_FIND_CLOSE2, SMB_COM_LOCKING_ANDX, SMB_COM_LOGOFF_ANDX, SMB_COM_MOVE, SMB_COM_NEGOTIATE, SMB_COM_NT_CANCEL, SMB_COM_NT_CREATE_ANDX, SMB_COM_NT_TRANSACT, SMB_COM_NT_TRANSACT_SECONDARY, SMB_COM_OPEN_ANDX, SMB_COM_QUERY_INFORMATION, SMB_COM_READ_ANDX, SMB_COM_RENAME, SMB_COM_SEEK, SMB_COM_SESSION_SETUP_ANDX, SMB_COM_SET_INFORMATION, SMB_COM_TRANSACTION, SMB_COM_TRANSACTION_SECONDARY, SMB_COM_TRANSACTION2, SMB_COM_TREE_CONNECT_ANDX, SMB_COM_TREE_DISCONNECT, SMB_COM_WRITE, SMB_COM_WRITE_ANDX, tid, uid, wordCount

Constructor Summary

Constructors

Constructor	Description
SmbComNegotiateResponse(CIFSContext ctx)	Creates a new SMB1 negotiate response.

Method Summary

Modifier and Type	Method	Description
boolean	canReuse(CIFSContext tc, boolean forceSigning)	Checks whether a connection can be reused for the given configuration.
int	getDialectIndex()	Returns the index of the selected SMB dialect from the negotiation.
int	getInitialCredits()	Gets the number of initial credits granted by the server for SMB2.
int	getNegotiatedCapabilities()	Returns the server capabilities negotiated during the SMB handshake.
int	getNegotiatedFlags2()	Gets the negotiated flags2 value.
int	getNegotiatedMpxCount()	Gets the negotiated multiplex count.
int	getNegotiatedSendBufferSize()	Gets the negotiated send buffer size.
int	getNegotiatedSessionKey()	Gets the negotiated session key.
int	getReceiveBufferSize()	Gets the negotiated receive buffer size.
DialectVersion	getSelectedDialect()	Gets the SMB dialect version selected by the server.
int	getSendBufferSize()	Gets the negotiated send buffer size.
ServerData	getServerData()	Gets the server data containing negotiated server capabilities and properties.
int	getTransactionBufferSize()	Gets the negotiated maximum transaction buffer size.
boolean	haveCapabilitiy(int cap)	Checks whether a specific capability has been negotiated.
boolean	isDFSSupported()	Checks whether the server supports Distributed File System (DFS).
boolean	isSigningEnabled()	Checks whether the server has SMB message signing enabled.
boolean	isSigningNegotiated()	Checks whether SMB message signing has been successfully negotiated.
boolean	isSigningRequired()	Checks whether the server requires SMB message signing.
boolean	isValid(CIFSContext ctx, SmbNegotiationRequest req)	Check if the negotiation response is valid
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the data bytes portion of the SMB message from the wire format.
protected int	readParameterWordsWireFormat(byte[] buffer, int bufferIndex)	Reads the parameter words portion of the SMB message from the wire format.
void	setupRequest(CommonServerMessageBlock request)	Sets up the given request with negotiated parameters.
void	setupResponse(Response resp)	Sets up the given response with negotiated parameters.
String	toString()
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the data bytes portion of the SMB message to the wire format.
protected int	writeParameterWordsWireFormat(byte[] dst, int dstIndex)	Writes the parameter words portion of the SMB message to the wire format.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

addFlags2, allowChain, clearReceived, createCancel, decode, encode, equals, error, exception, getByteCount, getCommand, getConfig, getCreditCost, getDigest, getDomain, getErrorCode, getException, getExpiration, getFlags, getFlags2, getFullUNCPath, getGrantedCredits, getLength, getMid, getNext, getNextResponse, getOverrideTimeout, getPath, getPid, getRawPayload, getResponse, getServer, getSignSeq, getTid, getUid, hashCode, ignoreDisconnect, isAsync, isCancel, isError, isExtendedSecurity, isForceUnicode, isReceived, isResolveInDfs, isResponse, isResponseAsync, isRetainPayload, isUseUnicode, isVerifyFailed, prepare, readHeaderWireFormat, readString, readString, readString, readStringLength, received, remFlags2, reset, retainPayload, setCommand, setDigest, setErrorCode, setExpiration, setExtendedSecurity, setFlags, setFlags2, setFullUNCPath, setMid, setOverrideTimeout, setPath, setPid, setRawPayload, setRequestCredits, setResolveInDfs, setResponse, setSessionId, setSignSeq, setTid, setUid, setUseUnicode, size, split, stringWireLength, verifySignature, writeHeaderWireFormat, writeString, writeString

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, reset, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

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

clearReceived, error, exception, getErrorCode, getException, getExpiration, getGrantedCredits, getMid, isError, isReceived, isVerifyFailed, received, reset, setExpiration, setMid, verifySignature

Constructor Details

SmbComNegotiateResponse

public SmbComNegotiateResponse(CIFSContext ctx)

Creates a new SMB1 negotiate response.

Parameters:

ctx - the CIFS context

Method Details

getSelectedDialect

public DialectVersion getSelectedDialect()

Gets the SMB dialect version selected by the server.

Specified by:

getSelectedDialect in interface SmbNegotiationResponse

Returns:

selected dialect

See Also:

• SmbNegotiationResponse.getSelectedDialect()

getTransactionBufferSize

public int getTransactionBufferSize()

Gets the negotiated maximum transaction buffer size.

Specified by:

getTransactionBufferSize in interface SmbNegotiationResponse

Returns:

the transaction buffer size

See Also:

• SmbNegotiationResponse.getTransactionBufferSize()

getInitialCredits

public int getInitialCredits()

Gets the number of initial credits granted by the server for SMB2.

Specified by:

getInitialCredits in interface SmbNegotiationResponse

Returns:

number of initial credits the server grants

See Also:

• SmbNegotiationResponse.getInitialCredits()

canReuse

public boolean canReuse(CIFSContext tc,
 boolean forceSigning)

Checks whether a connection can be reused for the given configuration.

Specified by:

canReuse in interface SmbNegotiationResponse

Parameters:

tc - the CIFS context to check compatibility with

forceSigning - whether signing is being forced

Returns:

whether a connection can be reused for this config

See Also:

• SmbNegotiationResponse.canReuse(org.codelibs.jcifs.smb.CIFSContext, boolean)

getDialectIndex

public int getDialectIndex()

Returns the index of the selected SMB dialect from the negotiation.

Returns:

the dialectIndex

getNegotiatedCapabilities

public int getNegotiatedCapabilities()

Returns the server capabilities negotiated during the SMB handshake.

Returns:

the negotiated capabilities

getNegotiatedSendBufferSize

public int getNegotiatedSendBufferSize()

Gets the negotiated send buffer size.

Returns:

negotiated send buffer size

getNegotiatedMpxCount

public int getNegotiatedMpxCount()

Gets the negotiated multiplex count.

Returns:

negotiated multiplex count

getNegotiatedSessionKey

public int getNegotiatedSessionKey()

Gets the negotiated session key.

Returns:

negotiated session key

getReceiveBufferSize

public int getReceiveBufferSize()

Gets the negotiated receive buffer size.

Specified by:

getReceiveBufferSize in interface SmbNegotiationResponse

Returns:

the receive buffer size

See Also:

• SmbNegotiationResponse.getReceiveBufferSize()

getSendBufferSize

public int getSendBufferSize()

Gets the negotiated send buffer size.

Specified by:

getSendBufferSize in interface SmbNegotiationResponse

Returns:

the send buffer size

See Also:

• SmbNegotiationResponse.getSendBufferSize()

getNegotiatedFlags2

public int getNegotiatedFlags2()

Gets the negotiated flags2 value.

Returns:

negotiated flags2

haveCapabilitiy

public boolean haveCapabilitiy(int cap)

Checks whether a specific capability has been negotiated.

Specified by:

haveCapabilitiy in interface SmbNegotiationResponse

Parameters:

cap - the capability flag to check

Returns:

whether capability is negotiated

See Also:

• SmbNegotiationResponse.haveCapabilitiy(int)

isDFSSupported

public boolean isDFSSupported()

Checks whether the server supports Distributed File System (DFS).

Specified by:

isDFSSupported in interface SmbNegotiationResponse

Returns:

whether the server supports DFS

See Also:

• SmbNegotiationResponse.isDFSSupported()

isSigningNegotiated

public boolean isSigningNegotiated()

Checks whether SMB message signing has been successfully negotiated.

Specified by:

isSigningNegotiated in interface SmbNegotiationResponse

Returns:

whether signing has been negotiated

See Also:

• SmbNegotiationResponse.isSigningNegotiated()

isValid

public boolean isValid(CIFSContext ctx,
 SmbNegotiationRequest req)

Description copied from interface: SmbNegotiationResponse

Check if the negotiation response is valid

Specified by:

isValid in interface SmbNegotiationResponse

Parameters:

ctx - the CIFS context

req - the negotiation request

Returns:

whether the protocol negotiation was successful

setupRequest

public void setupRequest(CommonServerMessageBlock request)

Sets up the given request with negotiated parameters.

Specified by:

setupRequest in interface SmbNegotiationResponse

Parameters:

request - the request to configure

See Also:

• SmbNegotiationResponse.setupRequest(org.codelibs.jcifs.smb.internal.CommonServerMessageBlock)

setupResponse

public void setupResponse(Response resp)

Sets up the given response with negotiated parameters.

Specified by:

setupResponse in interface SmbNegotiationResponse

Parameters:

resp - the response to configure

See Also:

• SmbNegotiationResponse.setupResponse(org.codelibs.jcifs.smb.util.transport.Response)

isSigningEnabled

public boolean isSigningEnabled()

Checks whether the server has SMB message signing enabled.

Specified by:

isSigningEnabled in interface SmbNegotiationResponse

Returns:

whether the server has signing enabled

See Also:

• SmbNegotiationResponse.isSigningEnabled()

isSigningRequired

public boolean isSigningRequired()

Checks whether the server requires SMB message signing.

Specified by:

isSigningRequired in interface SmbNegotiationResponse

Returns:

whether the server requires signing

See Also:

• SmbNegotiationResponse.isSigningRequired()

getServerData

public ServerData getServerData()

Gets the server data containing negotiated server capabilities and properties.

Returns:

the server

writeParameterWordsWireFormat

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

Description copied from class: ServerMessageBlock

Writes the parameter words portion of the SMB message to the wire format.

Specified by:

writeParameterWordsWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

writeBytesWireFormat

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

Description copied from class: ServerMessageBlock

Writes the data bytes portion of the SMB message to the wire format.

Specified by:

writeBytesWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

readParameterWordsWireFormat

protected int readParameterWordsWireFormat(byte[] buffer,
 int bufferIndex)

Description copied from class: ServerMessageBlock

Reads the parameter words portion of the SMB message from the wire format.

Specified by:

readParameterWordsWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

readBytesWireFormat

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

Description copied from class: ServerMessageBlock

Reads the data bytes portion of the SMB message from the wire format.

Specified by:

readBytesWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

toString

public String toString()

Overrides:

toString in class ServerMessageBlock