Module jcifs

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

Class Smb2NegotiateResponse

java.lang.Object

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

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

org.codelibs.jcifs.smb.internal.smb2.nego.Smb2NegotiateResponse

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockResponse, SmbNegotiationResponse, Message, Response

public class Smb2NegotiateResponse
extends ServerMessageBlock2Response
implements SmbNegotiationResponse

SMB2 Negotiate Protocol response message. This response contains the server's protocol capabilities, security mode, and negotiated dialect version.

Author:

mbechler

Field Summary

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
Smb2NegotiateResponse(Configuration cfg)	Constructs an SMB2 negotiate response with the given configuration.

Method Summary

Modifier and Type	Method	Description
boolean	canReuse(CIFSContext tc, boolean forceSigning)	Checks whether a connection can be reused for the given configuration.
protected static NegotiateContextResponse	createContext(int type)	Creates a negotiate context response based on the context type.
final int	getCapabilities()	Gets the capabilities returned by the server.
final int	getCommonCapabilities()	Gets the common capabilities negotiated between client and server.
int	getDialectRevision()	Gets the SMB dialect revision selected by the server.
int	getInitialCredits()	Gets the number of initial credits granted by the server for SMB2.
int	getMaxTransactSize()	Gets the maximum transaction size supported by the server.
NegotiateContextResponse[]	getNegotiateContexts()	Gets the negotiate contexts from the SMB 3.1.1 negotiation response.
int	getReceiveBufferSize()	Gets the negotiated receive buffer size.
byte[]	getSecurityBlob()	Gets the initial security blob for authentication negotiation.
int	getSecurityMode()	Gets the security mode flags from the server.
int	getSelectedCipher()	Gets the encryption cipher selected for SMB3 encryption.
DialectVersion	getSelectedDialect()	Gets the SMB dialect version selected by the server.
int	getSelectedPreauthHash()	Gets the pre-authentication integrity hash algorithm selected for SMB 3.1.1.
int	getSendBufferSize()	Gets the negotiated send buffer size.
byte[]	getServerGuid()	Gets the server GUID used for identification.
long	getServerStartTime()	Gets the server start time timestamp.
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	isEncryptionSupported()	Checks whether SMB3 encryption is supported by the server.
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 tc, SmbNegotiationRequest req)	Check if the negotiation response is valid
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body 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 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, prepare, 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, isErrorResponseStatus, isRetainPayload, pad8, readErrorResponse, readHeaderWireFormat, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, setResponse, setSessionId, setTreeId, setUid, size8, size8, 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, reset, 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

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

Constructor Details

Smb2NegotiateResponse

public Smb2NegotiateResponse(Configuration cfg)

Constructs an SMB2 negotiate response with the given configuration.

Parameters:

cfg - the configuration for this response

Method Details

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()

getDialectRevision

public int getDialectRevision()

Gets the SMB dialect revision selected by the server.

Returns:

the dialectRevision

getServerGuid

public byte[] getServerGuid()

Gets the server GUID used for identification.

Returns:

the serverGuid

getSelectedDialect

public DialectVersion getSelectedDialect()

Description copied from interface: SmbNegotiationResponse

Gets the SMB dialect version selected by the server.

Specified by:

getSelectedDialect in interface SmbNegotiationResponse

Returns:

the selectedDialect

getSelectedCipher

public int getSelectedCipher()

Gets the encryption cipher selected for SMB3 encryption.

Returns:

the selectedCipher

getSelectedPreauthHash

public int getSelectedPreauthHash()

Gets the pre-authentication integrity hash algorithm selected for SMB 3.1.1.

Returns:

the selectedPreauthHash

getCapabilities

public final int getCapabilities()

Gets the capabilities returned by the server.

Returns:

the server returned capabilities

getCommonCapabilities

public final int getCommonCapabilities()

Gets the common capabilities negotiated between client and server.

Returns:

the common/negotiated capabilities

getSecurityBlob

public byte[] getSecurityBlob()

Gets the initial security blob for authentication negotiation.

Returns:

initial security blob

getMaxTransactSize

public int getMaxTransactSize()

Gets the maximum transaction size supported by the server.

Returns:

the maxTransactSize

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()

getNegotiateContexts

public NegotiateContextResponse[] getNegotiateContexts()

Gets the negotiate contexts from the SMB 3.1.1 negotiation response.

Returns:

the negotiateContexts

getServerStartTime

public long getServerStartTime()

Gets the server start time timestamp.

Returns:

the serverStartTime

getSecurityMode

public int getSecurityMode()

Gets the security mode flags from the server.

Returns:

the securityMode

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()

isEncryptionSupported

public boolean isEncryptionSupported()

Checks whether SMB3 encryption is supported by the server.

Returns:

whether SMB encryption is supported by the server

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)

isValid

public boolean isValid(CIFSContext tc,
 SmbNegotiationRequest req)

Description copied from interface: SmbNegotiationResponse

Check if the negotiation response is valid

Specified by:

isValid in interface SmbNegotiationResponse

Parameters:

tc - the CIFS context

req - the negotiation request

Returns:

whether the protocol negotiation was successful

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()

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()

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()

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)

readBytesWireFormat

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

Description copied from class: ServerMessageBlock2

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 decoding fails

createContext

protected static NegotiateContextResponse createContext(int type)

Creates a negotiate context response based on the context type.

Parameters:

type - the negotiate context type

Returns:

the appropriate negotiate context response, or null if not recognized

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)

toString

public String toString()

Overrides:

toString in class ServerMessageBlock2