Harmonization field names

Section	Name	Type	Description
Classification	classification.identifier	String	The lowercase identifier defines the actual software or service (e.g. heartbleed or ntp_version) or standardized malware name (e.g. zeus). Note that you MAY overwrite this field during processing for your individual setup. This field is not standardized across IntelMQ setups/users.
Classification	classification.taxonomy	ClassificationTaxonomy	We recognize the need for the CSIRT teams to apply a static (incident) taxonomy to abuse data. With this goal in mind the type IOC will serve as a basis for this activity. Each value of the dynamic type mapping translates to a an element in the static taxonomy. The European CSIRT teams for example have decided to apply the eCSIRT.net incident classification. The value of the taxonomy key is thus a derivative of the dynamic type above. For more information about check ENISA taxonomies.
Classification	classification.type	ClassificationType	The abuse type IOC is one of the most crucial pieces of information for any given abuse event. The main idea of dynamic typing is to keep our ontology flexible, since we need to evolve with the evolving threatscape of abuse data. In contrast with the static taxonomy below, the dynamic typing is used to perform business decisions in the abuse handling pipeline. Furthermore, the value data set should be kept as minimal as possible to avoid type explosion, which in turn dilutes the business value of the dynamic typing. In general, we normally have two types of abuse type IOC: ones referring to a compromised resource or ones referring to pieces of the criminal infrastructure, such as a command and control servers for example.
	comment	String	Free text commentary about the abuse event inserted by an analyst.
Destination	destination.abuse_contact	LowercaseString	Abuse contact for destination address. A comma separated list.
Destination	destination.account	String	An account name or email address, which has been identified to relate to the destination of an abuse event.
Destination	destination.allocated	DateTime	Allocation date corresponding to BGP prefix.
Destination	destination.as_name	String	The autonomous system name to which the connection headed.
Destination	destination.asn	ASN	The autonomous system number to which the connection headed.
Destination	destination.domain_suffix	FQDN	The suffix of the domain from the public suffix list.
Destination	destination.fqdn	FQDN	A DNS name related to the host from which the connection originated. DNS allows even binary data in DNS, so we have to allow everything. A final point is stripped, string is converted to lower case characters.
Destination Geolocation	destination.geolocation.cc	UppercaseString	Country-Code according to ISO3166-1 alpha-2 for the destination IP.
Destination Geolocation	destination.geolocation.city	String	Some geolocation services refer to city-level geolocation.
Destination Geolocation	destination.geolocation.country	String	The country name derived from the ISO3166 country code (assigned to cc field).
Destination Geolocation	destination.geolocation.latitude	Float	Latitude coordinates derived from a geolocation service, such as MaxMind geoip db.
Destination Geolocation	destination.geolocation.longitude	Float	Longitude coordinates derived from a geolocation service, such as MaxMind geoip db.
Destination Geolocation	destination.geolocation.region	String	Some geolocation services refer to region-level geolocation.
Destination Geolocation	destination.geolocation.state	String	Some geolocation services refer to state-level geolocation.
Destination	destination.ip	IPAddress	The IP which is the target of the observed connections.
Destination	destination.local_hostname	String	Some sources report an internal hostname within a NAT related to the name configured for a compromised system
Destination	destination.local_ip	IPAddress	Some sources report an internal (NATed) IP address related a compromised system. N.B. RFC1918 IPs are OK here.
Destination	destination.network	IPNetwork	CIDR for an autonomous system. Also known as BGP prefix. If multiple values are possible, select the most specific.
Destination	destination.port	Integer	The port to which the connection headed.
Destination	destination.registry	Registry	The IP registry a given ip address is allocated by.
Destination	destination.reverse_dns	FQDN	Reverse DNS name acquired through a reverse DNS query on an IP address. N.B. Record types other than PTR records may also appear in the reverse DNS tree. Furthermore, unfortunately, there is no rule prohibiting people from writing anything in a PTR record. Even JavaScript will work. A final point is stripped, string is converted to lower case characters.
Destination	destination.tor_node	Boolean	If the destination IP was a known tor node.
Destination	destination.url	URL	A URL denotes on IOC, which refers to a malicious resource, whose interpretation is defined by the abuse type. A URL with the abuse type phishing refers to a phishing resource.
Destination	destination.urlpath	String	The path portion of an HTTP or related network request.
Event_Description	event_description.target	String	Some sources denominate the target (organization) of a an attack.
Event_Description	event_description.text	String	A free-form textual description of an abuse event.
Event_Description	event_description.url	URL	A description URL is a link to a further description of the the abuse event in question.
	event_hash	UppercaseString	Computed event hash with specific keys and values that identify a unique event. At present, the hash should default to using the SHA1 function. Please note that for an event hash to be able to match more than one event (deduplication) the receiver of an event should calculate it based on a minimal set of keys and values present in the event. Using for example the observation time in the calculation will most likely render the checksum useless for deduplication purposes.
	extra	JSONDict	All anecdotal information, which cannot be parsed into the data harmonization elements. E.g. os.name, os.version, etc. Note: this is only intended for mapping any fields which can not map naturally into the data harmonization. It is not intended for extending the data harmonization with your own fields.
Feed	feed.accuracy	Accuracy	A float between 0 and 100 that represents how accurate the data in the feed is
Feed	feed.code	String	Code name for the feed, e.g. DFGS, HSDAG etc.
Feed	feed.documentation	String	A URL or hint where to find the documentation of this feed.
Feed	feed.name	String	Name for the feed, usually found in collector bot configuration.
Feed	feed.provider	String	Name for the provider of the feed, usually found in collector bot configuration.
Feed	feed.url	URL	The URL of a given abuse feed, where applicable
Malware Hash	malware.hash.md5	String	A string depicting an MD5 checksum for a file, be it a malware sample for example.
Malware Hash	malware.hash.sha1	String	A string depicting a SHA1 checksum for a file, be it a malware sample for example.
Malware Hash	malware.hash.sha256	String	A string depicting a SHA256 checksum for a file, be it a malware sample for example.
Malware	malware.name	LowercaseString	The malware name in lower case.
Malware	malware.version	String	A version string for an identified artifact generation, e.g. a crime-ware kit.
Misp	misp.attribute_uuid	LowercaseString	MISP - Malware Information Sharing Platform & Threat Sharing UUID of an attribute.
Misp	misp.event_uuid	LowercaseString	MISP - Malware Information Sharing Platform & Threat Sharing UUID.
	output	JSON	Event data converted into foreign format, intended to be exported by output plugin.
Protocol	protocol.application	LowercaseString	e.g. vnc, ssh, sip, irc, http or smtp.
Protocol	protocol.transport	LowercaseString	e.g. tcp, udp, icmp.
	raw	Base64	The original line of the event from encoded in base64.
	rtir_id	Integer	Request Tracker Incident Response ticket id.
	screenshot_url	URL	Some source may report URLs related to a an image generated of a resource without any metadata. Or an URL pointing to resource, which has been rendered into a webshot, e.g. a PNG image and the relevant metadata related to its retrieval/generation.
Source	source.abuse_contact	LowercaseString	Abuse contact for source address. A comma separated list.
Source	source.account	String	An account name or email address, which has been identified to relate to the source of an abuse event.
Source	source.allocated	DateTime	Allocation date corresponding to BGP prefix.
Source	source.as_name	String	The autonomous system name from which the connection originated.
Source	source.asn	ASN	The autonomous system number from which originated the connection.
Source	source.domain_suffix	FQDN	The suffix of the domain from the public suffix list.
Source	source.fqdn	FQDN	A DNS name related to the host from which the connection originated. DNS allows even binary data in DNS, so we have to allow everything. A final point is stripped, string is converted to lower case characters.
Source Geolocation	source.geolocation.cc	UppercaseString	Country-Code according to ISO3166-1 alpha-2 for the source IP.
Source Geolocation	source.geolocation.city	String	Some geolocation services refer to city-level geolocation.
Source Geolocation	source.geolocation.country	String	The country name derived from the ISO3166 country code (assigned to cc field).
Source Geolocation	source.geolocation.cymru_cc	UppercaseString	The country code denoted for the ip by the Team Cymru asn to ip mapping service.
Source Geolocation	source.geolocation.geoip_cc	UppercaseString	MaxMind Country Code (ISO3166-1 alpha-2).
Source Geolocation	source.geolocation.latitude	Float	Latitude coordinates derived from a geolocation service, such as MaxMind geoip db.
Source Geolocation	source.geolocation.longitude	Float	Longitude coordinates derived from a geolocation service, such as MaxMind geoip db.
Source Geolocation	source.geolocation.region	String	Some geolocation services refer to region-level geolocation.
Source Geolocation	source.geolocation.state	String	Some geolocation services refer to state-level geolocation.
Source	source.ip	IPAddress	The ip observed to initiate the connection
Source	source.local_hostname	String	Some sources report a internal hostname within a NAT related to the name configured for a compromised system
Source	source.local_ip	IPAddress	Some sources report a internal (NATed) IP address related a compromised system. N.B. RFC1918 IPs are OK here.
Source	source.network	IPNetwork	CIDR for an autonomous system. Also known as BGP prefix. If multiple values are possible, select the most specific.
Source	source.port	Integer	The port from which the connection originated.
Source	source.registry	Registry	The IP registry a given ip address is allocated by.
Source	source.reverse_dns	FQDN	Reverse DNS name acquired through a reverse DNS query on an IP address. N.B. Record types other than PTR records may also appear in the reverse DNS tree. Furthermore, unfortunately, there is no rule prohibiting people from writing anything in a PTR record. Even JavaScript will work. A final point is stripped, string is converted to lower case characters.
Source	source.tor_node	Boolean	If the source IP was a known tor node.
Source	source.url	URL	A URL denotes an IOC, which refers to a malicious resource, whose interpretation is defined by the abuse type. A URL with the abuse type phishing refers to a phishing resource.
Source	source.urlpath	String	The path portion of an HTTP or related network request.
	status	String	Status of the malicious resource (phishing, dropzone, etc), e.g. online, offline.
Time	time.observation	DateTime	The time the collector of the local instance processed (observed) the event.
Time	time.source	DateTime	The time of occurrence of the event as reported the feed (source).
	tlp	TLP	Traffic Light Protocol level of the event.

Harmonization types

ASN

ASN type. Derived from Integer with forbidden values.

Only valid are: 0 < asn <= 4294967295 See https://en.wikipedia.org/wiki/Autonomous_system_(Internet) > The first and last ASNs of the original 16-bit integers, namely 0 and > 65,535, and the last ASN of the 32-bit numbers, namely 4,294,967,295 are > reserved and should not be used by operators.

Accuracy

Accuracy type. A Float between 0 and 100.

Base64

Base64 type. Always gives unicode strings.

Sanitation encodes to base64 and accepts binary and unicode strings.

Boolean

Boolean type. Without sanitation only python bool is accepted.

Sanitation accepts string ‘true’ and ‘false’ and integers 0 and 1.

ClassificationTaxonomy

classification.taxonomy type.

The mapping follows Reference Security Incident Taxonomy Working Group – RSIT WG https://github.com/enisaeu/Reference-Security-Incident-Taxonomy-Task-Force/

These old values are automatically mapped to the new ones:

‘abusive content’ -> ‘abusive-content’ ‘information gathering’ -> ‘information-gathering’ ‘intrusion attempts’ -> ‘intrusion-attempts’ ‘malicious code’ -> ‘malicious-code’

Allowed values are:

• abusive-content

• availability

• fraud

• information-content-security

• information-gathering

• intrusion-attempts

• intrusions

• malicious-code

• other

• test

• vulnerable

ClassificationType

classification.type type.

The mapping follows Reference Security Incident Taxonomy Working Group – RSIT WG https://github.com/enisaeu/Reference-Security-Incident-Taxonomy-Task-Force/ with extensions.

These old values are automatically mapped to the new ones:

‘botnet drone’ -> ‘infected-system’ ‘ids alert’ -> ‘ids-alert’ ‘c&c’ -> ‘c2-server’ ‘c2server’ -> ‘c2-server’ ‘infected system’ -> ‘infected-system’ ‘malware configuration’ -> ‘malware-configuration’ ‘Unauthorised-information-access’ -> ‘unauthorised-information-access’ ‘leak’ -> ‘data-leak’ ‘vulnerable client’ -> ‘vulnerable-system’ ‘vulnerable service’ -> ‘vulnerable-system’ ‘ransomware’ -> ‘infected-system’ ‘unknown’ -> ‘undetermined’

These values changed their taxonomy:

‘malware’: In terms of the taxonomy ‘malicious-code’ they can be either ‘infected-system’ or ‘malware-distribution’

but in terms of malware actually, it is now taxonomy ‘other’

Allowed values are:

• application-compromise

• blacklist

• brute-force

• burglary

• c2-server

• copyright

• data-leak

• data-loss

• ddos

• ddos-amplifier

• dga-domain

• dos

• exploit

• harmful-speech

• ids-alert

• infected-system

• information-disclosure

• malware

• malware-configuration

• malware-distribution

• masquerade

• misconfiguration

• other

• outage

• phishing

• potentially-unwanted-accessible

• privileged-account-compromise

• proxy

• sabotage

• scanner

• sniffing

• social-engineering

• spam

• system-compromise

• test

• tor

• unauthorised-information-access

• unauthorised-information-modification

• unauthorized-use-of-resources

• undetermined

• unprivileged-account-compromise

• violence

• vulnerable-system

• weak-crypto

DateTime

Date and time type for timestamps.

Valid values are timestamps with time zone and in the format ‘%Y-%m-%dT%H:%M:%S+00:00’. Invalid are missing times and missing timezone information (UTC). Microseconds are also allowed.

Sanitation normalizes the timezone to UTC, which is the only allowed timezone.

The following additional conversions are available with the convert function:

• timestamp

• windows_nt: From Windows NT / AD / LDAP

• epoch_millis: From Milliseconds since Epoch

• from_format: From a given format, eg. ‘from_format|%H %M %S %m %d %Y %Z’

• from_format_midnight: Date from a given format and assume midnight, e.g. ‘from_format_midnight|%d-%m-%Y’

• utc_isoformat: Parse date generated by datetime.isoformat()

• fuzzy (or None): Use dateutils’ fuzzy parser, default if no specific parser is given

FQDN

Fully qualified domain name type.

All valid lowercase domains are accepted, no IP addresses or URLs. Trailing dot is not allowed.

To prevent values like ‘10.0.0.1:8080’ (#1235), we check for the non-existence of ‘:’.

Float

Float type. Without sanitation only python float/integer/long is accepted. Boolean is explicitly denied.

Sanitation accepts strings and everything float() accepts.

IPAddress

Type for IP addresses, all families. Uses the ipaddress module.

Sanitation accepts integers, strings and objects of ipaddress.IPv4Address and ipaddress.IPv6Address.

Valid values are only strings. 0.0.0.0 is explicitly not allowed.

IPNetwork

Type for IP networks, all families. Uses the ipaddress module.

Sanitation accepts strings and objects of ipaddress.IPv4Network and ipaddress.IPv6Network. If host bits in strings are set, they will be ignored (e.g 127.0.0.1/32).

Valid values are only strings.

Integer

Integer type. Without sanitation only python integer/long is accepted. Bool is explicitly denied.

Sanitation accepts strings and everything int() accepts.

JSON

JSON type.

Sanitation accepts any valid JSON objects.

Valid values are only unicode strings with JSON objects.

JSONDict

JSONDict type.

Sanitation accepts pythons dictionaries and JSON strings.

Valid values are only unicode strings with JSON dictionaries.

LowercaseString

Like string, but only allows lower case characters.

Sanitation lowers all characters.

Registry

Registry type. Derived from UppercaseString.

Only valid values: AFRINIC, APNIC, ARIN, LACNIC, RIPE. RIPE-NCC and RIPENCC are normalized to RIPE.

String

Any non-empty string without leading or trailing whitespace.

TLP

TLP level type. Derived from UppercaseString.

Only valid values: WHITE, GREEN, AMBER, RED.

Accepted for sanitation are different cases and the prefix ‘tlp:’.

URL

URI type. Local and remote.

Sanitation converts hxxp and hxxps to http and https. For local URIs (file) a missing host is replaced by localhost.

Valid values must have the host (network location part).

UppercaseString

Like string, but only allows upper case characters.

Sanitation uppers all characters.