misp-rfc/misp-core-format/raw.md.html

4698 lines
238 KiB
HTML
Executable File
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

<!DOCTYPE html>
<html lang="en" class="Internet-Draft">
<head>
<meta charset="utf-8">
<meta content="Common,Latin" name="scripts">
<meta content="initial-scale=1.0" name="viewport">
<title>MISP core format</title>
<meta content="Alexandre Dulaunoy" name="author">
<meta content="Andras Iklody" name="author">
<meta 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.
" name="description">
<meta content="xml2rfc 3.21.0" name="generator">
<meta content="draft-17" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.21.0
Python 3.10.12
ConfigArgParse 1.7
google-i18n-address 3.1.0
intervaltree 3.1.0
Jinja2 3.1.2
lxml 4.9.2
platformdirs 4.1.0
pycountry 22.3.5
PyYAML 6.0
requests 2.31.0
setuptools 67.7.2
six 1.16.0
wcwidth 0.2.13
weasyprint 61.2
-->
<link href="raw.md.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
<style type="text/css">/*
NOTE: Changes at the bottom of this file overrides some earlier settings.
Once the style has stabilized and has been adopted as an official RFC style,
this can be consolidated so that style settings occur only in one place, but
for now the contents of this file consists first of the initial CSS work as
provided to the RFC Formatter (xml2rfc) work, followed by itemized and
commented changes found necessary during the development of the v3
formatters.
*/
/* fonts */
@import url('https://fonts.googleapis.com/css?family=Noto+Sans'); /* Sans-serif */
@import url('https://fonts.googleapis.com/css?family=Noto+Serif'); /* Serif (print) */
@import url('https://fonts.googleapis.com/css?family=Roboto+Mono'); /* Monospace */
:root {
--font-sans: 'Noto Sans', Arial, Helvetica, sans-serif;
--font-serif: 'Noto Serif', 'Times', 'Times New Roman', serif;
--font-mono: 'Roboto Mono', Courier, 'Courier New', monospace;
}
@viewport {
zoom: 1.0;
}
@-ms-viewport {
width: extend-to-zoom;
zoom: 1.0;
}
/* general and mobile first */
html {
}
body {
max-width: 90%;
margin: 1.5em auto;
color: #222;
background-color: #fff;
font-size: 14px;
font-family: var(--font-sans);
line-height: 1.6;
scroll-behavior: smooth;
overflow-wrap: break-word;
}
.ears {
display: none;
}
/* headings */
#title, h1, h2, h3, h4, h5, h6 {
margin: 1em 0 0.5em;
font-weight: bold;
line-height: 1.3;
}
#title {
clear: both;
border-bottom: 1px solid #ddd;
margin: 0 0 0.5em 0;
padding: 1em 0 0.5em;
}
.author {
padding-bottom: 4px;
}
h1 {
font-size: 26px;
margin: 1em 0;
}
h2 {
font-size: 22px;
margin-top: -20px; /* provide offset for in-page anchors */
padding-top: 33px;
}
h3 {
font-size: 18px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h4 {
font-size: 16px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h5, h6 {
font-size: 14px;
}
#n-copyright-notice {
border-bottom: 1px solid #ddd;
padding-bottom: 1em;
margin-bottom: 1em;
}
/* general structure */
p {
padding: 0;
margin: 0 0 1em 0;
text-align: left;
}
div, span {
position: relative;
}
div {
margin: 0;
}
.alignRight.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignRight.art-text pre {
padding: 0;
}
.alignRight {
margin: 1em 0;
}
.alignRight > *:first-child {
border: none;
margin: 0;
float: right;
clear: both;
}
.alignRight > *:nth-child(2) {
clear: both;
display: block;
border: none;
}
svg {
display: block;
}
svg[font-family~="serif" i], svg [font-family~="serif" i] {
font-family: var(--font-serif);
}
svg[font-family~="sans-serif" i], svg [font-family~="sans-serif" i] {
font-family: var(--font-sans);
}
svg[font-family~="monospace" i], svg [font-family~="monospace" i] {
font-family: var(--font-mono);
}
.alignCenter.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignCenter.art-text pre {
padding: 0;
}
.alignCenter {
margin: 1em 0;
}
.alignCenter > *:first-child {
display: table;
border: none;
margin: 0 auto;
}
/* lists */
ol, ul {
padding: 0;
margin: 0 0 1em 2em;
}
ol ol, ul ul, ol ul, ul ol {
margin-left: 1em;
}
li {
margin: 0 0 0.25em 0;
}
.ulCompact li {
margin: 0;
}
ul.empty, .ulEmpty {
list-style-type: none;
}
ul.empty li, .ulEmpty li {
margin-top: 0.5em;
}
ul.ulBare, li.ulBare {
margin-left: 0em !important;
}
ul.compact, .ulCompact,
ol.compact, .olCompact {
line-height: 100%;
margin: 0 0 0 2em;
}
/* definition lists */
dl {
}
dl > dt {
float: left;
margin-right: 1em;
}
/*
dl.nohang > dt {
float: none;
}
*/
dl > dd {
margin-bottom: .8em;
min-height: 1.3em;
}
dl.compact > dd, .dlCompact > dd {
margin-bottom: 0em;
}
dl > dd > dl {
margin-top: 0.5em;
margin-bottom: 0em;
}
/* links */
a {
text-decoration: none;
}
a[href] {
color: #22e; /* Arlen: WCAG 2019 */
}
a[href]:hover {
background-color: #f2f2f2;
}
figcaption a[href],
a[href].selfRef {
color: #222;
}
/* XXX probably not this:
a.selfRef:hover {
background-color: transparent;
cursor: default;
} */
/* Figures */
tt, code, pre {
background-color: #f9f9f9;
font-family: var(--font-mono);
}
pre {
border: 1px solid #eee;
margin: 0;
padding: 1em;
}
img {
max-width: 100%;
}
figure {
margin: 0;
}
figure blockquote {
margin: 0.8em 0.4em 0.4em;
}
figcaption {
font-style: italic;
margin: 0 0 1em 0;
}
@media screen {
pre {
overflow-x: auto;
max-width: 100%;
max-width: calc(100% - 22px);
}
}
/* aside, blockquote */
aside, blockquote {
margin-left: 0;
padding: 1.2em 2em;
}
blockquote {
background-color: #f9f9f9;
color: #111; /* Arlen: WCAG 2019 */
border: 1px solid #ddd;
border-radius: 3px;
margin: 1em 0;
}
blockquote > *:last-child {
margin-bottom: 0;
}
cite {
display: block;
text-align: right;
font-style: italic;
}
.xref {
overflow-wrap: normal;
}
/* tables */
table {
width: 100%;
margin: 0 0 1em;
border-collapse: collapse;
border: 1px solid #eee;
}
th, td {
text-align: left;
vertical-align: top;
padding: 0.5em 0.75em;
}
th {
text-align: left;
background-color: #e9e9e9;
}
tr:nth-child(2n+1) > td {
background-color: #f5f5f5;
}
table caption {
font-style: italic;
margin: 0;
padding: 0;
text-align: left;
}
table p {
/* XXX to avoid bottom margin on table row signifiers. If paragraphs should
be allowed within tables more generally, it would be far better to select on a class. */
margin: 0;
}
/* pilcrow */
a.pilcrow {
color: #666; /* Arlen: AHDJ 2019 */
text-decoration: none;
visibility: hidden;
user-select: none;
-ms-user-select: none;
-o-user-select:none;
-moz-user-select: none;
-khtml-user-select: none;
-webkit-user-select: none;
-webkit-touch-callout: none;
}
@media screen {
aside:hover > a.pilcrow,
p:hover > a.pilcrow,
blockquote:hover > a.pilcrow,
div:hover > a.pilcrow,
li:hover > a.pilcrow,
pre:hover > a.pilcrow {
visibility: visible;
}
a.pilcrow:hover {
background-color: transparent;
}
}
/* misc */
hr {
border: 0;
border-top: 1px solid #eee;
}
.bcp14 {
font-variant: small-caps;
}
.role {
font-variant: all-small-caps;
}
/* info block */
#identifiers {
margin: 0;
font-size: 0.9em;
}
#identifiers dt {
width: 3em;
clear: left;
}
#identifiers dd {
float: left;
margin-bottom: 0;
}
/* Fix PDF info block run off issue */
@media print {
#identifiers dd {
float: none;
}
}
#identifiers .authors .author {
display: inline-block;
margin-right: 1.5em;
}
#identifiers .authors .org {
font-style: italic;
}
/* The prepared/rendered info at the very bottom of the page */
.docInfo {
color: #666; /* Arlen: WCAG 2019 */
font-size: 0.9em;
font-style: italic;
margin-top: 2em;
}
.docInfo .prepared {
float: left;
}
.docInfo .prepared {
float: right;
}
/* table of contents */
#toc {
padding: 0.75em 0 2em 0;
margin-bottom: 1em;
}
nav.toc ul {
margin: 0 0.5em 0 0;
padding: 0;
list-style: none;
}
nav.toc li {
line-height: 1.3em;
margin: 0.75em 0;
padding-left: 1.2em;
text-indent: -1.2em;
}
/* references */
.references dt {
text-align: right;
font-weight: bold;
min-width: 7em;
}
.references dd {
margin-left: 8em;
overflow: auto;
}
.refInstance {
margin-bottom: 1.25em;
}
.refSubseries {
margin-bottom: 1.25em;
}
.references .ascii {
margin-bottom: 0.25em;
}
/* index */
.index ul {
margin: 0 0 0 1em;
padding: 0;
list-style: none;
}
.index ul ul {
margin: 0;
}
.index li {
margin: 0;
text-indent: -2em;
padding-left: 2em;
padding-bottom: 5px;
}
.indexIndex {
margin: 0.5em 0 1em;
}
.index a {
font-weight: 700;
}
/* make the index two-column on all but the smallest screens */
@media (min-width: 600px) {
.index ul {
-moz-column-count: 2;
-moz-column-gap: 20px;
}
.index ul ul {
-moz-column-count: 1;
-moz-column-gap: 0;
}
}
/* authors */
address.vcard {
font-style: normal;
margin: 1em 0;
}
address.vcard .nameRole {
font-weight: 700;
margin-left: 0;
}
address.vcard .label {
font-family: var(--font-sans);
margin: 0.5em 0;
}
address.vcard .type {
display: none;
}
.alternative-contact {
margin: 1.5em 0 1em;
}
hr.addr {
border-top: 1px dashed;
margin: 0;
color: #ddd;
max-width: calc(100% - 16px);
}
/* temporary notes */
.rfcEditorRemove::before {
position: absolute;
top: 0.2em;
right: 0.2em;
padding: 0.2em;
content: "The RFC Editor will remove this note";
color: #9e2a00; /* Arlen: WCAG 2019 */
background-color: #ffd; /* Arlen: WCAG 2019 */
}
.rfcEditorRemove {
position: relative;
padding-top: 1.8em;
background-color: #ffd; /* Arlen: WCAG 2019 */
border-radius: 3px;
}
.cref {
background-color: #ffd; /* Arlen: WCAG 2019 */
padding: 2px 4px;
}
.crefSource {
font-style: italic;
}
/* alternative layout for smaller screens */
@media screen and (max-width: 1023px) {
body {
padding-top: 2em;
}
#title {
padding: 1em 0;
}
h1 {
font-size: 24px;
}
h2 {
font-size: 20px;
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 38px;
}
#identifiers dd {
max-width: 60%;
}
#toc {
position: fixed;
z-index: 2;
top: 0;
right: 0;
padding: 0;
margin: 0;
background-color: inherit;
border-bottom: 1px solid #ccc;
}
#toc h2 {
margin: -1px 0 0 0;
padding: 4px 0 4px 6px;
padding-right: 1em;
min-width: 190px;
font-size: 1.1em;
text-align: right;
background-color: #444;
color: white;
cursor: pointer;
}
#toc h2::before { /* css hamburger */
float: right;
position: relative;
width: 1em;
height: 1px;
left: -164px;
margin: 6px 0 0 0;
background: white none repeat scroll 0 0;
box-shadow: 0 4px 0 0 white, 0 8px 0 0 white;
content: "";
}
#toc nav {
display: none;
padding: 0.5em 1em 1em;
overflow: auto;
height: calc(100vh - 48px);
border-left: 1px solid #ddd;
}
}
/* alternative layout for wide screens */
@media screen and (min-width: 1024px) {
body {
max-width: 724px;
margin: 42px auto;
padding-left: 1.5em;
padding-right: 29em;
}
#toc {
position: fixed;
top: 42px;
right: 42px;
width: 25%;
margin: 0;
padding: 0 1em;
z-index: 1;
}
#toc h2 {
border-top: none;
border-bottom: 1px solid #ddd;
font-size: 1em;
font-weight: normal;
margin: 0;
padding: 0.25em 1em 1em 0;
}
#toc nav {
display: block;
height: calc(90vh - 84px);
bottom: 0;
padding: 0.5em 0 0;
overflow: auto;
}
img { /* future proofing */
max-width: 100%;
height: auto;
}
}
/* pagination */
@media print {
body {
width: 100%;
}
p {
orphans: 3;
widows: 3;
}
#n-copyright-notice {
border-bottom: none;
}
#toc, #n-introduction {
page-break-before: always;
}
#toc {
border-top: none;
padding-top: 0;
}
figure, pre {
page-break-inside: avoid;
}
figure {
overflow: scroll;
}
.breakable pre {
break-inside: auto;
}
h1, h2, h3, h4, h5, h6 {
page-break-after: avoid;
}
h2+*, h3+*, h4+*, h5+*, h6+* {
page-break-before: avoid;
}
pre {
white-space: pre-wrap;
word-wrap: break-word;
font-size: 10pt;
}
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
}
/* This is commented out here, as the string-set: doesn't
pass W3C validation currently */
/*
.ears thead .left {
string-set: ears-top-left content();
}
.ears thead .center {
string-set: ears-top-center content();
}
.ears thead .right {
string-set: ears-top-right content();
}
.ears tfoot .left {
string-set: ears-bottom-left content();
}
.ears tfoot .center {
string-set: ears-bottom-center content();
}
.ears tfoot .right {
string-set: ears-bottom-right content();
}
*/
@page :first {
padding-top: 0;
@top-left {
content: normal;
border: none;
}
@top-center {
content: normal;
border: none;
}
@top-right {
content: normal;
border: none;
}
}
@page {
size: A4;
margin-bottom: 45mm;
padding-top: 20px;
/* The following is commented out here, but set appropriately by in code, as
the content depends on the document */
/*
@top-left {
content: 'Internet-Draft';
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-left {
content: string(ears-top-left);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-center {
content: string(ears-top-center);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-right {
content: string(ears-top-right);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@bottom-left {
content: string(ears-bottom-left);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-center {
content: string(ears-bottom-center);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-right {
content: '[Page ' counter(page) ']';
vertical-align: top;
border-top: solid 1px #ccc;
}
*/
}
/* Changes introduced to fix issues found during implementation */
/* Make sure links are clickable even if overlapped by following H* */
a {
z-index: 2;
}
/* Separate body from document info even without intervening H1 */
section {
clear: both;
}
/* Top align author divs, to avoid names without organization dropping level with org names */
.author {
vertical-align: top;
}
/* Leave room in document info to show Internet-Draft on one line */
#identifiers dt {
width: 8em;
}
/* Don't waste quite as much whitespace between label and value in doc info */
#identifiers dd {
margin-left: 1em;
}
/* Give floating toc a background color (needed when it's a div inside section */
#toc {
background-color: white;
}
/* Make the collapsed ToC header render white on gray also when it's a link */
@media screen and (max-width: 1023px) {
#toc h2 a,
#toc h2 a:link,
#toc h2 a:focus,
#toc h2 a:hover,
#toc a.toplink,
#toc a.toplink:hover {
color: white;
background-color: #444;
text-decoration: none;
}
}
/* Give the bottom of the ToC some whitespace */
@media screen and (min-width: 1024px) {
#toc {
padding: 0 0 1em 1em;
}
}
/* Style section numbers with more space between number and title */
.section-number {
padding-right: 0.5em;
}
/* prevent monospace from becoming overly large */
tt, code, pre {
font-size: 95%;
}
/* Fix the height/width aspect for ascii art*/
.sourcecode pre,
.art-text pre {
line-height: 1.12;
}
/* Add styling for a link in the ToC that points to the top of the document */
a.toplink {
float: right;
margin-right: 0.5em;
}
/* Fix the dl styling to match the RFC 7992 attributes */
dl > dt,
dl.dlParallel > dt {
float: left;
margin-right: 1em;
}
dl.dlNewline > dt {
float: none;
}
/* Provide styling for table cell text alignment */
table td.text-left,
table th.text-left {
text-align: left;
}
table td.text-center,
table th.text-center {
text-align: center;
}
table td.text-right,
table th.text-right {
text-align: right;
}
/* Make the alternative author contact information look less like just another
author, and group it closer with the primary author contact information */
.alternative-contact {
margin: 0.5em 0 0.25em 0;
}
address .non-ascii {
margin: 0 0 0 2em;
}
/* With it being possible to set tables with alignment
left, center, and right, { width: 100%; } does not make sense */
table {
width: auto;
}
/* Avoid reference text that sits in a block with very wide left margin,
because of a long floating dt label.*/
.references dd {
overflow: visible;
}
/* Control caption placement */
caption {
caption-side: bottom;
}
/* Limit the width of the author address vcard, so names in right-to-left
script don't end up on the other side of the page. */
address.vcard {
max-width: 30em;
margin-right: auto;
}
/* For address alignment dependent on LTR or RTL scripts */
address div.left {
text-align: left;
}
address div.right {
text-align: right;
}
/* Provide table alignment support. We can't use the alignX classes above
since they do unwanted things with caption and other styling. */
table.right {
margin-left: auto;
margin-right: 0;
}
table.center {
margin-left: auto;
margin-right: auto;
}
table.left {
margin-left: 0;
margin-right: auto;
}
/* Give the table caption label the same styling as the figcaption */
caption a[href] {
color: #222;
}
@media print {
.toplink {
display: none;
}
/* avoid overwriting the top border line with the ToC header */
#toc {
padding-top: 1px;
}
/* Avoid page breaks inside dl and author address entries */
.vcard {
page-break-inside: avoid;
}
}
/* Tweak the bcp14 keyword presentation */
.bcp14 {
font-variant: small-caps;
font-weight: bold;
font-size: 0.9em;
}
/* Tweak the invisible space above H* in order not to overlay links in text above */
h2 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 31px;
}
h3 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
h4 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
/* Float artwork pilcrow to the right */
@media screen {
.artwork a.pilcrow {
display: block;
line-height: 0.7;
margin-top: 0.15em;
}
}
/* Make pilcrows on dd visible */
@media screen {
dd:hover > a.pilcrow {
visibility: visible;
}
}
/* Make the placement of figcaption match that of a table's caption
by removing the figure's added bottom margin */
.alignLeft.art-text,
.alignCenter.art-text,
.alignRight.art-text {
margin-bottom: 0;
}
.alignLeft,
.alignCenter,
.alignRight {
margin: 1em 0 0 0;
}
/* In print, the pilcrow won't show on hover, so prevent it from taking up space,
possibly even requiring a new line */
@media print {
a.pilcrow {
display: none;
}
}
/* Styling for the external metadata */
div#external-metadata {
background-color: #eee;
padding: 0.5em;
margin-bottom: 0.5em;
display: none;
}
div#internal-metadata {
padding: 0.5em; /* to match the external-metadata padding */
}
/* Styling for title RFC Number */
h1#rfcnum {
clear: both;
margin: 0 0 -1em;
padding: 1em 0 0 0;
}
/* Make .olPercent look the same as <ol><li> */
dl.olPercent > dd {
margin-bottom: 0.25em;
min-height: initial;
}
/* Give aside some styling to set it apart */
aside {
border-left: 1px solid #ddd;
margin: 1em 0 1em 2em;
padding: 0.2em 2em;
}
aside > dl,
aside > ol,
aside > ul,
aside > table,
aside > p {
margin-bottom: 0.5em;
}
/* Additional page break settings */
@media print {
figcaption, table caption {
page-break-before: avoid;
}
}
/* Font size adjustments for print */
@media print {
body { font-size: 10pt; line-height: normal; max-width: 96%; }
h1 { font-size: 1.72em; padding-top: 1.5em; } /* 1*1.2*1.2*1.2 */
h2 { font-size: 1.44em; padding-top: 1.5em; } /* 1*1.2*1.2 */
h3 { font-size: 1.2em; padding-top: 1.5em; } /* 1*1.2 */
h4 { font-size: 1em; padding-top: 1.5em; }
h5, h6 { font-size: 1em; margin: initial; padding: 0.5em 0 0.3em; }
}
/* Sourcecode margin in print, when there's no pilcrow */
@media print {
.artwork,
.artwork > pre,
.sourcecode {
margin-bottom: 1em;
}
}
/* Avoid narrow tables forcing too narrow table captions, which may render badly */
table {
min-width: 20em;
}
/* ol type a */
ol.type-a { list-style-type: lower-alpha; }
ol.type-A { list-style-type: upper-alpha; }
ol.type-i { list-style-type: lower-roman; }
ol.type-I { list-style-type: lower-roman; }
/* Apply the print table and row borders in general, on request from the RPC,
and increase the contrast between border and odd row background slightly */
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
tr {
break-inside: avoid;
}
tr:nth-child(2n+1) > td {
background-color: #f8f8f8;
}
/* Use style rules to govern display of the TOC. */
@media screen and (max-width: 1023px) {
#toc nav { display: none; }
#toc.active nav { display: block; }
}
/* Add support for keepWithNext */
.keepWithNext {
break-after: avoid-page;
break-after: avoid-page;
}
/* Add support for keepWithPrevious */
.keepWithPrevious {
break-before: avoid-page;
}
/* Change the approach to avoiding breaks inside artwork etc. */
figure, pre, table, .artwork, .sourcecode {
break-before: auto;
break-after: auto;
}
/* Avoid breaks between <dt> and <dd> */
dl {
break-before: auto;
break-inside: auto;
}
dt {
break-before: auto;
break-after: avoid-page;
}
dd {
break-before: avoid-page;
break-after: auto;
orphans: 3;
widows: 3
}
span.break, dd.break {
margin-bottom: 0;
min-height: 0;
break-before: auto;
break-inside: auto;
break-after: auto;
}
/* Undo break-before ToC */
@media print {
#toc {
break-before: auto;
}
}
/* Text in compact lists should not get extra bottom margin space,
since that would makes the list not compact */
ul.compact p, .ulCompact p,
ol.compact p, .olCompact p {
margin: 0;
}
/* But the list as a whole needs the extra space at the end */
section ul.compact,
section .ulCompact,
section ol.compact,
section .olCompact {
margin-bottom: 1em; /* same as p not within ul.compact etc. */
}
/* The tt and code background above interferes with for instance table cell
backgrounds. Changed to something a bit more selective. */
tt, code {
background-color: transparent;
}
p tt, p code, li tt, li code {
background-color: #f8f8f8;
}
/* Tweak the pre margin -- 0px doesn't come out well */
pre {
margin-top: 0.5px;
}
/* Tweak the compact list text */
ul.compact, .ulCompact,
ol.compact, .olCompact,
dl.compact, .dlCompact {
line-height: normal;
}
/* Don't add top margin for nested lists */
li > ul, li > ol, li > dl,
dd > ul, dd > ol, dd > dl,
dl > dd > dl {
margin-top: initial;
}
/* Elements that should not be rendered on the same line as a <dt> */
/* This should match the element list in writer.text.TextWriter.render_dl() */
dd > div.artwork:first-child,
dd > aside:first-child,
dd > figure:first-child,
dd > ol:first-child,
dd > div.sourcecode:first-child,
dd > table:first-child,
dd > ul:first-child {
clear: left;
}
/* fix for weird browser behaviour when <dd/> is empty */
dt+dd:empty::before{
content: "\00a0";
}
/* Make paragraph spacing inside <li> smaller than in body text, to fit better within the list */
li > p {
margin-bottom: 0.5em
}
/* Don't let p margin spill out from inside list items */
li > p:last-of-type:only-child {
margin-bottom: 0;
}
</style>
<link href="rfc-local.css" rel="stylesheet" type="text/css">
<script type="application/javascript">async function addMetadata(){try{const e=document.styleSheets[0].cssRules;for(let t=0;t<e.length;t++)if(/#identifiers/.exec(e[t].selectorText)){const a=e[t].cssText.replace("#identifiers","#external-updates");document.styleSheets[0].insertRule(a,document.styleSheets[0].cssRules.length)}}catch(e){console.log(e)}const e=document.getElementById("external-metadata");if(e)try{var t,a="",o=function(e){const t=document.getElementsByTagName("meta");for(let a=0;a<t.length;a++)if(t[a].getAttribute("name")===e)return t[a].getAttribute("content");return""}("rfc.number");if(o){t="https://www.rfc-editor.org/rfc/rfc"+o+".json";try{const e=await fetch(t);a=await e.json()}catch(e){t=document.URL.indexOf("html")>=0?document.URL.replace(/html$/,"json"):document.URL+".json";const o=await fetch(t);a=await o.json()}}if(!a)return;e.style.display="block";const s="",d="https://datatracker.ietf.org/doc",n="https://datatracker.ietf.org/ipr/search",c="https://www.rfc-editor.org/info",l=a.doc_id.toLowerCase(),i=a.doc_id.slice(0,3).toLowerCase(),f=a.doc_id.slice(3).replace(/^0+/,""),u={status:"Status",obsoletes:"Obsoletes",obsoleted_by:"Obsoleted By",updates:"Updates",updated_by:"Updated By",see_also:"See Also",errata_url:"Errata"};let h="<dl style='overflow:hidden' id='external-updates'>";["status","obsoletes","obsoleted_by","updates","updated_by","see_also","errata_url"].forEach(e=>{if("status"==e){a[e]=a[e].toLowerCase();var t=a[e].split(" "),o=t.length,w="",p=1;for(let e=0;e<o;e++)p<o?w=w+r(t[e])+" ":w+=r(t[e]),p++;a[e]=w}else if("obsoletes"==e||"obsoleted_by"==e||"updates"==e||"updated_by"==e){var g,m="",b=1;g=a[e].length;for(let t=0;t<g;t++)a[e][t]&&(a[e][t]=String(a[e][t]).toLowerCase(),m=b<g?m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>, ":m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>",b++);a[e]=m}else if("see_also"==e){var y,L="",C=1;y=a[e].length;for(let t=0;t<y;t++)if(a[e][t]){a[e][t]=String(a[e][t]);var _=a[e][t].slice(0,3),v=a[e][t].slice(3).replace(/^0+/,"");L=C<y?"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>, ":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>, ":"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>",C++}a[e]=L}else if("errata_url"==e){var R="";R=a[e]?R+"<a href='"+a[e]+"'>Errata exist</a> | <a href='"+d+"/"+l+"'>Datatracker</a>| <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>":"<a href='"+d+"/"+l+"'>Datatracker</a> | <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>",a[e]=R}""!=a[e]?"Errata"==u[e]?h+=`<dt>More info:</dt><dd>${a[e]}</dd>`:h+=`<dt>${u[e]}:</dt><dd>${a[e]}</dd>`:"Errata"==u[e]&&(h+=`<dt>More info:</dt><dd>${a[e]}</dd>`)}),h+="</dl>",e.innerHTML=h}catch(e){console.log(e)}else console.log("Could not locate metadata <div> element");function r(e){return e.charAt(0).toUpperCase()+e.slice(1)}}window.removeEventListener("load",addMetadata),window.addEventListener("load",addMetadata);</script>
</head>
<body class="xml2rfc">
<script src="metadata.min.js"></script>
<table class="ears">
<thead><tr>
<td class="left">Internet-Draft</td>
<td class="center">MISP core format</td>
<td class="right">June 2024</td>
</tr></thead>
<tfoot><tr>
<td class="left">Dulaunoy &amp; Iklody</td>
<td class="center">Expires 30 December 2024</td>
<td class="right">[Page]</td>
</tr></tfoot>
</table>
<div id="external-metadata" class="document-information"></div>
<div id="internal-metadata" class="document-information">
<dl id="identifiers">
<dt class="label-workgroup">Workgroup:</dt>
<dd class="workgroup">Network Working Group</dd>
<dt class="label-internet-draft">Internet-Draft:</dt>
<dd class="internet-draft">draft-17</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2024-06-28" class="published">28 June 2024</time>
</dd>
<dt class="label-intended-status">Intended Status:</dt>
<dd class="intended-status">Informational</dd>
<dt class="label-expires">Expires:</dt>
<dd class="expires"><time datetime="2024-12-30">30 December 2024</time></dd>
<dt class="label-authors">Authors:</dt>
<dd class="authors">
<div class="author">
<div class="author-name">A. Dulaunoy</div>
<div class="org">CIRCL</div>
</div>
<div class="author">
<div class="author-name">A. Iklody</div>
<div class="org">CIRCL</div>
</div>
</dd>
</dl>
</div>
<h1 id="title">MISP core format</h1>
<section id="section-abstract">
<h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
<p id="section-abstract-1">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 <span>[<a href="#MISP-P" class="cite xref">MISP-P</a>]</span> software and other Threat Intelligence Platforms.<a href="#section-abstract-1" class="pilcrow"></a></p>
</section>
<div id="status-of-memo">
<section id="section-boilerplate.1">
<h2 id="name-status-of-this-memo">
<a href="#name-status-of-this-memo" class="section-name selfRef">Status of This Memo</a>
</h2>
<p id="section-boilerplate.1-1">
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.<a href="#section-boilerplate.1-1" class="pilcrow"></a></p>
<p id="section-boilerplate.1-2">
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 <span><a href="https://datatracker.ietf.org/drafts/current/">https://datatracker.ietf.org/drafts/current/</a></span>.<a href="#section-boilerplate.1-2" class="pilcrow"></a></p>
<p id="section-boilerplate.1-3">
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."<a href="#section-boilerplate.1-3" class="pilcrow"></a></p>
<p id="section-boilerplate.1-4">
This Internet-Draft will expire on 30 December 2024.<a href="#section-boilerplate.1-4" class="pilcrow"></a></p>
</section>
</div>
<div id="copyright">
<section id="section-boilerplate.2">
<h2 id="name-copyright-notice">
<a href="#name-copyright-notice" class="section-name selfRef">Copyright Notice</a>
</h2>
<p id="section-boilerplate.2-1">
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.<a href="#section-boilerplate.2-1" class="pilcrow"></a></p>
<p id="section-boilerplate.2-2">
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<span><a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a></span>) 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.<a href="#section-boilerplate.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="toc">
<section id="section-toc.1">
<a href="#" onclick="scroll(0,0)" class="toplink"></a><h2 id="name-table-of-contents">
<a href="#name-table-of-contents" class="section-name selfRef">Table of Contents</a>
</h2>
<nav class="toc"><ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1">
<p id="section-toc.1-1.1.1" class="keepWithNext"><a href="#section-1" class="auto internal xref">1</a>.  <a href="#name-introduction" class="internal xref">Introduction</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1.2.1">
<p id="section-toc.1-1.1.2.1.1" class="keepWithNext"><a href="#section-1.1" class="auto internal xref">1.1</a>.  <a href="#name-conventions-and-terminology" class="internal xref">Conventions and Terminology</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2">
<p id="section-toc.1-1.2.1"><a href="#section-2" class="auto internal xref">2</a>.  <a href="#name-format" class="internal xref">Format</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.1">
<p id="section-toc.1-1.2.2.1.1" class="keepWithNext"><a href="#section-2.1" class="auto internal xref">2.1</a>.  <a href="#name-overview" class="internal xref">Overview</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.2">
<p id="section-toc.1-1.2.2.2.1"><a href="#section-2.2" class="auto internal xref">2.2</a>.  <a href="#name-event" class="internal xref">Event</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.2.2.1">
<p id="section-toc.1-1.2.2.2.2.1.1"><a href="#section-2.2.1" class="auto internal xref">2.2.1</a>.  <a href="#name-event-attributes" class="internal xref">Event Attributes</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.2.2.2">
<p id="section-toc.1-1.2.2.2.2.2.1"><a href="#section-2.2.2" class="auto internal xref">2.2.2</a>.  <a href="#name-event-objects" class="internal xref">Event Objects</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.3">
<p id="section-toc.1-1.2.2.3.1"><a href="#section-2.3" class="auto internal xref">2.3</a>.  <a href="#name-attribute" class="internal xref">Attribute</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.3.2.1">
<p id="section-toc.1-1.2.2.3.2.1.1"><a href="#section-2.3.1" class="auto internal xref">2.3.1</a>.  <a href="#name-sample-attribute-object" class="internal xref">Sample Attribute Object</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.3.2.2">
<p id="section-toc.1-1.2.2.3.2.2.1"><a href="#section-2.3.2" class="auto internal xref">2.3.2</a>.  <a href="#name-attribute-attributes" class="internal xref">Attribute Attributes</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4">
<p id="section-toc.1-1.2.2.4.1"><a href="#section-2.4" class="auto internal xref">2.4</a>.  <a href="#name-shadowattribute-2" class="internal xref">ShadowAttribute</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.1">
<p id="section-toc.1-1.2.2.4.2.1.1"><a href="#section-2.4.1" class="auto internal xref">2.4.1</a>.  <a href="#name-sample-attribute-object-2" class="internal xref">Sample Attribute Object</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.2">
<p id="section-toc.1-1.2.2.4.2.2.1"><a href="#section-2.4.2" class="auto internal xref">2.4.2</a>.  <a href="#name-shadowattribute-attributes" class="internal xref">ShadowAttribute Attributes</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.3">
<p id="section-toc.1-1.2.2.4.2.3.1"><a href="#section-2.4.3" class="auto internal xref">2.4.3</a>.  <a href="#name-shadowattribute-objects" class="internal xref">ShadowAttribute Objects</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.5">
<p id="section-toc.1-1.2.2.5.1"><a href="#section-2.5" class="auto internal xref">2.5</a>.  <a href="#name-object" class="internal xref">Object</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.5.2.1">
<p id="section-toc.1-1.2.2.5.2.1.1"><a href="#section-2.5.1" class="auto internal xref">2.5.1</a>.  <a href="#name-sample-object" class="internal xref">Sample Object</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.5.2.2">
<p id="section-toc.1-1.2.2.5.2.2.1"><a href="#section-2.5.2" class="auto internal xref">2.5.2</a>.  <a href="#name-object-attributes" class="internal xref">Object Attributes</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.6">
<p id="section-toc.1-1.2.2.6.1"><a href="#section-2.6" class="auto internal xref">2.6</a>.  <a href="#name-object-references" class="internal xref">Object References</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.6.2.1">
<p id="section-toc.1-1.2.2.6.2.1.1"><a href="#section-2.6.1" class="auto internal xref">2.6.1</a>.  <a href="#name-sample-objectreference-obje" class="internal xref">Sample ObjectReference object</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.6.2.2">
<p id="section-toc.1-1.2.2.6.2.2.1"><a href="#section-2.6.2" class="auto internal xref">2.6.2</a>.  <a href="#name-objectreference-attributes" class="internal xref">ObjectReference Attributes</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7">
<p id="section-toc.1-1.2.2.7.1"><a href="#section-2.7" class="auto internal xref">2.7</a>.  <a href="#name-eventreport" class="internal xref">EventReport</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.1">
<p id="section-toc.1-1.2.2.7.2.1.1"><a href="#section-2.7.1" class="auto internal xref">2.7.1</a>.  <a href="#name-id-6" class="internal xref">id</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.2">
<p id="section-toc.1-1.2.2.7.2.2.1"><a href="#section-2.7.2" class="auto internal xref">2.7.2</a>.  <a href="#name-uuid-6" class="internal xref">UUID</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.3">
<p id="section-toc.1-1.2.2.7.2.3.1"><a href="#section-2.7.3" class="auto internal xref">2.7.3</a>.  <a href="#name-event_id-5" class="internal xref">event_id</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.4">
<p id="section-toc.1-1.2.2.7.2.4.1"><a href="#section-2.7.4" class="auto internal xref">2.7.4</a>.  <a href="#name-name-2" class="internal xref">name</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.5">
<p id="section-toc.1-1.2.2.7.2.5.1"><a href="#section-2.7.5" class="auto internal xref">2.7.5</a>.  <a href="#name-content" class="internal xref">content</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.6">
<p id="section-toc.1-1.2.2.7.2.6.1"><a href="#section-2.7.6" class="auto internal xref">2.7.6</a>.  <a href="#name-distribution-4" class="internal xref">distribution</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.7">
<p id="section-toc.1-1.2.2.7.2.7.1"><a href="#section-2.7.7" class="auto internal xref">2.7.7</a>.  <a href="#name-sharing_group_id-4" class="internal xref">sharing_group_id</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.8">
<p id="section-toc.1-1.2.2.7.2.8.1"><a href="#section-2.7.8" class="auto internal xref">2.7.8</a>.  <a href="#name-timestamp-6" class="internal xref">timestamp</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.7.2.9">
<p id="section-toc.1-1.2.2.7.2.9.1"><a href="#section-2.7.9" class="auto internal xref">2.7.9</a>.  <a href="#name-deleted-5" class="internal xref">deleted</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.8">
<p id="section-toc.1-1.2.2.8.1"><a href="#section-2.8" class="auto internal xref">2.8</a>.  <a href="#name-tag" class="internal xref">Tag</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.8.2.1">
<p id="section-toc.1-1.2.2.8.2.1.1"><a href="#section-2.8.1" class="auto internal xref">2.8.1</a>.  <a href="#name-sample-tag" class="internal xref">Sample Tag</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.9">
<p id="section-toc.1-1.2.2.9.1"><a href="#section-2.9" class="auto internal xref">2.9</a>.  <a href="#name-sighting" class="internal xref">Sighting</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.9.2.1">
<p id="section-toc.1-1.2.2.9.2.1.1"><a href="#section-2.9.1" class="auto internal xref">2.9.1</a>.  <a href="#name-sample-sighting" class="internal xref">Sample Sighting</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.10">
<p id="section-toc.1-1.2.2.10.1"><a href="#section-2.10" class="auto internal xref">2.10</a>. <a href="#name-galaxy" class="internal xref">Galaxy</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.10.2.1">
<p id="section-toc.1-1.2.2.10.2.1.1"><a href="#section-2.10.1" class="auto internal xref">2.10.1</a>.  <a href="#name-sample-galaxy" class="internal xref">Sample Galaxy</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.11">
<p id="section-toc.1-1.2.2.11.1"><a href="#section-2.11" class="auto internal xref">2.11</a>. <a href="#name-analyst-data" class="internal xref">Analyst Data</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.11.2.1">
<p id="section-toc.1-1.2.2.11.2.1.1"><a href="#section-2.11.1" class="auto internal xref">2.11.1</a>.  <a href="#name-opinion" class="internal xref">Opinion</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.11.2.2">
<p id="section-toc.1-1.2.2.11.2.2.1"><a href="#section-2.11.2" class="auto internal xref">2.11.2</a>.  <a href="#name-note" class="internal xref">Note</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.11.2.3">
<p id="section-toc.1-1.2.2.11.2.3.1"><a href="#section-2.11.3" class="auto internal xref">2.11.3</a>.  <a href="#name-relationship" class="internal xref">Relationship</a></p>
</li>
</ul>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3">
<p id="section-toc.1-1.3.1"><a href="#section-3" class="auto internal xref">3</a>.  <a href="#name-json-schema" class="internal xref">JSON Schema</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4">
<p id="section-toc.1-1.4.1"><a href="#section-4" class="auto internal xref">4</a>.  <a href="#name-manifest" class="internal xref">Manifest</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.1">
<p id="section-toc.1-1.4.2.1.1"><a href="#section-4.1" class="auto internal xref">4.1</a>.  <a href="#name-format-2" class="internal xref">Format</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4.2.1.2.1">
<p id="section-toc.1-1.4.2.1.2.1.1"><a href="#section-4.1.1" class="auto internal xref">4.1.1</a>.  <a href="#name-sample-manifest" class="internal xref">Sample Manifest</a></p>
</li>
</ul>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5">
<p id="section-toc.1-1.5.1"><a href="#section-5" class="auto internal xref">5</a>.  <a href="#name-implementation" class="internal xref">Implementation</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6">
<p id="section-toc.1-1.6.1"><a href="#section-6" class="auto internal xref">6</a>.  <a href="#name-security-considerations" class="internal xref">Security Considerations</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7">
<p id="section-toc.1-1.7.1"><a href="#section-7" class="auto internal xref">7</a>.  <a href="#name-acknowledgements" class="internal xref">Acknowledgements</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8">
<p id="section-toc.1-1.8.1"><a href="#section-8" class="auto internal xref">8</a>.  <a href="#name-references" class="internal xref">References</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9">
<p id="section-toc.1-1.9.1"><a href="#section-9" class="auto internal xref">9</a>.  <a href="#name-references-2" class="internal xref">References</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.1">
<p id="section-toc.1-1.9.2.1.1"><a href="#section-9.1" class="auto internal xref">9.1</a>.  <a href="#name-normative-references" class="internal xref">Normative References</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9.2.2">
<p id="section-toc.1-1.9.2.2.1"><a href="#section-9.2" class="auto internal xref">9.2</a>.  <a href="#name-informative-references" class="internal xref">Informative References</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10">
<p id="section-toc.1-1.10.1"><a href="#appendix-A" class="auto internal xref"></a><a href="#name-authors-addresses" class="internal xref">Authors' Addresses</a></p>
</li>
</ul>
</nav>
</section>
</div>
<div id="introduction">
<section id="section-1">
<h2 id="name-introduction">
<a href="#section-1" class="section-number selfRef">1. </a><a href="#name-introduction" class="section-name selfRef">Introduction</a>
</h2>
<p id="section-1-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 <span>[<a href="#MISP-P" class="cite xref">MISP-P</a>]</span> 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.<a href="#section-1-1" class="pilcrow"></a></p>
<div id="conventions-and-terminology">
<section id="section-1.1">
<h3 id="name-conventions-and-terminology">
<a href="#section-1.1" class="section-number selfRef">1.1. </a><a href="#name-conventions-and-terminology" class="section-name selfRef">Conventions and Terminology</a>
</h3>
<p id="section-1.1-1">The key words "<span class="bcp14">MUST</span>", "<span class="bcp14">MUST NOT</span>", "<span class="bcp14">REQUIRED</span>", "<span class="bcp14">SHALL</span>", "<span class="bcp14">SHALL NOT</span>",
"<span class="bcp14">SHOULD</span>", "<span class="bcp14">SHOULD NOT</span>", "<span class="bcp14">RECOMMENDED</span>", "<span class="bcp14">MAY</span>", and "<span class="bcp14">OPTIONAL</span>" in this
document are to be interpreted as described in RFC 2119 <span>[<a href="#RFC2119" class="cite xref">RFC2119</a>]</span>.<a href="#section-1.1-1" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="format">
<section id="section-2">
<h2 id="name-format">
<a href="#section-2" class="section-number selfRef">2. </a><a href="#name-format" class="section-name selfRef">Format</a>
</h2>
<div id="overview">
<section id="section-2.1">
<h3 id="name-overview">
<a href="#section-2.1" class="section-number selfRef">2.1. </a><a href="#name-overview" class="section-name selfRef">Overview</a>
</h3>
<p id="section-2.1-1">The MISP core format is in the JSON <span>[<a href="#RFC8259" class="cite xref">RFC8259</a>]</span> format. In MISP, an event is composed of a single JSON object.<a href="#section-2.1-1" class="pilcrow"></a></p>
<p id="section-2.1-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.<a href="#section-2.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event">
<section id="section-2.2">
<h3 id="name-event">
<a href="#section-2.2" class="section-number selfRef">2.2. </a><a href="#name-event" class="section-name selfRef">Event</a>
</h3>
<p id="section-2.2-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.<a href="#section-2.2-1" class="pilcrow"></a></p>
<div id="event-attributes">
<section id="section-2.2.1">
<h4 id="name-event-attributes">
<a href="#section-2.2.1" class="section-number selfRef">2.2.1. </a><a href="#name-event-attributes" class="section-name selfRef">Event Attributes</a>
</h4>
<div id="uuid">
<section id="section-2.2.1.1">
<h5 id="name-uuid">
<a href="#section-2.2.1.1" class="section-number selfRef">2.2.1.1. </a><a href="#name-uuid" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.2.1.1-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the event. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same event. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new event.<a href="#section-2.2.1.1-1" class="pilcrow"></a></p>
<p id="section-2.2.1.1-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="id">
<section id="section-2.2.1.2">
<h5 id="name-id">
<a href="#section-2.2.1.2" class="section-number selfRef">2.2.1.2. </a><a href="#name-id" class="section-name selfRef">id</a>
</h5>
<p id="section-2.2.1.2-1">id represents the human-readable identifier associated to the event for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.2.1.2-1" class="pilcrow"></a></p>
<p id="section-2.2.1.2-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.2.1.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="published">
<section id="section-2.2.1.3">
<h5 id="name-published">
<a href="#section-2.2.1.3" class="section-number selfRef">2.2.1.3. </a><a href="#name-published" class="section-name selfRef">published</a>
</h5>
<p id="section-2.2.1.3-1">published represents the event publication state. If the event was published, the published value <span class="bcp14">MUST</span> be true.
In any other publication state, the published value <span class="bcp14">MUST</span> be false.<a href="#section-2.2.1.3-1" class="pilcrow"></a></p>
<p id="section-2.2.1.3-2">published is represented as a JSON boolean. published <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="info">
<section id="section-2.2.1.4">
<h5 id="name-info">
<a href="#section-2.2.1.4" class="section-number selfRef">2.2.1.4. </a><a href="#name-info" class="section-name selfRef">info</a>
</h5>
<p id="section-2.2.1.4-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 <span class="bcp14">SHOULD</span> NOT be bigger than 256 characters and <span class="bcp14">SHOULD</span> NOT include new-lines.<a href="#section-2.2.1.4-1" class="pilcrow"></a></p>
<p id="section-2.2.1.4-2">info is represented as a JSON string. info <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="threat-level-id">
<section id="section-2.2.1.5">
<h5 id="name-threat_level_id">
<a href="#section-2.2.1.5" class="section-number selfRef">2.2.1.5. </a><a href="#name-threat_level_id" class="section-name selfRef">threat_level_id</a>
</h5>
<p id="section-2.2.1.5-1">threat_level_id represents the threat level.<a href="#section-2.2.1.5-1" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.2.1.5-2">
<dt id="section-2.2.1.5-2.1">4:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.5-2.2">Undefined<a href="#section-2.2.1.5-2.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.5-2.3">3:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.5-2.4">Low<a href="#section-2.2.1.5-2.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.5-2.5">2:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.5-2.6">Medium<a href="#section-2.2.1.5-2.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.5-2.7">1:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.5-2.8">High<a href="#section-2.2.1.5-2.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-2.2.1.5-3">If a higher granularity is required, a MISP taxonomy applied as a Tag <span class="bcp14">SHOULD</span> be preferred.<a href="#section-2.2.1.5-3" class="pilcrow"></a></p>
<p id="section-2.2.1.5-4">threat_level_id is represented as a JSON string. threat_level_id <span class="bcp14">SHALL</span> be present.<a href="#section-2.2.1.5-4" class="pilcrow"></a></p>
</section>
</div>
<div id="analysis">
<section id="section-2.2.1.6">
<h5 id="name-analysis">
<a href="#section-2.2.1.6" class="section-number selfRef">2.2.1.6. </a><a href="#name-analysis" class="section-name selfRef">analysis</a>
</h5>
<p id="section-2.2.1.6-1">analysis represents the analysis level.<a href="#section-2.2.1.6-1" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.2.1.6-2">
<dt id="section-2.2.1.6-2.1">0:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.6-2.2">Initial<a href="#section-2.2.1.6-2.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.6-2.3">1:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.6-2.4">Ongoing<a href="#section-2.2.1.6-2.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.6-2.5">2:</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.6-2.6">Complete<a href="#section-2.2.1.6-2.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-2.2.1.6-3">If a higher granularity is required, a MISP taxonomy applied as a Tag <span class="bcp14">SHOULD</span> be preferred.<a href="#section-2.2.1.6-3" class="pilcrow"></a></p>
<p id="section-2.2.1.6-4">analysis is represented as a JSON string. analysis <span class="bcp14">SHALL</span> be present.<a href="#section-2.2.1.6-4" class="pilcrow"></a></p>
</section>
</div>
<div id="date">
<section id="section-2.2.1.7">
<h5 id="name-date">
<a href="#section-2.2.1.7" class="section-number selfRef">2.2.1.7. </a><a href="#name-date" class="section-name selfRef">date</a>
</h5>
<p id="section-2.2.1.7-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.<a href="#section-2.2.1.7-1" class="pilcrow"></a></p>
<p id="section-2.2.1.7-2">date is represented as a JSON string. date <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.7-2" class="pilcrow"></a></p>
</section>
</div>
<div id="timestamp">
<section id="section-2.2.1.8">
<h5 id="name-timestamp">
<a href="#section-2.2.1.8" class="section-number selfRef">2.2.1.8. </a><a href="#name-timestamp" class="section-name selfRef">timestamp</a>
</h5>
<p id="section-2.2.1.8-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 <span class="bcp14">MUST</span> be UTC.<a href="#section-2.2.1.8-1" class="pilcrow"></a></p>
<p id="section-2.2.1.8-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="publish-timestamp">
<section id="section-2.2.1.9">
<h5 id="name-publish_timestamp">
<a href="#section-2.2.1.9" class="section-number selfRef">2.2.1.9. </a><a href="#name-publish_timestamp" class="section-name selfRef">publish_timestamp</a>
</h5>
<p id="section-2.2.1.9-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 <span class="bcp14">MUST</span> be updated. The time zone <span class="bcp14">MUST</span> 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 <span class="bcp14">MUST</span> be set to 0.<a href="#section-2.2.1.9-1" class="pilcrow"></a></p>
<p id="section-2.2.1.9-2">publish_timestamp is represented as a JSON string. publish_timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="org-id">
<section id="section-2.2.1.10">
<h5 id="name-org_id">
<a href="#section-2.2.1.10" class="section-number selfRef">2.2.1.10. </a><a href="#name-org_id" class="section-name selfRef">org_id</a>
</h5>
<p id="section-2.2.1.10-1">org_id represents a human-readable identifier referencing an Org object of the organisation which generated the event. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.2.1.10-1" class="pilcrow"></a></p>
<p id="section-2.2.1.10-2">The org_id <span class="bcp14">MUST</span> be updated when the event is generated by a new instance.<a href="#section-2.2.1.10-2" class="pilcrow"></a></p>
<p id="section-2.2.1.10-3">org_id is represented as a JSON string. org_id <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.10-3" class="pilcrow"></a></p>
</section>
</div>
<div id="orgc-id">
<section id="section-2.2.1.11">
<h5 id="name-orgc_id">
<a href="#section-2.2.1.11" class="section-number selfRef">2.2.1.11. </a><a href="#name-orgc_id" class="section-name selfRef">orgc_id</a>
</h5>
<p id="section-2.2.1.11-1">orgc_id represents a human-readable identifier referencing an Orgc object of the organisation which created the event.<a href="#section-2.2.1.11-1" class="pilcrow"></a></p>
<p id="section-2.2.1.11-2">The orgc_id and Org object <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same event.<a href="#section-2.2.1.11-2" class="pilcrow"></a></p>
<p id="section-2.2.1.11-3">orgc_id is represented as a JSON string. orgc_id <span class="bcp14">MUST</span> be present.<a href="#section-2.2.1.11-3" class="pilcrow"></a></p>
</section>
</div>
<div id="attribute-count">
<section id="section-2.2.1.12">
<h5 id="name-attribute_count">
<a href="#section-2.2.1.12" class="section-number selfRef">2.2.1.12. </a><a href="#name-attribute_count" class="section-name selfRef">attribute_count</a>
</h5>
<p id="section-2.2.1.12-1">attribute_count represents the number of attributes in the event. attribute_count is expressed in decimal.<a href="#section-2.2.1.12-1" class="pilcrow"></a></p>
<p id="section-2.2.1.12-2">attribute_count is represented as a JSON string. attribute_count <span class="bcp14">SHALL</span> be present.<a href="#section-2.2.1.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution">
<section id="section-2.2.1.13">
<h5 id="name-distribution">
<a href="#section-2.2.1.13" class="section-number selfRef">2.2.1.13. </a><a href="#name-distribution" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.2.1.13-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.<a href="#section-2.2.1.13-1" class="pilcrow"></a></p>
<p id="section-2.2.1.13-2">distribution is represented by a JSON string. distribution <span class="bcp14">MUST</span> be present and be one of the following options:<a href="#section-2.2.1.13-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.2.1.13-3">
<dt id="section-2.2.1.13-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.13-3.2">Your Organisation Only<a href="#section-2.2.1.13-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.13-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.13-3.4">This Community Only<a href="#section-2.2.1.13-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.13-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.13-3.6">Connected Communities<a href="#section-2.2.1.13-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.13-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.13-3.8">All Communities<a href="#section-2.2.1.13-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.2.1.13-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.2.1.13-3.10">Sharing Group<a href="#section-2.2.1.13-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id">
<section id="section-2.2.1.14">
<h5 id="name-sharing_group_id">
<a href="#section-2.2.1.14" class="section-number selfRef">2.2.1.14. </a><a href="#name-sharing_group_id" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.2.1.14-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 <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.2.1.14-1" class="pilcrow"></a></p>
<p id="section-2.2.1.14-2">sharing_group_id is represented by a JSON string and <span class="bcp14">SHOULD</span> be present. If a distribution level other than "4" is chosen the sharing_group_id <span class="bcp14">MUST</span> be set to "0".<a href="#section-2.2.1.14-2" class="pilcrow"></a></p>
</section>
</div>
<div id="extends-uuid">
<section id="section-2.2.1.15">
<h5 id="name-extends_uuid">
<a href="#section-2.2.1.15" class="section-number selfRef">2.2.1.15. </a><a href="#name-extends_uuid" class="section-name selfRef">extends_uuid</a>
</h5>
<p id="section-2.2.1.15-1">extends_uuid represents which event is extended by this event. The extends_uuid is described as a Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> with the UUID of the extended event.<a href="#section-2.2.1.15-1" class="pilcrow"></a></p>
<p id="section-2.2.1.15-2">extends_uuid is represented as a JSON string. extends_uuid <span class="bcp14">SHOULD</span> be present.<a href="#section-2.2.1.15-2" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="event-objects">
<section id="section-2.2.2">
<h4 id="name-event-objects">
<a href="#section-2.2.2" class="section-number selfRef">2.2.2. </a><a href="#name-event-objects" class="section-name selfRef">Event Objects</a>
</h4>
<div id="org">
<section id="section-2.2.2.1">
<h5 id="name-org">
<a href="#section-2.2.2.1" class="section-number selfRef">2.2.2.1. </a><a href="#name-org" class="section-name selfRef">Org</a>
</h5>
<p id="section-2.2.2.1-1">An Org object is composed of an uuid, name and id.<a href="#section-2.2.2.1-1" class="pilcrow"></a></p>
<p id="section-2.2.2.1-2">The uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the organisation.
The organisation UUID is globally assigned to an organisation and <span class="bcp14">SHALL</span> be kept overtime.<a href="#section-2.2.2.1-2" class="pilcrow"></a></p>
<p id="section-2.2.2.1-3">The name is a readable description of the organisation and <span class="bcp14">SHOULD</span> be present.
The id is a human-readable identifier generated by the instance and used as reference in the event.
A human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.2.2.1-3" class="pilcrow"></a></p>
<p id="section-2.2.2.1-4">uuid, name and id are represented as a JSON string. uuid, name and id <span class="bcp14">MUST</span> be present.<a href="#section-2.2.2.1-4" class="pilcrow"></a></p>
<div id="sample-org-object">
<section id="section-2.2.2.1.1">
<h6 id="name-sample-org-object">
<a href="#section-2.2.2.1.1" class="section-number selfRef">2.2.2.1.1. </a><a href="#name-sample-org-object" class="section-name selfRef">Sample Org Object</a>
</h6>
<div class="alignLeft art-text artwork" id="section-2.2.2.1.1-1">
<pre>"Org": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f"
}
</pre><a href="#section-2.2.2.1.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
<div id="orgc">
<section id="section-2.2.2.2">
<h5 id="name-orgc">
<a href="#section-2.2.2.2" class="section-number selfRef">2.2.2.2. </a><a href="#name-orgc" class="section-name selfRef">Orgc</a>
</h5>
<p id="section-2.2.2.2-1">An Orgc object is composed of an uuid, name and id.<a href="#section-2.2.2.2-1" class="pilcrow"></a></p>
<p id="section-2.2.2.2-2">The uuid <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same event. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new event.
The organisation UUID is globally assigned to an organisation and <span class="bcp14">SHALL</span> be kept overtime.<a href="#section-2.2.2.2-2" class="pilcrow"></a></p>
<p id="section-2.2.2.2-3">The name is a readable description of the organisation and <span class="bcp14">SHOULD</span> be present.
The id is a human-readable identifier generated by the instance and used as reference in the event.
A human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.2.2.2-3" class="pilcrow"></a></p>
<p id="section-2.2.2.2-4">uuid, name and id are represented as a JSON string. uuid, name and id <span class="bcp14">MUST</span> be present.<a href="#section-2.2.2.2-4" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="attribute">
<section id="section-2.3">
<h3 id="name-attribute">
<a href="#section-2.3" class="section-number selfRef">2.3. </a><a href="#name-attribute" class="section-name selfRef">Attribute</a>
</h3>
<p id="section-2.3-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.<a href="#section-2.3-1" class="pilcrow"></a></p>
<p id="section-2.3-2">A MISP document <span class="bcp14">MUST</span> at least includes category-type-value triplet described in section "Attribute Attributes".<a href="#section-2.3-2" class="pilcrow"></a></p>
<div id="sample-attribute-object">
<section id="section-2.3.1">
<h4 id="name-sample-attribute-object">
<a href="#section-2.3.1" class="section-number selfRef">2.3.1. </a><a href="#name-sample-attribute-object" class="section-name selfRef">Sample Attribute Object</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.3.1-1">
<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><a href="#section-2.3.1-1" class="pilcrow"></a>
</div>
</section>
</div>
<div id="attribute-attributes">
<section id="section-2.3.2">
<h4 id="name-attribute-attributes">
<a href="#section-2.3.2" class="section-number selfRef">2.3.2. </a><a href="#name-attribute-attributes" class="section-name selfRef">Attribute Attributes</a>
</h4>
<div id="uuid-1">
<section id="section-2.3.2.1">
<h5 id="name-uuid-2">
<a href="#section-2.3.2.1" class="section-number selfRef">2.3.2.1. </a><a href="#name-uuid-2" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.3.2.1-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the event. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same event. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new event.<a href="#section-2.3.2.1-1" class="pilcrow"></a></p>
<p id="section-2.3.2.1-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="id-1">
<section id="section-2.3.2.2">
<h5 id="name-id-2">
<a href="#section-2.3.2.2" class="section-number selfRef">2.3.2.2. </a><a href="#name-id-2" class="section-name selfRef">id</a>
</h5>
<p id="section-2.3.2.2-1">id represents the human-readable identifier associated to the event for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.3.2.2-1" class="pilcrow"></a></p>
<p id="section-2.3.2.2-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.3.2.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="type">
<section id="section-2.3.2.3">
<h5 id="name-type">
<a href="#section-2.3.2.3" class="section-number selfRef">2.3.2.3. </a><a href="#name-type" class="section-name selfRef">type</a>
</h5>
<p id="section-2.3.2.3-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.<a href="#section-2.3.2.3-1" class="pilcrow"></a></p>
<p id="section-2.3.2.3-2">type is represented as a JSON string. type <span class="bcp14">MUST</span> be present and it <span class="bcp14">MUST</span> be a valid selection for the chosen category. The list of valid category-type combinations is as follows:<a href="#section-2.3.2.3-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.3.2.3-3">
<dt id="section-2.3.2.3-3.1">Antivirus detection</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.2">link, comment, text, hex, attachment, other, anonymised<a href="#section-2.3.2.3-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.3">Artifacts dropped</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.4">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, process-state, 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<a href="#section-2.3.2.3-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.5">Attribution</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.6">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<a href="#section-2.3.2.3-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.7">External analysis</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.8">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, jarm-fingerprint, hassh-md5, hasshserver-md5, github-repository, other, cortex, anonymised, community-id<a href="#section-2.3.2.3-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.9">Financial fraud</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.10">btc, dash, xmr, iban, bic, bank-account-nr, aba-rtn, bin, cc-number, prtn, phone-number, comment, text, other, hex, anonymised<a href="#section-2.3.2.3-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.11">Internal reference</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.12">text, link, comment, other, hex, anonymised, git-commit-id<a href="#section-2.3.2.3-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.13">Network activity</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.14">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, jarm-fingerprint, hassh-md5, hasshserver-md5, other, hex, cookie, hostname|port, bro, zeek, anonymised, community-id, email-subject, favicon-mmh3, dkim, dkim-signature, ssh-fingerprint<a href="#section-2.3.2.3-3.14" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.15">Other</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.16">comment, text, other, size-in-bytes, counter, datetime, cpe, port, float, hex, phone-number, boolean, anonymised, pgp-public-key, pgp-private-key<a href="#section-2.3.2.3-3.16" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.17">Payload delivery</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.18">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, jarm-fingerprint, 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, azure-application-id, mobile-application-id, chrome-extension-id, whois-registrant-email, anonymised<a href="#section-2.3.2.3-3.18" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.19">Payload installation</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.20">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, azure-application-id, azure-application-id, mobile-application-id, chrome-extension-id, other, mime-type, anonymised<a href="#section-2.3.2.3-3.20" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.21">Payload type</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.22">comment, text, other, anonymised<a href="#section-2.3.2.3-3.22" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.23">Persistence mechanism</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.24">filename, regkey, regkey|value, comment, text, other, hex, anonymised<a href="#section-2.3.2.3-3.24" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.25">Person</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.26">first-name, middle-name, last-name, full-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<a href="#section-2.3.2.3-3.26" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.27">Social network</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.28">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<a href="#section-2.3.2.3-3.28" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.29">Support Tool</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.30">link, text, attachment, comment, other, hex, anonymised<a href="#section-2.3.2.3-3.30" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.3-3.31">Targeting data</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.3-3.32">target-user, target-email, target-machine, target-org, target-location, target-external, comment, anonymised<a href="#section-2.3.2.3-3.32" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-2.3.2.3-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.<a href="#section-2.3.2.3-4" class="pilcrow"></a></p>
</section>
</div>
<div id="category">
<section id="section-2.3.2.4">
<h5 id="name-category">
<a href="#section-2.3.2.4" class="section-number selfRef">2.3.2.4. </a><a href="#name-category" class="section-name selfRef">category</a>
</h5>
<p id="section-2.3.2.4-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.<a href="#section-2.3.2.4-1" class="pilcrow"></a></p>
<p id="section-2.3.2.4-2">category is represented as a JSON string. category <span class="bcp14">MUST</span> be present and it <span class="bcp14">MUST</span> be a valid selection for the chosen type. The list of valid category-type combinations is mentioned above.<a href="#section-2.3.2.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="to-ids">
<section id="section-2.3.2.5">
<h5 id="name-to_ids">
<a href="#section-2.3.2.5" class="section-number selfRef">2.3.2.5. </a><a href="#name-to_ids" class="section-name selfRef">to_ids</a>
</h5>
<p id="section-2.3.2.5-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.<a href="#section-2.3.2.5-1" class="pilcrow"></a></p>
<p id="section-2.3.2.5-2">to_ids is represented as a JSON boolean. to_ids <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event-id">
<section id="section-2.3.2.6">
<h5 id="name-event_id">
<a href="#section-2.3.2.6" class="section-number selfRef">2.3.2.6. </a><a href="#name-event_id" class="section-name selfRef">event_id</a>
</h5>
<p id="section-2.3.2.6-1">event_id represents a human-readable identifier referencing the Event object that the attribute belongs to. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.3.2.6-1" class="pilcrow"></a></p>
<p id="section-2.3.2.6-2">The event_id <span class="bcp14">SHOULD</span> be updated when the event is imported to reflect the newly created event's id on the instance.<a href="#section-2.3.2.6-2" class="pilcrow"></a></p>
<p id="section-2.3.2.6-3">event_id is represented as a JSON string. event_id <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.6-3" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-1">
<section id="section-2.3.2.7">
<h5 id="name-distribution-2">
<a href="#section-2.3.2.7" class="section-number selfRef">2.3.2.7. </a><a href="#name-distribution-2" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.3.2.7-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.<a href="#section-2.3.2.7-1" class="pilcrow"></a></p>
<p id="section-2.3.2.7-2">distribution is represented by a JSON string. distribution <span class="bcp14">MUST</span> be present and be one of the following options:<a href="#section-2.3.2.7-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.3.2.7-3">
<dt id="section-2.3.2.7-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.2">Your Organisation Only<a href="#section-2.3.2.7-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.7-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.4">This Community Only<a href="#section-2.3.2.7-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.7-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.6">Connected Communities<a href="#section-2.3.2.7-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.7-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.8">All Communities<a href="#section-2.3.2.7-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.7-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.10">Sharing Group<a href="#section-2.3.2.7-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.3.2.7-3.11">5</dt>
<dd style="margin-left: 1.5em" id="section-2.3.2.7-3.12">Inherit Event<a href="#section-2.3.2.7-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="timestamp-1">
<section id="section-2.3.2.8">
<h5 id="name-timestamp-2">
<a href="#section-2.3.2.8" class="section-number selfRef">2.3.2.8. </a><a href="#name-timestamp-2" class="section-name selfRef">timestamp</a>
</h5>
<p id="section-2.3.2.8-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 <span class="bcp14">MUST</span> be UTC.<a href="#section-2.3.2.8-1" class="pilcrow"></a></p>
<p id="section-2.3.2.8-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="comment">
<section id="section-2.3.2.9">
<h5 id="name-comment">
<a href="#section-2.3.2.9" class="section-number selfRef">2.3.2.9. </a><a href="#name-comment" class="section-name selfRef">comment</a>
</h5>
<p id="section-2.3.2.9-1">comment is a contextual comment field.<a href="#section-2.3.2.9-1" class="pilcrow"></a></p>
<p id="section-2.3.2.9-2">comment is represented by a JSON string. comment <span class="bcp14">MAY</span> be present.<a href="#section-2.3.2.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="sharing-group-id-1">
<section id="section-2.3.2.10">
<h5 id="name-sharing_group_id-2">
<a href="#section-2.3.2.10" class="section-number selfRef">2.3.2.10. </a><a href="#name-sharing_group_id-2" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.3.2.10-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 <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.3.2.10-1" class="pilcrow"></a></p>
<p id="section-2.3.2.10-2">sharing_group_id is represented by a JSON string and <span class="bcp14">SHOULD</span> be present. If a distribution level other than "4" is chosen the sharing_group_id <span class="bcp14">MUST</span> be set to "0".<a href="#section-2.3.2.10-2" class="pilcrow"></a></p>
</section>
</div>
<div id="deleted">
<section id="section-2.3.2.11">
<h5 id="name-deleted">
<a href="#section-2.3.2.11" class="section-number selfRef">2.3.2.11. </a><a href="#name-deleted" class="section-name selfRef">deleted</a>
</h5>
<p id="section-2.3.2.11-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.<a href="#section-2.3.2.11-1" class="pilcrow"></a></p>
<p id="section-2.3.2.11-2">deleted is represented by a JSON boolean. deleted <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.11-2" class="pilcrow"></a></p>
</section>
</div>
<div id="data">
<section id="section-2.3.2.12">
<h5 id="name-data">
<a href="#section-2.3.2.12" class="section-number selfRef">2.3.2.12. </a><a href="#name-data" class="section-name selfRef">data</a>
</h5>
<p id="section-2.3.2.12-1">data contains the base64 encoded contents of an attachment or a malware sample. For malware samples,
the sample <span class="bcp14">MUST</span> be encrypted using a password protected zip archive, with the password being "infected".<a href="#section-2.3.2.12-1" class="pilcrow"></a></p>
<p id="section-2.3.2.12-2">data is represented by a JSON string in base64 encoding. data <span class="bcp14">MUST</span> be set for attributes of type malware-sample and attachment.<a href="#section-2.3.2.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="relatedattribute">
<section id="section-2.3.2.13">
<h5 id="name-relatedattribute">
<a href="#section-2.3.2.13" class="section-number selfRef">2.3.2.13. </a><a href="#name-relatedattribute" class="section-name selfRef">RelatedAttribute</a>
</h5>
<p id="section-2.3.2.13-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 <span class="bcp14">MUST</span> include the id, org_id, info and a value. Only the correlations found on the local instance are shown in RelatedAttribute.<a href="#section-2.3.2.13-1" class="pilcrow"></a></p>
<p id="section-2.3.2.13-2">RelatedAttribute <span class="bcp14">MAY</span> be present.<a href="#section-2.3.2.13-2" class="pilcrow"></a></p>
</section>
</div>
<div id="shadowattribute">
<section id="section-2.3.2.14">
<h5 id="name-shadowattribute">
<a href="#section-2.3.2.14" class="section-number selfRef">2.3.2.14. </a><a href="#name-shadowattribute" class="section-name selfRef">ShadowAttribute</a>
</h5>
<p id="section-2.3.2.14-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.<a href="#section-2.3.2.14-1" class="pilcrow"></a></p>
<p id="section-2.3.2.14-2">Each shadow attribute that references an attribute <span class="bcp14">MUST</span> contain the containing attribute's ID in the old_id field and the event's ID in the event_id field.<a href="#section-2.3.2.14-2" class="pilcrow"></a></p>
</section>
</div>
<div id="value">
<section id="section-2.3.2.15">
<h5 id="name-value">
<a href="#section-2.3.2.15" class="section-number selfRef">2.3.2.15. </a><a href="#name-value" class="section-name selfRef">value</a>
</h5>
<p id="section-2.3.2.15-1">value represents the payload of an attribute. The format of the value is dependent on the type of the attribute.<a href="#section-2.3.2.15-1" class="pilcrow"></a></p>
<p id="section-2.3.2.15-2">value is represented by a JSON string. value <span class="bcp14">MUST</span> be present.<a href="#section-2.3.2.15-2" class="pilcrow"></a></p>
</section>
</div>
<div id="first-seen">
<section id="section-2.3.2.16">
<h5 id="name-first_seen">
<a href="#section-2.3.2.16" class="section-number selfRef">2.3.2.16. </a><a href="#name-first_seen" class="section-name selfRef">first_seen</a>
</h5>
<p id="section-2.3.2.16-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.<a href="#section-2.3.2.16-1" class="pilcrow"></a></p>
<p id="section-2.3.2.16-2">first_seen is represented as a JSON string. first_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.3.2.16-2" class="pilcrow"></a></p>
</section>
</div>
<div id="last-seen">
<section id="section-2.3.2.17">
<h5 id="name-last_seen">
<a href="#section-2.3.2.17" class="section-number selfRef">2.3.2.17. </a><a href="#name-last_seen" class="section-name selfRef">last_seen</a>
</h5>
<p id="section-2.3.2.17-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.<a href="#section-2.3.2.17-1" class="pilcrow"></a></p>
<p id="section-2.3.2.17-2">last_seen is represented as a JSON string. last_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.3.2.17-2" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="shadowattribute-1">
<section id="section-2.4">
<h3 id="name-shadowattribute-2">
<a href="#section-2.4" class="section-number selfRef">2.4. </a><a href="#name-shadowattribute-2" class="section-name selfRef">ShadowAttribute</a>
</h3>
<p id="section-2.4-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.<a href="#section-2.4-1" class="pilcrow"></a></p>
<p id="section-2.4-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.<a href="#section-2.4-2" class="pilcrow"></a></p>
<div id="sample-attribute-object-1">
<section id="section-2.4.1">
<h4 id="name-sample-attribute-object-2">
<a href="#section-2.4.1" class="section-number selfRef">2.4.1. </a><a href="#name-sample-attribute-object-2" class="section-name selfRef">Sample Attribute Object</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.4.1-1">
<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><a href="#section-2.4.1-1" class="pilcrow"></a>
</div>
</section>
</div>
<div id="shadowattribute-attributes">
<section id="section-2.4.2">
<h4 id="name-shadowattribute-attributes">
<a href="#section-2.4.2" class="section-number selfRef">2.4.2. </a><a href="#name-shadowattribute-attributes" class="section-name selfRef">ShadowAttribute Attributes</a>
</h4>
<div id="uuid-2">
<section id="section-2.4.2.1">
<h5 id="name-uuid-3">
<a href="#section-2.4.2.1" class="section-number selfRef">2.4.2.1. </a><a href="#name-uuid-3" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.4.2.1-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the event. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same event. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new event.<a href="#section-2.4.2.1-1" class="pilcrow"></a></p>
<p id="section-2.4.2.1-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="id-2">
<section id="section-2.4.2.2">
<h5 id="name-id-3">
<a href="#section-2.4.2.2" class="section-number selfRef">2.4.2.2. </a><a href="#name-id-3" class="section-name selfRef">id</a>
</h5>
<p id="section-2.4.2.2-1">id represents the human-readable identifier associated to the event for a specific MISP instance. human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.
id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.4.2.2-1" class="pilcrow"></a></p>
</section>
</div>
<div id="type-1">
<section id="section-2.4.2.3">
<h5 id="name-type-2">
<a href="#section-2.4.2.3" class="section-number selfRef">2.4.2.3. </a><a href="#name-type-2" class="section-name selfRef">type</a>
</h5>
<p id="section-2.4.2.3-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.<a href="#section-2.4.2.3-1" class="pilcrow"></a></p>
<p id="section-2.4.2.3-2">type is represented as a JSON string. type <span class="bcp14">MUST</span> be present and it <span class="bcp14">MUST</span> be a valid selection for the chosen category. The list of valid category-type combinations is as follows:<a href="#section-2.4.2.3-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.4.2.3-3">
<dt id="section-2.4.2.3-3.1">Antivirus detection</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.2">link, comment, text, hex, attachment, other, anonymised<a href="#section-2.4.2.3-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.3">Artifacts dropped</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.4">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, process-state, 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<a href="#section-2.4.2.3-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.5">Attribution</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.6">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<a href="#section-2.4.2.3-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.7">External analysis</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.8">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, jarm-fingerprint, hassh-md5, hasshserver-md5, github-repository, other, cortex, anonymised, community-id<a href="#section-2.4.2.3-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.9">Financial fraud</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.10">btc, dash, xmr, iban, bic, bank-account-nr, aba-rtn, bin, cc-number, prtn, phone-number, comment, text, other, hex, anonymised<a href="#section-2.4.2.3-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.11">Internal reference</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.12">text, link, comment, other, hex, anonymised, git-commit-id<a href="#section-2.4.2.3-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.13">Network activity</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.14">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, jarm-fingerprint, hassh-md5, hasshserver-md5, other, hex, cookie, hostname|port, bro, zeek, anonymised, community-id, email-subject, favicon-mmh3, dkim, dkim-signature, ssh-fingerprint<a href="#section-2.4.2.3-3.14" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.15">Other</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.16">comment, text, other, size-in-bytes, counter, datetime, cpe, port, float, hex, phone-number, boolean, anonymised, pgp-public-key, pgp-private-key<a href="#section-2.4.2.3-3.16" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.17">Payload delivery</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.18">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, jarm-fingerprint, 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, azure-application-id, mobile-application-id, chrome-extension-id, whois-registrant-email, anonymised<a href="#section-2.4.2.3-3.18" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.19">Payload installation</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.20">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, azure-application-id, azure-application-id, mobile-application-id, chrome-extension-id, other, mime-type, anonymised<a href="#section-2.4.2.3-3.20" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.21">Payload type</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.22">comment, text, other, anonymised<a href="#section-2.4.2.3-3.22" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.23">Persistence mechanism</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.24">filename, regkey, regkey|value, comment, text, other, hex, anonymised<a href="#section-2.4.2.3-3.24" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.25">Person</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.26">first-name, middle-name, last-name, full-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<a href="#section-2.4.2.3-3.26" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.27">Social network</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.28">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<a href="#section-2.4.2.3-3.28" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.29">Support Tool</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.30">link, text, attachment, comment, other, hex, anonymised<a href="#section-2.4.2.3-3.30" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.4.2.3-3.31">Targeting data</dt>
<dd style="margin-left: 1.5em" id="section-2.4.2.3-3.32">target-user, target-email, target-machine, target-org, target-location, target-external, comment, anonymised<a href="#section-2.4.2.3-3.32" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
<p id="section-2.4.2.3-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.<a href="#section-2.4.2.3-4" class="pilcrow"></a></p>
</section>
</div>
<div id="category-1">
<section id="section-2.4.2.4">
<h5 id="name-category-2">
<a href="#section-2.4.2.4" class="section-number selfRef">2.4.2.4. </a><a href="#name-category-2" class="section-name selfRef">category</a>
</h5>
<p id="section-2.4.2.4-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.<a href="#section-2.4.2.4-1" class="pilcrow"></a></p>
<p id="section-2.4.2.4-2">category is represented as a JSON string. category <span class="bcp14">MUST</span> be present and it <span class="bcp14">MUST</span> be a valid selection for the chosen type. The list of valid category-type combinations is mentioned above.<a href="#section-2.4.2.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="to-ids-1">
<section id="section-2.4.2.5">
<h5 id="name-to_ids-2">
<a href="#section-2.4.2.5" class="section-number selfRef">2.4.2.5. </a><a href="#name-to_ids-2" class="section-name selfRef">to_ids</a>
</h5>
<p id="section-2.4.2.5-1">to_ids represents whether the Attribute to be created if the ShadowAttribute is accepted 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.<a href="#section-2.4.2.5-1" class="pilcrow"></a></p>
<p id="section-2.4.2.5-2">to_ids is represented as a JSON boolean. to_ids <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event-id-1">
<section id="section-2.4.2.6">
<h5 id="name-event_id-2">
<a href="#section-2.4.2.6" class="section-number selfRef">2.4.2.6. </a><a href="#name-event_id-2" class="section-name selfRef">event_id</a>
</h5>
<p id="section-2.4.2.6-1">event_id represents a human-readable identifier referencing the Event object that the ShadowAttribute belongs to.<a href="#section-2.4.2.6-1" class="pilcrow"></a></p>
<p id="section-2.4.2.6-2">The event_id <span class="bcp14">SHOULD</span> be updated when the event is imported to reflect the newly created event's id on the instance.<a href="#section-2.4.2.6-2" class="pilcrow"></a></p>
<p id="section-2.4.2.6-3">event_id is represented as a JSON string. event_id <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.6-3" class="pilcrow"></a></p>
</section>
</div>
<div id="old-id">
<section id="section-2.4.2.7">
<h5 id="name-old_id">
<a href="#section-2.4.2.7" class="section-number selfRef">2.4.2.7. </a><a href="#name-old_id" class="section-name selfRef">old_id</a>
</h5>
<p id="section-2.4.2.7-1">old_id represents a human-readable identifier referencing the Attribute object that the ShadowAttribute belongs to. A ShadowAttribute can this way target an existing Attribute, implying that it is a proposal to modify an existing Attribute, or alternatively it can be a proposal to create a new Attribute for the containing Event.<a href="#section-2.4.2.7-1" class="pilcrow"></a></p>
<p id="section-2.4.2.7-2">The old_id <span class="bcp14">SHOULD</span> be updated when the event is imported to reflect the newly created Attribute's id on the instance. Alternatively, if the ShadowAttribute proposes the creation of a new Attribute, it should be set to 0.<a href="#section-2.4.2.7-2" class="pilcrow"></a></p>
<p id="section-2.4.2.7-3">old_id is represented as a JSON string. old_id <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.7-3" class="pilcrow"></a></p>
</section>
</div>
<div id="timestamp-2">
<section id="section-2.4.2.8">
<h5 id="name-timestamp-3">
<a href="#section-2.4.2.8" class="section-number selfRef">2.4.2.8. </a><a href="#name-timestamp-3" class="section-name selfRef">timestamp</a>
</h5>
<p id="section-2.4.2.8-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 <span class="bcp14">MUST</span> be UTC.<a href="#section-2.4.2.8-1" class="pilcrow"></a></p>
<p id="section-2.4.2.8-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="comment-1">
<section id="section-2.4.2.9">
<h5 id="name-comment-2">
<a href="#section-2.4.2.9" class="section-number selfRef">2.4.2.9. </a><a href="#name-comment-2" class="section-name selfRef">comment</a>
</h5>
<p id="section-2.4.2.9-1">comment is a contextual comment field.<a href="#section-2.4.2.9-1" class="pilcrow"></a></p>
<p id="section-2.4.2.9-2">comment is represented by a JSON string. comment <span class="bcp14">MAY</span> be present.<a href="#section-2.4.2.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="org-id-1">
<section id="section-2.4.2.10">
<h5 id="name-org_id-2">
<a href="#section-2.4.2.10" class="section-number selfRef">2.4.2.10. </a><a href="#name-org_id-2" class="section-name selfRef">org_id</a>
</h5>
<p id="section-2.4.2.10-1">org_id represents a human-readable identifier referencing the proposal creator's Organisation object. A human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.4.2.10-1" class="pilcrow"></a></p>
<p id="section-2.4.2.10-2">Whilst attributes can only be created by the event creator organisation, shadow attributes can be created by third parties. org_id tracks the creator organisation.<a href="#section-2.4.2.10-2" class="pilcrow"></a></p>
<p id="section-2.4.2.10-3">org_id is represented by a JSON string and <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.10-3" class="pilcrow"></a></p>
</section>
</div>
<div id="proposal-to-delete">
<section id="section-2.4.2.11">
<h5 id="name-proposal_to_delete">
<a href="#section-2.4.2.11" class="section-number selfRef">2.4.2.11. </a><a href="#name-proposal_to_delete" class="section-name selfRef">proposal_to_delete</a>
</h5>
<p id="section-2.4.2.11-1">proposal_to_delete is a boolean flag that sets whether the shadow attribute proposes to alter an attribute, or whether it proposes to remove it completely.<a href="#section-2.4.2.11-1" class="pilcrow"></a></p>
<p id="section-2.4.2.11-2">Accepting a shadow attribute with this flag set will remove the target attribute.<a href="#section-2.4.2.11-2" class="pilcrow"></a></p>
<p id="section-2.4.2.11-3">proposal_to_delete is a JSON boolean and it <span class="bcp14">MUST</span> be present. If proposal_to_delete is set to true, old_id <span class="bcp14">MUST NOT</span> be 0.<a href="#section-2.4.2.11-3" class="pilcrow"></a></p>
</section>
</div>
<div id="deleted-1">
<section id="section-2.4.2.12">
<h5 id="name-deleted-2">
<a href="#section-2.4.2.12" class="section-number selfRef">2.4.2.12. </a><a href="#name-deleted-2" class="section-name selfRef">deleted</a>
</h5>
<p id="section-2.4.2.12-1">deleted represents a setting that allows shadow attributes to be revoked. Revoked shadow attributes only serve to inform other instances that the shadow attribute is no longer active.<a href="#section-2.4.2.12-1" class="pilcrow"></a></p>
<p id="section-2.4.2.12-2">deleted is represented by a JSON boolean. deleted <span class="bcp14">SHOULD</span> be present.<a href="#section-2.4.2.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="data-1">
<section id="section-2.4.2.13">
<h5 id="name-data-2">
<a href="#section-2.4.2.13" class="section-number selfRef">2.4.2.13. </a><a href="#name-data-2" class="section-name selfRef">data</a>
</h5>
<p id="section-2.4.2.13-1">data contains the base64 encoded contents of an attachment or a malware sample. For malware samples,
the sample <span class="bcp14">MUST</span> be encrypted using a password protected zip archive, with the password being "infected".<a href="#section-2.4.2.13-1" class="pilcrow"></a></p>
<p id="section-2.4.2.13-2">data is represented by a JSON string in base64 encoding. data <span class="bcp14">MUST</span> be set for shadow attributes of type malware-sample and attachment.<a href="#section-2.4.2.13-2" class="pilcrow"></a></p>
</section>
</div>
<div id="first-seen-1">
<section id="section-2.4.2.14">
<h5 id="name-first_seen-2">
<a href="#section-2.4.2.14" class="section-number selfRef">2.4.2.14. </a><a href="#name-first_seen-2" class="section-name selfRef">first_seen</a>
</h5>
<p id="section-2.4.2.14-1">first_seen represents a reference time when the attribute was first seen. first_seen as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.4.2.14-1" class="pilcrow"></a></p>
<p id="section-2.4.2.14-2">first_seen is represented as a JSON string. first_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.4.2.14-2" class="pilcrow"></a></p>
</section>
</div>
<div id="last-seen-1">
<section id="section-2.4.2.15">
<h5 id="name-last_seen-2">
<a href="#section-2.4.2.15" class="section-number selfRef">2.4.2.15. </a><a href="#name-last_seen-2" class="section-name selfRef">last_seen</a>
</h5>
<p id="section-2.4.2.15-1">last_seen represents a reference time when the attribute was last seen. last_seen as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.4.2.15-1" class="pilcrow"></a></p>
<p id="section-2.4.2.15-2">last_seen is represented as a JSON string. last_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.4.2.15-2" class="pilcrow"></a></p>
</section>
</div>
<div id="value-1">
<section id="section-2.4.2.16">
<h5 id="name-value-2">
<a href="#section-2.4.2.16" class="section-number selfRef">2.4.2.16. </a><a href="#name-value-2" class="section-name selfRef">value</a>
</h5>
<p id="section-2.4.2.16-1">value represents the payload of an attribute. The format of the value is dependent on the type of the attribute.<a href="#section-2.4.2.16-1" class="pilcrow"></a></p>
<p id="section-2.4.2.16-2">value is represented by a JSON string. value <span class="bcp14">MUST</span> be present.<a href="#section-2.4.2.16-2" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="shadowattribute-objects">
<section id="section-2.4.3">
<h4 id="name-shadowattribute-objects">
<a href="#section-2.4.3" class="section-number selfRef">2.4.3. </a><a href="#name-shadowattribute-objects" class="section-name selfRef">ShadowAttribute Objects</a>
</h4>
<div id="org-1">
<section id="section-2.4.3.1">
<h5 id="name-org-2">
<a href="#section-2.4.3.1" class="section-number selfRef">2.4.3.1. </a><a href="#name-org-2" class="section-name selfRef">Org</a>
</h5>
<p id="section-2.4.3.1-1">An Org object is composed of an uuid, name and id.<a href="#section-2.4.3.1-1" class="pilcrow"></a></p>
<p id="section-2.4.3.1-2">The uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the organization.
The organization UUID is globally assigned to an organization and <span class="bcp14">SHALL</span> be kept overtime.<a href="#section-2.4.3.1-2" class="pilcrow"></a></p>
<p id="section-2.4.3.1-3">The name is a readable description of the organization and <span class="bcp14">SHOULD</span> be present.
The id is a human-readable identifier generated by the instance and used as reference in the event.
A human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.4.3.1-3" class="pilcrow"></a></p>
<p id="section-2.4.3.1-4">uuid, name and id are represented as a JSON string. uuid, name and id <span class="bcp14">MUST</span> be present.<a href="#section-2.4.3.1-4" class="pilcrow"></a></p>
<div id="sample-org-object-1">
<section id="section-2.4.3.1.1">
<h6 id="name-sample-org-object-2">
<a href="#section-2.4.3.1.1" class="section-number selfRef">2.4.3.1.1. </a><a href="#name-sample-org-object-2" class="section-name selfRef">Sample Org Object</a>
</h6>
<div class="alignLeft art-text artwork" id="section-2.4.3.1.1-1">
<pre>"Org": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f"
}
</pre><a href="#section-2.4.3.1.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="object">
<section id="section-2.5">
<h3 id="name-object">
<a href="#section-2.5" class="section-number selfRef">2.5. </a><a href="#name-object" class="section-name selfRef">Object</a>
</h3>
<p id="section-2.5-1">Objects serve as a contextual bond between a list of attributes within an event. Their main purpose is to describe more complex structures than can be described by a single attribute
Each object is created using an Object Template and carries the meta-data of the template used for its creation within. Objects belong to a meta-category and are defined by a name.<a href="#section-2.5-1" class="pilcrow"></a></p>
<p id="section-2.5-2">The schema used is described by the template_uuid and template_version fields.<a href="#section-2.5-2" class="pilcrow"></a></p>
<p id="section-2.5-3">A MISP document containing an Object <span class="bcp14">MUST</span> contain a name, a meta-category, a description, a template_uuid and a template_version as described in the "Object Attributes" section.<a href="#section-2.5-3" class="pilcrow"></a></p>
<div id="sample-object">
<section id="section-2.5.1">
<h4 id="name-sample-object">
<a href="#section-2.5.1" class="section-number selfRef">2.5.1. </a><a href="#name-sample-object" class="section-name selfRef">Sample Object</a>
</h4>
<div id="fig-sample-object">
<div class="alignLeft art-text artwork" id="section-2.5.1-1">
<pre>"Object": {
"id": "588",
"name": "file",
"meta-category": "file",
"description": "File object describing a file with meta-information",
"template_uuid": "688c46fb-5edb-40a3-8273-1af7923e2215",
"template_version": "3",
"event_id": "56",
"uuid": "398b0094-0384-4c48-9bf0-22b3dff9c4d3",
"timestamp": "1505747965",
"distribution": "5",
"sharing_group_id": "0",
"comment": "",
"deleted": false,
"ObjectReference": [],
"Attribute": [
{
"id": "7822",
"type": "filename",
"category": "Payload delivery",
"to_ids": true,
"uuid": "59bfe3fb-bde0-4dfe-b5b1-2b10a07724d1",
"event_id": "56",
"distribution": "0",
"timestamp": "1505747963",
"comment": "",
"sharing_group_id": "0",
"deleted": false,
"disable_correlation": false,
"object_id": "588",
"object_relation": "filename",
"value": "StarCraft.exe",
"ShadowAttribute": [],
"first_seen": null,
"last_seen": null
},
"first_seen": "2019-06-02T22:14:28.711954+00:00",
"last_seen": null
]
}
</pre><a href="#section-2.5.1-1" class="pilcrow"></a>
</div>
</div>
</section>
</div>
<div id="object-attributes">
<section id="section-2.5.2">
<h4 id="name-object-attributes">
<a href="#section-2.5.2" class="section-number selfRef">2.5.2. </a><a href="#name-object-attributes" class="section-name selfRef">Object Attributes</a>
</h4>
<div id="uuid-3">
<section id="section-2.5.2.1">
<h5 id="name-uuid-4">
<a href="#section-2.5.2.1" class="section-number selfRef">2.5.2.1. </a><a href="#name-uuid-4" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.5.2.1-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the object. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same object. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new object.<a href="#section-2.5.2.1-1" class="pilcrow"></a></p>
</section>
</div>
<div id="id-3">
<section id="section-2.5.2.2">
<h5 id="name-id-4">
<a href="#section-2.5.2.2" class="section-number selfRef">2.5.2.2. </a><a href="#name-id-4" class="section-name selfRef">id</a>
</h5>
<p id="section-2.5.2.2-1">id represents the human-readable identifier associated to the object for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.5.2.2-1" class="pilcrow"></a></p>
<p id="section-2.5.2.2-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.5.2.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="name">
<section id="section-2.5.2.3">
<h5 id="name-name">
<a href="#section-2.5.2.3" class="section-number selfRef">2.5.2.3. </a><a href="#name-name" class="section-name selfRef">name</a>
</h5>
<p id="section-2.5.2.3-1">name represents the human-readable name of the object describing the intent of the object package.<a href="#section-2.5.2.3-1" class="pilcrow"></a></p>
<p id="section-2.5.2.3-2">name is represented as a JSON string. name <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="meta-category">
<section id="section-2.5.2.4">
<h5 id="name-meta-category">
<a href="#section-2.5.2.4" class="section-number selfRef">2.5.2.4. </a><a href="#name-meta-category" class="section-name selfRef">meta-category</a>
</h5>
<p id="section-2.5.2.4-1">meta-category represents the sub-category of objects that the given object belongs to. meta-categories are not
tied to a fixed list of options but can be created on the fly.<a href="#section-2.5.2.4-1" class="pilcrow"></a></p>
<p id="section-2.5.2.4-2">meta-category is represented as a JSON string. meta-category <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="description">
<section id="section-2.5.2.5">
<h5 id="name-description">
<a href="#section-2.5.2.5" class="section-number selfRef">2.5.2.5. </a><a href="#name-description" class="section-name selfRef">description</a>
</h5>
<p id="section-2.5.2.5-1">description is a human-readable description of the given object type, as derived from the template used for creation.<a href="#section-2.5.2.5-1" class="pilcrow"></a></p>
<p id="section-2.5.2.5-2">description is represented as a JSON string. description <span class="bcp14">SHALL</span> be present.<a href="#section-2.5.2.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="template-uuid">
<section id="section-2.5.2.6">
<h5 id="name-template_uuid">
<a href="#section-2.5.2.6" class="section-number selfRef">2.5.2.6. </a><a href="#name-template_uuid" class="section-name selfRef">template_uuid</a>
</h5>
<p id="section-2.5.2.6-1">template_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the template used to create the object. The uuid <span class="bcp14">MUST</span> be preserved
to preserve the object's association with the correct template used for creation. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new object.<a href="#section-2.5.2.6-1" class="pilcrow"></a></p>
<p id="section-2.5.2.6-2">template_uuid is represented as a JSON string. template_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.6-2" class="pilcrow"></a></p>
</section>
</div>
<div id="template-version">
<section id="section-2.5.2.7">
<h5 id="name-template_version">
<a href="#section-2.5.2.7" class="section-number selfRef">2.5.2.7. </a><a href="#name-template_version" class="section-name selfRef">template_version</a>
</h5>
<p id="section-2.5.2.7-1">template_version represents a numeric incrementing version of the template used to create the object. It is used to associate the object to the
correct version of the template and together with the template_uuid forms an association to the correct template type and version.<a href="#section-2.5.2.7-1" class="pilcrow"></a></p>
<p id="section-2.5.2.7-2">template_version is represented as a JSON string. template_version <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.7-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event-id-2">
<section id="section-2.5.2.8">
<h5 id="name-event_id-3">
<a href="#section-2.5.2.8" class="section-number selfRef">2.5.2.8. </a><a href="#name-event_id-3" class="section-name selfRef">event_id</a>
</h5>
<p id="section-2.5.2.8-1">event_id represents the human-readable identifier of the event that the object belongs to on a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.5.2.8-1" class="pilcrow"></a></p>
<p id="section-2.5.2.8-2">event_id is represented as a JSON string. event_id <span class="bcp14">SHALL</span> be present.<a href="#section-2.5.2.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="timestamp-3">
<section id="section-2.5.2.9">
<h5 id="name-timestamp-4">
<a href="#section-2.5.2.9" class="section-number selfRef">2.5.2.9. </a><a href="#name-timestamp-4" class="section-name selfRef">timestamp</a>
</h5>
<p id="section-2.5.2.9-1">timestamp represents a reference time when the object was created or last modified. timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). The time zone <span class="bcp14">MUST</span> be UTC.<a href="#section-2.5.2.9-1" class="pilcrow"></a></p>
<p id="section-2.5.2.9-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-2">
<section id="section-2.5.2.10">
<h5 id="name-distribution-3">
<a href="#section-2.5.2.10" class="section-number selfRef">2.5.2.10. </a><a href="#name-distribution-3" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.5.2.10-1">distribution represents the basic distribution rules of the object. The system must adhere to the distribution setting for access control and for dissemination of the object.<a href="#section-2.5.2.10-1" class="pilcrow"></a></p>
<p id="section-2.5.2.10-2">distribution is represented by a JSON string. distribution <span class="bcp14">MUST</span> be present and be one of the following options:<a href="#section-2.5.2.10-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.5.2.10-3">
<dt id="section-2.5.2.10-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.5.2.10-3.2">Your Organisation Only<a href="#section-2.5.2.10-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.5.2.10-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.5.2.10-3.4">This Community Only<a href="#section-2.5.2.10-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.5.2.10-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.5.2.10-3.6">Connected Communities<a href="#section-2.5.2.10-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.5.2.10-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.5.2.10-3.8">All Communities<a href="#section-2.5.2.10-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.5.2.10-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.5.2.10-3.10">Sharing Group<a href="#section-2.5.2.10-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id-2">
<section id="section-2.5.2.11">
<h5 id="name-sharing_group_id-3">
<a href="#section-2.5.2.11" class="section-number selfRef">2.5.2.11. </a><a href="#name-sharing_group_id-3" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.5.2.11-1">sharing_group_id represents a human-readable identifier referencing a Sharing Group object that defines the distribution of the object, if distribution level "4" is set. A human-readable identifier <span class="bcp14">MUST</span> be represented as an unsigned integer.<a href="#section-2.5.2.11-1" class="pilcrow"></a></p>
<p id="section-2.5.2.11-2">sharing_group_id is represented by a JSON string and <span class="bcp14">SHOULD</span> be present. If a distribution level other than "4" is chosen the sharing_group_id <span class="bcp14">MUST</span> be set to "0".<a href="#section-2.5.2.11-2" class="pilcrow"></a></p>
</section>
</div>
<div id="comment-2">
<section id="section-2.5.2.12">
<h5 id="name-comment-3">
<a href="#section-2.5.2.12" class="section-number selfRef">2.5.2.12. </a><a href="#name-comment-3" class="section-name selfRef">comment</a>
</h5>
<p id="section-2.5.2.12-1">comment is a contextual comment field.<a href="#section-2.5.2.12-1" class="pilcrow"></a></p>
<p id="section-2.5.2.12-2">comment is represented by a JSON string. comment <span class="bcp14">MAY</span> be present.<a href="#section-2.5.2.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="deleted-2">
<section id="section-2.5.2.13">
<h5 id="name-deleted-3">
<a href="#section-2.5.2.13" class="section-number selfRef">2.5.2.13. </a><a href="#name-deleted-3" class="section-name selfRef">deleted</a>
</h5>
<p id="section-2.5.2.13-1">deleted represents a setting that allows objects to be revoked. Revoked objects are not actionable and exist merely to inform other instances of a revocation.<a href="#section-2.5.2.13-1" class="pilcrow"></a></p>
<p id="section-2.5.2.13-2">deleted is represented by a JSON boolean. deleted <span class="bcp14">MUST</span> be present.<a href="#section-2.5.2.13-2" class="pilcrow"></a></p>
</section>
</div>
<div id="attribute-1">
<section id="section-2.5.2.14">
<h5 id="name-attribute-2">
<a href="#section-2.5.2.14" class="section-number selfRef">2.5.2.14. </a><a href="#name-attribute-2" class="section-name selfRef">Attribute</a>
</h5>
<p id="section-2.5.2.14-1">Attribute is an array of attributes that describe the object with data.<a href="#section-2.5.2.14-1" class="pilcrow"></a></p>
<p id="section-2.5.2.14-2">Each attribute in an object <span class="bcp14">MUST</span> contain the parent event's ID in the event_id field and the parent object's ID in the object_id field.<a href="#section-2.5.2.14-2" class="pilcrow"></a></p>
</section>
</div>
<div id="first-seen-2">
<section id="section-2.5.2.15">
<h5 id="name-first_seen-3">
<a href="#section-2.5.2.15" class="section-number selfRef">2.5.2.15. </a><a href="#name-first_seen-3" class="section-name selfRef">first_seen</a>
</h5>
<p id="section-2.5.2.15-1">first_seen represents a reference time when the object was first seen. first_seen as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.5.2.15-1" class="pilcrow"></a></p>
<p id="section-2.5.2.15-2">first_seen is represented as a JSON string. first_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.5.2.15-2" class="pilcrow"></a></p>
</section>
</div>
<div id="last-seen-2">
<section id="section-2.5.2.16">
<h5 id="name-last_seen-3">
<a href="#section-2.5.2.16" class="section-number selfRef">2.5.2.16. </a><a href="#name-last_seen-3" class="section-name selfRef">last_seen</a>
</h5>
<p id="section-2.5.2.16-1">last_seen represents a reference time when the object was last seen. last_seen as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.5.2.16-1" class="pilcrow"></a></p>
<p id="section-2.5.2.16-2">last_seen is represented as a JSON string. last_seen <span class="bcp14">MAY</span> be present.<a href="#section-2.5.2.16-2" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="object-references">
<section id="section-2.6">
<h3 id="name-object-references">
<a href="#section-2.6" class="section-number selfRef">2.6. </a><a href="#name-object-references" class="section-name selfRef">Object References</a>
</h3>
<p id="section-2.6-1">Object References serve as a logical link between an Object and another referenced Object or Attribute. The relationship is categorised by an enumerated value from a fixed vocabulary.<a href="#section-2.6-1" class="pilcrow"></a></p>
<p id="section-2.6-2">The relationship_type is recommended to be taken from the MISP object relationship list [<span>[<a href="#MISP-R" class="cite xref">MISP-R</a>]</span>] is <span class="bcp14">RECOMMENDED</span> to ensure a coherent naming of the tags<a href="#section-2.6-2" class="pilcrow"></a></p>
<p id="section-2.6-3">All Object References <span class="bcp14">MUST</span> contain an object_uuid, a referenced_uuid and a relationship type.<a href="#section-2.6-3" class="pilcrow"></a></p>
<div id="sample-objectreference-object">
<section id="section-2.6.1">
<h4 id="name-sample-objectreference-obje">
<a href="#section-2.6.1" class="section-number selfRef">2.6.1. </a><a href="#name-sample-objectreference-obje" class="section-name selfRef">Sample ObjectReference object</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.6.1-1">
<pre>"ObjectReference": {
"id": "195",
"uuid": "59c21a2c-c0ac-4083-93b3-363da07724d1",
"timestamp": "1505892908",
"object_id": "591",
"event_id": "113",
"referenced_id": "590",
"referenced_type": "1",
"relationship_type": "derived-from",
"comment": "",
"deleted": false,
"object_uuid": "59c1134d-8a40-4c14-ad94-0f7ba07724d1",
"referenced_uuid": "59c1133c-9adc-4d06-a34b-0f7ca07724d1",
}
</pre><a href="#section-2.6.1-1" class="pilcrow"></a>
</div>
</section>
</div>
<div id="objectreference-attributes">
<section id="section-2.6.2">
<h4 id="name-objectreference-attributes">
<a href="#section-2.6.2" class="section-number selfRef">2.6.2. </a><a href="#name-objectreference-attributes" class="section-name selfRef">ObjectReference Attributes</a>
</h4>
<div id="uuid-4">
<section id="section-2.6.2.1">
<h5 id="name-uuid-5">
<a href="#section-2.6.2.1" class="section-number selfRef">2.6.2.1. </a><a href="#name-uuid-5" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.6.2.1-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the object reference. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same object reference. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new object reference.<a href="#section-2.6.2.1-1" class="pilcrow"></a></p>
</section>
</div>
<div id="id-4">
<section id="section-2.6.2.2">
<h5 id="name-id-5">
<a href="#section-2.6.2.2" class="section-number selfRef">2.6.2.2. </a><a href="#name-id-5" class="section-name selfRef">id</a>
</h5>
<p id="section-2.6.2.2-1">id represents the human-readable identifier associated to the object reference for a specific MISP instance.<a href="#section-2.6.2.2-1" class="pilcrow"></a></p>
<p id="section-2.6.2.2-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.6.2.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="timestamp-4">
<section id="section-2.6.2.3">
<h5 id="name-timestamp-5">
<a href="#section-2.6.2.3" class="section-number selfRef">2.6.2.3. </a><a href="#name-timestamp-5" class="section-name selfRef">timestamp</a>
</h5>
<p id="section-2.6.2.3-1">timestamp represents a reference time when the object was created or last modified. timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). The time zone <span class="bcp14">MUST</span> be UTC.<a href="#section-2.6.2.3-1" class="pilcrow"></a></p>
<p id="section-2.6.2.3-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.6.2.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-id">
<section id="section-2.6.2.4">
<h5 id="name-object_id">
<a href="#section-2.6.2.4" class="section-number selfRef">2.6.2.4. </a><a href="#name-object_id" class="section-name selfRef">object_id</a>
</h5>
<p id="section-2.6.2.4-1">object_id represents the human-readable identifier of the object that the object reference belongs to on a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.6.2.4-1" class="pilcrow"></a></p>
<p id="section-2.6.2.4-2">object_id is represented as a JSON string. object_id <span class="bcp14">SHALL</span> be present.<a href="#section-2.6.2.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event-id-3">
<section id="section-2.6.2.5">
<h5 id="name-event_id-4">
<a href="#section-2.6.2.5" class="section-number selfRef">2.6.2.5. </a><a href="#name-event_id-4" class="section-name selfRef">event_id</a>
</h5>
<p id="section-2.6.2.5-1">event_id represents the human-readable identifier of the event that the object reference belongs to on a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.6.2.5-1" class="pilcrow"></a></p>
<p id="section-2.6.2.5-2">event_id is represented as a JSON string. event_id <span class="bcp14">SHALL</span> be present.<a href="#section-2.6.2.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="referenced-id">
<section id="section-2.6.2.6">
<h5 id="name-referenced_id">
<a href="#section-2.6.2.6" class="section-number selfRef">2.6.2.6. </a><a href="#name-referenced_id" class="section-name selfRef">referenced_id</a>
</h5>
<p id="section-2.6.2.6-1">referenced_id represents the human-readable identifier of the object or attribute that the parent object of the object reference points to on a specific MISP instance.<a href="#section-2.6.2.6-1" class="pilcrow"></a></p>
<p id="section-2.6.2.6-2">referenced_id is represented as a JSON string. referenced_id <span class="bcp14">MAY</span> be present.<a href="#section-2.6.2.6-2" class="pilcrow"></a></p>
</section>
</div>
<div id="referenced-type">
<section id="section-2.6.2.7">
<h5 id="name-referenced_type">
<a href="#section-2.6.2.7" class="section-number selfRef">2.6.2.7. </a><a href="#name-referenced_type" class="section-name selfRef">referenced_type</a>
</h5>
<p id="section-2.6.2.7-1">referenced_type represents the numeric value describing what the object reference points to, "0" representing an attribute and "1" representing an object<a href="#section-2.6.2.7-1" class="pilcrow"></a></p>
<p id="section-2.6.2.7-2">referenced_type is represented as a JSON string. referenced_type <span class="bcp14">MAY</span> be present.<a href="#section-2.6.2.7-2" class="pilcrow"></a></p>
</section>
</div>
<div id="relationship-type">
<section id="section-2.6.2.8">
<h5 id="name-relationship_type">
<a href="#section-2.6.2.8" class="section-number selfRef">2.6.2.8. </a><a href="#name-relationship_type" class="section-name selfRef">relationship_type</a>
</h5>
<p id="section-2.6.2.8-1">relationship_type represents the human-readable context of the relationship between an object and another object or attribute as described by the object_reference.<a href="#section-2.6.2.8-1" class="pilcrow"></a></p>
<p id="section-2.6.2.8-2">relationship_type is represented as a JSON string. relationship_type <span class="bcp14">MUST</span> be present.<a href="#section-2.6.2.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="comment-3">
<section id="section-2.6.2.9">
<h5 id="name-comment-4">
<a href="#section-2.6.2.9" class="section-number selfRef">2.6.2.9. </a><a href="#name-comment-4" class="section-name selfRef">comment</a>
</h5>
<p id="section-2.6.2.9-1">comment is a contextual comment field.<a href="#section-2.6.2.9-1" class="pilcrow"></a></p>
<p id="section-2.6.2.9-2">comment is represented by a JSON string. comment <span class="bcp14">MAY</span> be present.<a href="#section-2.6.2.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="deleted-3">
<section id="section-2.6.2.10">
<h5 id="name-deleted-4">
<a href="#section-2.6.2.10" class="section-number selfRef">2.6.2.10. </a><a href="#name-deleted-4" class="section-name selfRef">deleted</a>
</h5>
<p id="section-2.6.2.10-1">deleted represents a setting that allows object references to be revoked. Revoked object references are not actionable and exist merely to inform other instances of a revocation.<a href="#section-2.6.2.10-1" class="pilcrow"></a></p>
<p id="section-2.6.2.10-2">deleted is represented by a JSON boolean. deleted <span class="bcp14">MUST</span> be present.<a href="#section-2.6.2.10-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-uuid">
<section id="section-2.6.2.11">
<h5 id="name-object_uuid">
<a href="#section-2.6.2.11" class="section-number selfRef">2.6.2.11. </a><a href="#name-object_uuid" class="section-name selfRef">object_uuid</a>
</h5>
<p id="section-2.6.2.11-1">object_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the object that the given object reference belongs to. The object_uuid <span class="bcp14">MUST</span> be preserved
to preserve the object reference's association with the object.<a href="#section-2.6.2.11-1" class="pilcrow"></a></p>
</section>
</div>
<div id="referenced-uuid">
<section id="section-2.6.2.12">
<h5 id="name-referenced_uuid">
<a href="#section-2.6.2.12" class="section-number selfRef">2.6.2.12. </a><a href="#name-referenced_uuid" class="section-name selfRef">referenced_uuid</a>
</h5>
<p id="section-2.6.2.12-1">referenced_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the object or attribute that is being referenced by the object reference. The referenced_uuid <span class="bcp14">MUST</span> be preserved
to preserve the object reference's association with the object or attribute.<a href="#section-2.6.2.12-1" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="eventreport">
<section id="section-2.7">
<h3 id="name-eventreport">
<a href="#section-2.7" class="section-number selfRef">2.7. </a><a href="#name-eventreport" class="section-name selfRef">EventReport</a>
</h3>
<p id="section-2.7-1">EventReport are used to complement an event with one or more report in Markdown format. The EventReport contains unstructured information which can be linked to Attributes, Objects, Tags or Galaxy with
an extension to the Markdown marking language.<a href="#section-2.7-1" class="pilcrow"></a></p>
<div id="id-5">
<section id="section-2.7.1">
<h4 id="name-id-6">
<a href="#section-2.7.1" class="section-number selfRef">2.7.1. </a><a href="#name-id-6" class="section-name selfRef">id</a>
</h4>
<p id="section-2.7.1-1">id represents the human-readable identifier associated to the EventReport for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.7.1-1" class="pilcrow"></a></p>
<p id="section-2.7.1-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.7.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="uuid-5">
<section id="section-2.7.2">
<h4 id="name-uuid-6">
<a href="#section-2.7.2" class="section-number selfRef">2.7.2. </a><a href="#name-uuid-6" class="section-name selfRef">UUID</a>
</h4>
<p id="section-2.7.2-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the EventReport. The uuid <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same EventReport. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new EventReport.<a href="#section-2.7.2-1" class="pilcrow"></a></p>
<p id="section-2.7.2-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.7.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="event-id-4">
<section id="section-2.7.3">
<h4 id="name-event_id-5">
<a href="#section-2.7.3" class="section-number selfRef">2.7.3. </a><a href="#name-event_id-5" class="section-name selfRef">event_id</a>
</h4>
<p id="section-2.7.3-1">event_id represents the human-readable identifier associating the EventReport to an event on a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.7.3-1" class="pilcrow"></a></p>
<p id="section-2.7.3-2">event_id is represented as a JSON string. event_id <span class="bcp14">MUST</span> be present.<a href="#section-2.7.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="name-1">
<section id="section-2.7.4">
<h4 id="name-name-2">
<a href="#section-2.7.4" class="section-number selfRef">2.7.4. </a><a href="#name-name-2" class="section-name selfRef">name</a>
</h4>
<p id="section-2.7.4-1">name represents the information field of the EventReport. name is a free-text value to provide a human-readable summary
of the report. name <span class="bcp14">SHOULD</span> NOT be bigger than 256 characters and <span class="bcp14">SHOULD</span> NOT include new-lines.<a href="#section-2.7.4-1" class="pilcrow"></a></p>
<p id="section-2.7.4-2">name is represented as a JSON string. name <span class="bcp14">MUST</span> be present.<a href="#section-2.7.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="content">
<section id="section-2.7.5">
<h4 id="name-content">
<a href="#section-2.7.5" class="section-number selfRef">2.7.5. </a><a href="#name-content" class="section-name selfRef">content</a>
</h4>
<p id="section-2.7.5-1">content includes the raw EventReport in Markdown format with or without the specific MISP Markdown markup extension.<a href="#section-2.7.5-1" class="pilcrow"></a></p>
<p id="section-2.7.5-2">The markdown extension for MISP is composed with a symbol as prefix then between square bracket the scope (attribute, object, tag or galaxymatrix) followed by the UUID in parenthesis.<a href="#section-2.7.5-2" class="pilcrow"></a></p>
<p id="section-2.7.5-3">content is represented as a JSON string. content <span class="bcp14">MUST</span> be present.<a href="#section-2.7.5-3" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-3">
<section id="section-2.7.6">
<h4 id="name-distribution-4">
<a href="#section-2.7.6" class="section-number selfRef">2.7.6. </a><a href="#name-distribution-4" class="section-name selfRef">distribution</a>
</h4>
<p id="section-2.7.6-1">distribution represents the basic distribution rules of the EventReport. The system must adhere to the distribution setting for access control and for dissemination of the EventReport.<a href="#section-2.7.6-1" class="pilcrow"></a></p>
<p id="section-2.7.6-2">distribution is represented by a JSON string. distribution <span class="bcp14">MUST</span> be present and be one of the following options:<a href="#section-2.7.6-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.7.6-3">
<dt id="section-2.7.6-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.2">Your Organisation Only<a href="#section-2.7.6-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.7.6-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.4">This Community Only<a href="#section-2.7.6-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.7.6-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.6">Connected Communities<a href="#section-2.7.6-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.7.6-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.8">All Communities<a href="#section-2.7.6-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.7.6-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.10">Sharing Group<a href="#section-2.7.6-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.7.6-3.11">5</dt>
<dd style="margin-left: 1.5em" id="section-2.7.6-3.12">Inherit Event<a href="#section-2.7.6-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id-3">
<section id="section-2.7.7">
<h4 id="name-sharing_group_id-4">
<a href="#section-2.7.7" class="section-number selfRef">2.7.7. </a><a href="#name-sharing_group_id-4" class="section-name selfRef">sharing_group_id</a>
</h4>
<p id="section-2.7.7-1">sharing_group_id represents the local id to the MISP local instance of the Sharing Group associated for the distribution.<a href="#section-2.7.7-1" class="pilcrow"></a></p>
<p id="section-2.7.7-2">sharing_group_id is represented by a JSON string. sharing_group_id <span class="bcp14">MUST</span> be present and set to "0" if not used.<a href="#section-2.7.7-2" class="pilcrow"></a></p>
</section>
</div>
<div id="timestamp-5">
<section id="section-2.7.8">
<h4 id="name-timestamp-6">
<a href="#section-2.7.8" class="section-number selfRef">2.7.8. </a><a href="#name-timestamp-6" class="section-name selfRef">timestamp</a>
</h4>
<p id="section-2.7.8-1">timestamp represents a reference time when the EventReport was created or last modified. timestamp is expressed in seconds (decimal) since 1st of January 1970 (Unix timestamp). The time zone <span class="bcp14">MUST</span> be UTC.<a href="#section-2.7.8-1" class="pilcrow"></a></p>
<p id="section-2.7.8-2">timestamp is represented as a JSON string. timestamp <span class="bcp14">MUST</span> be present.<a href="#section-2.7.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="deleted-4">
<section id="section-2.7.9">
<h4 id="name-deleted-5">
<a href="#section-2.7.9" class="section-number selfRef">2.7.9. </a><a href="#name-deleted-5" class="section-name selfRef">deleted</a>
</h4>
<p id="section-2.7.9-1">deleted represents a setting that allows EventReport to be revoked. Revoked EventReport are not actionable and exist merely to inform other instances of a revocation.<a href="#section-2.7.9-1" class="pilcrow"></a></p>
<p id="section-2.7.9-2">deleted is represented by a JSON boolean. deleted <span class="bcp14">MUST</span> be present.<a href="#section-2.7.9-2" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="tag">
<section id="section-2.8">
<h3 id="name-tag">
<a href="#section-2.8" class="section-number selfRef">2.8. </a><a href="#name-tag" class="section-name selfRef">Tag</a>
</h3>
<p id="section-2.8-1">A tag is a simple method to classify an event with a simple string. The tag name can be freely chosen. The tag name can be also chosen from a fixed machine-tag vocabulary called MISP taxonomies[<span>[<a href="#MISP-T" class="cite xref">MISP-T</a>]</span>]. When an event is distributed outside an organisation, the use of MISP taxonomies[<span>[<a href="#MISP-T" class="cite xref">MISP-T</a>]</span>] is <span class="bcp14">RECOMMENDED</span> to ensure a coherent naming of the tags. A tag is represented as a JSON array where each element describes each tag associated. A tag array <span class="bcp14">SHALL</span> be at event level or attribute level. A tag element is described with a name, id, colour and exportable flag.<a href="#section-2.8-1" class="pilcrow"></a></p>
<p id="section-2.8-2">exportable represents a setting if the tag is kept local or exportable to other MISP instances. exportable is represented by a JSON boolean. id is a human-readable identifier that references the tag on the local instance. colour represents an RGB value of the tag.<a href="#section-2.8-2" class="pilcrow"></a></p>
<p id="section-2.8-3">name <span class="bcp14">MUST</span> be present. colour, id and exportable <span class="bcp14">SHALL</span> be present.<a href="#section-2.8-3" class="pilcrow"></a></p>
<div id="sample-tag">
<section id="section-2.8.1">
<h4 id="name-sample-tag">
<a href="#section-2.8.1" class="section-number selfRef">2.8.1. </a><a href="#name-sample-tag" class="section-name selfRef">Sample Tag</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.8.1-1">
<pre>"Tag": [{
"exportable": true,
"colour": "#ffffff",
"name": "tlp:white",
"id": "2" }]
</pre><a href="#section-2.8.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
<div id="sighting">
<section id="section-2.9">
<h3 id="name-sighting">
<a href="#section-2.9" class="section-number selfRef">2.9. </a><a href="#name-sighting" class="section-name selfRef">Sighting</a>
</h3>
<p id="section-2.9-1">A sighting is an ascertainment which describes whether an attribute has been seen under a given set of conditions. The sighting can include the organisation who sighted the attribute or can
be anonymised. Sighting is composed of a JSON array in which each element describes one singular instance of a sighting. A sighting element is a JSON object composed of the following values:<a href="#section-2.9-1" class="pilcrow"></a></p>
<p id="section-2.9-2">type <span class="bcp14">MUST</span> be present. type describes the type of a sighting. MISP allows 3 default types:<a href="#section-2.9-2" class="pilcrow"></a></p>
<table class="center" id="table-1">
<caption><a href="#table-1" class="selfRef">Table 1</a></caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Sighting type</th>
<th class="text-center" rowspan="1" colspan="1">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">0</td>
<td class="text-center" rowspan="1" colspan="1">denotes an attribute which has been seen</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">1</td>
<td class="text-center" rowspan="1" colspan="1">denotes an attribute which has been seen and confirmed as false-positive</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">2</td>
<td class="text-center" rowspan="1" colspan="1">denotes an attribute which will be expired at the time of the sighting</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">3</td>
<td class="text-center" rowspan="1" colspan="1">denotes an attribute which has been seen and confirmed as a true-positive</td>
</tr>
</tbody>
</table>
<p id="section-2.9-4">uuid <span class="bcp14">MUST</span> be present. uuid references the uuid of the sighted attribute.<a href="#section-2.9-4" class="pilcrow"></a></p>
<p id="section-2.9-5">date_sighting <span class="bcp14">MUST</span> be present. date_sighting is expressed in seconds (decimal) elapsed since 1st of January 1970 (Unix timestamp). date_sighting represents when the referenced attribute, designated by its uuid, is sighted.<a href="#section-2.9-5" class="pilcrow"></a></p>
<p id="section-2.9-6">source <span class="bcp14">MAY</span> be present. source is represented as a JSON string and represents the human-readable version of the sighting source, which can be a given piece of software (e.g. SIEM), device or a specific analytical process.<a href="#section-2.9-6" class="pilcrow"></a></p>
<p id="section-2.9-7">id, event_id and attribute_id are represented as a JSON string and <span class="bcp14">MAY</span> be present.<a href="#section-2.9-7" class="pilcrow"></a></p>
<p id="section-2.9-8">id represents the human-readable identifier of the sighting reference which belongs to a specific MISP instance.
event_id represents the human-readable identifier of the event referenced by the sighting and belongs to a specific MISP instance.
attribute_id represents the human-readable identifier of the attribute referenced by the sighting and belongs to a specific MISP instance.<a href="#section-2.9-8" class="pilcrow"></a></p>
<p id="section-2.9-9">org_id <span class="bcp14">MAY</span> be present along the JSON object describing the organisation. If the org_id is not present, the sighting is considered as anonymised.<a href="#section-2.9-9" class="pilcrow"></a></p>
<p id="section-2.9-10">org_id represents the human-readable identifier of the organisation which did the sighting and belongs to a specific MISP instance.<a href="#section-2.9-10" class="pilcrow"></a></p>
<p id="section-2.9-11">A human-readable identifier <span class="bcp14">MUST</span> be considered as an unsigned integer.<a href="#section-2.9-11" class="pilcrow"></a></p>
<div id="sample-sighting">
<section id="section-2.9.1">
<h4 id="name-sample-sighting">
<a href="#section-2.9.1" class="section-number selfRef">2.9.1. </a><a href="#name-sample-sighting" class="section-name selfRef">Sample Sighting</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.9.1-1">
<pre>"Sighting": [
{
"id": "13599",
"attribute_id": "1201615",
"event_id": "10164",
"org_id": "2",
"date_sighting": "1517581400",
"uuid": "5a747459-41b4-4826-9b29-42dd950d210f",
"source": "M2M-CIRCL",
"type": "0",
"Organisation": {
"id": "2",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"name": "CIRCL"
}
},
{
"id": "13601",
"attribute_id": "1201615",
"event_id": "10164",
"org_id": "2",
"date_sighting": "1517581401",
"uuid": "5a74745a-a190-4d04-b719-4916950d210f",
"source": "M2M-CIRCL",
"type": "0",
"Organisation": {
"id": "2",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"name": "CIRCL"
}
}
]
</pre><a href="#section-2.9.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
<div id="galaxy">
<section id="section-2.10">
<h3 id="name-galaxy">
<a href="#section-2.10" class="section-number selfRef">2.10. </a><a href="#name-galaxy" class="section-name selfRef">Galaxy</a>
</h3>
<p id="section-2.10-1">A galaxy is a simple method to express a large object called cluster that can be attached to MISP events. A cluster can be composed of one or more elements. Elements are expressed as key-values.<a href="#section-2.10-1" class="pilcrow"></a></p>
<div id="sample-galaxy">
<section id="section-2.10.1">
<h4 id="name-sample-galaxy">
<a href="#section-2.10.1" class="section-number selfRef">2.10.1. </a><a href="#name-sample-galaxy" class="section-name selfRef">Sample Galaxy</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.10.1-1">
<pre>"Galaxy": [ {
"id": "18",
"uuid": "698774c7-8022-42c4-917f-8d6e4f06ada3",
"name": "Threat Actor",
"type": "threat-actor",
"description": "Threat actors are characteristics of malicious actors
(or adversaries) representing a cyber attack threat
including presumed intent and historically observed behaviour.",
"version": "1",
"GalaxyCluster": [
{
"id": "1699",
"uuid": "7cdff317-a673-4474-84ec-4f1754947823",
"type": "threat-actor",
"value": "Anunak",
"tag_name": "misp-galaxy:threat-actor=\"Anunak\"",
"description": "Groups targeting financial organizations
or people with significant financial assets.",
"galaxy_id": "18",
"source": "MISP Project",
"authors": [
"Alexandre Dulaunoy",
"Florian Roth",
"Thomas Schreck",
"Timo Steffens",
"Various"
],
"tag_id": "111",
"meta": {
"synonyms": [
"Carbanak",
"Carbon Spider"
],
"country": [
"RU"
],
"motive": [
"Cybercrime"
]
}
}
]
}
]
</pre><a href="#section-2.10.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
<div id="analyst-data">
<section id="section-2.11">
<h3 id="name-analyst-data">
<a href="#section-2.11" class="section-number selfRef">2.11. </a><a href="#name-analyst-data" class="section-name selfRef">Analyst Data</a>
</h3>
<p id="section-2.11-1">Analyst Data are objects which can be in different level of MISP format including objects, attributes, event or detached from MISP core format. It can expressed
a <code>Opinion</code>, <code>Note</code> or a <code>Relationship</code> from an analyst. Those three types define the key of the analyst data and can be present at the level where analyst data is applied.
Analyst data can be nested to describe complementary analysis on the analyst data by itself.<a href="#section-2.11-1" class="pilcrow"></a></p>
<div id="opinion">
<section id="section-2.11.1">
<h4 id="name-opinion">
<a href="#section-2.11.1" class="section-number selfRef">2.11.1. </a><a href="#name-opinion" class="section-name selfRef">Opinion</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.11.1-1">
<pre> "Opinion": [
{
"id": "13",
"uuid": "238b1e74-e378-4bde-a463-cbb8fc496989",
"object_uuid": "ae4396d9-3deb-49c9-b13e-b01f3a0736c3",
"object_type": "Attribute",
"authors": "alexandre.dulaunoy@circl.lu",
"org_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"orgc_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"created": "2024-06-25 04:40:01",
"modified": "2024-06-25 04:40:01",
"distribution": "3",
"sharing_group_id": null,
"opinion": "0",
"comment": "Incorrect selector",
"note_type_name": "Opinion",
"Orgc": {
"id": "2",
"name": "CIRCL",
"date_created": "2016-06-29 08:47:35",
"date_modified": "2017-11-24 12:51:22",
"description": "CIRCL is the CERT (Computer Emergency Response Team/Computer Security Incident Response Team) for the private sector, communes and non-governmental entities in Luxembourg.",
"type": "",
"nationality": "Luxembourg",
"sector": "",
"created_by": "218",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"contacts": "",
"local": true,
"landingpage": "",
"restricted_to_domain": null
},
"Org": {
"id": "2",
"name": "CIRCL",
"date_created": "2016-06-29 08:47:35",
"date_modified": "2017-11-24 12:51:22",
"description": "CIRCL is the CERT (Computer Emergency Response Team/Computer Security Incident Response Team) for the private sector, communes and non-governmental entities in Luxembourg.",
"type": "",
"nationality": "Luxembourg",
"sector": "",
"created_by": "218",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"contacts": "",
"local": true,
"landingpage": "",
"restricted_to_domain": null
}
}
]
</pre><a href="#section-2.11.1-1" class="pilcrow"></a>
</div>
<div id="id-6">
<section id="section-2.11.1.1">
<h5 id="name-id-7">
<a href="#section-2.11.1.1" class="section-number selfRef">2.11.1.1. </a><a href="#name-id-7" class="section-name selfRef">id</a>
</h5>
<p id="section-2.11.1.1-1">id represents the human-readable identifier associated to the opinion for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.11.1.1-1" class="pilcrow"></a></p>
<p id="section-2.11.1.1-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.1.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="uuid-6">
<section id="section-2.11.1.2">
<h5 id="name-uuid-7">
<a href="#section-2.11.1.2" class="section-number selfRef">2.11.1.2. </a><a href="#name-uuid-7" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.11.1.2-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the opinion. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same <code>Opinion</code> object. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new <code>Opinion</code>.<a href="#section-2.11.1.2-1" class="pilcrow"></a></p>
<p id="section-2.11.1.2-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-uuid-1">
<section id="section-2.11.1.3">
<h5 id="name-object_uuid-2">
<a href="#section-2.11.1.3" class="section-number selfRef">2.11.1.3. </a><a href="#name-object_uuid-2" class="section-name selfRef">object_uuid</a>
</h5>
<p id="section-2.11.1.3-1">object_uuid represents the target UUID element with an opinion.<a href="#section-2.11.1.3-1" class="pilcrow"></a></p>
<p id="section-2.11.1.3-2">object_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-type">
<section id="section-2.11.1.4">
<h5 id="name-object_type">
<a href="#section-2.11.1.4" class="section-number selfRef">2.11.1.4. </a><a href="#name-object_type" class="section-name selfRef">object_type</a>
</h5>
<p id="section-2.11.1.4-1">object_type represents the type of element targeted in object_uuid.<a href="#section-2.11.1.4-1" class="pilcrow"></a></p>
<p id="section-2.11.1.4-2">object_type is represented as a JSON string.<a href="#section-2.11.1.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="authors">
<section id="section-2.11.1.5">
<h5 id="name-authors">
<a href="#section-2.11.1.5" class="section-number selfRef">2.11.1.5. </a><a href="#name-authors" class="section-name selfRef">authors</a>
</h5>
<p id="section-2.11.1.5-1">authors represent the authors of the opinion. the authors <span class="bcp14">SHALL</span> be represented with an email address or an identifier.<a href="#section-2.11.1.5-1" class="pilcrow"></a></p>
<p id="section-2.11.1.5-2">authors is represented as a JSON string. authors <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.1.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="org-uuid">
<section id="section-2.11.1.6">
<h5 id="name-org_uuid">
<a href="#section-2.11.1.6" class="section-number selfRef">2.11.1.6. </a><a href="#name-org_uuid" class="section-name selfRef">org_uuid</a>
</h5>
<p id="section-2.11.1.6-1">org_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Org object of the organisation which owns the opinion on a MISP instance.<a href="#section-2.11.1.6-1" class="pilcrow"></a></p>
<p id="section-2.11.1.6-2">The org_uuid object <span class="bcp14">MUST</span> be updated for any updates or transfer to another MISP instance.<a href="#section-2.11.1.6-2" class="pilcrow"></a></p>
<p id="section-2.11.1.6-3">org_uuid is represented as a JSON string. org_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.6-3" class="pilcrow"></a></p>
</section>
</div>
<div id="orgc-uuid">
<section id="section-2.11.1.7">
<h5 id="name-orgc_uuid">
<a href="#section-2.11.1.7" class="section-number selfRef">2.11.1.7. </a><a href="#name-orgc_uuid" class="section-name selfRef">orgc_uuid</a>
</h5>
<p id="section-2.11.1.7-1">orgc_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Orgc object of the organisation which created the opinion.<a href="#section-2.11.1.7-1" class="pilcrow"></a></p>
<p id="section-2.11.1.7-2">The orgc_uuid object <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same opinion.<a href="#section-2.11.1.7-2" class="pilcrow"></a></p>
<p id="section-2.11.1.7-3">orgc_uuid is represented as a JSON string. orgc_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.7-3" class="pilcrow"></a></p>
</section>
</div>
<div id="created">
<section id="section-2.11.1.8">
<h5 id="name-created">
<a href="#section-2.11.1.8" class="section-number selfRef">2.11.1.8. </a><a href="#name-created" class="section-name selfRef">created</a>
</h5>
<p id="section-2.11.1.8-1">created represents a reference time when the element was created. created is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.1.8-1" class="pilcrow"></a></p>
<p id="section-2.11.1.8-2">created is represented as a JSON string. created <span class="bcp14">MAY</span> be present.<a href="#section-2.11.1.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="modified">
<section id="section-2.11.1.9">
<h5 id="name-modified">
<a href="#section-2.11.1.9" class="section-number selfRef">2.11.1.9. </a><a href="#name-modified" class="section-name selfRef">modified</a>
</h5>
<p id="section-2.11.1.9-1">modified represents a reference time when the element was modified. modified is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.1.9-1" class="pilcrow"></a></p>
<p id="section-2.11.1.9-2">modified is represented as a JSON string. modified <span class="bcp14">MAY</span> be present.<a href="#section-2.11.1.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-4">
<section id="section-2.11.1.10">
<h5 id="name-distribution-5">
<a href="#section-2.11.1.10" class="section-number selfRef">2.11.1.10. </a><a href="#name-distribution-5" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.11.1.10-1">distribution represents the basic distribution rules of the opinion. The system must adhere to the distribution setting for access control and for dissemination of the opinion.<a href="#section-2.11.1.10-1" class="pilcrow"></a></p>
<p id="section-2.11.1.10-2">distribution is represented by a JSON string. distribution <span class="bcp14">SHALL</span> be present and be one of the following options:<a href="#section-2.11.1.10-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.11.1.10-3">
<dt id="section-2.11.1.10-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.2">Your Organisation Only<a href="#section-2.11.1.10-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.1.10-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.4">This Community Only<a href="#section-2.11.1.10-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.1.10-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.6">Connected Communities<a href="#section-2.11.1.10-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.1.10-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.8">All Communities<a href="#section-2.11.1.10-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.1.10-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.10">Sharing Group<a href="#section-2.11.1.10-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.1.10-3.11">5</dt>
<dd style="margin-left: 1.5em" id="section-2.11.1.10-3.12">Inherit Event<a href="#section-2.11.1.10-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id-4">
<section id="section-2.11.1.11">
<h5 id="name-sharing_group_id-5">
<a href="#section-2.11.1.11" class="section-number selfRef">2.11.1.11. </a><a href="#name-sharing_group_id-5" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.11.1.11-1">sharing_group_id represents the local id to the MISP local instance of the Sharing Group associated for the distribution.<a href="#section-2.11.1.11-1" class="pilcrow"></a></p>
<p id="section-2.11.1.11-2">sharing_group_id is represented by a JSON string. sharing_group_id <span class="bcp14">SHALL</span> be present and set to "0" if not used.<a href="#section-2.11.1.11-2" class="pilcrow"></a></p>
</section>
</div>
<div id="opinion-1">
<section id="section-2.11.1.12">
<h5 id="name-opinion-2">
<a href="#section-2.11.1.12" class="section-number selfRef">2.11.1.12. </a><a href="#name-opinion-2" class="section-name selfRef">opinion</a>
</h5>
<p id="section-2.11.1.12-1">opinion is a value between 0 to 100 to represent the level of confidence. 50 is an neutral opinion.<a href="#section-2.11.1.12-1" class="pilcrow"></a></p>
<p id="section-2.11.1.12-2">opinion is represented as a JSON string. opinion <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="comment-4">
<section id="section-2.11.1.13">
<h5 id="name-comment-5">
<a href="#section-2.11.1.13" class="section-number selfRef">2.11.1.13. </a><a href="#name-comment-5" class="section-name selfRef">comment</a>
</h5>
<p id="section-2.11.1.13-1">comment describes the opinion.<a href="#section-2.11.1.13-1" class="pilcrow"></a></p>
<p id="section-2.11.1.13-2">comment is represented as a JSON string. comment <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.13-2" class="pilcrow"></a></p>
</section>
</div>
<div id="note-type-name">
<section id="section-2.11.1.14">
<h5 id="name-note_type_name">
<a href="#section-2.11.1.14" class="section-number selfRef">2.11.1.14. </a><a href="#name-note_type_name" class="section-name selfRef">note_type_name</a>
</h5>
<p id="section-2.11.1.14-1">note_type_name describe the type of the analyst data such as 'Opinion', 'Note' or 'Relationship'.<a href="#section-2.11.1.14-1" class="pilcrow"></a></p>
<p id="section-2.11.1.14-2">An opinion is defined as <code>Opinion</code>.<a href="#section-2.11.1.14-2" class="pilcrow"></a></p>
<p id="section-2.11.1.14-3">note_type_name is represented as a JSON string. note_type_name <span class="bcp14">MUST</span> be present.<a href="#section-2.11.1.14-3" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="note">
<section id="section-2.11.2">
<h4 id="name-note">
<a href="#section-2.11.2" class="section-number selfRef">2.11.2. </a><a href="#name-note" class="section-name selfRef">Note</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.11.2-1">
<pre> "Note": [
{
"id": "6",
"uuid": "e4b54bda-1006-43f3-a269-2c271c1aaed0",
"object_uuid": "ac22932c-27dc-415d-bc7b-6fd1dbf8743d",
"object_type": "Event",
"authors": "alexandre.dulaunoy@circl.lu",
"org_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"orgc_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"created": "2024-06-25 04:37:03",
"modified": "2024-06-25 04:37:03",
"distribution": "3",
"sharing_group_id": null,
"note": "Note to an event",
"language": "en",
"note_type_name": "Note",
"Orgc": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"type": "",
"sector": "",
"nationality": "Luxembourg",
"local": true
},
"Org": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"type": "",
"description": "CIRCL is the CERT (Computer Emergency Response Team/Computer Security Incident Response Team) for the private sector, communes and non-governmental entities in Luxembourg.",
"sector": "",
"nationality": "Luxembourg",
"local": true
}
</pre><a href="#section-2.11.2-1" class="pilcrow"></a>
</div>
<div id="id-7">
<section id="section-2.11.2.1">
<h5 id="name-id-8">
<a href="#section-2.11.2.1" class="section-number selfRef">2.11.2.1. </a><a href="#name-id-8" class="section-name selfRef">id</a>
</h5>
<p id="section-2.11.2.1-1">id represents the human-readable identifier associated to the note for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.11.2.1-1" class="pilcrow"></a></p>
<p id="section-2.11.2.1-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.2.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="uuid-7">
<section id="section-2.11.2.2">
<h5 id="name-uuid-8">
<a href="#section-2.11.2.2" class="section-number selfRef">2.11.2.2. </a><a href="#name-uuid-8" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.11.2.2-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the note. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same <code>Note</code> object. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new <code>Note</code>.<a href="#section-2.11.2.2-1" class="pilcrow"></a></p>
<p id="section-2.11.2.2-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-uuid-2">
<section id="section-2.11.2.3">
<h5 id="name-object_uuid-3">
<a href="#section-2.11.2.3" class="section-number selfRef">2.11.2.3. </a><a href="#name-object_uuid-3" class="section-name selfRef">object_uuid</a>
</h5>
<p id="section-2.11.2.3-1">object_uuid represents the target UUID element with an note.<a href="#section-2.11.2.3-1" class="pilcrow"></a></p>
<p id="section-2.11.2.3-2">object_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-type-1">
<section id="section-2.11.2.4">
<h5 id="name-object_type-2">
<a href="#section-2.11.2.4" class="section-number selfRef">2.11.2.4. </a><a href="#name-object_type-2" class="section-name selfRef">object_type</a>
</h5>
<p id="section-2.11.2.4-1">object_type represents the type of element targeted in object_uuid.<a href="#section-2.11.2.4-1" class="pilcrow"></a></p>
<p id="section-2.11.2.4-2">object_type is represented as a JSON string.<a href="#section-2.11.2.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="authors-1">
<section id="section-2.11.2.5">
<h5 id="name-authors-2">
<a href="#section-2.11.2.5" class="section-number selfRef">2.11.2.5. </a><a href="#name-authors-2" class="section-name selfRef">authors</a>
</h5>
<p id="section-2.11.2.5-1">authors represent the authors of the note. the authors <span class="bcp14">SHALL</span> be represented with an email address or an identifier.<a href="#section-2.11.2.5-1" class="pilcrow"></a></p>
<p id="section-2.11.2.5-2">authors is represented as a JSON string. authors <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.2.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="org-uuid-1">
<section id="section-2.11.2.6">
<h5 id="name-org_uuid-2">
<a href="#section-2.11.2.6" class="section-number selfRef">2.11.2.6. </a><a href="#name-org_uuid-2" class="section-name selfRef">org_uuid</a>
</h5>
<p id="section-2.11.2.6-1">org_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Org object of the organisation which owns the note on a MISP instance.<a href="#section-2.11.2.6-1" class="pilcrow"></a></p>
<p id="section-2.11.2.6-2">The org_uuid object <span class="bcp14">MUST</span> be updated for any updates or transfer to another MISP instance.<a href="#section-2.11.2.6-2" class="pilcrow"></a></p>
<p id="section-2.11.2.6-3">org_uuid is represented as a JSON string. org_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.6-3" class="pilcrow"></a></p>
</section>
</div>
<div id="orgc-uuid-1">
<section id="section-2.11.2.7">
<h5 id="name-orgc_uuid-2">
<a href="#section-2.11.2.7" class="section-number selfRef">2.11.2.7. </a><a href="#name-orgc_uuid-2" class="section-name selfRef">orgc_uuid</a>
</h5>
<p id="section-2.11.2.7-1">orgc_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Orgc object of the organisation which created the note.<a href="#section-2.11.2.7-1" class="pilcrow"></a></p>
<p id="section-2.11.2.7-2">The orgc_uuid object <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same note.<a href="#section-2.11.2.7-2" class="pilcrow"></a></p>
<p id="section-2.11.2.7-3">orgc_uuid is represented as a JSON string. orgc_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.7-3" class="pilcrow"></a></p>
</section>
</div>
<div id="created-1">
<section id="section-2.11.2.8">
<h5 id="name-created-2">
<a href="#section-2.11.2.8" class="section-number selfRef">2.11.2.8. </a><a href="#name-created-2" class="section-name selfRef">created</a>
</h5>
<p id="section-2.11.2.8-1">created represents a reference time when the element was created. created is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.2.8-1" class="pilcrow"></a></p>
<p id="section-2.11.2.8-2">created is represented as a JSON string. created <span class="bcp14">MAY</span> be present.<a href="#section-2.11.2.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="modified-1">
<section id="section-2.11.2.9">
<h5 id="name-modified-2">
<a href="#section-2.11.2.9" class="section-number selfRef">2.11.2.9. </a><a href="#name-modified-2" class="section-name selfRef">modified</a>
</h5>
<p id="section-2.11.2.9-1">modified represents a reference time when the element was modified. modified is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.2.9-1" class="pilcrow"></a></p>
<p id="section-2.11.2.9-2">modified is represented as a JSON string. modified <span class="bcp14">MAY</span> be present.<a href="#section-2.11.2.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-5">
<section id="section-2.11.2.10">
<h5 id="name-distribution-6">
<a href="#section-2.11.2.10" class="section-number selfRef">2.11.2.10. </a><a href="#name-distribution-6" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.11.2.10-1">distribution represents the basic distribution rules of the opinion. The system must adhere to the distribution setting for access control and for dissemination of the opinion.<a href="#section-2.11.2.10-1" class="pilcrow"></a></p>
<p id="section-2.11.2.10-2">distribution is represented by a JSON string. distribution <span class="bcp14">SHALL</span> be present and be one of the following options:<a href="#section-2.11.2.10-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.11.2.10-3">
<dt id="section-2.11.2.10-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.2">Your Organisation Only<a href="#section-2.11.2.10-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.2.10-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.4">This Community Only<a href="#section-2.11.2.10-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.2.10-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.6">Connected Communities<a href="#section-2.11.2.10-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.2.10-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.8">All Communities<a href="#section-2.11.2.10-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.2.10-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.10">Sharing Group<a href="#section-2.11.2.10-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.2.10-3.11">5</dt>
<dd style="margin-left: 1.5em" id="section-2.11.2.10-3.12">Inherit Event<a href="#section-2.11.2.10-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id-5">
<section id="section-2.11.2.11">
<h5 id="name-sharing_group_id-6">
<a href="#section-2.11.2.11" class="section-number selfRef">2.11.2.11. </a><a href="#name-sharing_group_id-6" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.11.2.11-1">sharing_group_id represents the local id to the MISP local instance of the Sharing Group associated for the distribution.<a href="#section-2.11.2.11-1" class="pilcrow"></a></p>
<p id="section-2.11.2.11-2">sharing_group_id is represented by a JSON string. sharing_group_id <span class="bcp14">SHALL</span> be present and set to "0" if not used.<a href="#section-2.11.2.11-2" class="pilcrow"></a></p>
</section>
</div>
<div id="note-1">
<section id="section-2.11.2.12">
<h5 id="name-note-2">
<a href="#section-2.11.2.12" class="section-number selfRef">2.11.2.12. </a><a href="#name-note-2" class="section-name selfRef">note</a>
</h5>
<p id="section-2.11.2.12-1">note describes the note in text format.<a href="#section-2.11.2.12-1" class="pilcrow"></a></p>
<p id="section-2.11.2.12-2">note is represented as a JSON string. <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.12-2" class="pilcrow"></a></p>
</section>
</div>
<div id="note-type-name-1">
<section id="section-2.11.2.13">
<h5 id="name-note_type_name-2">
<a href="#section-2.11.2.13" class="section-number selfRef">2.11.2.13. </a><a href="#name-note_type_name-2" class="section-name selfRef">note_type_name</a>
</h5>
<p id="section-2.11.2.13-1">note_type_name describe the type of the analyst data such as 'Opinion', 'Note' or 'Relationship'.<a href="#section-2.11.2.13-1" class="pilcrow"></a></p>
<p id="section-2.11.2.13-2">A note is defined as <code>Note</code>.<a href="#section-2.11.2.13-2" class="pilcrow"></a></p>
<p id="section-2.11.2.13-3">note_type_name is represented as a JSON string. note_type_name <span class="bcp14">MUST</span> be present.<a href="#section-2.11.2.13-3" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="relationship">
<section id="section-2.11.3">
<h4 id="name-relationship">
<a href="#section-2.11.3" class="section-number selfRef">2.11.3. </a><a href="#name-relationship" class="section-name selfRef">Relationship</a>
</h4>
<div class="alignLeft art-text artwork" id="section-2.11.3-1">
<pre>"Relationship": [
{
"id": "2",
"uuid": "8f358641-4bdc-4261-8a9f-5a926fde2b0d",
"object_uuid": "ac22932c-27dc-415d-bc7b-6fd1dbf8743d",
"object_type": "Event",
"authors": "alexandre.dulaunoy@circl.lu",
"org_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"orgc_uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"created": "2024-06-25 04:39:30",
"modified": "2024-06-25 04:39:30",
"distribution": "3",
"sharing_group_id": null,
"relationship_type": "relates",
"related_object_uuid": "f3290493-8f74-4220-aa04-b83408e37a0c",
"related_object_type": "Event",
"note_type": 2,
"note_type_name": "Relationship",
"Orgc": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"type": "",
"sector": "",
"nationality": "Luxembourg",
"local": true
},
"Org": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f",
"type": "",
"description": "CIRCL is the CERT (Computer Emergency Response Team/Computer Security Incident Response Team) for the private sector, communes and non-governmental entities in Luxembourg.",
"sector": "",
"nationality": "Luxembourg",
"local": true
},
"related_object": {
"Event": {
"id": "205025",
"date": "2023-12-19",
"info": "Phishing targeting Luxembourg services (hosted and served on/from AWS)",
"user_id": "21",
"published": true,
"uuid": "f3290493-8f74-4220-aa04-b83408e37a0c",
"attribute_count": "446",
"analysis": "2",
"timestamp": "1719217388",
"distribution": "3",
"proposal_email_lock": false,
"locked": false,
"threat_level_id": "2",
"publish_timestamp": "1719217456",
"sighting_timestamp": "0",
"sharing_group_id": "0",
"org_id": "2",
"orgc_id": "2",
"disable_correlation": false,
"extends_uuid": "",
"protected": null
}
}
}
]
</pre><a href="#section-2.11.3-1" class="pilcrow"></a>
</div>
<div id="id-8">
<section id="section-2.11.3.1">
<h5 id="name-id-9">
<a href="#section-2.11.3.1" class="section-number selfRef">2.11.3.1. </a><a href="#name-id-9" class="section-name selfRef">id</a>
</h5>
<p id="section-2.11.3.1-1">id represents the human-readable identifier associated to the relationship for a specific MISP instance. A human-readable identifier <span class="bcp14">MUST</span> be
represented as an unsigned integer.<a href="#section-2.11.3.1-1" class="pilcrow"></a></p>
<p id="section-2.11.3.1-2">id is represented as a JSON string. id <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.3.1-2" class="pilcrow"></a></p>
</section>
</div>
<div id="uuid-8">
<section id="section-2.11.3.2">
<h5 id="name-uuid-9">
<a href="#section-2.11.3.2" class="section-number selfRef">2.11.3.2. </a><a href="#name-uuid-9" class="section-name selfRef">uuid</a>
</h5>
<p id="section-2.11.3.2-1">uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> of the relationship. The uuid <span class="bcp14">MUST</span> be preserved
for any updates or transfer of the same <code>Relationship</code> object. UUID version 4 is <span class="bcp14">RECOMMENDED</span> when assigning it to a new <code>Relationship</code>.<a href="#section-2.11.3.2-1" class="pilcrow"></a></p>
<p id="section-2.11.3.2-2">uuid is represented as a JSON string. uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.2-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-uuid-3">
<section id="section-2.11.3.3">
<h5 id="name-object_uuid-4">
<a href="#section-2.11.3.3" class="section-number selfRef">2.11.3.3. </a><a href="#name-object_uuid-4" class="section-name selfRef">object_uuid</a>
</h5>
<p id="section-2.11.3.3-1">object_uuid represents the target UUID element with a relationship.<a href="#section-2.11.3.3-1" class="pilcrow"></a></p>
<p id="section-2.11.3.3-2">object_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.3-2" class="pilcrow"></a></p>
</section>
</div>
<div id="object-type-2">
<section id="section-2.11.3.4">
<h5 id="name-object_type-3">
<a href="#section-2.11.3.4" class="section-number selfRef">2.11.3.4. </a><a href="#name-object_type-3" class="section-name selfRef">object_type</a>
</h5>
<p id="section-2.11.3.4-1">object_type represents the type of element targeted in object_uuid.<a href="#section-2.11.3.4-1" class="pilcrow"></a></p>
<p id="section-2.11.3.4-2">object_type is represented as a JSON string.<a href="#section-2.11.3.4-2" class="pilcrow"></a></p>
</section>
</div>
<div id="authors-2">
<section id="section-2.11.3.5">
<h5 id="name-authors-3">
<a href="#section-2.11.3.5" class="section-number selfRef">2.11.3.5. </a><a href="#name-authors-3" class="section-name selfRef">authors</a>
</h5>
<p id="section-2.11.3.5-1">authors represent the authors of the relationship. the authors <span class="bcp14">SHALL</span> be represented with an email address or an identifier.<a href="#section-2.11.3.5-1" class="pilcrow"></a></p>
<p id="section-2.11.3.5-2">authors is represented as a JSON string. authors <span class="bcp14">SHALL</span> be present.<a href="#section-2.11.3.5-2" class="pilcrow"></a></p>
</section>
</div>
<div id="org-uuid-2">
<section id="section-2.11.3.6">
<h5 id="name-org_uuid-3">
<a href="#section-2.11.3.6" class="section-number selfRef">2.11.3.6. </a><a href="#name-org_uuid-3" class="section-name selfRef">org_uuid</a>
</h5>
<p id="section-2.11.3.6-1">org_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Org object of the organisation which owns the relationship on a MISP instance.<a href="#section-2.11.3.6-1" class="pilcrow"></a></p>
<p id="section-2.11.3.6-2">The org_uuid object <span class="bcp14">MUST</span> updated for any updates or transfer to another MISP instance.<a href="#section-2.11.3.6-2" class="pilcrow"></a></p>
<p id="section-2.11.3.6-3">org_uuid is represented as a JSON string. org_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.6-3" class="pilcrow"></a></p>
</section>
</div>
<div id="orgc-uuid-2">
<section id="section-2.11.3.7">
<h5 id="name-orgc_uuid-3">
<a href="#section-2.11.3.7" class="section-number selfRef">2.11.3.7. </a><a href="#name-orgc_uuid-3" class="section-name selfRef">orgc_uuid</a>
</h5>
<p id="section-2.11.3.7-1">orgc_uuid represents the Universally Unique IDentifier (UUID) <span>[<a href="#RFC4122" class="cite xref">RFC4122</a>]</span> identifier referencing an Orgc object of the organisation which created the relationship.<a href="#section-2.11.3.7-1" class="pilcrow"></a></p>
<p id="section-2.11.3.7-2">The orgc_uuid object <span class="bcp14">MUST</span> be preserved for any updates or transfer of the same relationship.<a href="#section-2.11.3.7-2" class="pilcrow"></a></p>
<p id="section-2.11.3.7-3">orgc_uuid is represented as a JSON string. orgc_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.7-3" class="pilcrow"></a></p>
</section>
</div>
<div id="created-2">
<section id="section-2.11.3.8">
<h5 id="name-created-3">
<a href="#section-2.11.3.8" class="section-number selfRef">2.11.3.8. </a><a href="#name-created-3" class="section-name selfRef">created</a>
</h5>
<p id="section-2.11.3.8-1">created represents a reference time when the element was created. created is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.3.8-1" class="pilcrow"></a></p>
<p id="section-2.11.3.8-2">created is represented as a JSON string. created <span class="bcp14">MAY</span> be present.<a href="#section-2.11.3.8-2" class="pilcrow"></a></p>
</section>
</div>
<div id="modified-2">
<section id="section-2.11.3.9">
<h5 id="name-modified-3">
<a href="#section-2.11.3.9" class="section-number selfRef">2.11.3.9. </a><a href="#name-modified-3" class="section-name selfRef">modified</a>
</h5>
<p id="section-2.11.3.9-1">modified represents a reference time when the element was modified. modified is expressed as an ISO 8601 datetime up to the micro-second with time zone support.<a href="#section-2.11.3.9-1" class="pilcrow"></a></p>
<p id="section-2.11.3.9-2">modified is represented as a JSON string. modified <span class="bcp14">MAY</span> be present.<a href="#section-2.11.3.9-2" class="pilcrow"></a></p>
</section>
</div>
<div id="distribution-6">
<section id="section-2.11.3.10">
<h5 id="name-distribution-7">
<a href="#section-2.11.3.10" class="section-number selfRef">2.11.3.10. </a><a href="#name-distribution-7" class="section-name selfRef">distribution</a>
</h5>
<p id="section-2.11.3.10-1">distribution represents the basic distribution rules of the opinion. The system must adhere to the distribution setting for access control and for dissemination of the opinion.<a href="#section-2.11.3.10-1" class="pilcrow"></a></p>
<p id="section-2.11.3.10-2">distribution is represented by a JSON string. distribution <span class="bcp14">SHALL</span> be present and be one of the following options:<a href="#section-2.11.3.10-2" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlCompact dlParallel" id="section-2.11.3.10-3">
<dt id="section-2.11.3.10-3.1">0</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.2">Your Organisation Only<a href="#section-2.11.3.10-3.2" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.3.10-3.3">1</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.4">This Community Only<a href="#section-2.11.3.10-3.4" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.3.10-3.5">2</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.6">Connected Communities<a href="#section-2.11.3.10-3.6" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.3.10-3.7">3</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.8">All Communities<a href="#section-2.11.3.10-3.8" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.3.10-3.9">4</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.10">Sharing Group<a href="#section-2.11.3.10-3.10" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
<dt id="section-2.11.3.10-3.11">5</dt>
<dd style="margin-left: 1.5em" id="section-2.11.3.10-3.12">Inherit Event<a href="#section-2.11.3.10-3.12" class="pilcrow"></a>
</dd>
<dd class="break"></dd>
</dl>
</section>
</div>
<div id="sharing-group-id-6">
<section id="section-2.11.3.11">
<h5 id="name-sharing_group_id-7">
<a href="#section-2.11.3.11" class="section-number selfRef">2.11.3.11. </a><a href="#name-sharing_group_id-7" class="section-name selfRef">sharing_group_id</a>
</h5>
<p id="section-2.11.3.11-1">sharing_group_id represents the local id to the MISP local instance of the Sharing Group associated for the distribution.<a href="#section-2.11.3.11-1" class="pilcrow"></a></p>
<p id="section-2.11.3.11-2">sharing_group_id is represented by a JSON string. sharing_group_id <span class="bcp14">SHALL</span> be present and set to "0" if not used.<a href="#section-2.11.3.11-2" class="pilcrow"></a></p>
</section>
</div>
<div id="relationship-type-1">
<section id="section-2.11.3.12">
<h5 id="name-relationship_type-2">
<a href="#section-2.11.3.12" class="section-number selfRef">2.11.3.12. </a><a href="#name-relationship_type-2" class="section-name selfRef">relationship_type</a>
</h5>
<p id="section-2.11.3.12-1">relationship_type represents the human readable relation from the Analyst Data towards the related_object_uuid.<a href="#section-2.11.3.12-1" class="pilcrow"></a></p>
<p id="section-2.11.3.12-2">relationship_type <span class="bcp14">SHALL</span> use a relationship from the MISP object relationship types.<a href="#section-2.11.3.12-2" class="pilcrow"></a></p>
<p id="section-2.11.3.12-3">relationship_type is represented as a JSON string. relationship_type <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.12-3" class="pilcrow"></a></p>
</section>
</div>
<div id="related-object-uuid">
<section id="section-2.11.3.13">
<h5 id="name-related_object_uuid">
<a href="#section-2.11.3.13" class="section-number selfRef">2.11.3.13. </a><a href="#name-related_object_uuid" class="section-name selfRef">related_object_uuid</a>
</h5>
<p id="section-2.11.3.13-1">related_object_uuid represents the target relationship UUID reference.<a href="#section-2.11.3.13-1" class="pilcrow"></a></p>
<p id="section-2.11.3.13-2">relationship_object_uuid is represented as a JSON string. relationship_object_uuid <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.13-2" class="pilcrow"></a></p>
</section>
</div>
<div id="related-object-type">
<section id="section-2.11.3.14">
<h5 id="name-related_object_type">
<a href="#section-2.11.3.14" class="section-number selfRef">2.11.3.14. </a><a href="#name-related_object_type" class="section-name selfRef">related_object_type</a>
</h5>
<p id="section-2.11.3.14-1">relationship_object_type represents the type of the target.<a href="#section-2.11.3.14-1" class="pilcrow"></a></p>
<p id="section-2.11.3.14-2">relationship_object_type is represented as a JSON string.<a href="#section-2.11.3.14-2" class="pilcrow"></a></p>
</section>
</div>
<div id="note-type-name-2">
<section id="section-2.11.3.15">
<h5 id="name-note_type_name-3">
<a href="#section-2.11.3.15" class="section-number selfRef">2.11.3.15. </a><a href="#name-note_type_name-3" class="section-name selfRef">note_type_name</a>
</h5>
<p id="section-2.11.3.15-1">note_type_name describe the type of the analyst data such as 'Opinion', 'Note' or 'Relationship'.<a href="#section-2.11.3.15-1" class="pilcrow"></a></p>
<p id="section-2.11.3.15-2">A relationship is defined as <code>Relationship</code>.<a href="#section-2.11.3.15-2" class="pilcrow"></a></p>
<p id="section-2.11.3.15-3">note_type_name is represented as a JSON string. note_type_name <span class="bcp14">MUST</span> be present.<a href="#section-2.11.3.15-3" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="json-schema">
<section id="section-3">
<h2 id="name-json-schema">
<a href="#section-3" class="section-number selfRef">3. </a><a href="#name-json-schema" class="section-name selfRef">JSON Schema</a>
</h2>
<p id="section-3-1">The JSON Schema <span>[<a href="#JSON-SCHEMA" class="cite xref">JSON-SCHEMA</a>]</span> below defines the structure of the MISP core format
as literally described before. The JSON Schema is used to validate MISP events at creation time
or parsing.<a href="#section-3-1" class="pilcrow"></a></p>
<div class="alignLeft art-text artwork" id="section-3-2">
<pre>{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Validator for misp events",
"id": "https://github.com/MISP/MISP/blob/2.4/format/2.4/schema.json",
"defs": {
"org": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"uuid": {
"type": "string"
}
},
"required": [
"uuid"
]
},
"orgc": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"uuid": {
"type": "string"
}
},
"required": [
"uuid"
]
},
"sharing_group": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"releasability": {
"type": "string"
},
"description": {
"type": "string"
},
"uuid": {
"type": "string"
},
"organisation_uuid": {
"type": "string"
},
"org_id": {
"type": "string"
},
"sync_user_id": {
"type": "string"
},
"active": {
"type": "boolean"
},
"created": {
"type": "string"
},
"modified": {
"type": "string"
},
"local": {
"type": "boolean"
},
"roaming": {
"type": "boolean"
},
"Organisation": {
"$ref": "#/defs/org"
},
"SharingGroupOrg": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/sharing_group_org"
}
},
"SharingGroupServer": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/sharing_group_server"
}
},
"required": [
"uuid"
]
},
"required": [
"uuid"
]
},
"sharing_group_org": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sharing_group_id": {
"type": "string"
},
"org_id": {
"type": "string"
},
"extend": {
"type": "boolean"
},
"Organisation": {
"$ref": "#/defs/org"
}
}
},
"sharing_group_server": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sharing_group_id": {
"type": "string"
},
"server_id": {
"type": "string"
},
"all_orgs": {
"type": "boolean"
},
"Server": {
"$ref": "#/defs/server"
}
}
},
"server": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"object": {
"type": "object",
"additionalProperties": false,
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"event_id": {
"type": "string"
},
"description": {
"type": "string"
},
"template_uuid": {
"type": "string"
},
"template_version": {
"type": "string"
},
"id": {
"type": "string"
},
"meta-category": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"timestamp": {
"type": "string"
},
"first_seen": {
"type": "string"
},
"last_seen": {
"type": "string"
},
"distribution": {
"type": "string"
},
"sharing_group_id": {
"type": "string"
},
"comment": {
"type": "string"
},
"ObjectReference": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/objectreference"
}
},
"Attribute": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/attribute"
}
}
}
},
"sighthing": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"attribute_id": {
"type": "string"
},
"event_id": {
"type": "string"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"org_id": {
"type": "string"
},
"date_sighting": {
"type": "string"
},
"uuid": {
"type": "string"
},
"Organisation": {
"$ref": "#/defs/organisation"
}
}
},
"organisation": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"objectreference": {
"type": "object",
"additionalProperties": false,
"properties": {
"deleted": {
"type": "boolean"
},
"object_id": {
"type": "string"
},
"event_id": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"type": {
"type": "string"
},
"referenced_id": {
"type": "string"
},
"referenced_uuid": {
"type": "string"
},
"referenced_type": {
"type": "string"
},
"relationship_type": {
"type": "string"
},
"object_uuid": {
"type": "string"
},
"comment": {
"type": "string"
},
"Object": {
"$ref": "#/defs/object"
}
}
},
"attribute": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"old_id": {
"type": "string"
},
"type": {
"type": "string"
},
"category": {
"type": "string"
},
"to_ids": {
"type": "boolean"
},
"uuid": {
"type": "string"
},
"event_id": {
"type": "string"
},
"event_uuid": {
"type": "string"
},
"proposal_to_delete": {
"type": "boolean"
},
"validationIssue": {
"type": "boolean"
},
"Org": {
"$ref": "#/defs/organisation"
},
"org_id": {
"type": "string"
},
"distribution": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"first_seen": {
"type": "string"
},
"last_seen": {
"type": "string"
},
"comment": {
"type": "string"
},
"sharing_group_id": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"disable_correlation": {
"type": "boolean"
},
"value": {
"type": "string"
},
"data": {
"type": "string"
},
"object_relation": {
"type": ["string", "null"]
},
"object_id": {
"type": "string"
},
"SharingGroup": {
"$ref": "#/defs/sharing_group"
},
"ShadowAttribute": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/attribute"
}
},
"Sighting": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/sighthing"
}
},
"Galaxy": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/galaxy"
}
},
"Tag": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/defs/tag"
}
}
}
},
"event": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"orgc_id": {
"type": "string"
},
"org_id": {
"type": "string"
},
"date": {
"type": "string"
},
"extends_uuid": {
"type": "string"
},
"threat_level_id": {
"type": "string"
},
"info": {
"type": "string"
},
"published": {
"type": "boolean"
},
"uuid": {
"type": "string"
},
"attribute_count": {
"type": "string"
},
"analysis": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"distribution": {
"type": "string"
},
"proposal_email_lock": {
"type": "boolean"
},
"locked": {
"type": "boolean"
},
"publish_timestamp": {
"type": "string"
},
"sharing_group_id": {
"type": "string"
},
"disable_correlation": {
"type": "boolean"
},
"event_creator_email": {
"type": "string"
},
"Org": {
"$ref": "#/defs/org"
},
"Orgc": {
"$ref": "#/defs/org"
},
"SharingGroup": {
"$ref": "#/defs/sharing_group"
},
"Attribute": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/attribute"
}
},
"ShadowAttribute": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/attribute"
}
},
"RelatedEvent": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"Event":{
"$ref": "#/defs/event"
}
}
}
},
"Galaxy": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/galaxy"
}
},
"Object": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/object"
}
},
"Tag": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/tag"
}
}
}
},
"tag": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"colour": {
"type": "string"
},
"exportable": {
"type": "boolean"
},
"hide_tag": {
"type": "boolean"
},
"user_id": {
"type": "string"
}
}
},
"galaxy": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"version": {
"type": "string"
},
"icon": {
"type": "string"
},
"namespace": {
"type": "string"
},
"GalaxyCluster": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/defs/galaxy_cluster"
}
}
}
},
"galaxy_cluster": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"tag_name": {
"type": "string"
},
"description": {
"type": "string"
},
"galaxy_id": {
"type": "string"
},
"version": {
"type": "string"
},
"source": {
"type": "string"
},
"authors": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"tag_id": {
"type": "string"
},
"meta": {
"type": "object"
}
}
}
},
"type": "object",
"properties": {
"Event": {
"$ref": "#/defs/event"
}
},
"required": [
"Event"
]
}
</pre><a href="#section-3-2" class="pilcrow"></a>
</div>
</section>
</div>
<div id="manifest">
<section id="section-4">
<h2 id="name-manifest">
<a href="#section-4" class="section-number selfRef">4. </a><a href="#name-manifest" class="section-name selfRef">Manifest</a>
</h2>
<p id="section-4-1">MISP events can be shared over an HTTP repository, a file package or USB key. A manifest file is used to
provide an index of MISP events allowing to only fetch the recently updated files without the need to parse
each json file.<a href="#section-4-1" class="pilcrow"></a></p>
<div id="format-1">
<section id="section-4.1">
<h3 id="name-format-2">
<a href="#section-4.1" class="section-number selfRef">4.1. </a><a href="#name-format-2" class="section-name selfRef">Format</a>
</h3>
<p id="section-4.1-1">A manifest file is a simple JSON file named manifest.json in a directory where the MISP events are located.
Each MISP event is a file located in the same directory with the event uuid as filename with the json extension.<a href="#section-4.1-1" class="pilcrow"></a></p>
<p id="section-4.1-2">The manifest format is a JSON object composed of a dictionary where the field is the uuid of the event.<a href="#section-4.1-2" class="pilcrow"></a></p>
<p id="section-4.1-3">Each uuid is composed of a JSON object with the following fields which came from the original event referenced
by the same uuid:<a href="#section-4.1-3" class="pilcrow"></a></p>
<ul class="compact">
<li class="compact" id="section-4.1-4.1">info (<span class="bcp14">MUST</span>)<a href="#section-4.1-4.1" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-4.2">Orgc object (<span class="bcp14">MUST</span>)<a href="#section-4.1-4.2" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-4.3">analysis (<span class="bcp14">SHALL</span>)<a href="#section-4.1-4.3" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-4.4">timestamp (<span class="bcp14">MUST</span>)<a href="#section-4.1-4.4" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-4.5">date (<span class="bcp14">MUST</span>)<a href="#section-4.1-4.5" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-4.6">threat_level_id (<span class="bcp14">SHALL</span>)<a href="#section-4.1-4.6" class="pilcrow"></a>
</li>
</ul>
<p id="section-4.1-5">In addition to the fields originating from the event, the following fields can be added:<a href="#section-4.1-5" class="pilcrow"></a></p>
<ul class="compact">
<li class="compact" id="section-4.1-6.1">integrity:sha256 represents the SHA256 value in hexadecimal representation of the associated MISP event file to ensure integrity of the file. (<span class="bcp14">SHOULD</span>)<a href="#section-4.1-6.1" class="pilcrow"></a>
</li>
<li class="compact" id="section-4.1-6.2">integrity:pgp represents a detached PGP signature <span>[<a href="#RFC4880" class="cite xref">RFC4880</a>]</span> of the associated MISP event file to ensure integrity of the file. (<span class="bcp14">SHOULD</span>)<a href="#section-4.1-6.2" class="pilcrow"></a>
</li>
</ul>
<p id="section-4.1-7">If a detached PGP signature is used for each MISP event, a detached PGP signature is a <span class="bcp14">MUST</span> to ensure integrity of the manifest file.
A detached PGP signature for a manifest file is a manifest.json.asc file containing the PGP signature.<a href="#section-4.1-7" class="pilcrow"></a></p>
<div id="sample-manifest">
<section id="section-4.1.1">
<h4 id="name-sample-manifest">
<a href="#section-4.1.1" class="section-number selfRef">4.1.1. </a><a href="#name-sample-manifest" class="section-name selfRef">Sample Manifest</a>
</h4>
<div class="alignLeft art-text artwork" id="section-4.1.1-1">
<pre>{
"57c6ac4c-c60c-4f79-a38f-b666950d210f": {
"info": "Malspam 2016-08-31 (.wsf in .zip) - campaign: Photo",
"Orgc": {
"id": "2",
"name": "CIRCL",
"uuid": "55f6ea5e-2c60-40e5-964f-47a8950d210f"
},
"analysis": "0",
"Tag": [
{
"colour": "#3d7a00",
"name": "circl:incident-classification=\"malware\""
},
{
"colour": "#ffffff",
"name": "tlp:white"
}
],
"timestamp": "1472638251",
"date": "2016-08-31",
"threat_level_id": "3"
},
"5720accd-dd28-45f8-80e5-4605950d210f": {
"info": "Malspam 2016-04-27 - Locky",
"Orgc": {
"id": "2",
"name": "CIRCL"
},
"analysis": "2",
"Tag": [
{
"colour": "#ffffff",
"name": "tlp:white"
},
{
"colour": "#3d7a00",
"name": "circl:incident-classification=\"malware\""
},
{
"colour": "#2c4f00",
"name": "malware_classification:malware-category=\"Ransomware\""
}
],
"timestamp": "1461764231",
"date": "2016-04-27",
"threat_level_id": "3"
}
}
</pre><a href="#section-4.1.1-1" class="pilcrow"></a>
</div>
</section>
</div>
</section>
</div>
</section>
</div>
<div id="implementation">
<section id="section-5">
<h2 id="name-implementation">
<a href="#section-5" class="section-number selfRef">5. </a><a href="#name-implementation" class="section-name selfRef">Implementation</a>
</h2>
<p id="section-5-1">MISP format is implemented by different software including the MISP threat sharing
platform and libraries like PyMISP <span>[<a href="#MISP-P" class="cite xref">MISP-P</a>]</span>. Implementations use the format
as an export/import mechanism, staging transport format or synchronisation format
as used in the MISP core platform. MISP format doesn't impose any restriction on
the data representation of the format in data-structure of other implementations.<a href="#section-5-1" class="pilcrow"></a></p>
</section>
</div>
<div id="security-considerations">
<section id="section-6">
<h2 id="name-security-considerations">
<a href="#section-6" class="section-number selfRef">6. </a><a href="#name-security-considerations" class="section-name selfRef">Security Considerations</a>
</h2>
<p id="section-6-1">MISP events might contain sensitive or confidential information. Adequate
access control and encryption measures shall be implemented to ensure
the confidentiality of the MISP events.<a href="#section-6-1" class="pilcrow"></a></p>
<p id="section-6-2">Adversaries might include malicious content in MISP events and attributes.
Implementation <span class="bcp14">MUST</span> consider the input of malicious inputs beside the
standard threat information that might already include malicious intended inputs.<a href="#section-6-2" class="pilcrow"></a></p>
</section>
</div>
<div id="acknowledgements">
<section id="section-7">
<h2 id="name-acknowledgements">
<a href="#section-7" class="section-number selfRef">7. </a><a href="#name-acknowledgements" class="section-name selfRef">Acknowledgements</a>
</h2>
<p id="section-7-1">The authors wish to thank all the MISP community who are supporting the creation
of open standards in threat intelligence sharing. A special thank to Nicolas Bareil
for the review of the JSON Schema.<a href="#section-7-1" class="pilcrow"></a></p>
</section>
</div>
<div id="references">
<section id="section-8">
<h2 id="name-references">
<a href="#section-8" class="section-number selfRef">8. </a><a href="#name-references" class="section-name selfRef">References</a>
</h2>
</section>
</div>
<section id="section-9">
<h2 id="name-references-2">
<a href="#section-9" class="section-number selfRef">9. </a><a href="#name-references-2" class="section-name selfRef">References</a>
</h2>
<section id="section-9.1">
<h3 id="name-normative-references">
<a href="#section-9.1" class="section-number selfRef">9.1. </a><a href="#name-normative-references" class="section-name selfRef">Normative References</a>
</h3>
<dl class="references">
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC4122">[RFC4122]</dt>
<dd>
<span class="refAuthor">Leach, P.</span>, <span class="refAuthor">Mealling, M.</span>, and <span class="refAuthor">R. Salz</span>, <span class="refTitle">"A Universally Unique IDentifier (UUID) URN Namespace"</span>, <span class="seriesInfo">RFC 4122</span>, <span class="seriesInfo">DOI 10.17487/RFC4122</span>, <time datetime="2005-07" class="refDate">July 2005</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc4122">https://www.rfc-editor.org/info/rfc4122</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC4880">[RFC4880]</dt>
<dd>
<span class="refAuthor">Callas, J.</span>, <span class="refAuthor">Donnerhacke, L.</span>, <span class="refAuthor">Finney, H.</span>, <span class="refAuthor">Shaw, D.</span>, and <span class="refAuthor">R. Thayer</span>, <span class="refTitle">"OpenPGP Message Format"</span>, <span class="seriesInfo">RFC 4880</span>, <span class="seriesInfo">DOI 10.17487/RFC4880</span>, <time datetime="2007-11" class="refDate">November 2007</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc4880">https://www.rfc-editor.org/info/rfc4880</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC8259">[RFC8259]</dt>
<dd>
<span class="refAuthor">Bray, T., Ed.</span>, <span class="refTitle">"The JavaScript Object Notation (JSON) Data Interchange Format"</span>, <span class="seriesInfo">STD 90</span>, <span class="seriesInfo">RFC 8259</span>, <span class="seriesInfo">DOI 10.17487/RFC8259</span>, <time datetime="2017-12" class="refDate">December 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8259">https://www.rfc-editor.org/info/rfc8259</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
<section id="section-9.2">
<h3 id="name-informative-references">
<a href="#section-9.2" class="section-number selfRef">9.2. </a><a href="#name-informative-references" class="section-name selfRef">Informative References</a>
</h3>
<dl class="references">
<dt id="JSON-SCHEMA">[JSON-SCHEMA]</dt>
<dd>
<span class="refAuthor">Wright, A.</span>, <span class="refTitle">"JSON Schema: A Media Type for Describing JSON Documents"</span>, <time datetime="2016" class="refDate">2016</time>, <span>&lt;<a href="https://tools.ietf.org/html/draft-wright-json-schema">https://tools.ietf.org/html/draft-wright-json-schema</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="MISP-P">[MISP-P]</dt>
<dd>
<span class="refAuthor">Community, M.</span>, <span class="refTitle">"MISP Project - Open Source Threat Intelligence Platform and Open Standards For Threat Information Sharing"</span>, <span>&lt;<a href="https://github.com/MISP">https://github.com/MISP</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="MISP-R">[MISP-R]</dt>
<dd>
<span class="refAuthor">Community, M.</span>, <span class="refTitle">"MISP Object Relationship Types - common vocabulary of relationships"</span>, <span>&lt;<a href="https://github.com/MISP/misp-objects/tree/master/relationships">https://github.com/MISP/misp-objects/tree/master/relationships</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="MISP-T">[MISP-T]</dt>
<dd>
<span class="refAuthor">Community, M.</span>, <span class="refTitle">"MISP Taxonomies - shared and common vocabularies of tags"</span>, <span>&lt;<a href="https://github.com/MISP/misp-taxonomies">https://github.com/MISP/misp-taxonomies</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
</section>
<div id="authors-addresses">
<section id="appendix-A">
<h2 id="name-authors-addresses">
<a href="#name-authors-addresses" class="section-name selfRef">Authors' Addresses</a>
</h2>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Alexandre Dulaunoy</span></div>
<div dir="auto" class="left"><span class="org">Computer Incident Response Center Luxembourg</span></div>
<div dir="auto" class="left"><span class="street-address">122, rue Adolphe Fischer</span></div>
<div dir="auto" class="left">L-<span class="postal-code">L-1521</span> <span class="locality">Luxembourg</span>
</div>
<div dir="auto" class="left"><span class="country-name">Luxembourg</span></div>
<div class="tel">
<span>Phone:</span>
<a href="tel:+352%20247%2088444" class="tel">+352 247 88444</a>
</div>
<div class="email">
<span>Email:</span>
<a href="mailto:alexandre.dulaunoy@circl.lu" class="email">alexandre.dulaunoy@circl.lu</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Andras Iklody</span></div>
<div dir="auto" class="left"><span class="org">Computer Incident Response Center Luxembourg</span></div>
<div dir="auto" class="left"><span class="street-address">122, rue Adolphe Fischer</span></div>
<div dir="auto" class="left">L-<span class="postal-code">L-1521</span> <span class="locality">Luxembourg</span>
</div>
<div dir="auto" class="left"><span class="country-name">Luxembourg</span></div>
<div class="tel">
<span>Phone:</span>
<a href="tel:+352%20247%2088444" class="tel">+352 247 88444</a>
</div>
<div class="email">
<span>Email:</span>
<a href="mailto:andras.iklody@circl.lu" class="email">andras.iklody@circl.lu</a>
</div>
</address>
</section>
</div>
<script>const toc = document.getElementById("toc");
toc.querySelector("h2").addEventListener("click", e => {
toc.classList.toggle("active");
});
toc.querySelector("nav").addEventListener("click", e => {
toc.classList.remove("active");
});
</script>
</body>
</html>