Specifications used in the MISP project including MISP core format
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2498 lines
118 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head profile="http://www.w3.org/2006/03/hcard http://dublincore.org/documents/2008/08/04/dc-html/">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<title>MISP core format</title>
<style type="text/css" title="Xml2Rfc (sans serif)">
/*<![CDATA[*/
a {
text-decoration: none;
}
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
a.info {
/* This is the key. */
position: relative;
z-index: 24;
text-decoration: none;
}
a.info:hover {
z-index: 25;
color: #FFF; background-color: #900;
}
a.info span { display: none; }
a.info:hover span.info {
/* The span will display just on :hover state. */
display: block;
position: absolute;
font-size: smaller;
top: 2em; left: -5em; width: 15em;
padding: 2px; border: 1px solid #333;
color: #900; background-color: #EEE;
text-align: left;
}
a.smpl {
color: black;
}
a:hover {
text-decoration: underline;
}
a:active {
text-decoration: underline;
}
address {
margin-top: 1em;
margin-left: 2em;
font-style: normal;
}
body {
color: black;
font-family: verdana, helvetica, arial, sans-serif;
font-size: 10pt;
max-width: 55em;
}
cite {
font-style: normal;
}
dd {
margin-right: 2em;
}
dl {
margin-left: 2em;
}
ul.empty {
list-style-type: none;
}
ul.empty li {
margin-top: .5em;
}
dl p {
margin-left: 0em;
}
dt {
margin-top: .5em;
}
h1 {
font-size: 14pt;
line-height: 21pt;
page-break-after: avoid;
}
h1.np {
page-break-before: always;
}
h1 a {
color: #333333;
}
h2 {
font-size: 12pt;
line-height: 15pt;
page-break-after: avoid;
}
h3, h4, h5, h6 {
font-size: 10pt;
page-break-after: avoid;
}
h2 a, h3 a, h4 a, h5 a, h6 a {
color: black;
}
img {
margin-left: 3em;
}
li {
margin-left: 2em;
margin-right: 2em;
}
ol {
margin-left: 2em;
margin-right: 2em;
}
ol p {
margin-left: 0em;
}
p {
margin-left: 2em;
margin-right: 2em;
}
pre {
margin-left: 3em;
background-color: lightyellow;
padding: .25em;
}
pre.text2 {
border-style: dotted;
border-width: 1px;
background-color: #f0f0f0;
width: 69em;
}
pre.inline {
background-color: white;
padding: 0em;
}
pre.text {
border-style: dotted;
border-width: 1px;
background-color: #f8f8f8;
width: 69em;
}
pre.drawing {
border-style: solid;
border-width: 1px;
background-color: #f8f8f8;
padding: 2em;
}
table {
margin-left: 2em;
}
table.tt {
vertical-align: top;
}
table.full {
border-style: outset;
border-width: 1px;
}
table.headers {
border-style: outset;
border-width: 1px;
}
table.tt td {
vertical-align: top;
}
table.full td {
border-style: inset;
border-width: 1px;
}
table.tt th {
vertical-align: top;
}
table.full th {
border-style: inset;
border-width: 1px;
}
table.headers th {
border-style: none none inset none;
border-width: 1px;
}
table.left {
margin-right: auto;
}
table.right {
margin-left: auto;
}
table.center {
margin-left: auto;
margin-right: auto;
}
caption {
caption-side: bottom;
font-weight: bold;
font-size: 9pt;
margin-top: .5em;
}
table.header {
border-spacing: 1px;
width: 95%;
font-size: 10pt;
color: white;
}
td.top {
vertical-align: top;
}
td.topnowrap {
vertical-align: top;
white-space: nowrap;
}
table.header td {
background-color: gray;
width: 50%;
}
table.header a {
color: white;
}
td.reference {
vertical-align: top;
white-space: nowrap;
padding-right: 1em;
}
thead {
display:table-header-group;
}
ul.toc, ul.toc ul {
list-style: none;
margin-left: 1.5em;
margin-right: 0em;
padding-left: 0em;
}
ul.toc li {
line-height: 150%;
font-weight: bold;
font-size: 10pt;
margin-left: 0em;
margin-right: 0em;
}
ul.toc li li {
line-height: normal;
font-weight: normal;
font-size: 9pt;
margin-left: 0em;
margin-right: 0em;
}
li.excluded {
font-size: 0pt;
}
ul p {
margin-left: 0em;
}
.comment {
background-color: yellow;
}
.center {
text-align: center;
}
.error {
color: red;
font-style: italic;
font-weight: bold;
}
.figure {
font-weight: bold;
text-align: center;
font-size: 9pt;
}
.filename {
color: #333333;
font-weight: bold;
font-size: 12pt;
line-height: 21pt;
text-align: center;
}
.fn {
font-weight: bold;
}
.hidden {
display: none;
}
.left {
text-align: left;
}
.right {
text-align: right;
}
.title {
color: #990000;
font-size: 18pt;
line-height: 18pt;
font-weight: bold;
text-align: center;
margin-top: 36pt;
}
.vcardline {
display: block;
}
.warning {
font-size: 14pt;
background-color: yellow;
}
@media print {
.noprint {
display: none;
}
a {
color: black;
text-decoration: none;
}
table.header {
width: 90%;
}
td.header {
width: 50%;
color: black;
background-color: white;
vertical-align: top;
font-size: 12pt;
}
ul.toc a::after {
content: leader('.') target-counter(attr(href), page);
}
ul.ind li li a {
content: target-counter(attr(href), page);
}
.print2col {
column-count: 2;
-moz-column-count: 2;
column-fill: auto;
}
}
@page {
@top-left {
content: "Internet-Draft";
}
@top-right {
content: "December 2010";
}
@top-center {
content: "Abbreviated Title";
}
@bottom-left {
content: "Doe";
}
@bottom-center {
content: "Expires June 2011";
}
@bottom-right {
content: "[Page " counter(page) "]";
}
}
@page:first {
@top-left {
content: normal;
}
@top-right {
content: normal;
}
@top-center {
content: normal;
}
}
/*]]>*/
</style>
<link href="#rfc.toc" rel="Contents">
<link href="#rfc.section.1" rel="Chapter" title="1 Introduction">
<link href="#rfc.section.1.1" rel="Chapter" title="1.1 Conventions and Terminology">
<link href="#rfc.section.2" rel="Chapter" title="2 Format">
<link href="#rfc.section.2.1" rel="Chapter" title="2.1 Overview">
<link href="#rfc.section.2.2" rel="Chapter" title="2.2 Event">
<link href="#rfc.section.2.2.1" rel="Chapter" title="2.2.1 Event Attributes">
<link href="#rfc.section.2.3" rel="Chapter" title="2.3 Objects">
<link href="#rfc.section.2.3.1" rel="Chapter" title="2.3.1 Org">
<link href="#rfc.section.2.3.2" rel="Chapter" title="2.3.2 Orgc">
<link href="#rfc.section.2.4" rel="Chapter" title="2.4 Attribute">
<link href="#rfc.section.2.4.1" rel="Chapter" title="2.4.1 Sample Attribute Object">
<link href="#rfc.section.2.4.2" rel="Chapter" title="2.4.2 Attribute Attributes">
<link href="#rfc.section.2.5" rel="Chapter" title="2.5 ShadowAttribute">
<link href="#rfc.section.2.5.1" rel="Chapter" title="2.5.1 Sample Attribute Object">
<link href="#rfc.section.2.5.2" rel="Chapter" title="2.5.2 ShadowAttribute Attributes">
<link href="#rfc.section.2.5.3" rel="Chapter" title="2.5.3 Org">
<link href="#rfc.section.2.6" rel="Chapter" title="2.6 Object">
<link href="#rfc.section.2.6.1" rel="Chapter" title="2.6.1 Sample Object">
<link href="#rfc.section.2.6.2" rel="Chapter" title="2.6.2 Object Attributes">
<link href="#rfc.section.2.7" rel="Chapter" title="2.7 Object References">
<link href="#rfc.section.2.7.1" rel="Chapter" title="2.7.1 Sample ObjectReference object">
<link href="#rfc.section.2.7.2" rel="Chapter" title="2.7.2 ObjectReference Attributes">
<link href="#rfc.section.2.8" rel="Chapter" title="2.8 EventReport">
<link href="#rfc.section.2.8.1" rel="Chapter" title="2.8.1 id">
<link href="#rfc.section.2.8.2" rel="Chapter" title="2.8.2 UUID">
<link href="#rfc.section.2.8.3" rel="Chapter" title="2.8.3 event_id">
<link href="#rfc.section.2.8.4" rel="Chapter" title="2.8.4 name">
<link href="#rfc.section.2.8.5" rel="Chapter" title="2.8.5 content">
<link href="#rfc.section.2.8.6" rel="Chapter" title="2.8.6 distribution">
<link href="#rfc.section.2.8.7" rel="Chapter" title="2.8.7 sharing_group_id">
<link href="#rfc.section.2.8.8" rel="Chapter" title="2.8.8 timestamp">
<link href="#rfc.section.2.8.9" rel="Chapter" title="2.8.9 deleted">
<link href="#rfc.section.2.9" rel="Chapter" title="2.9 Tag">
<link href="#rfc.section.2.9.1" rel="Chapter" title="2.9.1 Sample Tag">
<link href="#rfc.section.2.10" rel="Chapter" title="2.10 Sighting">
<link href="#rfc.section.2.10.1" rel="Chapter" title="2.10.1 Sample Sighting">
<link href="#rfc.section.2.11" rel="Chapter" title="2.11 Galaxy">
<link href="#rfc.section.2.11.1" rel="Chapter" title="2.11.1 Sample Galaxy">
<link href="#rfc.section.3" rel="Chapter" title="3 JSON Schema">
<link href="#rfc.section.4" rel="Chapter" title="4 Manifest">
<link href="#rfc.section.4.1" rel="Chapter" title="4.1 Format">
<link href="#rfc.section.4.1.1" rel="Chapter" title="4.1.1 Sample Manifest">
<link href="#rfc.section.5" rel="Chapter" title="5 Implementation">
<link href="#rfc.section.6" rel="Chapter" title="6 Security Considerations">
<link href="#rfc.section.7" rel="Chapter" title="7 Acknowledgements">
<link href="#rfc.section.8" rel="Chapter" title="8 References">
<link href="#rfc.references" rel="Chapter" title="9 References">
<link href="#rfc.references.1" rel="Chapter" title="9.1 Normative References">
<link href="#rfc.references.2" rel="Chapter" title="9.2 Informative References">
<link href="#rfc.authors" rel="Chapter">
<meta name="generator" content="xml2rfc version 2.23.1 - https://tools.ietf.org/tools/xml2rfc" />
<link rel="schema.dct" href="http://purl.org/dc/terms/" />
<meta name="dct.creator" content="Dulaunoy, A. and A. Iklody" />
<meta name="dct.identifier" content="urn:ietf:id:draft-dulaunoy-misp-core-format" />
<meta name="dct.issued" scheme="ISO8601" content="2020-10-21" />
<meta name="dct.abstract" content="This document describes the MISP core format used to exchange indicators and threat information between MISP (Open Source Threat Intelligence Sharing Platform formerly known as Malware Information Sharing Platform) instances. The JSON format includes the overall structure along with the semantic associated for each respective key. The format is described to support other implementations which reuse the format and ensuring an interoperability with existing MISP software and other Threat Intelligence Platforms. " />
<meta name="description" content="This document describes the MISP core format used to exchange indicators and threat information between MISP (Open Source Threat Intelligence Sharing Platform formerly known as Malware Information Sharing Platform) instances. The JSON format includes the overall structure along with the semantic associated for each respective key. The format is described to support other implementations which reuse the format and ensuring an interoperability with existing MISP software and other Threat Intelligence Platforms. " />
</head>
<body>
<table class="header">
<tbody>
<tr>
<td class="left">Network Working Group</td>
<td class="right">A. Dulaunoy</td>
</tr>
<tr>
<td class="left">Internet-Draft</td>
<td class="right">A. Iklody</td>
</tr>
<tr>
<td class="left">Intended status: Informational</td>
<td class="right">CIRCL</td>
</tr>
<tr>
<td class="left">Expires: April 24, 2021</td>
<td class="right">October 21, 2020</td>
</tr>
</tbody>
</table>
<p class="title">MISP core format<br />
<span class="filename">draft-dulaunoy-misp-core-format</span></p>
<h1 id="rfc.abstract"><a href="#rfc.abstract">Abstract</a></h1>
<p>This document describes the MISP core format used to exchange indicators and threat information between MISP (Open Source Threat Intelligence Sharing Platform formerly known as Malware Information Sharing Platform) instances. The JSON format includes the overall structure along with the semantic associated for each respective key. The format is described to support other implementations which reuse the format and ensuring an interoperability with existing MISP <a href="#MISP-P" class="xref">[MISP-P]</a> software and other Threat Intelligence Platforms. </p>
<h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
<p>This Internet-Draft will expire on April 24, 2021.</p>
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
<p>Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>
<hr class="noprint" />
<h1 class="np" id="rfc.toc"><a href="#rfc.toc">Table of Contents</a></h1>
<ul class="toc">
<li>1. <a href="#rfc.section.1">Introduction</a>
</li>
<ul><li>1.1. <a href="#rfc.section.1.1">Conventions and Terminology</a>
</li>
</ul><li>2. <a href="#rfc.section.2">Format</a>
</li>
<ul><li>2.1. <a href="#rfc.section.2.1">Overview</a>
</li>
<li>2.2. <a href="#rfc.section.2.2">Event</a>
</li>
<ul><li>2.2.1. <a href="#rfc.section.2.2.1">Event Attributes</a>
</li>
</ul><li>2.3. <a href="#rfc.section.2.3">Objects</a>
</li>
<ul><li>2.3.1. <a href="#rfc.section.2.3.1">Org</a>
</li>
<li>2.3.2. <a href="#rfc.section.2.3.2">Orgc</a>
</li>
</ul><li>2.4. <a href="#rfc.section.2.4">Attribute</a>
</li>
<ul><li>2.4.1. <a href="#rfc.section.2.4.1">Sample Attribute Object</a>
</li>
<li>2.4.2. <a href="#rfc.section.2.4.2">Attribute Attributes</a>
</li>
</ul><li>2.5. <a href="#rfc.section.2.5">ShadowAttribute</a>
</li>
<ul><li>2.5.1. <a href="#rfc.section.2.5.1">Sample Attribute Object</a>
</li>
<li>2.5.2. <a href="#rfc.section.2.5.2">ShadowAttribute Attributes</a>
</li>
<li>2.5.3. <a href="#rfc.section.2.5.3">Org</a>
</li>
</ul><li>2.6. <a href="#rfc.section.2.6">Object</a>
</li>
<ul><li>2.6.1. <a href="#rfc.section.2.6.1">Sample Object</a>
</li>
<li>2.6.2. <a href="#rfc.section.2.6.2">Object Attributes</a>
</li>
</ul><li>2.7. <a href="#rfc.section.2.7">Object References</a>
</li>
<ul><li>2.7.1. <a href="#rfc.section.2.7.1">Sample ObjectReference object</a>
</li>
<li>2.7.2. <a href="#rfc.section.2.7.2">ObjectReference Attributes</a>
</li>
</ul><li>2.8. <a href="#rfc.section.2.8">EventReport</a>
</li>
<ul><li>2.8.1. <a href="#rfc.section.2.8.1">id</a>
</li>
<li>2.8.2. <a href="#rfc.section.2.8.2">UUID</a>
</li>
<li>2.8.3. <a href="#rfc.section.2.8.3">event_id</a>
</li>
<li>2.8.4. <a href="#rfc.section.2.8.4">name</a>
</li>
<li>2.8.5. <a href="#rfc.section.2.8.5">content</a>
</li>
<li>2.8.6. <a href="#rfc.section.2.8.6">distribution</a>
</li>
<li>2.8.7. <a href="#rfc.section.2.8.7">sharing_group_id</a>
</li>
<li>2.8.8. <a href="#rfc.section.2.8.8">timestamp</a>
</li>
<li>2.8.9. <a href="#rfc.section.2.8.9">deleted</a>
</li>
</ul><li>2.9. <a href="#rfc.section.2.9">Tag</a>
</li>
<ul><li>2.9.1. <a href="#rfc.section.2.9.1">Sample Tag</a>
</li>
</ul><li>2.10. <a href="#rfc.section.2.10">Sighting</a>
</li>
<ul><li>2.10.1. <a href="#rfc.section.2.10.1">Sample Sighting</a>
</li>
</ul><li>2.11. <a href="#rfc.section.2.11">Galaxy</a>
</li>
<ul><li>2.11.1. <a href="#rfc.section.2.11.1">Sample Galaxy</a>
</li>
</ul></ul><li>3. <a href="#rfc.section.3">JSON Schema</a>
</li>
<li>4. <a href="#rfc.section.4">Manifest</a>
</li>
<ul><li>4.1. <a href="#rfc.section.4.1">Format</a>
</li>
<ul><li>4.1.1. <a href="#rfc.section.4.1.1">Sample Manifest</a>
</li>
</ul></ul><li>5. <a href="#rfc.section.5">Implementation</a>
</li>
<li>6. <a href="#rfc.section.6">Security Considerations</a>
</li>
<li>7. <a href="#rfc.section.7">Acknowledgements</a>
</li>
<li>8. <a href="#rfc.section.8">References</a>
</li>
<li>9. <a href="#rfc.references">References</a>
</li>
<ul><li>9.1. <a href="#rfc.references.1">Normative References</a>
</li>
<li>9.2. <a href="#rfc.references.2">Informative References</a>
</li>
</ul><li><a href="#rfc.authors">Authors' Addresses</a>
</li>
</ul>
<h1 id="rfc.section.1">
<a href="#rfc.section.1">1.</a> <a href="#introduction" id="introduction">Introduction</a>
</h1>
<p id="rfc.section.1.p.1">Sharing threat information became a fundamental requirements in the Internet, security and intelligence community at large. Threat information can include indicators of compromise, malicious file indicators, financial fraud indicators or even detailed information about a threat actor. MISP <a href="#MISP-P" class="xref">[MISP-P]</a> started as an open source project in late 2011 and the MISP format started to be widely used as an exchange format within the community in the past years. The aim of this document is to describe the specification and the MISP core format. </p>
<h1 id="rfc.section.1.1">
<a href="#rfc.section.1.1">1.1.</a> <a href="#conventions-and-terminology" id="conventions-and-terminology">Conventions and Terminology</a>
</h1>
<p id="rfc.section.1.1.p.1">The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 <a href="#RFC2119" class="xref">[RFC2119]</a>. </p>
<h1 id="rfc.section.2">
<a href="#rfc.section.2">2.</a> <a href="#format" id="format">Format</a>
</h1>
<h1 id="rfc.section.2.1">
<a href="#rfc.section.2.1">2.1.</a> <a href="#overview" id="overview">Overview</a>
</h1>
<p id="rfc.section.2.1.p.1">The MISP core format is in the JSON <a href="#RFC8259" class="xref">[RFC8259]</a> format. In MISP, an event is composed of a single JSON object. </p>
<p id="rfc.section.2.1.p.2">A capitalized key (like Event, Org) represent a data model and a non-capitalised key is just an attribute. This nomenclature can support an implementation to represent the MISP format in another data structure. </p>
<h1 id="rfc.section.2.2">
<a href="#rfc.section.2.2">2.2.</a> <a href="#event" id="event">Event</a>
</h1>
<p id="rfc.section.2.2.p.1">An event is a simple meta structure scheme where attributes and meta-data are embedded to compose a coherent set of indicators. An event can be composed from an incident, a security analysis report or a specific threat actor analysis. The meaning of an event only depends of the information embedded in the event. </p>
<h1 id="rfc.section.2.2.1">
<a href="#rfc.section.2.2.1">2.2.1.</a> <a href="#event-attributes" id="event-attributes">Event Attributes</a>
</h1>
<h1 id="rfc.section.2.2.1.1">
<a href="#rfc.section.2.2.1.1">2.2.1.1.</a> <a href="#uuid" id="uuid">uuid</a>
</h1>
<p id="rfc.section.2.2.1.1.p.1">uuid represents the Universally Unique IDentifier (UUID) <a href="#RFC4122" class="xref">[RFC4122]</a> of the event. The uuid MUST be preserved for any updates or transfer of the same event. UUID version 4 is RECOMMENDED when assigning it to a new event. </p>
<p id="rfc.section.2.2.1.1.p.2">uuid is represented as a JSON string. uuid MUST be present. </p>
<h1 id="rfc.section.2.2.1.2">
<a href="#rfc.section.2.2.1.2">2.2.1.2.</a> <a href="#id" id="id">id</a>
</h1>
<p id="rfc.section.2.2.1.2.p.1">id represents the human-readable identifier associated to the event for a specific MISP instance. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.2.1.2.p.2">id is represented as a JSON string. id SHALL be present. </p>
<h1 id="rfc.section.2.2.1.3">
<a href="#rfc.section.2.2.1.3">2.2.1.3.</a> <a href="#published" id="published">published</a>
</h1>
<p id="rfc.section.2.2.1.3.p.1">published represents the event publication state. If the event was published, the published value MUST be true. In any other publication state, the published value MUST be false. </p>
<p id="rfc.section.2.2.1.3.p.2">published is represented as a JSON boolean. published MUST be present. </p>
<h1 id="rfc.section.2.2.1.4">
<a href="#rfc.section.2.2.1.4">2.2.1.4.</a> <a href="#info" id="info">info</a>
</h1>
<p id="rfc.section.2.2.1.4.p.1">info represents the information field of the event. info is a free-text value to provide a human-readable summary of the event. info SHOULD NOT be bigger than 256 characters and SHOULD NOT include new-lines. </p>
<p id="rfc.section.2.2.1.4.p.2">info is represented as a JSON string. info MUST be present. </p>
<h1 id="rfc.section.2.2.1.5">
<a href="#rfc.section.2.2.1.5">2.2.1.5.</a> <a href="#threatlevelid" id="threatlevelid">threat_level_id</a>
</h1>
<p id="rfc.section.2.2.1.5.p.1">threat_level_id represents the threat level. </p>
<p></p>
<dl>
<dt>4:</dt>
<dd style="margin-left: 8">
<br> Undefined</dd>
<dt>3:</dt>
<dd style="margin-left: 8">
<br> Low</dd>
<dt>2:</dt>
<dd style="margin-left: 8">
<br> Medium</dd>
<dt>1:</dt>
<dd style="margin-left: 8">
<br> High</dd>
</dl>
<p> </p>
<p id="rfc.section.2.2.1.5.p.3">If a higher granularity is required, a MISP taxonomy applied as a Tag SHOULD be preferred. </p>
<p id="rfc.section.2.2.1.5.p.4">threat_level_id is represented as a JSON string. threat_level_id SHALL be present. </p>
<h1 id="rfc.section.2.2.1.6">
<a href="#rfc.section.2.2.1.6">2.2.1.6.</a> <a href="#analysis" id="analysis">analysis</a>
</h1>
<p id="rfc.section.2.2.1.6.p.1">analysis represents the analysis level. </p>
<p></p>
<dl>
<dt>0:</dt>
<dd style="margin-left: 8">
<br> Initial</dd>
<dt>1:</dt>
<dd style="margin-left: 8">
<br> Ongoing</dd>
<dt>2:</dt>
<dd style="margin-left: 8">
<br> Complete</dd>
</dl>
<p> </p>
<p id="rfc.section.2.2.1.6.p.3">If a higher granularity is required, a MISP taxonomy applied as a Tag SHOULD be preferred. </p>
<p id="rfc.section.2.2.1.6.p.4">analysis is represented as a JSON string. analysis SHALL be present. </p>
<h1 id="rfc.section.2.2.1.7">
<a href="#rfc.section.2.2.1.7">2.2.1.7.</a> <a href="#date" id="date">date</a>
</h1>
<p id="rfc.section.2.2.1.7.p.1">date represents a reference date to the event in ISO 8601 format (date only: YYYY-MM-DD). This date corresponds to the date the event occurred, which may be in the past. </p>
<p id="rfc.section.2.2.1.7.p.2">date is represented as a JSON string. date MUST be present. </p>
<h1 id="rfc.section.2.2.1.8">
<a href="#rfc.section.2.2.1.8">2.2.1.8.</a> <a href="#timestamp" id="timestamp">timestamp</a>
</h1>
<p id="rfc.section.2.2.1.8.p.1">timestamp represents a reference time when the event, or one of the attributes within the event was created, or last updated/edited on the instance. timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). The time zone MUST be UTC. </p>
<p id="rfc.section.2.2.1.8.p.2">timestamp is represented as a JSON string. timestamp MUST be present. </p>
<h1 id="rfc.section.2.2.1.9">
<a href="#rfc.section.2.2.1.9">2.2.1.9.</a> <a href="#publishtimestamp" id="publishtimestamp">publish_timestamp</a>
</h1>
<p id="rfc.section.2.2.1.9.p.1">publish_timestamp represents a reference time when the event was published on the instance. published_timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). At each publication of an event, publish_timestamp MUST be updated. The time zone MUST be UTC. If the published_timestamp is present and the published flag is set to false, the publish_timestamp represents the previous publication timestamp. If the event was never published, the published_timestamp MUST be set to 0. </p>
<p id="rfc.section.2.2.1.9.p.2">publish_timestamp is represented as a JSON string. publish_timestamp MUST be present. </p>
<h1 id="rfc.section.2.2.1.10">
<a href="#rfc.section.2.2.1.10">2.2.1.10.</a> <a href="#orgid" id="orgid">org_id</a>
</h1>
<p id="rfc.section.2.2.1.10.p.1">org_id represents a human-readable identifier referencing an Org object of the organisation which generated the event. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.2.1.10.p.2">The org_id MUST be updated when the event is generated by a new instance. </p>
<p id="rfc.section.2.2.1.10.p.3">org_id is represented as a JSON string. org_id MUST be present. </p>
<h1 id="rfc.section.2.2.1.11">
<a href="#rfc.section.2.2.1.11">2.2.1.11.</a> <a href="#orgcid" id="orgcid">orgc_id</a>
</h1>
<p id="rfc.section.2.2.1.11.p.1">orgc_id represents a human-readable identifier referencing an Orgc object of the organisation which created the event. </p>
<p id="rfc.section.2.2.1.11.p.2">The orgc_id and Org object MUST be preserved for any updates or transfer of the same event. </p>
<p id="rfc.section.2.2.1.11.p.3">orgc_id is represented as a JSON string. orgc_id MUST be present. </p>
<h1 id="rfc.section.2.2.1.12">
<a href="#rfc.section.2.2.1.12">2.2.1.12.</a> <a href="#attributecount" id="attributecount">attribute_count</a>
</h1>
<p id="rfc.section.2.2.1.12.p.1">attribute_count represents the number of attributes in the event. attribute_count is expressed in decimal. </p>
<p id="rfc.section.2.2.1.12.p.2">attribute_count is represented as a JSON string. attribute_count SHALL be present. </p>
<h1 id="rfc.section.2.2.1.13">
<a href="#rfc.section.2.2.1.13">2.2.1.13.</a> <a href="#distribution" id="distribution">distribution</a>
</h1>
<p id="rfc.section.2.2.1.13.p.1">distribution represents the basic distribution rules of the event. The system must adhere to the distribution setting for access control and for dissemination of the event. </p>
<p id="rfc.section.2.2.1.13.p.2">distribution is represented by a JSON string. distribution MUST be present and be one of the following options: </p>
<p></p>
<dl>
<dt>0</dt>
<dd style="margin-left: 8">
<br> Your Organisation Only</dd>
<dt>1</dt>
<dd style="margin-left: 8">
<br> This Community Only</dd>
<dt>2</dt>
<dd style="margin-left: 8">
<br> Connected Communities</dd>
<dt>3</dt>
<dd style="margin-left: 8">
<br> All Communities</dd>
<dt>4</dt>
<dd style="margin-left: 8">
<br> Sharing Group</dd>
</dl>
<p> </p>
<h1 id="rfc.section.2.2.1.14">
<a href="#rfc.section.2.2.1.14">2.2.1.14.</a> <a href="#sharinggroupid" id="sharinggroupid">sharing_group_id</a>
</h1>
<p id="rfc.section.2.2.1.14.p.1">sharing_group_id represents a human-readable identifier referencing a Sharing Group object that defines the distribution of the event, if distribution level "4" is set. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.2.1.14.p.2">sharing_group_id is represented by a JSON string and SHOULD be present. If a distribution level other than "4" is chosen the sharing_group_id MUST be set to "0". </p>
<h1 id="rfc.section.2.2.1.15">
<a href="#rfc.section.2.2.1.15">2.2.1.15.</a> <a href="#extendsuuid" id="extendsuuid">extends_uuid</a>
</h1>
<p id="rfc.section.2.2.1.15.p.1">extends_uuid represents which event is extended by this event. The extends_uuid is described as a Universally Unique IDentifier (UUID) <a href="#RFC4122" class="xref">[RFC4122]</a> with the UUID of the extended event. </p>
<p id="rfc.section.2.2.1.15.p.2">extends_uuid is represented as a JSON string. extends_uuid SHOULD be present. </p>
<h1 id="rfc.section.2.3">
<a href="#rfc.section.2.3">2.3.</a> <a href="#objects" id="objects">Objects</a>
</h1>
<h1 id="rfc.section.2.3.1">
<a href="#rfc.section.2.3.1">2.3.1.</a> <a href="#org" id="org">Org</a>
</h1>
<p id="rfc.section.2.3.1.p.1">An Org object is composed of an uuid, name and id. </p>
<p id="rfc.section.2.3.1.p.2">The uuid represents the Universally Unique IDentifier (UUID) <a href="#RFC4122" class="xref">[RFC4122]</a> of the organisation. The organisation UUID is globally assigned to an organisation and SHALL be kept overtime. </p>
<p id="rfc.section.2.3.1.p.3">The name is a readable description of the organisation and SHOULD be present. The id is a human-readable identifier generated by the instance and used as reference in the event. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.3.1.p.4">uuid, name and id are represented as a JSON string. uuid, name and id MUST be present. </p>
<h1 id="rfc.section.2.3.1.1">
<a href="#rfc.section.2.3.1.1">2.3.1.1.</a> <a href="#sample-org-object" id="sample-org-object">Sample Org Object</a>
</h1>
<pre>
"Org": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f"
}
</pre>
<h1 id="rfc.section.2.3.2">
<a href="#rfc.section.2.3.2">2.3.2.</a> <a href="#orgc" id="orgc">Orgc</a>
</h1>
<p id="rfc.section.2.3.2.p.1">An Orgc object is composed of an uuid, name and id. </p>
<p id="rfc.section.2.3.2.p.2">The uuid MUST be preserved for any updates or transfer of the same event. UUID version 4 is RECOMMENDED when assigning it to a new event. The organisation UUID is globally assigned to an organisation and SHALL be kept overtime. </p>
<p id="rfc.section.2.3.2.p.3">The name is a readable description of the organisation and SHOULD be present. The id is a human-readable identifier generated by the instance and used as reference in the event. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.3.2.p.4">uuid, name and id are represented as a JSON string. uuid, name and id MUST be present. </p>
<h1 id="rfc.section.2.4">
<a href="#rfc.section.2.4">2.4.</a> <a href="#attribute" id="attribute">Attribute</a>
</h1>
<p id="rfc.section.2.4.p.1">Attributes are used to describe the indicators and contextual data of an event. The main information contained in an attribute is made up of a category-type-value triplet, where the category and type give meaning and context to the value. Through the various category-type combinations a wide range of information can be conveyed. </p>
<p id="rfc.section.2.4.p.2">A MISP document MUST at least includes category-type-value triplet described in section "Attribute Attributes". </p>
<h1 id="rfc.section.2.4.1">
<a href="#rfc.section.2.4.1">2.4.1.</a> <a href="#sample-attribute-object" id="sample-attribute-object">Sample Attribute Object</a>
</h1>
<pre>
"Attribute": {
"id": "346056",
"type": "comment",
"category": "Other",
"to_ids": false,
"uuid": "57f4f6d9-cd20-458b-84fd-109ec0a83869",
"event_id": "3357",
"distribution": "5",
"timestamp": "1475679332",
"comment": "",
"sharing_group_id": "0",
"deleted": false,
"value": "Hello world",
"SharingGroup": [],
"ShadowAttribute": [],
"RelatedAttribute": [],
"first_seen": "2019-06-02T22:14:28.711954+00:00",
"last_seen": null
}
</pre>
<h1 id="rfc.section.2.4.2">
<a href="#rfc.section.2.4.2">2.4.2.</a> <a href="#attribute-attributes" id="attribute-attributes">Attribute Attributes</a>
</h1>
<h1 id="rfc.section.2.4.2.1">
<a href="#rfc.section.2.4.2.1">2.4.2.1.</a> <a href="#uuid-1" id="uuid-1">uuid</a>
</h1>
<p id="rfc.section.2.4.2.1.p.1">uuid represents the Universally Unique IDentifier (UUID) <a href="#RFC4122" class="xref">[RFC4122]</a> of the event. The uuid MUST be preserved for any updates or transfer of the same event. UUID version 4 is RECOMMENDED when assigning it to a new event. </p>
<p id="rfc.section.2.4.2.1.p.2">uuid is represented as a JSON string. uuid MUST be present. </p>
<h1 id="rfc.section.2.4.2.2">
<a href="#rfc.section.2.4.2.2">2.4.2.2.</a> <a href="#id-1" id="id-1">id</a>
</h1>
<p id="rfc.section.2.4.2.2.p.1">id represents the human-readable identifier associated to the event for a specific MISP instance. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.4.2.2.p.2">id is represented as a JSON string. id SHALL be present. </p>
<h1 id="rfc.section.2.4.2.3">
<a href="#rfc.section.2.4.2.3">2.4.2.3.</a> <a href="#type" id="type">type</a>
</h1>
<p id="rfc.section.2.4.2.3.p.1">type represents the means through which an attribute tries to describe the intent of the attribute creator, using a list of pre-defined attribute types. </p>
<p id="rfc.section.2.4.2.3.p.2">type is represented as a JSON string. type MUST be present and it MUST be a valid selection for the chosen category. The list of valid category-type combinations is as follows: </p>
<p></p>
<dl>
<dt>Antivirus detection</dt>
<dd style="margin-left: 8">
<br> link, comment, text, hex, attachment, other, anonymised</dd>
<dt>Artifacts dropped</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, regkey, regkey|value, pattern-in-file, pattern-in-memory, filename-pattern, pdb, stix2-pattern, yara, sigma, attachment, malware-sample, named pipe, mutex, windows-scheduled-task, windows-service-name, windows-service-displayname, comment, text, hex, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, other, cookie, gene, kusto-query, mime-type, anonymised, pgp-public-key, pgp-private-key</dd>
<dt>Attribution</dt>
<dd style="margin-left: 8">
<br> threat-actor, campaign-name, campaign-id, whois-registrant-phone, whois-registrant-email, whois-registrant-name, whois-registrant-org, whois-registrar, whois-creation-date, comment, text, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, other, dns-soa-email, anonymised, email</dd>
<dt>External analysis</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha256, sha3-224, sha3-256, sha3-384, sha3-512, filename, filename|md5, filename|sha1, filename|sha256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, ip-src, ip-dst, ip-dst|port, ip-src|port, mac-address, mac-eui-64, hostname, domain, domain|ip, url, user-agent, regkey, regkey|value, AS, snort, bro, zeek, pattern-in-file, pattern-in-traffic, pattern-in-memory, filename-pattern, vulnerability, cpe, weakness, attachment, malware-sample, link, comment, text, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, github-repository, other, cortex, anonymised, community-id</dd>
<dt>Financial fraud</dt>
<dd style="margin-left: 8">
<br> btc, dash, xmr, iban, bic, bank-account-nr, aba-rtn, bin, cc-number, prtn, phone-number, comment, text, other, hex, anonymised</dd>
<dt>Internal reference</dt>
<dd style="margin-left: 8">
<br> text, link, comment, other, hex, anonymised, git-commit-id</dd>
<dt>Network activity</dt>
<dd style="margin-left: 8">
<br> ip-src, ip-dst, ip-dst|port, ip-src|port, port, hostname, domain, domain|ip, mac-address, mac-eui-64, email, email-dst, email-src, eppn, url, uri, user-agent, http-method, AS, snort, pattern-in-file, filename-pattern, stix2-pattern, pattern-in-traffic, attachment, comment, text, x509-fingerprint-md5, x509-fingerprint-sha1, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, other, hex, cookie, hostname|port, bro, zeek, anonymised, community-id, email-subject</dd>
<dt>Other</dt>
<dd style="margin-left: 8">
<br> comment, text, other, size-in-bytes, counter, datetime, cpe, port, float, hex, phone-number, boolean, anonymised, pgp-public-key, pgp-private-key</dd>
<dt>Payload delivery</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, pehash, tlsh, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, mac-address, mac-eui-64, ip-src, ip-dst, ip-dst|port, ip-src|port, hostname, domain, email, email-src, email-dst, email-subject, email-attachment, email-body, url, user-agent, AS, pattern-in-file, pattern-in-traffic, filename-pattern, stix2-pattern, yara, sigma, mime-type, attachment, malware-sample, link, malware-type, comment, text, hex, vulnerability, cpe, weakness, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, other, hostname|port, email-dst-display-name, email-src-display-name, email-header, email-reply-to, email-x-mailer, email-mime-boundary, email-thread-index, email-message-id, mobile-application-id, chrome-extension-id, whois-registrant-email, anonymised</dd>
<dt>Payload installation</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, pehash, tlsh, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, pattern-in-file, pattern-in-traffic, pattern-in-memory, filename-pattern, stix2-pattern, yara, sigma, vulnerability, cpe, weakness, attachment, malware-sample, malware-type, comment, text, hex, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, mobile-application-id, chrome-extension-id, other, mime-type, anonymised</dd>
<dt>Payload type</dt>
<dd style="margin-left: 8">
<br> comment, text, other, anonymised</dd>
<dt>Persistence mechanism</dt>
<dd style="margin-left: 8">
<br> filename, regkey, regkey|value, comment, text, other, hex, anonymised</dd>
<dt>Person</dt>
<dd style="margin-left: 8">
<br> first-name, middle-name, last-name, date-of-birth, place-of-birth, gender, passport-number, passport-country, passport-expiration, redress-number, nationality, visa-number, issue-date-of-the-visa, primary-residence, country-of-residence, special-service-request, frequent-flyer-number, travel-details, payment-details, place-port-of-original-embarkation, place-port-of-clearance, place-port-of-onward-foreign-destination, passenger-name-record-locator-number, comment, text, other, phone-number, identity-card-number, anonymised, email, pgp-public-key, pgp-private-key</dd>
<dt>Social network</dt>
<dd style="margin-left: 8">
<br> github-username, github-repository, github-organisation, jabber-id, twitter-id, email, email-src, email-dst, eppn, comment, text, other, whois-registrant-email, anonymised, pgp-public-key, pgp-private-key</dd>
<dt>Support Tool</dt>
<dd style="margin-left: 8">
<br> link, text, attachment, comment, other, hex, anonymised</dd>
<dt>Targeting data</dt>
<dd style="margin-left: 8">
<br> target-user, target-email, target-machine, target-org, target-location, target-external, comment, anonymised</dd>
</dl>
<p> </p>
<p id="rfc.section.2.4.2.3.p.4">Attributes are based on the usage within their different communities. Attributes can be extended on a regular basis and this reference document is updated accordingly. </p>
<h1 id="rfc.section.2.4.2.4">
<a href="#rfc.section.2.4.2.4">2.4.2.4.</a> <a href="#category" id="category">category</a>
</h1>
<p id="rfc.section.2.4.2.4.p.1">category represents the intent of what the attribute is describing as selected by the attribute creator, using a list of pre-defined attribute categories. </p>
<p id="rfc.section.2.4.2.4.p.2">category is represented as a JSON string. category MUST be present and it MUST be a valid selection for the chosen type. The list of valid category-type combinations is mentioned above. </p>
<h1 id="rfc.section.2.4.2.5">
<a href="#rfc.section.2.4.2.5">2.4.2.5.</a> <a href="#toids" id="toids">to_ids</a>
</h1>
<p id="rfc.section.2.4.2.5.p.1">to_ids represents whether the attribute is meant to be actionable. Actionable defined attributes that can be used in automated processes as a pattern for detection in Local or Network Intrusion Detection System, log analysis tools or even filtering mechanisms. </p>
<p id="rfc.section.2.4.2.5.p.2">to_ids is represented as a JSON boolean. to_ids MUST be present. </p>
<h1 id="rfc.section.2.4.2.6">
<a href="#rfc.section.2.4.2.6">2.4.2.6.</a> <a href="#eventid" id="eventid">event_id</a>
</h1>
<p id="rfc.section.2.4.2.6.p.1">event_id represents a human-readable identifier referencing the Event object that the attribute belongs to. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.4.2.6.p.2">The event_id SHOULD be updated when the event is imported to reflect the newly created event's id on the instance. </p>
<p id="rfc.section.2.4.2.6.p.3">event_id is represented as a JSON string. event_id MUST be present. </p>
<h1 id="rfc.section.2.4.2.7">
<a href="#rfc.section.2.4.2.7">2.4.2.7.</a> <a href="#distribution-1" id="distribution-1">distribution</a>
</h1>
<p id="rfc.section.2.4.2.7.p.1">distribution represents the basic distribution rules of the attribute. The system must adhere to the distribution setting for access control and for dissemination of the attribute. </p>
<p id="rfc.section.2.4.2.7.p.2">distribution is represented by a JSON string. distribution MUST be present and be one of the following options: </p>
<p></p>
<dl>
<dt>0</dt>
<dd style="margin-left: 8">
<br> Your Organisation Only</dd>
<dt>1</dt>
<dd style="margin-left: 8">
<br> This Community Only</dd>
<dt>2</dt>
<dd style="margin-left: 8">
<br> Connected Communities</dd>
<dt>3</dt>
<dd style="margin-left: 8">
<br> All Communities</dd>
<dt>4</dt>
<dd style="margin-left: 8">
<br> Sharing Group</dd>
<dt>5</dt>
<dd style="margin-left: 8">
<br> Inherit Event</dd>
</dl>
<p> </p>
<h1 id="rfc.section.2.4.2.8">
<a href="#rfc.section.2.4.2.8">2.4.2.8.</a> <a href="#timestamp-1" id="timestamp-1">timestamp</a>
</h1>
<p id="rfc.section.2.4.2.8.p.1">timestamp represents a reference time when the attribute was created or last modified. timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). The time zone MUST be UTC. </p>
<p id="rfc.section.2.4.2.8.p.2">timestamp is represented as a JSON string. timestamp MUST be present. </p>
<h1 id="rfc.section.2.4.2.9">
<a href="#rfc.section.2.4.2.9">2.4.2.9.</a> <a href="#comment" id="comment">comment</a>
</h1>
<p id="rfc.section.2.4.2.9.p.1">comment is a contextual comment field. </p>
<p id="rfc.section.2.4.2.9.p.2">comment is represented by a JSON string. comment MAY be present. </p>
<h1 id="rfc.section.2.4.2.10">
<a href="#rfc.section.2.4.2.10">2.4.2.10.</a> <a href="#sharinggroupid-1" id="sharinggroupid-1">sharing_group_id</a>
</h1>
<p id="rfc.section.2.4.2.10.p.1">sharing_group_id represents a human-readable identifier referencing a Sharing Group object that defines the distribution of the attribute, if distribution level "4" is set. A human-readable identifier MUST be represented as an unsigned integer. </p>
<p id="rfc.section.2.4.2.10.p.2">sharing_group_id is represented by a JSON string and SHOULD be present. If a distribution level other than "4" is chosen the sharing_group_id MUST be set to "0". </p>
<h1 id="rfc.section.2.4.2.11">
<a href="#rfc.section.2.4.2.11">2.4.2.11.</a> <a href="#deleted" id="deleted">deleted</a>
</h1>
<p id="rfc.section.2.4.2.11.p.1">deleted represents a setting that allows attributes to be revoked. Revoked attributes are not actionable and exist merely to inform other instances of a revocation. </p>
<p id="rfc.section.2.4.2.11.p.2">deleted is represented by a JSON boolean. deleted MUST be present. </p>
<h1 id="rfc.section.2.4.2.12">
<a href="#rfc.section.2.4.2.12">2.4.2.12.</a> <a href="#data" id="data">data</a>
</h1>
<p id="rfc.section.2.4.2.12.p.1">data contains the base64 encoded contents of an attachment or a malware sample. For malware samples, the sample MUST be encrypted using a password protected zip archive, with the password being "infected". </p>
<p id="rfc.section.2.4.2.12.p.2">data is represented by a JSON string in base64 encoding. data MUST be set for attributes of type malware-sample and attachment. </p>
<h1 id="rfc.section.2.4.2.13">
<a href="#rfc.section.2.4.2.13">2.4.2.13.</a> <a href="#relatedattribute" id="relatedattribute">RelatedAttribute</a>
</h1>
<p id="rfc.section.2.4.2.13.p.1">RelatedAttribute is an array of attributes correlating with the current attribute. Each element in the array represents an JSON object which contains an Attribute dictionnary with the external attributes who correlate. Each Attribute MUST include the id, org_id, info and a value. Only the correlations found on the local instance are shown in RelatedAttribute. </p>
<p id="rfc.section.2.4.2.13.p.2">RelatedAttribute MAY be present. </p>
<h1 id="rfc.section.2.4.2.14">
<a href="#rfc.section.2.4.2.14">2.4.2.14.</a> <a href="#shadowattribute" id="shadowattribute">ShadowAttribute</a>
</h1>
<p id="rfc.section.2.4.2.14.p.1">ShadowAttribute is an array of shadow attributes that serve as proposals by third parties to alter the containing attribute. The structure of a ShadowAttribute is similar to that of an Attribute, which can be accepted or discarded by the event creator. If accepted, the original attribute containing the shadow attribute is removed and the shadow attribute is converted into an attribute. </p>
<p id="rfc.section.2.4.2.14.p.2">Each shadow attribute that references an attribute MUST contain the containing attribute's ID in the old_id field and the event's ID in the event_id field. </p>
<h1 id="rfc.section.2.4.2.15">
<a href="#rfc.section.2.4.2.15">2.4.2.15.</a> <a href="#value" id="value">value</a>
</h1>
<p id="rfc.section.2.4.2.15.p.1">value represents the payload of an attribute. The format of the value is dependent on the type of the attribute. </p>
<p id="rfc.section.2.4.2.15.p.2">value is represented by a JSON string. value MUST be present. </p>
<h1 id="rfc.section.2.4.2.16">
<a href="#rfc.section.2.4.2.16">2.4.2.16.</a> <a href="#firstseen" id="firstseen">first_seen</a>
</h1>
<p id="rfc.section.2.4.2.16.p.1">first_seen represents a reference time when the attribute was first seen. first_seen is expressed as an ISO 8601 datetime up to the micro-second with time zone support. </p>
<p id="rfc.section.2.4.2.16.p.2">first_seen is represented as a JSON string. first_seen MAY be present. </p>
<h1 id="rfc.section.2.4.2.17">
<a href="#rfc.section.2.4.2.17">2.4.2.17.</a> <a href="#lastseen" id="lastseen">last_seen</a>
</h1>
<p id="rfc.section.2.4.2.17.p.1">last_seen represents a reference time when the attribute was last seen. last_seen is expressed as an ISO 8601 datetime up to the micro-second with time zone support. </p>
<p id="rfc.section.2.4.2.17.p.2">last_seen is represented as a JSON string. last_seen MAY be present. </p>
<h1 id="rfc.section.2.5">
<a href="#rfc.section.2.5">2.5.</a> <a href="#shadowattribute-1" id="shadowattribute-1">ShadowAttribute</a>
</h1>
<p id="rfc.section.2.5.p.1">ShadowAttributes are 3rd party created attributes that either propose to add new information to an event or modify existing information. They are not meant to be actionable until the event creator accepts them - at which point they will be converted into attributes or modify an existing attribute. </p>
<p id="rfc.section.2.5.p.2">They are similar in structure to Attributes but additionally carry a reference to the creator of the ShadowAttribute as well as a revocation flag. </p>
<h1 id="rfc.section.2.5.1">
<a href="#rfc.section.2.5.1">2.5.1.</a> <a href="#sample-attribute-object-1" id="sample-attribute-object-1">Sample Attribute Object</a>
</h1>
<pre>
"ShadowAttribute": {
"id": "8",
"type": "ip-src",
"category": "Network activity",
"to_ids": false,
"uuid": "57d475f1-da78-4569-89de-1458c0a83869",
"event_uuid": "57d475e6-41c4-41ca-b450-145ec0a83869",
"event_id": "9",
"old_id": "319",
"comment": "",
"org_id": "1",
"proposal_to_delete": false,
"value": "5.5.5.5",
"deleted": false,
"Org": {
"id": "1",
"name": "MISP",
"uuid": "568cce5a-0c80-412b-8fdf-1ffac0a83869"
},
"first_seen": "2019-06-02T22:14:28.711954+00:00",
"last_seen": null
}
</pre>
<h1 id="rfc.section.2.5.2">
<a href="#rfc.section.2.5.2">2.5.2.</a> <a href="#shadowattribute-attributes" id="shadowattribute-attributes">ShadowAttribute Attributes</a>
</h1>
<h1 id="rfc.section.2.5.2.1">
<a href="#rfc.section.2.5.2.1">2.5.2.1.</a> <a href="#uuid-2" id="uuid-2">uuid</a>
</h1>
<p id="rfc.section.2.5.2.1.p.1">uuid represents the Universally Unique IDentifier (UUID) <a href="#RFC4122" class="xref">[RFC4122]</a> of the event. The uuid MUST be preserved for any updates or transfer of the same event. UUID version 4 is RECOMMENDED when assigning it to a new event. </p>
<p id="rfc.section.2.5.2.1.p.2">uuid is represented as a JSON string. uuid MUST be present. </p>
<h1 id="rfc.section.2.5.2.2">
<a href="#rfc.section.2.5.2.2">2.5.2.2.</a> <a href="#id-2" id="id-2">id</a>
</h1>
<p id="rfc.section.2.5.2.2.p.1">id represents the human-readable identifier associated to the event for a specific MISP instance. human-readable identifier MUST be represented as an unsigned integer. id is represented as a JSON string. id SHALL be present. </p>
<h1 id="rfc.section.2.5.2.3">
<a href="#rfc.section.2.5.2.3">2.5.2.3.</a> <a href="#type-1" id="type-1">type</a>
</h1>
<p id="rfc.section.2.5.2.3.p.1">type represents the means through which an attribute tries to describe the intent of the attribute creator, using a list of pre-defined attribute types. </p>
<p id="rfc.section.2.5.2.3.p.2">type is represented as a JSON string. type MUST be present and it MUST be a valid selection for the chosen category. The list of valid category-type combinations is as follows: </p>
<p></p>
<dl>
<dt>Antivirus detection</dt>
<dd style="margin-left: 8">
<br> link, comment, text, hex, attachment, other, anonymised</dd>
<dt>Artifacts dropped</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, regkey, regkey|value, pattern-in-file, pattern-in-memory, filename-pattern, pdb, stix2-pattern, yara, sigma, attachment, malware-sample, named pipe, mutex, windows-scheduled-task, windows-service-name, windows-service-displayname, comment, text, hex, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, other, cookie, gene, kusto-query, mime-type, anonymised, pgp-public-key, pgp-private-key</dd>
<dt>Attribution</dt>
<dd style="margin-left: 8">
<br> threat-actor, campaign-name, campaign-id, whois-registrant-phone, whois-registrant-email, whois-registrant-name, whois-registrant-org, whois-registrar, whois-creation-date, comment, text, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, other, dns-soa-email, anonymised, email</dd>
<dt>External analysis</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha256, sha3-224, sha3-256, sha3-384, sha3-512, filename, filename|md5, filename|sha1, filename|sha256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, ip-src, ip-dst, ip-dst|port, ip-src|port, mac-address, mac-eui-64, hostname, domain, domain|ip, url, user-agent, regkey, regkey|value, AS, snort, bro, zeek, pattern-in-file, pattern-in-traffic, pattern-in-memory, filename-pattern, vulnerability, cpe, weakness, attachment, malware-sample, link, comment, text, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, github-repository, other, cortex, anonymised, community-id</dd>
<dt>Financial fraud</dt>
<dd style="margin-left: 8">
<br> btc, dash, xmr, iban, bic, bank-account-nr, aba-rtn, bin, cc-number, prtn, phone-number, comment, text, other, hex, anonymised</dd>
<dt>Internal reference</dt>
<dd style="margin-left: 8">
<br> text, link, comment, other, hex, anonymised, git-commit-id</dd>
<dt>Network activity</dt>
<dd style="margin-left: 8">
<br> ip-src, ip-dst, ip-dst|port, ip-src|port, port, hostname, domain, domain|ip, mac-address, mac-eui-64, email, email-dst, email-src, eppn, url, uri, user-agent, http-method, AS, snort, pattern-in-file, filename-pattern, stix2-pattern, pattern-in-traffic, attachment, comment, text, x509-fingerprint-md5, x509-fingerprint-sha1, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, other, hex, cookie, hostname|port, bro, zeek, anonymised, community-id, email-subject</dd>
<dt>Other</dt>
<dd style="margin-left: 8">
<br> comment, text, other, size-in-bytes, counter, datetime, cpe, port, float, hex, phone-number, boolean, anonymised, pgp-public-key, pgp-private-key</dd>
<dt>Payload delivery</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, pehash, tlsh, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, mac-address, mac-eui-64, ip-src, ip-dst, ip-dst|port, ip-src|port, hostname, domain, email, email-src, email-dst, email-subject, email-attachment, email-body, url, user-agent, AS, pattern-in-file, pattern-in-traffic, filename-pattern, stix2-pattern, yara, sigma, mime-type, attachment, malware-sample, link, malware-type, comment, text, hex, vulnerability, cpe, weakness, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, ja3-fingerprint-md5, hassh-md5, hasshserver-md5, other, hostname|port, email-dst-display-name, email-src-display-name, email-header, email-reply-to, email-x-mailer, email-mime-boundary, email-thread-index, email-message-id, mobile-application-id, chrome-extension-id, whois-registrant-email, anonymised</dd>
<dt>Payload installation</dt>
<dd style="margin-left: 8">
<br> md5, sha1, sha224, sha256, sha384, sha512, sha512/224, sha512/256, sha3-224, sha3-256, sha3-384, sha3-512, ssdeep, imphash, telfhash, impfuzzy, authentihash, vhash, pehash, tlsh, cdhash, filename, filename|md5, filename|sha1, filename|sha224, filename|sha256, filename|sha384, filename|sha512, filename|sha512/224, filename|sha512/256, filename|sha3-224, filename|sha3-256, filename|sha3-384, filename|sha3-512, filename|authentihash, filename|vhash, filename|ssdeep, filename|tlsh, filename|imphash, filename|impfuzzy, filename|pehash, pattern-in-file, pattern-in-traffic, pattern-in-memory, filename-pattern, stix2-pattern, yara, sigma, vulnerability, cpe, weakness, attachment, malware-sample, malware-type, comment, text, hex, x509-fingerprint-sha1, x509-fingerprint-md5, x509-fingerprint-sha256, mobile-application-id, chrome-extension-id, other, mime-type, anonymised</dd>
<dt>Payload type</dt>
<dd style="margin-left: 8">
<br> comment, text, other, anonymised</dd>
<dt>Persistence mechanism</dt>
<dd style="margin-left: 8">
<br> filename, regkey, regkey|value, comment, text, other, hex, anonymised</dd>
<dt>Person</dt>
</