TaskMessage¶

Model for Service Task Message

Field	Type	Description	Required	Default
msg	Task	Body of the message	Yes	`None`
msg_loader	Enum	Class to use to load the message as an object Supported values are: `"assemblyline.odm.messages.task.TaskMessage"`	Yes	`assemblyline.odm.messages.task.TaskMessage`
msg_type	Enum	Type of message Supported values are: `"Task"`	Yes	`Task`
sender	Keyword	Sender of the message	Yes	`None`

Task¶

Service Task Model

Field	Type	Description	Required	Default
sid	UUID	Submission ID	Yes	`None`
metadata	FlatMapping	Metadata associated to the submission	Yes	`{}`
min_classification	Classification	Minimum classification of the file being scanned	Yes	`None`
fileinfo	FileInfo	File info block	Yes	`None`
filename	Keyword	File name	Yes	`None`
service_name	Keyword	Service name	Yes	`None`
service_config	Mapping [String, Any]	Service specific parameters	Yes	`{}`
depth	Integer	File depth relative to initital submitted file	Yes	`0`
max_files	Integer	Maximum number of files that submission can have	Yes	`None`
ttl	Integer	Task TTL	Yes	`0`
tags	List [TagItem]	List of tags	Yes	`[]`
temporary_submission_data	List [DataItem]	Temporary submission data	Yes	`[]`
deep_scan	Boolean	Perform deep scanning	Yes	`False`
ignore_cache	Boolean	Whether the service cache should be ignored during the processing of this task	Yes	`False`
ignore_recursion_prevention	Boolean	Whether the service should ignore recursion prevention or not	Yes	`False`
ignore_filtering	Boolean	Should the service filter it's output?	Yes	`False`
priority	Integer	Priority for processing order	Yes	`1`
safelist_config	ServiceSafelist	Safelisting configuration (as defined in global configuration)	Yes	See ServiceSafelist for more details.

Data Item

Field	Type	Description	Required	Default
name	Keyword	None	Yes	`None`
value	Any	None	Yes	`None`

File Information

Field	Type	Description	Required	Default
magic	Keyword	The output from libmagic which was used to determine the tag	Yes	`None`
md5	MD5	MD5 of the file	Yes	`None`
mime	Keyword	The libmagic mime type	Optional	`None`
sha1	SHA1	SHA1 hash of the file	Yes	`None`
sha256	SHA256	SHA256 hash of the file	Yes	`None`
size	Integer	Size of the file in bytes	Yes	`None`
ssdeep	SSDeepHash	None	Optional	`None`
tlsh	Keyword	None	Optional	`None`
type	Keyword	Type of file as identified by Assemblyline	Yes	`None`
uri_info	URIInfo	URI structure to speed up specialty file searching	Optional	`None`

Tag Item

Field	Type	Description	Required	Default
type	Keyword	Type of tag item	Yes	`None`
value	Keyword	Value of tag item	Yes	`None`
short_type	Keyword	Short version of tag type	Yes	`None`
score	Integer	Score of tag item	Optional	`None`