mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
5fa9c5865b
This cleans up internals of how analyzer instances get identified by the tag plus any args given to it and doesn't change script code a user would write.
108 lines
3.4 KiB
C++
108 lines
3.4 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#ifndef FILE_ANALYSIS_ANALYZER_H
|
|
#define FILE_ANALYSIS_ANALYZER_H
|
|
|
|
#include "Val.h"
|
|
#include "NetVar.h"
|
|
#include "Tag.h"
|
|
|
|
#include "file_analysis/file_analysis.bif.h"
|
|
|
|
namespace file_analysis {
|
|
|
|
class File;
|
|
|
|
/**
|
|
* Base class for analyzers that can be attached to file_analysis::File objects.
|
|
*/
|
|
class Analyzer {
|
|
public:
|
|
|
|
/**
|
|
* Destructor. Nothing special about it. Virtual since we definitely expect
|
|
* to delete instances of derived classes via pointers to this class.
|
|
*/
|
|
virtual ~Analyzer();
|
|
|
|
/**
|
|
* Subclasses may override this metod to receive file data non-sequentially.
|
|
* @param data points to start of a chunk of file data.
|
|
* @param len length in bytes of the chunk of data pointed to by \a data.
|
|
* @param offset the byte offset within full file that data chunk starts.
|
|
* @return true if the analyzer is still in a valid state to continue
|
|
* receiving data/events or false if it's essentially "done".
|
|
*/
|
|
virtual bool DeliverChunk(const u_char* data, uint64 len, uint64 offset)
|
|
{ return true; }
|
|
|
|
/**
|
|
* Subclasses may override this method to receive file sequentially.
|
|
* @param data points to start of the next chunk of file data.
|
|
* @param len length in bytes of the chunk of data pointed to by \a data.
|
|
* @return true if the analyzer is still in a valid state to continue
|
|
* receiving data/events or false if it's essentially "done".
|
|
*/
|
|
virtual bool DeliverStream(const u_char* data, uint64 len)
|
|
{ return true; }
|
|
|
|
/**
|
|
* Subclasses may override this method to specifically handle an EOF signal,
|
|
* which means no more data is going to be incoming and the analyzer
|
|
* may be deleted/cleaned up soon.
|
|
* @return true if the analyzer is still in a valid state to continue
|
|
* receiving data/events or false if it's essentially "done".
|
|
*/
|
|
virtual bool EndOfFile()
|
|
{ return true; }
|
|
|
|
/**
|
|
* Subclasses may override this method to handle missing data in a file.
|
|
* @param offset the byte offset within full file at which the missing
|
|
* data chunk occurs.
|
|
* @param len the number of missing bytes.
|
|
* @return true if the analyzer is still in a valid state to continue
|
|
* receiving data/events or false if it's essentially "done".
|
|
*/
|
|
virtual bool Undelivered(uint64 offset, uint64 len)
|
|
{ return true; }
|
|
|
|
/**
|
|
* @return the analyzer type enum value.
|
|
*/
|
|
file_analysis::Tag Tag() const { return tag; }
|
|
|
|
/**
|
|
* @return the AnalyzerArgs associated with the analyzer.
|
|
*/
|
|
RecordVal* Args() const { return args; }
|
|
|
|
/**
|
|
* @return the file_analysis::File object to which the analyzer is attached.
|
|
*/
|
|
File* GetFile() const { return file; }
|
|
|
|
protected:
|
|
|
|
/**
|
|
* Constructor. Only derived classes are meant to be instantiated.
|
|
* @param arg_args an \c AnalyzerArgs (script-layer type) value specifiying
|
|
* tunable options, if any, related to a particular analyzer type.
|
|
* @param arg_file the file to which the the analyzer is being attached.
|
|
*/
|
|
Analyzer(file_analysis::Tag arg_tag, RecordVal* arg_args, File* arg_file)
|
|
: tag(arg_tag),
|
|
args(arg_args->Ref()->AsRecordVal()),
|
|
file(arg_file)
|
|
{}
|
|
|
|
private:
|
|
|
|
file_analysis::Tag tag; /**< The particular type of the analyzer instance. */
|
|
RecordVal* args; /**< \c AnalyzerArgs val gives tunable analyzer params. */
|
|
File* file; /**< The file to which the analyzer is attached. */
|
|
};
|
|
|
|
} // namespace file_analysis
|
|
|
|
#endif
|