suricata
util-file.c File Reference
#include "suricata-common.h"
#include "suricata.h"
#include "debug.h"
#include "flow.h"
#include "stream.h"
#include "stream-tcp.h"
#include "runmodes.h"
#include "util-hash.h"
#include "util-debug.h"
#include "util-memcmp.h"
#include "util-print.h"
#include "app-layer-parser.h"
#include "util-validate.h"
Include dependency graph for util-file.c:

Go to the source code of this file.

Functions

void FileForceFilestoreEnable (void)
 
void FileForceMagicEnable (void)
 
void FileForceMd5Enable (void)
 
void FileForceSha1Enable (void)
 
void FileForceSha256Enable (void)
 
int FileForceFilestore (void)
 
void FileReassemblyDepthEnable (uint32_t size)
 
uint32_t FileReassemblyDepth (void)
 
int FileForceMagic (void)
 
int FileForceMd5 (void)
 
int FileForceSha1 (void)
 
int FileForceSha256 (void)
 
void FileForceTrackingEnable (void)
 
void FileForceHashParseCfg (ConfNode *conf)
 Function to parse forced file hashing configuration. More...
 
uint16_t FileFlowToFlags (const Flow *flow, uint8_t direction)
 
uint64_t FileDataSize (const File *file)
 get the size of the file data More...
 
uint64_t FileTrackedSize (const File *file)
 get the size of the file More...
 
void FilePrune (FileContainer *ffc)
 
FileContainerFileContainerAlloc (void)
 allocate a FileContainer More...
 
void FileContainerRecycle (FileContainer *ffc)
 Recycle a FileContainer. More...
 
void FileContainerFree (FileContainer *ffc)
 Free a FileContainer. More...
 
void FileContainerAdd (FileContainer *ffc, File *ff)
 
int FileStore (File *ff)
 Tag a file for storing. More...
 
int FileSetTx (File *ff, uint64_t txid)
 Set the TX id for a file. More...
 
void FileContainerSetTx (FileContainer *ffc, uint64_t tx_id)
 
int FileAppendData (FileContainer *ffc, const uint8_t *data, uint32_t data_len)
 Store/handle a chunk of file data in the File structure The last file in the FileContainer will be used. More...
 
int FileAppendDataById (FileContainer *ffc, uint32_t track_id, const uint8_t *data, uint32_t data_len)
 Store/handle a chunk of file data in the File structure The file with 'track_id' in the FileContainer will be used. More...
 
int FileAppendGAPById (FileContainer *ffc, uint32_t track_id, const uint8_t *data, uint32_t data_len)
 Store/handle a chunk of file data in the File structure The file with 'track_id' in the FileContainer will be used. More...
 
void FileSetInspectSizes (File *file, const uint32_t win, const uint32_t min)
 
int FileSetRange (FileContainer *ffc, uint64_t start, uint64_t end)
 Sets the offset range for a file. More...
 
int FileOpenFileWithId (FileContainer *ffc, const StreamingBufferConfig *sbcfg, uint32_t track_id, const uint8_t *name, uint16_t name_len, const uint8_t *data, uint32_t data_len, uint16_t flags)
 Open a new File. More...
 
int FileCloseFilePtr (File *ff, const uint8_t *data, uint32_t data_len, uint16_t flags)
 
int FileCloseFile (FileContainer *ffc, const uint8_t *data, uint32_t data_len, uint16_t flags)
 Close a File. More...
 
int FileCloseFileById (FileContainer *ffc, uint32_t track_id, const uint8_t *data, uint32_t data_len, uint16_t flags)
 
void FileUpdateFlowFileFlags (Flow *f, uint16_t set_file_flags, uint8_t direction)
 set a flow's file flags More...
 
void FileDisableStoringForTransaction (Flow *f, uint8_t direction, uint64_t tx_id)
 disable file storing for files in a transaction More...
 
void FileStoreFileById (FileContainer *fc, uint32_t file_id)
 flag a file with id "file_id" to be stored. More...
 
void FileStoreAllFilesForTx (FileContainer *fc, uint64_t tx_id)
 
void FileStoreAllFiles (FileContainer *fc)
 
void FileTruncateAllOpenFiles (FileContainer *fc)
 

Variables

int g_detect_disabled
 

Detailed Description

Function Documentation

◆ FileAppendData()

int FileAppendData ( FileContainer ffc,
const uint8_t *  data,
uint32_t  data_len 
)

Store/handle a chunk of file data in the File structure The last file in the FileContainer will be used.

Store a chunk of file data in the flow. The open "flowfile" will be used.

Parameters
ffcFileContainer used to append to
datadata chunk
data_lendata chunk len
Return values
0ok
-1error
-2no store for this file

Definition at line 722 of file util-file.c.

References SCEnter, SCReturnInt, and FileContainer_::tail.

Referenced by HTPFileStoreChunk().

Here is the caller graph for this function:

◆ FileAppendDataById()

int FileAppendDataById ( FileContainer ffc,
uint32_t  track_id,
const uint8_t *  data,
uint32_t  data_len 
)

Store/handle a chunk of file data in the File structure The file with 'track_id' in the FileContainer will be used.

Parameters
ffcFileContainer used to append to
track_idid to lookup the file
datadata chunk
data_lendata chunk len
Return values
0ok
-1error
-2no store for this file

Definition at line 746 of file util-file.c.

References File_::file_track_id, FileContainer_::head, File_::next, SCEnter, SCReturnInt, and FileContainer_::tail.

Referenced by InitGlobal().

Here is the caller graph for this function:

◆ FileAppendGAPById()

int FileAppendGAPById ( FileContainer ffc,
uint32_t  track_id,
const uint8_t *  data,
uint32_t  data_len 
)

Store/handle a chunk of file data in the File structure The file with 'track_id' in the FileContainer will be used.

Parameters
ffcFileContainer used to append to
track_idid to lookup the file
datadata chunk
data_lendata chunk len
Return values
0ok
-1error
-2no store for this file

Definition at line 777 of file util-file.c.

References File_::file_track_id, FileContainer_::head, File_::next, SCEnter, SCReturnInt, and FileContainer_::tail.

Referenced by InitGlobal().

Here is the caller graph for this function:

◆ FileCloseFile()

int FileCloseFile ( FileContainer ffc,
const uint8_t *  data,
uint32_t  data_len,
uint16_t  flags 
)

Close a File.

Parameters
ffcthe container
datafinal data if any
data_lendata len if any
flagsflags
Return values
0ok
-1error

Definition at line 1027 of file util-file.c.

References FileCloseFilePtr(), flags, SCEnter, SCReturnInt, and FileContainer_::tail.

Referenced by HTPFileClose().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FileCloseFileById()

int FileCloseFileById ( FileContainer ffc,
uint32_t  track_id,
const uint8_t *  data,
uint32_t  data_len,
uint16_t  flags 
)

Definition at line 1043 of file util-file.c.

References File_::file_track_id, FileCloseFilePtr(), flags, FileContainer_::head, File_::next, SCEnter, SCReturnInt, and FileContainer_::tail.

Referenced by InitGlobal().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FileCloseFilePtr()

int FileCloseFilePtr ( File ff,
const uint8_t *  data,
uint32_t  data_len,
uint16_t  flags 
)

Definition at line 945 of file util-file.c.

References FILE_NOSTORE, FILE_STATE_OPENED, File_::flags, SCEnter, SCReturnInt, File_::size, and File_::state.

Referenced by FileCloseFile(), FileCloseFileById(), and FileTruncateAllOpenFiles().

Here is the caller graph for this function:

◆ FileContainerAdd()

void FileContainerAdd ( FileContainer ffc,
File ff 
)

Definition at line 539 of file util-file.c.

References FileContainer_::head, File_::next, and FileContainer_::tail.

◆ FileContainerAlloc()

FileContainer* FileContainerAlloc ( void  )

allocate a FileContainer

Return values
newnewly allocated FileContainer
NULLerror

Definition at line 423 of file util-file.c.

References SC_ERR_MEM_ALLOC, SCLogError, SCMalloc, and unlikely.

Referenced by SMTPProcessDataChunk().

Here is the caller graph for this function:

◆ FileContainerFree()

void FileContainerFree ( FileContainer ffc)

Free a FileContainer.

Parameters
ffcFileContainer

Definition at line 459 of file util-file.c.

References FileContainer_::head, next, and File_::next.

◆ FileContainerRecycle()

void FileContainerRecycle ( FileContainer ffc)

Recycle a FileContainer.

Parameters
ffcFileContainer

Definition at line 440 of file util-file.c.

References FileContainer_::head, next, and File_::next.

Referenced by InitGlobal().

Here is the caller graph for this function:

◆ FileContainerSetTx()

void FileContainerSetTx ( FileContainer ffc,
uint64_t  tx_id 
)

Definition at line 574 of file util-file.c.

References FileSetTx(), and FileContainer_::tail.

Referenced by InitGlobal().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FileDataSize()

uint64_t FileDataSize ( const File file)

get the size of the file data

This doesn't reflect how much of the file we have in memory, just the total size of filedata so far.

Definition at line 291 of file util-file.c.

References StreamingBuffer_::buf_offset, File_::sb, SCLogDebug, and StreamingBuffer_::stream_offset.

◆ FileDisableStoringForTransaction()

void FileDisableStoringForTransaction ( Flow f,
uint8_t  direction,
uint64_t  tx_id 
)

disable file storing for files in a transaction

disable file storing for a transaction

Parameters
fLOCKED flow
directionflow direction
tx_idtransaction id

Definition at line 1169 of file util-file.c.

References AppLayerParserGetFiles(), DEBUG_ASSERT_FLOW_LOCKED, FILE_STORE, File_::flags, FileContainer_::head, File_::next, SCEnter, SCLogDebug, and File_::txid.

Here is the call graph for this function:

◆ FileFlowToFlags()

◆ FileForceFilestore()

int FileForceFilestore ( void  )

Definition at line 124 of file util-file.c.

◆ FileForceFilestoreEnable()

void FileForceFilestoreEnable ( void  )

Definition at line 94 of file util-file.c.

◆ FileForceHashParseCfg()

void FileForceHashParseCfg ( ConfNode conf)

Function to parse forced file hashing configuration.

Definition at line 172 of file util-file.c.

References BUG_ON, ConfNodeLookupChild(), ConfNodeLookupChildValue(), ConfValIsTrue(), FileForceMd5Enable(), FileForceSha1Enable(), FileForceSha256Enable(), next, SC_ERR_DEPRECATED_CONF, SCLogInfo, SCLogWarning, TAILQ_FOREACH, and ConfNode_::val.

Here is the call graph for this function:

◆ FileForceMagic()

int FileForceMagic ( void  )

Definition at line 143 of file util-file.c.

◆ FileForceMagicEnable()

void FileForceMagicEnable ( void  )

Definition at line 100 of file util-file.c.

◆ FileForceMd5()

int FileForceMd5 ( void  )

Definition at line 148 of file util-file.c.

◆ FileForceMd5Enable()

void FileForceMd5Enable ( void  )

Definition at line 106 of file util-file.c.

Referenced by FileForceHashParseCfg().

Here is the caller graph for this function:

◆ FileForceSha1()

int FileForceSha1 ( void  )

Definition at line 153 of file util-file.c.

◆ FileForceSha1Enable()

void FileForceSha1Enable ( void  )

Definition at line 112 of file util-file.c.

Referenced by FileForceHashParseCfg().

Here is the caller graph for this function:

◆ FileForceSha256()

int FileForceSha256 ( void  )

Definition at line 158 of file util-file.c.

◆ FileForceSha256Enable()

void FileForceSha256Enable ( void  )

Definition at line 118 of file util-file.c.

Referenced by FileForceHashParseCfg().

Here is the caller graph for this function:

◆ FileForceTrackingEnable()

void FileForceTrackingEnable ( void  )

Definition at line 163 of file util-file.c.

◆ FileOpenFileWithId()

int FileOpenFileWithId ( FileContainer ffc,
const StreamingBufferConfig sbcfg,
uint32_t  track_id,
const uint8_t *  name,
uint16_t  name_len,
const uint8_t *  data,
uint32_t  data_len,
uint16_t  flags 
)

Open a new File.

Return values
0ok
-1failed

Definition at line 933 of file util-file.c.

Referenced by InitGlobal(), and SMTPProcessDataChunk().

Here is the caller graph for this function:

◆ FilePrune()

void FilePrune ( FileContainer ffc)

Definition at line 388 of file util-file.c.

References FileContainer_::head.

Referenced by InitGlobal().

Here is the caller graph for this function:

◆ FileReassemblyDepth()

uint32_t FileReassemblyDepth ( void  )

Definition at line 135 of file util-file.c.

◆ FileReassemblyDepthEnable()

void FileReassemblyDepthEnable ( uint32_t  size)

Definition at line 129 of file util-file.c.

◆ FileSetInspectSizes()

void FileSetInspectSizes ( File file,
const uint32_t  win,
const uint32_t  min 
)

Definition at line 798 of file util-file.c.

References File_::inspect_min_size, and File_::inspect_window.

◆ FileSetRange()

int FileSetRange ( FileContainer ffc,
uint64_t  start,
uint64_t  end 
)

Sets the offset range for a file.

Parameters
ffcthe container
startstart offset
endend offset
Return values
0ok
-1error

Definition at line 814 of file util-file.c.

References File_::end, SCEnter, SCReturnInt, File_::start, and FileContainer_::tail.

Referenced by HTPFileSetRange().

Here is the caller graph for this function:

◆ FileSetTx()

int FileSetTx ( File ff,
uint64_t  txid 
)

Set the TX id for a file.

Parameters
ffThe file to store
txidthe tx id

Definition at line 566 of file util-file.c.

References SCLogDebug, SCReturnInt, and File_::txid.

Referenced by FileContainerSetTx().

Here is the caller graph for this function:

◆ FileStore()

int FileStore ( File ff)

Tag a file for storing.

Parameters
ffThe file to store

Definition at line 554 of file util-file.c.

References FILE_STORE, File_::flags, and SCReturnInt.

Referenced by FileStoreAllFiles(), FileStoreAllFilesForTx(), and FileStoreFileById().

Here is the caller graph for this function:

◆ FileStoreAllFiles()

void FileStoreAllFiles ( FileContainer fc)

Definition at line 1230 of file util-file.c.

References FileStore(), FileContainer_::head, File_::next, and SCEnter.

Here is the call graph for this function:

◆ FileStoreAllFilesForTx()

void FileStoreAllFilesForTx ( FileContainer fc,
uint64_t  tx_id 
)

Definition at line 1215 of file util-file.c.

References FileStore(), FileContainer_::head, File_::next, SCEnter, and File_::txid.

Here is the call graph for this function:

◆ FileStoreFileById()

void FileStoreFileById ( FileContainer fc,
uint32_t  file_id 
)

flag a file with id "file_id" to be stored.

Parameters
fcfile store
file_idthe file's id

Definition at line 1200 of file util-file.c.

References File_::file_track_id, FileStore(), FileContainer_::head, File_::next, and SCEnter.

Here is the call graph for this function:

◆ FileTrackedSize()

uint64_t FileTrackedSize ( const File file)

get the size of the file

This doesn't reflect how much of the file we have in memory, just the total size of file so far.

Definition at line 308 of file util-file.c.

References File_::size.

Referenced by EveFileInfo().

Here is the caller graph for this function:

◆ FileTruncateAllOpenFiles()

void FileTruncateAllOpenFiles ( FileContainer fc)

Definition at line 1243 of file util-file.c.

References FILE_STATE_OPENED, FILE_TRUNCATED, FileCloseFilePtr(), FileContainer_::head, File_::next, SCEnter, and File_::state.

Here is the call graph for this function:

◆ FileUpdateFlowFileFlags()

void FileUpdateFlowFileFlags ( Flow f,
uint16_t  set_file_flags,
uint8_t  direction 
)

set a flow's file flags

Parameters
set_file_flagsflags in both directions that are requested to set

This function will ignore the flags for the irrelevant direction and also mask the flags with the global settings.

Definition at line 1068 of file util-file.c.

References DEBUG_ASSERT_FLOW_LOCKED, FLOWFILE_NONE_TC, SCEnter, and STREAM_TOSERVER.

Variable Documentation

◆ g_detect_disabled

int g_detect_disabled

global indicating if detection is enabled

Definition at line 215 of file suricata.c.