include/razorback/types.h File Reference

Razorback API data types. More...

#include <stdint.h>
#include <stdbool.h>
#include <unistd.h>
#include <uuid/uuid.h>
#include <stdlib.h>
#include <openssl/evp.h>
#include <razorback/list.h>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Hash
	Block Hash utilize various algorithms, e.g. More...
struct	BlockId
	Data Block ID If iLength is zero we don't have the block just the hash. More...
struct	BlockData
	Data Block tracker. More...
struct	Block
	Data Block. More...
struct	BlockPoolData
	Block Pool Item Data. More...
struct	BlockPoolItem
	Block Pool Item. More...
struct	EventId
	Event ID. More...
struct	Event
	Event. More...
struct	Judgment
	Judgment. More...
struct	Nugget
	Nugget information. More...
struct	DeferredList
	Deferred Data Block List. More...
Defines
#define	UUID_STRING_LENGTH   37
	The size of a UUID String including the null.
#define	HASH_TYPE_MD5   1
	Hash types.
#define	HASH_TYPE_SHA1   2
	SHA-1 Hash.
#define	HASH_TYPE_SHA224   3
	SHA224 Hash.
#define	HASH_TYPE_SHA256   4
	SHA256 Hash.
#define	HASH_TYPE_SHA512   5
	SHA512 Hash.
#define	HASH_FLAG_FINAL   0x00000001
	Hash Flags.
#define	SF_FLAG_GOOD   0x00000001
	Sourcefire Flags.
#define	SF_FLAG_BAD   0x00000002
	Block is bad.
#define	SF_FLAG_WHITE_LIST   0x00000004
	Block is white listed.
#define	SF_FLAG_BLACK_LIST   0x00000008
	Block is black listed.
#define	SF_FLAG_DIRTY   0x00000010
	Block is marked for re-inspection.
#define	SF_FLAG_CANHAZ   0x00000020
	Block data is required.
#define	SF_FLAG_PROCESSING   0x00000040
	Block is being processed currently.
#define	SF_FLAG_DODGY   0x00000080
	Block is neither good nor bad.
#define	SF_FLAG_SUSPICIOUS   0x00000080
	Block is neither good nor bad.
#define	SF_FLAG_ALL   0xffffffff
	All flags mask.
#define	JUDGMENT_REASON_DONE   0
	Judgment types.
#define	JUDGMENT_REASON_ALERT   1
	Inspection alert output.
#define	JUDGMENT_REASON_ERROR   2
	Inspection failed.
#define	JUDGMENT_REASON_DEFERRED   3
	Inspection enqueued and results deferred.
#define	JUDGMENT_REASON_PENDING   4
	Inspection result current pending (.
#define	TRANSFER_METHOD_FILE   0
	Transfer protocols.
#define	TRANSFER_METHOD_SSH   1
	Transfer via SSH+SFTP.
#define	TRANSFER_METHOD_HTTP   2
	Transfer via HTTP.
#define	SUBMISSION_REASON_EVENT   0
	Submission types.
#define	SUBMISSION_REASON_REQUESTED   1
	Submission due to administrative request.
Enumerations
enum	Lookup_Result { R_SUCCESS = 0, R_ERROR = 1, R_FOUND = 2, R_NOT_FOUND = 3 }
	Lookup results enum. More...

---

Detailed Description

Razorback API data types.

---

Define Documentation

#define HASH_FLAG_FINAL   0x00000001

Hash Flags.

Hash has been finalized.

#define HASH_TYPE_MD5   1

Hash types.

MD5 Hash

#define JUDGMENT_REASON_DONE   0

Judgment types.

Inspection has completed

#define JUDGMENT_REASON_PENDING   4

Inspection result current pending (.

Note:

This is never sent in a message, it is the state the dispatcher stores for an inspection record.)

#define SF_FLAG_ALL   0xffffffff

All flags mask.

#define SF_FLAG_GOOD   0x00000001

Sourcefire Flags.

Block is good

#define SUBMISSION_REASON_EVENT   0

Submission types.

Submission from event.

#define SUBMISSION_REASON_REQUESTED   1

Submission due to administrative request.

#define TRANSFER_METHOD_FILE   0

Transfer protocols.

Transfer to block store shared file system

---

Enumeration Type Documentation

enum Lookup_Result

Lookup results enum.

Enumerator:

R_SUCCESS	R_SUCCESS.
R_ERROR	R_ERROR.
R_FOUND	R_FOUND.
R_NOT_FOUND	R_NOT_FOUND.