Module jcifs

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

Class SmbComTransaction

java.lang.Object

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

org.codelibs.jcifs.smb.internal.smb1.trans.SmbComTransaction

All Implemented Interfaces:

Enumeration<SmbComTransaction>, CommonServerMessageBlock, CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, RequestWithPath, Message, Request, Response

Direct Known Subclasses:

NetServerEnum2, NetShareEnum, SmbComNtTransaction, Trans2FindFirst2, Trans2FindNext2, Trans2GetDfsReferral, Trans2QueryFSInformation, Trans2QueryPathInformation, Trans2SetFileInformation, TransCallNamedPipe, TransPeekNamedPipe, TransTransactNamedPipe, TransWaitNamedPipe

public abstract class SmbComTransaction
extends ServerMessageBlock
implements Enumeration<SmbComTransaction>

Base class for SMB1 transaction request messages. This abstract class provides the foundation for all SMB1 transaction commands, handling parameter and data buffer encoding, multi-part transactions, and setup word management.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	dataCount	Number of data bytes being sent in this request
protected int	dataDisplacement	Displacement of these data bytes from the start of the total data block
protected int	dataOffset	Offset from the start of the SMB header to the data bytes
protected int	maxBufferSize	Maximum buffer size set in SmbTransport.sendTransaction() before nextElement called
protected int	maxDataCount	Maximum number of data bytes the server should return
protected int	maxParameterCount	Maximum number of parameter bytes the server should return
protected byte	maxSetupCount	Maximum number of setup words the server should return
protected String	name	The transaction name for named pipe transactions
static final byte	NET_SERVER_ENUM2	Network server enumeration subcommand version 2
static final byte	NET_SERVER_ENUM3	Network server enumeration subcommand version 3
static final byte	NET_SHARE_ENUM	Network share enumeration subcommand
protected int	parameterCount	Number of parameter bytes being sent in this request
protected int	parameterDisplacement	Displacement of these parameter bytes from the start of the total parameter block
protected int	parameterOffset	Offset from the start of the SMB header to the parameter bytes
protected int	primarySetupOffset	Offset to the setup words in the primary request
protected int	secondaryParameterOffset	Offset to the parameters in secondary requests
protected int	setupCount	Number of setup words in this request
protected int	timeout	Timeout in milliseconds to wait for the transaction to complete
protected int	totalDataCount	Total number of data bytes to be sent
protected int	totalParameterCount	Total number of parameter bytes to be sent
static final byte	TRANS_CALL_NAMED_PIPE	Transaction subcommand for calling a named pipe
static final byte	TRANS_PEEK_NAMED_PIPE	Transaction subcommand for peeking data from a named pipe
static final byte	TRANS_TRANSACT_NAMED_PIPE	Transaction subcommand for transacting with a named pipe
static final byte	TRANS_WAIT_NAMED_PIPE	Transaction subcommand for waiting on a named pipe
static final byte	TRANS2_FIND_FIRST2	SMB TRANS2 subcommand for finding first matching files
static final byte	TRANS2_FIND_NEXT2	SMB TRANS2 subcommand for finding next matching files
static final byte	TRANS2_GET_DFS_REFERRAL	SMB TRANS2 subcommand for getting DFS referrals
static final byte	TRANS2_QUERY_FILE_INFORMATION	SMB TRANS2 subcommand for querying file information
static final byte	TRANS2_QUERY_FS_INFORMATION	SMB TRANS2 subcommand for querying file system information
static final byte	TRANS2_QUERY_PATH_INFORMATION	SMB TRANS2 subcommand for querying path information
static final byte	TRANS2_SET_FILE_INFORMATION	SMB TRANS2 subcommand for setting file information

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

Modifier	Constructor	Description
protected	SmbComTransaction(Configuration config, byte command, byte subCommand)	Constructs a transaction request.

Method Summary

Modifier and Type	Method	Description
int	getPadding()	Gets the padding size for alignment
final byte	getSubCommand()	Gets the transaction subcommand
boolean	hasMoreElements()
SmbComTransaction	nextElement()
protected int	pad(int offset)	Calculates padding needed for the given offset
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the data bytes portion of the SMB message from the wire format.
protected abstract int	readDataWireFormat(byte[] buffer, int bufferIndex, int len)	Reads data from wire format
protected abstract int	readParametersWireFormat(byte[] buffer, int bufferIndex, int len)	Reads parameters from wire format
protected int	readParameterWordsWireFormat(byte[] buffer, int bufferIndex)	Reads the parameter words portion of the SMB message from the wire format.
protected abstract int	readSetupWireFormat(byte[] buffer, int bufferIndex, int len)	Reads setup data from wire format
byte[]	releaseBuffer()	Releases and returns the transaction buffer
void	reset()	Resets this message to its initial state.
protected void	reset(int key, String lastName)	Resets the transaction state with key and last name
void	setBuffer(byte[] buffer)	Sets the transaction buffer
final void	setMaxBufferSize(int maxBufferSize)	Sets the maximum buffer size for this transaction
final void	setMaxDataCount(int maxDataCount)	Sets the maximum data count for this transaction
final void	setSubCommand(byte subCommand)	Sets the transaction subcommand
String	toString()
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the data bytes portion of the SMB message to the wire format.
protected abstract int	writeDataWireFormat(byte[] dst, int dstIndex)	Writes data in wire format
protected abstract int	writeParametersWireFormat(byte[] dst, int dstIndex)	Writes parameters in wire format
protected int	writeParameterWordsWireFormat(byte[] dst, int dstIndex)	Writes the parameter words portion of the SMB message to the wire format.
protected abstract int	writeSetupWireFormat(byte[] dst, int dstIndex)	Writes setup data in 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, 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 java.util.Enumeration

asIterator

Field Details

TRANS2_FIND_FIRST2

public static final byte TRANS2_FIND_FIRST2

SMB TRANS2 subcommand for finding first matching files

See Also:

• Constant Field Values

TRANS2_FIND_NEXT2

public static final byte TRANS2_FIND_NEXT2

SMB TRANS2 subcommand for finding next matching files

See Also:

• Constant Field Values

TRANS2_QUERY_FS_INFORMATION

public static final byte TRANS2_QUERY_FS_INFORMATION

SMB TRANS2 subcommand for querying file system information

See Also:

• Constant Field Values

TRANS2_QUERY_PATH_INFORMATION

public static final byte TRANS2_QUERY_PATH_INFORMATION

SMB TRANS2 subcommand for querying path information

See Also:

• Constant Field Values

TRANS2_GET_DFS_REFERRAL

public static final byte TRANS2_GET_DFS_REFERRAL

SMB TRANS2 subcommand for getting DFS referrals

See Also:

• Constant Field Values

TRANS2_QUERY_FILE_INFORMATION

public static final byte TRANS2_QUERY_FILE_INFORMATION

SMB TRANS2 subcommand for querying file information

See Also:

• Constant Field Values

TRANS2_SET_FILE_INFORMATION

public static final byte TRANS2_SET_FILE_INFORMATION

SMB TRANS2 subcommand for setting file information

See Also:

• Constant Field Values

NET_SHARE_ENUM

public static final byte NET_SHARE_ENUM

Network share enumeration subcommand

See Also:

• Constant Field Values

NET_SERVER_ENUM2

public static final byte NET_SERVER_ENUM2

Network server enumeration subcommand version 2

See Also:

• Constant Field Values

NET_SERVER_ENUM3

public static final byte NET_SERVER_ENUM3

Network server enumeration subcommand version 3

See Also:

• Constant Field Values

TRANS_PEEK_NAMED_PIPE

public static final byte TRANS_PEEK_NAMED_PIPE

Transaction subcommand for peeking data from a named pipe

See Also:

• Constant Field Values

TRANS_WAIT_NAMED_PIPE

public static final byte TRANS_WAIT_NAMED_PIPE

Transaction subcommand for waiting on a named pipe

See Also:

• Constant Field Values

TRANS_CALL_NAMED_PIPE

public static final byte TRANS_CALL_NAMED_PIPE

Transaction subcommand for calling a named pipe

See Also:

• Constant Field Values

TRANS_TRANSACT_NAMED_PIPE

public static final byte TRANS_TRANSACT_NAMED_PIPE

Transaction subcommand for transacting with a named pipe

See Also:

• Constant Field Values

primarySetupOffset

protected int primarySetupOffset

Offset to the setup words in the primary request

secondaryParameterOffset

protected int secondaryParameterOffset

Offset to the parameters in secondary requests

parameterCount

protected int parameterCount

Number of parameter bytes being sent in this request

parameterOffset

protected int parameterOffset

Offset from the start of the SMB header to the parameter bytes

parameterDisplacement

protected int parameterDisplacement

Displacement of these parameter bytes from the start of the total parameter block

dataCount

protected int dataCount

Number of data bytes being sent in this request

dataOffset

protected int dataOffset

Offset from the start of the SMB header to the data bytes

dataDisplacement

protected int dataDisplacement

Displacement of these data bytes from the start of the total data block

totalParameterCount

protected int totalParameterCount

Total number of parameter bytes to be sent

totalDataCount

protected int totalDataCount

Total number of data bytes to be sent

maxParameterCount

protected int maxParameterCount

Maximum number of parameter bytes the server should return

maxDataCount

protected int maxDataCount

Maximum number of data bytes the server should return

maxSetupCount

protected byte maxSetupCount

Maximum number of setup words the server should return

timeout

protected int timeout

Timeout in milliseconds to wait for the transaction to complete

setupCount

protected int setupCount

Number of setup words in this request

name

protected String name

The transaction name for named pipe transactions

maxBufferSize

protected int maxBufferSize

Maximum buffer size set in SmbTransport.sendTransaction() before nextElement called

Constructor Details

SmbComTransaction

protected SmbComTransaction(Configuration config,
 byte command,
 byte subCommand)

Constructs a transaction request.

Parameters:

config - the configuration to use

command - the SMB command code

subCommand - the transaction subcommand code

Method Details

setMaxBufferSize

public final void setMaxBufferSize(int maxBufferSize)

Sets the maximum buffer size for this transaction

Parameters:

maxBufferSize - the maxBufferSize to set

setMaxDataCount

public final void setMaxDataCount(int maxDataCount)

Sets the maximum data count for this transaction

Parameters:

maxDataCount - the maxDataCount to set

setBuffer

public void setBuffer(byte[] buffer)

Sets the transaction buffer

Parameters:

buffer - the transaction buffer to use

releaseBuffer

public byte[] releaseBuffer()

Releases and returns the transaction buffer

Returns:

the txn_buf

getSubCommand

public final byte getSubCommand()

Gets the transaction subcommand

Returns:

the subCommand

setSubCommand

public final void setSubCommand(byte subCommand)

Sets the transaction subcommand

Parameters:

subCommand - the subCommand to set

reset

public void reset()

Description copied from interface: CommonServerMessageBlock

Resets this message to its initial state.

Specified by:

reset in interface CommonServerMessageBlock

Specified by:

reset in interface Response

Overrides:

reset in class ServerMessageBlock

reset

protected void reset(int key,
 String lastName)

Resets the transaction state with key and last name

Parameters:

key - the key to use for reset

lastName - the last name for the transaction

hasMoreElements

public boolean hasMoreElements()

Specified by:

hasMoreElements in interface Enumeration<SmbComTransaction>

nextElement

public SmbComTransaction nextElement()

Specified by:

nextElement in interface Enumeration<SmbComTransaction>

pad

protected int pad(int offset)

Calculates padding needed for the given offset

Parameters:

offset - the current offset

Returns:

padding size in bytes

getPadding

public int getPadding()

Gets the padding size for alignment

Returns:

padding size

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

writeSetupWireFormat

protected abstract int writeSetupWireFormat(byte[] dst,
 int dstIndex)

Writes setup data in wire format

Parameters:

dst - destination buffer

dstIndex - starting index in destination buffer

Returns:

number of bytes written

writeParametersWireFormat

protected abstract int writeParametersWireFormat(byte[] dst,
 int dstIndex)

Writes parameters in wire format

Parameters:

dst - destination buffer

dstIndex - starting index in destination buffer

Returns:

number of bytes written

writeDataWireFormat

protected abstract int writeDataWireFormat(byte[] dst,
 int dstIndex)

Writes data in wire format

Parameters:

dst - destination buffer

dstIndex - starting index in destination buffer

Returns:

number of bytes written

readSetupWireFormat

protected abstract int readSetupWireFormat(byte[] buffer,
 int bufferIndex,
 int len)

Reads setup data from wire format

Parameters:

buffer - source buffer

bufferIndex - starting index in source buffer

len - length of data to read

Returns:

number of bytes read

readParametersWireFormat

protected abstract int readParametersWireFormat(byte[] buffer,
 int bufferIndex,
 int len)

Reads parameters from wire format

Parameters:

buffer - source buffer

bufferIndex - starting index in source buffer

len - length of data to read

Returns:

number of bytes read

readDataWireFormat

protected abstract int readDataWireFormat(byte[] buffer,
 int bufferIndex,
 int len)

Reads data from wire format

Parameters:

buffer - source buffer

bufferIndex - starting index in source buffer

len - length of data to read

Returns:

number of bytes read

toString

public String toString()

Overrides:

toString in class ServerMessageBlock