/* packet-smb.h * Defines for SMB packet dissection * Copyright 1999, Richard Sharpe * * Wireshark - Network traffic analyzer * By Gerald Combs * Copyright 1998, 1999 Gerald Combs * * SPDX-License-Identifier: GPL-2.0-or-later */ #ifndef __PACKET_SMB_H__ #define __PACKET_SMB_H__ #include "ws_symbol_export.h" #include #include WS_DLL_PUBLIC bool sid_name_snooping; /* SMB command codes, from the SNIA CIFS spec. With MSVC and a * libwireshark.dll, we need a special declaration. */ WS_DLL_PUBLIC value_string_ext smb_cmd_vals_ext; WS_DLL_PUBLIC value_string_ext trans2_cmd_vals_ext; WS_DLL_PUBLIC value_string_ext nt_cmd_vals_ext; #define SMB_COM_CREATE_DIRECTORY 0x00 #define SMB_COM_DELETE_DIRECTORY 0x01 #define SMB_COM_OPEN 0x02 #define SMB_COM_CREATE 0x03 #define SMB_COM_CLOSE 0x04 #define SMB_COM_FLUSH 0x05 #define SMB_COM_DELETE 0x06 #define SMB_COM_RENAME 0x07 #define SMB_COM_QUERY_INFORMATION 0x08 #define SMB_COM_SET_INFORMATION 0x09 #define SMB_COM_READ 0x0A #define SMB_COM_WRITE 0x0B #define SMB_COM_LOCK_BYTE_RANGE 0x0C #define SMB_COM_UNLOCK_BYTE_RANGE 0x0D #define SMB_COM_CREATE_TEMPORARY 0x0E #define SMB_COM_CREATE_NEW 0x0F #define SMB_COM_CHECK_DIRECTORY 0x10 #define SMB_COM_PROCESS_EXIT 0x11 #define SMB_COM_SEEK 0x12 #define SMB_COM_LOCK_AND_READ 0x13 #define SMB_COM_WRITE_AND_UNLOCK 0x14 #define SMB_COM_READ_RAW 0x1A #define SMB_COM_READ_MPX 0x1B #define SMB_COM_READ_MPX_SECONDARY 0x1C #define SMB_COM_WRITE_RAW 0x1D #define SMB_COM_WRITE_MPX 0x1E #define SMB_COM_WRITE_MPX_SECONDARY 0x1F #define SMB_COM_WRITE_COMPLETE 0x20 #define SMB_COM_QUERY_SERVER 0x21 #define SMB_COM_SET_INFORMATION2 0x22 #define SMB_COM_QUERY_INFORMATION2 0x23 #define SMB_COM_LOCKING_ANDX 0x24 #define SMB_COM_TRANSACTION 0x25 #define SMB_COM_TRANSACTION_SECONDARY 0x26 #define SMB_COM_IOCTL 0x27 #define SMB_COM_IOCTL_SECONDARY 0x28 #define SMB_COM_COPY 0x29 #define SMB_COM_MOVE 0x2A #define SMB_COM_ECHO 0x2B #define SMB_COM_WRITE_AND_CLOSE 0x2C #define SMB_COM_OPEN_ANDX 0x2D #define SMB_COM_READ_ANDX 0x2E #define SMB_COM_WRITE_ANDX 0x2F #define SMB_COM_NEW_FILE_SIZE 0x30 #define SMB_COM_CLOSE_AND_TREE_DISC 0x31 #define SMB_COM_TRANSACTION2 0x32 #define SMB_COM_TRANSACTION2_SECONDARY 0x33 #define SMB_COM_FIND_CLOSE2 0x34 #define SMB_COM_FIND_NOTIFY_CLOSE 0x35 /* Used by Xenix/Unix 0x60-0x6E */ #define SMB_COM_TREE_CONNECT 0x70 #define SMB_COM_TREE_DISCONNECT 0x71 #define SMB_COM_NEGOTIATE 0x72 #define SMB_COM_SESSION_SETUP_ANDX 0x73 #define SMB_COM_LOGOFF_ANDX 0x74 #define SMB_COM_TREE_CONNECT_ANDX 0x75 #define SMB_COM_QUERY_INFORMATION_DISK 0x80 #define SMB_COM_SEARCH 0x81 #define SMB_COM_FIND 0x82 #define SMB_COM_FIND_UNIQUE 0x83 #define SMB_COM_FIND_CLOSE 0x84 #define SMB_COM_NT_TRANSACT 0xA0 #define SMB_COM_NT_TRANSACT_SECONDARY 0xA1 #define SMB_COM_NT_CREATE_ANDX 0xA2 #define SMB_COM_NT_CANCEL 0xA4 #define SMB_COM_NT_RENAME 0xA5 #define SMB_COM_OPEN_PRINT_FILE 0xC0 #define SMB_COM_WRITE_PRINT_FILE 0xC1 #define SMB_COM_CLOSE_PRINT_FILE 0xC2 #define SMB_COM_GET_PRINT_QUEUE 0xC3 #define SMB_COM_READ_BULK 0xD8 #define SMB_COM_WRITE_BULK 0xD9 #define SMB_COM_WRITE_BULK_DATA 0xDA /* Error codes */ #define SMB_SUCCESS 0x00 /* All OK */ #define SMB_ERRDOS 0x01 /* DOS based error */ #define SMB_ERRSRV 0x02 /* server error, network file manager */ #define SMB_ERRHRD 0x03 /* Hardware style error */ #define SMB_ERRCMD 0x04 /* Not an SMB format command */ /* used for SMB export object functionality */ typedef struct _smb_eo_t { unsigned smbversion; uint16_t cmd; int tid,uid; unsigned fid; uint32_t pkt_num; char *hostname; char *filename; int fid_type; int64_t end_of_file; char *content_type; uint32_t payload_len; const uint8_t *payload_data; uint64_t smb_file_offset; uint32_t smb_chunk_len; } smb_eo_t; /* the information we need to keep around for NT transaction commands */ typedef struct { int subcmd; int fid_type; uint32_t ioctl_function; } smb_nt_transact_info_t; /* the information we need to keep around for transaction2 commands * t2i and st2i */ typedef struct { int subcmd; int info_level; bool resume_keys; /* if "return resume" keys set in T2 FIND_FIRST request */ const char *name; } smb_transact2_info_t; /* * The information we need to save about a request in order to show the * frame number of the request in the dissection of the reply. */ #define SMB_SIF_TID_IS_IPC 0x0001 #define SMB_SIF_IS_CONTINUED 0x0002 typedef enum { SMB_EI_NONE, /* Unassigned / NULL */ SMB_EI_FID, /* FID */ SMB_EI_NTI, /* smb_nt_transact_info_t * */ SMB_EI_TRI, /* smb_transact_info_t * */ SMB_EI_T2I, /* smb_transact2_info_t * */ SMB_EI_TIDNAME, /* tid tracking char * */ SMB_EI_FILEDATA, /* fid tracking */ SMB_EI_FILENAME, /* filename tracking */ SMB_EI_UID, /* smb_uid_t */ SMB_EI_RWINFO, /* read/write offset/count info */ SMB_EI_LOCKDATA, /* locking and x data */ SMB_EI_RENAMEDATA, /* rename data */ SMB_EI_DIALECTS /* negprot dialects */ } smb_extra_info_t; typedef struct _smb_fid_into_t smb_fid_info_t; /* sip */ typedef struct { uint32_t frame_req, frame_res; nstime_t req_time; uint16_t flags; uint8_t cmd; void *extra_info; smb_extra_info_t extra_info_type; /* we save the fid in each transaction so that we can get fid filters to match both request and response */ bool fid_seen_in_request; uint16_t fid; } smb_saved_info_t; /* * The information we need to save about a Transaction request in order * to dissect the reply; this includes information for use by the * Remote API and Mailslot dissectors. * XXX - have an additional data structure hung off of this by the * subdissectors? * tri */ typedef struct { int subcmd; int trans_subcmd; int function; /* Unification of fid variable type (was int) */ uint16_t fid; uint16_t lanman_cmd; unsigned char *param_descrip; /* Keep these descriptors around */ unsigned char *data_descrip; unsigned char *aux_data_descrip; int info_level; } smb_transact_info_t; /* * Subcommand type. */ #define TRANSACTION_PIPE 0 #define TRANSACTION_MAILSLOT 1 /* these are defines used to represent different types of TIDs. don't use the value 0 for any of these */ #define TID_NORMAL 1 #define TID_IPC 2 /* this is the structure which is associated with each conversation */ typedef struct conv_tables { /* these two tables are used to match requests with responses */ GHashTable *unmatched; GHashTable *matched; /* This table keeps primary transact requests so secondaries can find them */ GHashTable *primaries; /* This table is used to track TID->services for a conversation */ GHashTable *tid_service; bool raw_ntlmssp; /* Do extended security exc use raw ntlmssp */ /* track fid to fidstruct (filename/openframe/closeframe */ wmem_tree_t *fid_tree; /* We'll use a GSL list instead */ GSList *GSL_fid_info; /* track tid to fidstruct (sharename/shareframe/unshareframe */ wmem_tree_t *tid_tree; /* track uid to username mappings */ wmem_tree_t *uid_tree; } conv_tables_t; /* si */ typedef struct smb_info { uint8_t cmd; int tid, pid, uid, mid; uint32_t nt_status; bool unicode; /* Are strings in this SMB Unicode? */ bool request; /* Is this a request? */ bool unidir; int info_level; int info_count; smb_saved_info_t *sip; /* smb_saved_info_t, if any, for this */ conv_tables_t *ct; } smb_info_t; /* * Show file data for a read or write. */ extern int dissect_file_data(tvbuff_t *tvb, proto_tree *tree, int offset, uint16_t bc, int dataoffset, uint16_t datalen); #define SMB_FID_TYPE_UNKNOWN 0 #define SMB_FID_TYPE_FILE 1 #define SMB_FID_TYPE_DIR 2 #define SMB_FID_TYPE_PIPE 3 /* used for tracking filenames from rename request to response */ typedef struct _smb_rename_saved_info_t { char *old_name; char *new_name; } smb_rename_saved_info_t; /* used for tracking lock data between lock request/response */ typedef struct _smb_lock_info_t { struct _smb_lock_info_t *next; uint16_t pid; uint64_t offset; uint64_t length; } smb_lock_info_t; typedef struct _smb_locking_saved_info_t { uint8_t type; uint8_t oplock_level; uint16_t num_lock; uint16_t num_unlock; smb_lock_info_t *locks; smb_lock_info_t *unlocks; } smb_locking_saved_info_t; /* used for tracking fid/tid to filename/sharename openedframe closedframe */ typedef struct _smb_fid_saved_info_t { char *filename; uint32_t create_flags; uint32_t access_mask; uint32_t file_attributes; uint32_t share_access; uint32_t create_options; uint32_t create_disposition; } smb_fid_saved_info_t; struct _smb_fid_into_t { uint16_t tid,fid; /* The end_of_file will store the last registered offset or the reported end_of_file from the SMB protocol */ int64_t end_of_file; /* These two were int */ unsigned opened_in; unsigned closed_in; int type; smb_fid_saved_info_t *fsi; }; /* used for tracking tid to sharename openedframe closedframe */ typedef struct _smb_tid_into_t { int opened_in; int closed_in; char *filename; int type; } smb_tid_info_t; /* * Dissect an smb FID */ extern smb_fid_info_t *dissect_smb_fid(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, int len, uint16_t fid, bool is_created, bool is_closed, bool is_generated, smb_info_t* si); /* * Dissect named pipe state information. */ extern int dissect_ipc_state(tvbuff_t *tvb, proto_tree *parent_tree, int offset, bool setstate); extern bool smb_dcerpc_reassembly; extern const value_string create_disposition_vals[]; extern int dissect_nt_create_options(tvbuff_t *tvb, proto_tree *parent_tree, int offset); extern int dissect_nt_share_access(tvbuff_t *tvb, proto_tree *parent_tree, int offset); extern int dissect_smb_access_mask(tvbuff_t *tvb, proto_tree *parent_tree, int offset); extern const value_string oa_open_vals[]; extern const value_string impersonation_level_vals[]; extern bool sid_display_hex; extern int dissect_security_information_mask(tvbuff_t *tvb, proto_tree *parent_tree, int offset); extern int dissect_qfsi_FS_VOLUME_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp, int unicode); extern int dissect_qfsi_FS_SIZE_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp); extern int dissect_qfsi_FS_DEVICE_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp); extern int dissect_qfsi_FS_ATTRIBUTE_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp); extern int dissect_nt_quota(tvbuff_t *tvb, proto_tree *tree, int offset, uint16_t *bcp); extern int dissect_nt_user_quota(tvbuff_t *tvb, proto_tree *tree, int offset, uint16_t *bcp); extern int dissect_nt_get_user_quota(tvbuff_t *tvb, proto_tree *tree, int offset, uint32_t *bcp); extern int dissect_qfsi_FS_OBJECTID_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp); extern int dissect_qfsi_FS_FULL_SIZE_INFO(tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, int offset, uint16_t *bcp); extern int dissect_qfi_SMB_FILE_EA_INFO(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_STREAM_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *parent_tree, int offset, uint16_t *bcp, bool *trunc, int unicode); extern int dissect_qfi_SMB_FILE_NAME_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc, bool unicode); extern int dissect_qfi_SMB_FILE_STANDARD_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_INTERNAL_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qsfi_SMB_FILE_POSITION_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qsfi_SMB_FILE_MODE_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_ALIGNMENT_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_COMPRESSION_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_NETWORK_OPEN_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qfi_SMB_FILE_ATTRIBUTE_TAG_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qsfi_SMB_FILE_ALLOCATION_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_qsfi_SMB_FILE_ENDOFFILE_INFO(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_nt_notify_completion_filter(tvbuff_t *tvb, proto_tree *parent_tree, int offset); extern int dissect_sfi_SMB_FILE_PIPE_INFO(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, int offset, uint16_t *bcp, bool *trunc); extern int dissect_get_dfs_request_data(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool unicode); extern int dissect_get_dfs_referral_data(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, uint16_t *bcp, bool unicode); /* Returns an IP (v4 or v6) of the server in a SMB/SMB2 conversation */ extern const char *tree_ip_str(packet_info *pinfo, uint16_t cmd); #endif /* * Editor modelines - https://www.wireshark.org/tools/modelines.html * * Local variables: * c-basic-offset: 8 * tab-width: 8 * indent-tabs-mode: t * End: * * vi: set shiftwidth=8 tabstop=8 noexpandtab: * :indentSize=8:tabSize=8:noTabs=false: */