PyMISP/pymisp/mispevent.py

1734 lines
72 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
from datetime import timezone, datetime, date
import copy
import json
import os
2016-11-17 17:07:29 +01:00
import base64
2020-01-27 20:14:14 +01:00
import sys
2020-01-23 11:03:23 +01:00
from io import BytesIO, IOBase
from zipfile import ZipFile
2017-08-30 12:47:32 +02:00
import uuid
2018-01-22 10:33:34 +01:00
from collections import defaultdict
import logging
2019-11-19 15:53:58 +01:00
import hashlib
2019-12-18 14:45:14 +01:00
from pathlib import Path
from typing import List, Optional, Union, IO, Dict, Any
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
from .abstract import AbstractMISP, MISPTag
2017-08-30 12:47:32 +02:00
from .exceptions import UnknownMISPObjectTemplate, InvalidMISPObject, PyMISPError, NewEventError, NewAttributeError
logger = logging.getLogger('pymisp')
2017-08-30 12:47:32 +02:00
2018-08-08 11:19:24 +02:00
try:
from dateutil.parser import parse
except ImportError:
logger.exception("Cannot import dateutil")
try:
2020-01-02 15:55:00 +01:00
import jsonschema # type: ignore
except ImportError:
logger.exception("Cannot import jsonschema")
2016-11-17 17:07:29 +01:00
try:
# pyme renamed to gpg the 2016-10-28
2020-01-02 15:55:00 +01:00
import gpg # type: ignore
from gpg.constants.sig import mode # type: ignore
2016-11-17 17:07:29 +01:00
has_pyme = True
except ImportError:
2016-11-17 17:30:17 +01:00
try:
# pyme renamed to gpg the 2016-10-28
2020-01-02 15:55:00 +01:00
import pyme as gpg # type: ignore
from pyme.constants.sig import mode # type: ignore
2016-11-17 17:30:17 +01:00
has_pyme = True
except ImportError:
has_pyme = False
2016-11-17 17:07:29 +01:00
2020-01-27 20:14:14 +01:00
def _make_datetime(value) -> datetime:
if isinstance(value, (int, float)):
# Timestamp
value = datetime.fromtimestamp(value)
elif isinstance(value, str):
if sys.version_info >= (3, 7):
try:
# faster
value = datetime.fromisoformat(value)
except Exception:
value = parse(value)
else:
try:
# faster
if '+' in value or value.find('-', 10) > -1: # date contains `-` char
2020-01-27 20:14:14 +01:00
value = datetime.strptime(value, "%Y-%m-%dT%H:%M:%S.%f%z")
elif '.' in value:
value = datetime.strptime(value, "%Y-%m-%dT%H:%M:%S.%f")
elif 'T' in value:
value = datetime.strptime(value, "%Y-%m-%dT%H:%M:%S")
else:
value = datetime.strptime(value, "%Y-%m-%d")
except Exception:
value = parse(value)
elif isinstance(value, datetime):
pass
2020-01-28 14:12:39 +01:00
elif isinstance(value, date): # NOTE: date has to be *after* datetime, or it will be overwritten
value = datetime.combine(value, datetime.min.time())
2020-01-27 20:14:14 +01:00
else:
2020-01-28 14:12:39 +01:00
raise PyMISPError(f'Invalid format for {value}: {type(value)}.')
2020-01-27 20:14:14 +01:00
if not value.tzinfo:
# set localtimezone if not present
value = value.astimezone()
return value
def make_bool(value: Optional[Union[bool, int, str, dict, list]]) -> bool:
if isinstance(value, bool):
return value
if isinstance(value, int):
return bool(value)
2019-03-20 10:44:12 +01:00
if not value: # None, 0, '', {}, []
return False
if isinstance(value, str):
if value == '0':
return False
return True
else:
raise PyMISPError('Unable to convert {} to a boolean.'.format(value))
2019-12-18 14:45:14 +01:00
class MISPOrganisation(AbstractMISP):
2020-01-02 15:55:00 +01:00
_fields_for_feed: set = {'name', 'uuid'}
2019-12-18 14:45:14 +01:00
def __init__(self):
super().__init__()
self.id: int
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Organisation' in kwargs:
kwargs = kwargs['Organisation']
super(MISPOrganisation, self).from_dict(**kwargs)
2020-01-28 14:12:39 +01:00
2020-01-23 10:27:40 +01:00
class MISPSharingGroup(AbstractMISP):
def from_dict(self, **kwargs):
if 'SharingGroup' in kwargs:
kwargs = kwargs['SharingGroup']
super().from_dict(**kwargs)
2019-12-18 14:45:14 +01:00
class MISPShadowAttribute(AbstractMISP):
def __init__(self):
super().__init__()
self.type: str
self.value: str
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'ShadowAttribute' in kwargs:
kwargs = kwargs['ShadowAttribute']
super().from_dict(**kwargs)
def __repr__(self) -> str:
if hasattr(self, 'value'):
return f'<{self.__class__.__name__}(type={self.type}, value={self.value})'
2020-01-02 15:55:00 +01:00
return f'<{self.__class__.__name__}(NotInitialized)'
2019-12-18 14:45:14 +01:00
class MISPSighting(AbstractMISP):
def __init__(self):
super().__init__()
self.id: int
self.value: str
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
"""Initialize the MISPSighting from a dictionary
:value: Value of the attribute the sighting is related too. Pushing this object
will update the sighting count of each attriutes with thifs value on the instance
:uuid: UUID of the attribute to update
:id: ID of the attriute to update
:source: Source of the sighting
:type: Type of the sighting
:timestamp: Timestamp associated to the sighting
"""
if 'Sighting' in kwargs:
kwargs = kwargs['Sighting']
super(MISPSighting, self).from_dict(**kwargs)
def __repr__(self) -> str:
if hasattr(self, 'value'):
return '<{self.__class__.__name__}(value={self.value})'.format(self=self)
2019-12-18 14:45:14 +01:00
if hasattr(self, 'id'):
return '<{self.__class__.__name__}(id={self.id})'.format(self=self)
2019-12-18 14:45:14 +01:00
if hasattr(self, 'uuid'):
return '<{self.__class__.__name__}(uuid={self.uuid})'.format(self=self)
2019-12-18 14:45:14 +01:00
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
class MISPAttribute(AbstractMISP):
_fields_for_feed: set = {'uuid', 'value', 'category', 'type', 'comment', 'data',
'deleted', 'timestamp', 'to_ids', 'disable_correlation',
'first_seen', 'last_seen'}
2020-07-28 20:05:42 +02:00
def __init__(self, describe_types: Optional[Dict] = None, strict: bool = False):
"""Represents an Attribute
:describe_type: Use it is you want to overwrite the defualt describeTypes.json file (you don't)
:strict: If false, fallback to sane defaults for the attribute type if the ones passed by the user are incorrect
"""
2019-12-18 14:45:14 +01:00
super().__init__()
if describe_types:
self.describe_types: Dict[str, Any] = describe_types
2020-01-02 15:55:00 +01:00
self.__categories: List[str] = self.describe_types['categories']
self.__category_type_mapping: Dict[str, List[str]] = self.describe_types['category_type_mappings']
self.__sane_default: Dict[str, Dict[str, Union[str, int]]] = self.describe_types['sane_defaults']
2020-01-02 15:55:00 +01:00
self.__strict: bool = strict
self.data: Optional[BytesIO] = None
self.first_seen: datetime
self.last_seen: datetime
2020-01-02 15:55:00 +01:00
self.uuid: str = str(uuid.uuid4())
self.ShadowAttribute: List[MISPShadowAttribute] = []
2020-01-23 10:27:40 +01:00
self.SharingGroup: MISPSharingGroup
2020-01-02 15:55:00 +01:00
self.Sighting: List[MISPSighting] = []
2020-01-23 10:27:40 +01:00
self.Tag: List[MISPTag] = []
# For search
self.Event: MISPEvent
self.RelatedAttribute: List[MISPAttribute]
2020-07-28 20:05:42 +02:00
def add_tag(self, tag: Optional[Union[str, MISPTag, Dict]] = None, **kwargs) -> MISPTag:
2020-01-23 10:27:40 +01:00
return super()._add_tag(tag, **kwargs)
@property
def tags(self) -> List[MISPTag]:
"""Returns a lost of tags associated to this Attribute"""
return self.Tag
@tags.setter
def tags(self, tags: List[MISPTag]):
"""Set a list of prepared MISPTag."""
super()._set_tags(tags)
def _prepare_data(self, data: Optional[Union[Path, str, bytes, BytesIO]]):
if not data:
super().__setattr__('data', None)
return
if isinstance(data, BytesIO):
super().__setattr__('data', data)
elif isinstance(data, Path):
with data.open('rb') as f_temp:
super().__setattr__('data', BytesIO(f_temp.read()))
elif isinstance(data, (str, bytes)):
super().__setattr__('data', BytesIO(base64.b64decode(data)))
else:
raise PyMISPError(f'Invalid type ({type(data)}) for the data key: {data}')
if self.type == 'malware-sample':
try:
2020-02-24 17:09:42 +01:00
# Ignore type, if data is None -> exception
with ZipFile(self.data) as f: # type: ignore
if not self.__is_misp_encrypted_file(f):
raise PyMISPError('Not an existing malware sample')
for name in f.namelist():
if name.endswith('.filename.txt'):
with f.open(name, pwd=b'infected') as unpacked:
self.malware_filename = unpacked.read().decode().strip()
else:
with f.open(name, pwd=b'infected') as unpacked:
self._malware_binary = BytesIO(unpacked.read())
except Exception:
# not a encrypted zip file, assuming it is a new malware sample
self._prepare_new_malware_sample()
def __setattr__(self, name: str, value: Any):
if name in ['first_seen', 'last_seen']:
_datetime = _make_datetime(value)
if name == 'last_seen' and hasattr(self, 'first_seen') and self.first_seen > _datetime:
raise PyMISPError('last_seen ({value}) has to be after first_seen ({self.first_seen})')
if name == 'first_seen' and hasattr(self, 'last_seen') and self.last_seen < _datetime:
raise PyMISPError('first_seen ({value}) has to be before last_seen ({self.last_seen})')
super().__setattr__(name, _datetime)
elif name == 'data':
self._prepare_data(value)
else:
super().__setattr__(name, value)
2020-07-28 20:05:42 +02:00
def hash_values(self, algorithm: str = 'sha512') -> List[str]:
"""Compute the hash of every values for fast lookups"""
if algorithm not in hashlib.algorithms_available:
raise PyMISPError('The algorithm {} is not available for hashing.'.format(algorithm))
if '|' in self.type or self.type == 'malware-sample':
hashes = []
for v in self.value.split('|'):
h = hashlib.new(algorithm)
h.update(v.encode("utf-8"))
hashes.append(h.hexdigest())
return hashes
else:
h = hashlib.new(algorithm)
to_encode = self.value
if not isinstance(to_encode, str):
to_encode = str(to_encode)
h.update(to_encode.encode("utf-8"))
return [h.hexdigest()]
def _set_default(self):
if not hasattr(self, 'comment'):
self.comment = ''
if not hasattr(self, 'timestamp'):
self.timestamp = datetime.timestamp(datetime.now())
def _to_feed(self) -> Dict:
2019-12-18 14:45:14 +01:00
to_return = super()._to_feed()
2019-11-20 12:49:42 +01:00
if self.data:
to_return['data'] = base64.b64encode(self.data.getvalue()).decode()
if self.tags:
to_return['Tag'] = list(filter(None, [tag._to_feed() for tag in self.tags]))
2019-11-19 15:53:58 +01:00
return to_return
2017-12-21 18:46:28 +01:00
@property
2019-12-18 14:45:14 +01:00
def known_types(self) -> List[str]:
"""Returns a list of all the known MISP attributes types"""
2019-10-08 16:06:28 +02:00
return self.describe_types['types']
2017-12-21 18:46:28 +01:00
@property
def malware_binary(self) -> Optional[BytesIO]:
"""Returns a BytesIO of the malware (if the attribute has one, obvs)."""
2017-12-21 18:46:28 +01:00
if hasattr(self, '_malware_binary'):
return self._malware_binary
return None
2016-11-17 17:07:29 +01:00
@property
2019-12-18 14:45:14 +01:00
def shadow_attributes(self) -> List[MISPShadowAttribute]:
return self.ShadowAttribute
@shadow_attributes.setter
2019-12-18 14:45:14 +01:00
def shadow_attributes(self, shadow_attributes: List[MISPShadowAttribute]):
"""Set a list of prepared MISPShadowAttribute."""
if all(isinstance(x, MISPShadowAttribute) for x in shadow_attributes):
self.ShadowAttribute = shadow_attributes
else:
raise PyMISPError('All the attributes have to be of type MISPShadowAttribute.')
2016-11-17 17:07:29 +01:00
2019-08-20 15:34:21 +02:00
@property
2019-12-18 14:45:14 +01:00
def sightings(self) -> List[MISPSighting]:
2019-08-20 15:34:21 +02:00
return self.Sighting
@sightings.setter
2019-12-18 14:45:14 +01:00
def sightings(self, sightings: List[MISPSighting]):
2019-08-20 15:34:21 +02:00
"""Set a list of prepared MISPShadowAttribute."""
if all(isinstance(x, MISPSighting) for x in sightings):
self.Sighting = sightings
else:
raise PyMISPError('All the attributes have to be of type MISPSighting.')
def delete(self):
2017-12-22 14:49:14 +01:00
"""Mark the attribute as deleted (soft delete)"""
self.deleted = True
2019-12-18 14:45:14 +01:00
def add_proposal(self, shadow_attribute=None, **kwargs) -> MISPShadowAttribute:
"""Alias for add_shadow_attribute"""
return self.add_shadow_attribute(shadow_attribute, **kwargs)
2020-07-28 20:05:42 +02:00
def add_shadow_attribute(self, shadow_attribute: Optional[Union[MISPShadowAttribute, Dict]] = None, **kwargs) -> MISPShadowAttribute:
2019-08-20 15:34:21 +02:00
"""Add a shadow attribute to the attribute (by name or a MISPShadowAttribute object)"""
if isinstance(shadow_attribute, MISPShadowAttribute):
misp_shadow_attribute = shadow_attribute
elif isinstance(shadow_attribute, dict):
misp_shadow_attribute = MISPShadowAttribute()
misp_shadow_attribute.from_dict(**shadow_attribute)
elif kwargs:
misp_shadow_attribute = MISPShadowAttribute()
misp_shadow_attribute.from_dict(**kwargs)
else:
raise PyMISPError("The shadow_attribute is in an invalid format (can be either string, MISPShadowAttribute, or an expanded dict): {}".format(shadow_attribute))
self.shadow_attributes.append(misp_shadow_attribute)
self.edited = True
return misp_shadow_attribute
2020-07-28 20:05:42 +02:00
def add_sighting(self, sighting: Optional[Union[MISPSighting, dict]] = None, **kwargs) -> MISPSighting:
2019-08-20 15:34:21 +02:00
"""Add a sighting to the attribute (by name or a MISPSighting object)"""
if isinstance(sighting, MISPSighting):
misp_sighting = sighting
elif isinstance(sighting, dict):
misp_sighting = MISPSighting()
misp_sighting.from_dict(**sighting)
elif kwargs:
misp_sighting = MISPSighting()
misp_sighting.from_dict(**kwargs)
else:
raise PyMISPError("The sighting is in an invalid format (can be either string, MISPShadowAttribute, or an expanded dict): {}".format(sighting))
self.sightings.append(misp_sighting)
self.edited = True
return misp_sighting
2017-08-30 12:47:32 +02:00
def from_dict(self, **kwargs):
if 'Attribute' in kwargs:
kwargs = kwargs['Attribute']
2016-09-28 18:20:37 +02:00
if kwargs.get('type') and kwargs.get('category'):
if kwargs['type'] not in self.__category_type_mapping[kwargs['category']]:
if self.__strict:
raise NewAttributeError('{} and {} is an invalid combination, type for this category has to be in {}'.format(
kwargs.get('type'), kwargs.get('category'), (', '.join(self.__category_type_mapping[kwargs['category']]))))
else:
kwargs.pop('category', None)
2017-12-21 18:46:28 +01:00
self.type = kwargs.pop('type', None) # Required
if self.type is None:
2016-09-28 18:20:37 +02:00
raise NewAttributeError('The type of the attribute is required.')
2017-12-22 14:49:14 +01:00
if self.type not in self.known_types:
2019-10-08 08:15:56 +02:00
raise NewAttributeError('{} is invalid, type has to be in {}'.format(self.type, (', '.join(self.known_types))))
2016-09-28 18:20:37 +02:00
type_defaults = self.__sane_default[self.type]
self.value = kwargs.pop('value', None)
if self.value is None:
2016-09-28 18:20:37 +02:00
raise NewAttributeError('The value of the attribute is required.')
if self.type == 'datetime' and isinstance(self.value, str):
try:
2020-01-27 20:14:14 +01:00
# Faster
if sys.version_info >= (3, 7):
self.value = datetime.fromisoformat(self.value)
else:
2020-01-27 20:14:14 +01:00
if '+' in self.value or '-' in self.value:
self.value = datetime.strptime(self.value, "%Y-%m-%dT%H:%M:%S.%f%z")
elif '.' in self.value:
self.value = datetime.strptime(self.value, "%Y-%m-%dT%H:%M:%S.%f")
else:
self.value = datetime.strptime(self.value, "%Y-%m-%dT%H:%M:%S")
except ValueError:
# Slower, but if the other ones fail, that's a good fallback
self.value = parse(self.value)
2016-09-28 18:20:37 +02:00
# Default values
self.category = kwargs.pop('category', type_defaults['default_category'])
if self.category is None:
# In case the category key is passed, but None
self.category = type_defaults['default_category']
if self.category not in self.__categories:
raise NewAttributeError('{} is invalid, category has to be in {}'.format(self.category, (', '.join(self.__categories))))
2016-09-28 18:20:37 +02:00
self.to_ids = kwargs.pop('to_ids', bool(int(type_defaults['to_ids'])))
if self.to_ids is None:
self.to_ids = bool(int(type_defaults['to_ids']))
else:
self.to_ids = make_bool(self.to_ids)
if not isinstance(self.to_ids, bool):
raise NewAttributeError('{} is invalid, to_ids has to be True or False'.format(self.to_ids))
self.distribution = kwargs.pop('distribution', None)
if self.distribution is not None:
self.distribution = int(self.distribution)
if self.distribution not in [0, 1, 2, 3, 4, 5]:
raise NewAttributeError('{} is invalid, the distribution has to be in 0, 1, 2, 3, 4, 5'.format(self.distribution))
# other possible values
if kwargs.get('data'):
self.data = kwargs.pop('data')
2016-09-28 18:20:37 +02:00
if kwargs.get('id'):
self.id = int(kwargs.pop('id'))
if kwargs.get('event_id'):
2017-09-18 12:43:48 +02:00
self.event_id = int(kwargs.pop('event_id'))
2016-09-28 18:20:37 +02:00
if kwargs.get('timestamp'):
ts = kwargs.pop('timestamp')
if isinstance(ts, datetime):
self.timestamp = ts
else:
self.timestamp = datetime.fromtimestamp(int(ts), timezone.utc)
if kwargs.get('first_seen'):
fs = kwargs.pop('first_seen')
try:
# Faster
2020-01-27 20:14:14 +01:00
if sys.version_info >= (3, 7):
self.first_seen = datetime.fromisoformat(fs)
else:
self.first_seen = datetime.strptime(fs, "%Y-%m-%dT%H:%M:%S.%f%z")
2020-01-28 14:12:39 +01:00
except Exception:
# Use __setattr__
self.first_seen = fs
if kwargs.get('last_seen'):
ls = kwargs.pop('last_seen')
try:
# Faster
2020-01-27 20:14:14 +01:00
if sys.version_info >= (3, 7):
self.last_seen = datetime.fromisoformat(ls)
else:
self.last_seen = datetime.strptime(ls, "%Y-%m-%dT%H:%M:%S.%f%z")
2020-01-28 14:12:39 +01:00
except Exception:
# Use __setattr__
self.last_seen = ls
2016-09-28 18:20:37 +02:00
if kwargs.get('sharing_group_id'):
self.sharing_group_id = int(kwargs.pop('sharing_group_id'))
if self.distribution == 4:
# The distribution is set to sharing group, a sharing_group_id is required.
if not hasattr(self, 'sharing_group_id'):
raise NewAttributeError('If the distribution is set to sharing group, a sharing group ID is required.')
elif not self.sharing_group_id:
# Cannot be None or 0 either.
raise NewAttributeError('If the distribution is set to sharing group, a sharing group ID is required (cannot be {}).'.format(self.sharing_group_id))
if kwargs.get('Tag'):
[self.add_tag(tag) for tag in kwargs.pop('Tag')]
2019-08-20 15:34:21 +02:00
if kwargs.get('Sighting'):
[self.add_sighting(sighting) for sighting in kwargs.pop('Sighting')]
if kwargs.get('ShadowAttribute'):
[self.add_shadow_attribute(s_attr) for s_attr in kwargs.pop('ShadowAttribute')]
2020-01-23 10:27:40 +01:00
if kwargs.get('SharingGroup'):
self.SharingGroup = MISPSharingGroup()
self.SharingGroup.from_dict(**kwargs.pop('SharingGroup'))
# If the user wants to disable correlation, let them. Defaults to False.
self.disable_correlation = kwargs.pop("disable_correlation", False)
if self.disable_correlation is None:
self.disable_correlation = False
2019-12-18 14:45:14 +01:00
super().from_dict(**kwargs)
def to_dict(self) -> Dict:
2019-12-18 14:45:14 +01:00
to_return = super().to_dict()
if self.data:
2017-12-22 14:49:14 +01:00
to_return['data'] = base64.b64encode(self.data.getvalue()).decode()
return to_return
def _prepare_new_malware_sample(self):
if '|' in self.value:
# Get the filename, ignore the md5, because humans.
self.malware_filename, md5 = self.value.split('|')
else:
# Assuming the user only passed the filename
self.malware_filename = self.value
# m = hashlib.md5()
# m.update(self.data.getvalue())
self.value = self.malware_filename
# md5 = m.hexdigest()
# self.value = '{}|{}'.format(self.malware_filename, md5)
self._malware_binary = self.data
self.encrypt = True
2019-12-18 14:45:14 +01:00
def __is_misp_encrypted_file(self, f) -> bool:
files_list = f.namelist()
if len(files_list) != 2:
return False
md5_from_filename = ''
md5_from_file = ''
for name in files_list:
if name.endswith('.filename.txt'):
md5_from_filename = name.replace('.filename.txt', '')
else:
md5_from_file = name
if not md5_from_filename or not md5_from_file or md5_from_filename != md5_from_file:
return False
return True
2017-12-22 14:49:14 +01:00
def __repr__(self):
if hasattr(self, 'value'):
return '<{self.__class__.__name__}(type={self.type}, value={self.value})'.format(self=self)
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2017-12-21 18:46:28 +01:00
def verify(self, gpg_uid): # pragma: no cover
2017-12-21 18:46:28 +01:00
# Not used
if not has_pyme:
raise PyMISPError('pyme is required, please install: pip install --pre pyme3. You will also need libgpg-error-dev and libgpgme11-dev.')
signed_data = self._serialize()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
try:
c.verify(signed_data, signature=base64.b64decode(self.sig), verify=keys[:1])
return {self.uuid: True}
except Exception:
return {self.uuid: False}
def _serialize(self): # pragma: no cover
2017-12-21 18:46:28 +01:00
# Not used
return '{type}{category}{to_ids}{uuid}{timestamp}{comment}{deleted}{value}'.format(
type=self.type, category=self.category, to_ids=self.to_ids, uuid=self.uuid, timestamp=self.timestamp,
comment=self.comment, deleted=self.deleted, value=self.value).encode()
def sign(self, gpg_uid, passphrase=None): # pragma: no cover
2017-12-21 18:46:28 +01:00
# Not used
if not has_pyme:
raise PyMISPError('pyme is required, please install: pip install --pre pyme3. You will also need libgpg-error-dev and libgpgme11-dev.')
to_sign = self._serialize()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
c.signers = keys[:1]
if passphrase:
c.set_passphrase_cb(lambda *args: passphrase)
signed, _ = c.sign(to_sign, mode=mode.DETACH)
self.sig = base64.b64encode(signed).decode()
2019-12-18 14:45:14 +01:00
class MISPObjectReference(AbstractMISP):
2020-01-02 15:55:00 +01:00
_fields_for_feed: set = {'uuid', 'timestamp', 'relationship_type', 'comment',
'object_uuid', 'referenced_uuid'}
2019-12-18 14:45:14 +01:00
def __init__(self):
super().__init__()
self.uuid = str(uuid.uuid4())
2020-01-23 10:27:40 +01:00
self.object_uuid: str
self.referenced_uuid: str
self.relationship_type: str
2019-12-18 14:45:14 +01:00
def _set_default(self):
if not hasattr(self, 'comment'):
self.comment = ''
if not hasattr(self, 'timestamp'):
self.timestamp = datetime.timestamp(datetime.now())
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'ObjectReference' in kwargs:
kwargs = kwargs['ObjectReference']
super(MISPObjectReference, self).from_dict(**kwargs)
def __repr__(self) -> str:
if hasattr(self, 'referenced_uuid') and hasattr(self, 'object_uuid'):
return '<{self.__class__.__name__}(object_uuid={self.object_uuid}, referenced_uuid={self.referenced_uuid}, relationship_type={self.relationship_type})'.format(self=self)
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2019-12-18 14:45:14 +01:00
class MISPObject(AbstractMISP):
2017-09-18 12:43:48 +02:00
2020-01-02 15:55:00 +01:00
_fields_for_feed: set = {'name', 'meta-category', 'description', 'template_uuid',
'template_version', 'uuid', 'timestamp', 'distribution',
'sharing_group_id', 'comment', 'first_seen', 'last_seen',
'deleted'}
def __init__(self, name: str, strict: bool = False, standalone: bool = True, default_attributes_parameters: Dict = {}, **kwargs):
2019-12-18 14:45:14 +01:00
''' Master class representing a generic MISP object
:name: Name of the object
2019-12-18 14:45:14 +01:00
:strict: Enforce validation with the object templates
2019-12-18 14:45:14 +01:00
:standalone: The object will be pushed as directly on MISP, not as a part of an event.
In this case the ObjectReference needs to be pushed manually and cannot be in the JSON dump.
2019-11-19 15:53:58 +01:00
2019-12-18 14:45:14 +01:00
:default_attributes_parameters: Used as template for the attributes if they are not overwritten in add_attribute
:misp_objects_path_custom: Path to custom object templates
'''
super().__init__(**kwargs)
2020-01-02 15:55:00 +01:00
self._strict: bool = strict
self.name: str = name
self._known_template: bool = False
2020-01-23 10:27:40 +01:00
self.id: int
2019-12-18 14:45:14 +01:00
self._set_template(kwargs.get('misp_objects_path_custom'))
2020-01-02 15:55:00 +01:00
self.uuid: str = str(uuid.uuid4())
self.first_seen: datetime
self.last_seen: datetime
2020-01-02 15:55:00 +01:00
self.__fast_attribute_access: dict = defaultdict(list) # Hashtable object_relation: [attributes]
self.ObjectReference: List[MISPObjectReference] = []
self._standalone: bool = False
self.Attribute: List[MISPObjectAttribute] = []
2020-01-23 10:27:40 +01:00
self.SharingGroup: MISPSharingGroup
self._default_attributes_parameters: dict
2019-12-18 14:45:14 +01:00
if isinstance(default_attributes_parameters, MISPAttribute):
# Just make sure we're not modifying an existing MISPAttribute
2020-01-23 10:27:40 +01:00
self._default_attributes_parameters = default_attributes_parameters.to_dict()
else:
self._default_attributes_parameters = copy.copy(default_attributes_parameters)
2019-12-18 14:45:14 +01:00
if self._default_attributes_parameters:
# Let's clean that up
self._default_attributes_parameters.pop('value', None) # duh
self._default_attributes_parameters.pop('uuid', None) # duh
self._default_attributes_parameters.pop('id', None) # duh
self._default_attributes_parameters.pop('object_id', None) # duh
self._default_attributes_parameters.pop('type', None) # depends on the value
self._default_attributes_parameters.pop('object_relation', None) # depends on the value
self._default_attributes_parameters.pop('disable_correlation', None) # depends on the value
self._default_attributes_parameters.pop('to_ids', None) # depends on the value
self._default_attributes_parameters.pop('deleted', None) # doesn't make sense to pre-set it
self._default_attributes_parameters.pop('data', None) # in case the original in a sample or an attachment
# Those values are set for the current object, if they exist, but not pop'd because they are still useful for the attributes
self.distribution: int = self._default_attributes_parameters.get('distribution', 5)
self.sharing_group_id: int = self._default_attributes_parameters.get('sharing_group_id', 0)
2019-10-08 16:06:28 +02:00
else:
2019-12-18 14:45:14 +01:00
self.distribution = 5 # Default to inherit
self.sharing_group_id = 0
self.standalone = standalone
2019-12-18 14:45:14 +01:00
def _load_template_path(self, template_path: Union[Path, str]) -> bool:
self._definition: Optional[Dict] = self._load_json(template_path)
2019-12-18 14:45:14 +01:00
if not self._definition:
return False
setattr(self, 'meta-category', self._definition['meta-category'])
self.template_uuid = self._definition['uuid']
self.description = self._definition['description']
self.template_version = self._definition['version']
return True
def _set_default(self):
2019-12-18 14:45:14 +01:00
if not hasattr(self, 'comment'):
self.comment = ''
2019-11-19 15:53:58 +01:00
if not hasattr(self, 'timestamp'):
self.timestamp = datetime.timestamp(datetime.now())
2019-11-20 12:49:42 +01:00
def _to_feed(self) -> Dict:
2019-12-18 14:45:14 +01:00
to_return = super(MISPObject, self)._to_feed()
if self.references:
to_return['ObjectReference'] = [reference._to_feed() for reference in self.references]
return to_return
def __setattr__(self, name, value):
if name in ['first_seen', 'last_seen']:
2020-01-27 20:14:14 +01:00
value = _make_datetime(value)
if name == 'last_seen' and hasattr(self, 'first_seen') and self.first_seen > value:
raise PyMISPError('last_seen ({value}) has to be after first_seen ({self.first_seen})')
if name == 'first_seen' and hasattr(self, 'last_seen') and self.last_seen < value:
raise PyMISPError('first_seen ({value}) has to be before last_seen ({self.last_seen})')
super().__setattr__(name, value)
2020-07-28 20:05:42 +02:00
def force_misp_objects_path_custom(self, misp_objects_path_custom: Union[Path, str], object_name: Optional[str] = None):
2019-12-18 14:45:14 +01:00
if object_name:
self.name = object_name
self._set_template(misp_objects_path_custom)
2020-07-28 20:05:42 +02:00
def _set_template(self, misp_objects_path_custom: Optional[Union[Path, str]] = None):
2019-12-18 14:45:14 +01:00
if misp_objects_path_custom:
# If misp_objects_path_custom is given, and an object with the given name exists, use that.
2020-01-23 10:27:40 +01:00
if isinstance(misp_objects_path_custom, str):
self.misp_objects_path = Path(misp_objects_path_custom)
else:
self.misp_objects_path = misp_objects_path_custom
2019-12-18 14:45:14 +01:00
# Try to get the template
self._known_template = self._load_template_path(self.misp_objects_path / self.name / 'definition.json')
2019-12-18 14:45:14 +01:00
if not self._known_template and self._strict:
raise UnknownMISPObjectTemplate('{} is unknown in the MISP object directory.'.format(self.name))
else:
# Then we have no meta-category, template_uuid, description and template_version
pass
2019-11-19 15:53:58 +01:00
2017-12-21 18:46:28 +01:00
@property
2019-12-18 14:45:14 +01:00
def disable_validation(self):
self._strict = False
@property
def attributes(self) -> List['MISPObjectAttribute']:
2017-12-22 14:49:14 +01:00
return self.Attribute
@attributes.setter
def attributes(self, attributes: List['MISPObjectAttribute']):
2019-12-18 14:45:14 +01:00
if all(isinstance(x, MISPObjectAttribute) for x in attributes):
2017-12-22 14:49:14 +01:00
self.Attribute = attributes
2019-12-18 14:45:14 +01:00
self.__fast_attribute_access = defaultdict(list)
2017-12-22 14:49:14 +01:00
else:
2019-12-18 14:45:14 +01:00
raise PyMISPError('All the attributes have to be of type MISPObjectAttribute.')
2017-12-22 14:49:14 +01:00
@property
2019-12-18 14:45:14 +01:00
def references(self) -> List[MISPObjectReference]:
return self.ObjectReference
2019-12-18 14:45:14 +01:00
@references.setter
def references(self, references: List[MISPObjectReference]):
if all(isinstance(x, MISPObjectReference) for x in references):
self.ObjectReference = references
2017-12-12 17:34:09 +01:00
else:
2019-12-18 14:45:14 +01:00
raise PyMISPError('All the attributes have to be of type MISPObjectReference.')
2017-08-30 12:47:32 +02:00
@property
def standalone(self):
return self._standalone
@standalone.setter
def standalone(self, new_standalone: bool):
if self._standalone != new_standalone:
if new_standalone:
self.update_not_jsonable("ObjectReference")
else:
self._remove_from_not_jsonable("ObjectReference")
self._standalone = new_standalone
else:
pass
2019-07-12 17:35:02 +02:00
def from_dict(self, **kwargs):
2019-12-18 14:45:14 +01:00
if 'Object' in kwargs:
kwargs = kwargs['Object']
if self._known_template:
if kwargs.get('template_uuid') and kwargs['template_uuid'] != self.template_uuid:
if self._strict:
raise UnknownMISPObjectTemplate('UUID of the object is different from the one of the template.')
else:
self._known_template = False
if kwargs.get('template_version') and int(kwargs['template_version']) != self.template_version:
if self._strict:
raise UnknownMISPObjectTemplate('Version of the object ({}) is different from the one of the template ({}).'.format(kwargs['template_version'], self.template_version))
else:
self._known_template = False
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
if 'distribution' in kwargs and kwargs['distribution'] is not None:
self.distribution = kwargs.pop('distribution')
self.distribution = int(self.distribution)
if self.distribution not in [0, 1, 2, 3, 4, 5]:
raise NewAttributeError('{} is invalid, the distribution has to be in 0, 1, 2, 3, 4, 5'.format(self.distribution))
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
if kwargs.get('timestamp'):
ts = kwargs.pop('timestamp')
if isinstance(ts, datetime):
2019-12-18 14:45:14 +01:00
self.timestamp = ts
else:
self.timestamp = datetime.fromtimestamp(int(ts), timezone.utc)
if kwargs.get('first_seen'):
fs = kwargs.pop('first_seen')
try:
# Faster
2020-01-27 20:14:14 +01:00
if sys.version_info >= (3, 7):
self.first_seen = datetime.fromisoformat(fs)
else:
self.first_seen = datetime.strptime(fs, "%Y-%m-%dT%H:%M:%S.%f%z")
except Exception:
# Use __setattr__
self.first_seen = fs
if kwargs.get('last_seen'):
ls = kwargs.pop('last_seen')
try:
# Faster
2020-01-27 20:14:14 +01:00
if sys.version_info >= (3, 7):
self.last_seen = datetime.fromisoformat(ls)
else:
self.last_seen = datetime.strptime(ls, "%Y-%m-%dT%H:%M:%S.%f%z")
except Exception:
# Use __setattr__
self.last_seen = ls
2019-12-18 14:45:14 +01:00
if kwargs.get('Attribute'):
[self.add_attribute(**a) for a in kwargs.pop('Attribute')]
if kwargs.get('ObjectReference'):
[self.add_reference(**r) for r in kwargs.pop('ObjectReference')]
2019-07-12 17:35:02 +02:00
2020-01-23 10:27:40 +01:00
if kwargs.get('SharingGroup'):
self.SharingGroup = MISPSharingGroup()
self.SharingGroup.from_dict(**kwargs.pop('SharingGroup'))
2019-12-18 14:45:14 +01:00
# Not supported yet - https://github.com/MISP/PyMISP/issues/168
# if kwargs.get('Tag'):
# for tag in kwargs.pop('Tag'):
# self.add_tag(tag)
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
super().from_dict(**kwargs)
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def add_reference(self, referenced_uuid: Union[AbstractMISP, str], relationship_type: str, comment: Optional[str] = None, **kwargs) -> MISPObjectReference:
2019-12-18 14:45:14 +01:00
"""Add a link (uuid) to an other object"""
if isinstance(referenced_uuid, AbstractMISP):
# Allow to pass an object or an attribute instead of its UUID
referenced_uuid = referenced_uuid.uuid
if kwargs.get('object_uuid'):
# Load existing object
object_uuid = kwargs.pop('object_uuid')
else:
# New reference
object_uuid = self.uuid
reference = MISPObjectReference()
reference.from_dict(object_uuid=object_uuid, referenced_uuid=referenced_uuid,
relationship_type=relationship_type, comment=comment, **kwargs)
self.ObjectReference.append(reference)
self.edited = True
return reference
2019-12-18 14:45:14 +01:00
def get_attributes_by_relation(self, object_relation: str) -> List[MISPAttribute]:
'''Returns the list of attributes with the given object relation in the object'''
return self._fast_attribute_access.get(object_relation, [])
2019-12-18 14:45:14 +01:00
@property
def _fast_attribute_access(self) -> Dict:
2019-12-18 14:45:14 +01:00
if not self.__fast_attribute_access:
for a in self.attributes:
self.__fast_attribute_access[a.object_relation].append(a)
return self.__fast_attribute_access
2018-08-09 18:11:45 +02:00
def has_attributes_by_relation(self, list_of_relations: List[str]) -> bool:
2019-12-18 14:45:14 +01:00
'''True if all the relations in the list are defined in the object'''
return all(relation in self._fast_attribute_access for relation in list_of_relations)
2019-08-07 18:20:38 +02:00
2020-07-28 20:05:42 +02:00
def add_attribute(self, object_relation: str, simple_value: Optional[Union[str, int, float]] = None, **value) -> Optional[MISPAttribute]:
2019-12-18 14:45:14 +01:00
"""Add an attribute. object_relation is required and the value key is a
dictionary with all the keys supported by MISPAttribute"""
if simple_value is not None: # /!\ The value *can* be 0
value = {'value': simple_value}
if value.get('value') is None:
logger.warning("The value of the attribute you're trying to add is None, skipping it. Object relation: {}".format(object_relation))
2019-12-18 14:45:14 +01:00
return None
else:
# Make sure we're not adding an empty value.
if isinstance(value['value'], str):
value['value'] = value['value'].strip()
if value['value'] == '':
logger.warning("The value of the attribute you're trying to add is an empty string, skipping it. Object relation: {}".format(object_relation))
return None
2020-01-02 15:55:00 +01:00
if self._known_template and self._definition:
2019-12-18 14:45:14 +01:00
if object_relation in self._definition['attributes']:
attribute = MISPObjectAttribute(self._definition['attributes'][object_relation])
else:
# Woopsie, this object_relation is unknown, no sane defaults for you.
logger.warning("The template ({}) doesn't have the object_relation ({}) you're trying to add.".format(self.name, object_relation))
attribute = MISPObjectAttribute({})
else:
attribute = MISPObjectAttribute({})
# Overwrite the parameters of self._default_attributes_parameters with the ones of value
attribute.from_dict(object_relation=object_relation, **dict(self._default_attributes_parameters, **value))
# FIXME New syntax python3 only, keep for later.
# attribute.from_dict(object_relation=object_relation, **{**self._default_attributes_parameters, **value})
self.__fast_attribute_access[object_relation].append(attribute)
self.Attribute.append(attribute)
self.edited = True
return attribute
2020-01-02 15:55:00 +01:00
def add_attributes(self, object_relation: str, *attributes) -> List[Optional[MISPAttribute]]:
2019-12-18 14:45:14 +01:00
'''Add multiple attributes with the same object_relation.
Helper for object_relation when multiple is True in the template.
It is the same as calling multiple times add_attribute with the same object_relation.
'''
to_return = []
for attribute in attributes:
if isinstance(attribute, dict):
a = self.add_attribute(object_relation, **attribute)
else:
a = self.add_attribute(object_relation, value=attribute)
to_return.append(a)
return to_return
2020-07-28 20:05:42 +02:00
def to_dict(self, strict: bool = False) -> Dict:
2019-12-18 14:45:14 +01:00
if strict or self._strict and self._known_template:
self._validate()
return super(MISPObject, self).to_dict()
2019-11-19 15:53:58 +01:00
2020-07-28 20:05:42 +02:00
def to_json(self, sort_keys: bool = False, indent: Optional[int] = None, strict: bool = False):
2019-12-18 14:45:14 +01:00
if strict or self._strict and self._known_template:
self._validate()
return super(MISPObject, self).to_json(sort_keys=sort_keys, indent=indent)
def _validate(self) -> bool:
if not self._definition:
raise PyMISPError('No object definition available, unable to validate.')
2019-12-18 14:45:14 +01:00
"""Make sure the object we're creating has the required fields"""
if self._definition.get('required'):
required_missing = set(self._definition['required']) - set(self._fast_attribute_access.keys())
2019-12-18 14:45:14 +01:00
if required_missing:
raise InvalidMISPObject('{} are required.'.format(required_missing))
if self._definition.get('requiredOneOf'):
if not set(self._definition['requiredOneOf']) & set(self._fast_attribute_access.keys()):
# We ecpect at least one of the object_relation in requiredOneOf, and it isn't the case
raise InvalidMISPObject('At least one of the following attributes is required: {}'.format(', '.join(self._definition['requiredOneOf'])))
for rel, attrs in self._fast_attribute_access.items():
if len(attrs) == 1:
# object_relation's here only once, everything's cool, moving on
continue
if not self._definition['attributes'][rel].get('multiple'):
# object_relation's here more than once, but it isn't allowed in the template.
raise InvalidMISPObject('Multiple occurrences of {} is not allowed'.format(rel))
return True
2018-08-09 18:11:45 +02:00
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
if hasattr(self, 'name'):
return '<{self.__class__.__name__}(name={self.name})'.format(self=self)
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2019-12-18 14:45:14 +01:00
class MISPEvent(AbstractMISP):
2020-01-02 15:55:00 +01:00
_fields_for_feed: set = {'uuid', 'info', 'threat_level_id', 'analysis', 'timestamp',
'publish_timestamp', 'published', 'date', 'extends_uuid'}
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def __init__(self, describe_types: Optional[Dict] = None, strict_validation: bool = False, **kwargs):
2019-12-18 14:45:14 +01:00
super().__init__(**kwargs)
if strict_validation:
schema_file = 'schema.json'
else:
schema_file = 'schema-lax.json'
self.__json_schema = self._load_json(self.resources_path / schema_file)
if describe_types:
# This variable is used in add_attribute in order to avoid duplicating the structure
self.describe_types = describe_types
2019-07-12 17:35:02 +02:00
self.uuid: str = str(uuid.uuid4())
self.date: date
2020-01-02 15:55:00 +01:00
self.Attribute: List[MISPAttribute] = []
self.Object: List[MISPObject] = []
self.RelatedEvent: List[MISPEvent] = []
self.ShadowAttribute: List[MISPShadowAttribute] = []
2020-01-23 10:27:40 +01:00
self.SharingGroup: MISPSharingGroup
self.Tag: List[MISPTag] = []
2020-07-28 20:05:42 +02:00
def add_tag(self, tag: Optional[Union[str, MISPTag, dict]] = None, **kwargs) -> MISPTag:
2020-01-23 10:27:40 +01:00
return super()._add_tag(tag, **kwargs)
@property
def tags(self) -> List[MISPTag]:
"""Returns a lost of tags associated to this Event"""
return self.Tag
@tags.setter
def tags(self, tags: List[MISPTag]):
"""Set a list of prepared MISPTag."""
super()._set_tags(tags)
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
def _set_default(self):
"""There are a few keys that could, or need to be set by default for the feed generator"""
if not hasattr(self, 'published'):
self.published = True
if not hasattr(self, 'uuid'):
self.uuid = str(uuid.uuid4())
if not hasattr(self, 'extends_uuid'):
self.extends_uuid = ''
if not hasattr(self, 'date'):
self.set_date(date.today())
2019-12-18 14:45:14 +01:00
if not hasattr(self, 'timestamp'):
self.timestamp = datetime.timestamp(datetime.now())
2019-12-18 14:45:14 +01:00
if not hasattr(self, 'publish_timestamp'):
self.publish_timestamp = datetime.timestamp(datetime.now())
2019-12-18 14:45:14 +01:00
if not hasattr(self, 'analysis'):
# analysis: 0 means initial, 1 ongoing, 2 completed
self.analysis = 2
if not hasattr(self, 'threat_level_id'):
# threat_level_id 4 means undefined. Tags are recommended.
self.threat_level_id = 4
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def manifest(self) -> Dict:
2019-12-18 14:45:14 +01:00
required = ['info', 'Orgc']
for r in required:
if not hasattr(self, r):
raise PyMISPError('The field {} is required to generate the event manifest.')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
self._set_default()
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
return {
self.uuid: {
'Orgc': self.Orgc._to_feed(),
'Tag': list(filter(None, [tag._to_feed() for tag in self.tags])),
'info': self.info,
'date': self.date.isoformat(),
'analysis': self.analysis,
'threat_level_id': self.threat_level_id,
'timestamp': self._datetime_to_timestamp(self.timestamp)
}
}
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def attributes_hashes(self, algorithm: str = 'sha512') -> List[str]:
2020-01-02 15:55:00 +01:00
to_return: List[str] = []
2019-12-18 14:45:14 +01:00
for attribute in self.attributes:
to_return += attribute.hash_values(algorithm)
for obj in self.objects:
for attribute in obj.attributes:
to_return += attribute.hash_values(algorithm)
return to_return
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def to_feed(self, valid_distributions: List[int] = [0, 1, 2, 3, 4, 5], with_meta: bool = False) -> Dict:
2019-12-18 14:45:14 +01:00
""" Generate a json output for MISP Feed.
Note: valid_distributions only makes sense if the distribution key is set; i.e., the event is exported from a MISP instance.
2019-12-18 14:45:14 +01:00
"""
required = ['info', 'Orgc']
for r in required:
if not hasattr(self, r):
2020-01-28 14:12:39 +01:00
raise PyMISPError(f'The field {r} is required to generate the event feed output.')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
if (hasattr(self, 'distribution')
and self.distribution is not None
and int(self.distribution) not in valid_distributions):
2020-01-02 15:55:00 +01:00
return {}
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
to_return = super()._to_feed()
if with_meta:
to_return['_hashes'] = []
to_return['_manifest'] = self.manifest
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
to_return['Orgc'] = self.Orgc._to_feed()
to_return['Tag'] = list(filter(None, [tag._to_feed() for tag in self.tags]))
if self.attributes:
to_return['Attribute'] = []
for attribute in self.attributes:
if (valid_distributions and attribute.get('distribution') is not None and attribute.distribution not in valid_distributions):
continue
to_return['Attribute'].append(attribute._to_feed())
if with_meta:
to_return['_hashes'] += attribute.hash_values('md5')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
if self.objects:
to_return['Object'] = []
for obj in self.objects:
if (valid_distributions and obj.get('distribution') is not None and obj.distribution not in valid_distributions):
continue
obj_to_attach = obj._to_feed()
obj_to_attach['Attribute'] = []
for attribute in obj.attributes:
if (valid_distributions and attribute.get('distribution') is not None and attribute.distribution not in valid_distributions):
continue
obj_to_attach['Attribute'].append(attribute._to_feed())
if with_meta:
to_return['_hashes'] += attribute.hash_values('md5')
to_return['Object'].append(obj_to_attach)
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
return {'Event': to_return}
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def known_types(self) -> List[str]:
return self.describe_types['types']
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def org(self) -> MISPOrganisation:
return self.Org
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def orgc(self) -> MISPOrganisation:
return self.Orgc
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@orgc.setter
def orgc(self, orgc: MISPOrganisation):
if isinstance(orgc, MISPOrganisation):
self.Orgc = orgc
else:
raise PyMISPError('Orgc must be of type MISPOrganisation.')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def attributes(self) -> List[MISPAttribute]:
return self.Attribute
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@attributes.setter
def attributes(self, attributes: List[MISPAttribute]):
if all(isinstance(x, MISPAttribute) for x in attributes):
self.Attribute = attributes
else:
raise PyMISPError('All the attributes have to be of type MISPAttribute.')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def shadow_attributes(self) -> List[MISPShadowAttribute]:
return self.ShadowAttribute
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@shadow_attributes.setter
def shadow_attributes(self, shadow_attributes: List[MISPShadowAttribute]):
if all(isinstance(x, MISPShadowAttribute) for x in shadow_attributes):
self.ShadowAttribute = shadow_attributes
else:
raise PyMISPError('All the attributes have to be of type MISPShadowAttribute.')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def related_events(self) -> List['MISPEvent']:
2019-12-18 14:45:14 +01:00
return self.RelatedEvent
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@property
def objects(self) -> List[MISPObject]:
return self.Object
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
@objects.setter
def objects(self, objects: List[MISPObject]):
if all(isinstance(x, MISPObject) for x in objects):
self.Object = objects
else:
raise PyMISPError('All the attributes have to be of type MISPObject.')
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def load_file(self, event_path: Union[Path, str], validate: bool = False, metadata_only: bool = False):
2019-12-18 14:45:14 +01:00
"""Load a JSON dump from a file on the disk"""
if not os.path.exists(event_path):
raise PyMISPError('Invalid path, unable to load the event.')
with open(event_path, 'rb') as f:
self.load(f, validate, metadata_only)
2019-07-12 17:35:02 +02:00
2020-07-28 20:05:42 +02:00
def load(self, json_event: Union[IO, str, bytes, dict], validate: bool = False, metadata_only: bool = False):
2019-12-18 14:45:14 +01:00
"""Load a JSON dump from a pseudo file or a JSON string"""
2020-01-23 11:03:23 +01:00
if isinstance(json_event, IOBase):
2019-12-18 14:45:14 +01:00
# python2 and python3 compatible to find if we have a file
json_event = json_event.read()
if isinstance(json_event, (str, bytes)):
json_event = json.loads(json_event)
2020-01-23 10:27:40 +01:00
if isinstance(json_event, dict) and 'response' in json_event and isinstance(json_event['response'], list):
event = json_event['response'][0]
2019-12-18 14:45:14 +01:00
else:
event = json_event
if not event:
raise PyMISPError('Invalid event')
if metadata_only:
event.pop('Attribute', None)
event.pop('Object', None)
self.from_dict(**event)
if validate:
jsonschema.validate(json.loads(self.to_json()), self.__json_schema)
2019-07-12 17:35:02 +02:00
def __setattr__(self, name, value):
if name in ['date']:
if isinstance(value, date):
pass
elif isinstance(value, str):
2020-01-27 20:14:14 +01:00
if sys.version_info >= (3, 7):
try:
# faster
2020-01-28 14:12:39 +01:00
value = date.fromisoformat(value)
2020-01-27 20:14:14 +01:00
except Exception:
value = parse(value).date()
else:
value = parse(value).date()
elif isinstance(value, (int, float)):
value = date.fromtimestamp(value)
elif isinstance(value, datetime):
value = value.date()
else:
raise NewEventError(f'Invalid format for the date: {type(value)} - {value}')
super().__setattr__(name, value)
2020-07-28 20:05:42 +02:00
def set_date(self, d: Optional[Union[str, int, float, datetime, date]] = None, ignore_invalid: bool = False):
2019-12-18 14:45:14 +01:00
"""Set a date for the event (string, datetime, or date object)"""
if isinstance(d, (str, int, float, datetime, date)):
2020-01-28 14:12:39 +01:00
self.date = d # type: ignore
elif ignore_invalid:
self.date = date.today()
2019-12-18 14:45:14 +01:00
else:
raise NewEventError(f'Invalid format for the date: {type(d)} - {d}')
2019-07-12 17:35:02 +02:00
def from_dict(self, **kwargs):
2019-12-18 14:45:14 +01:00
if 'Event' in kwargs:
kwargs = kwargs['Event']
# Required value
self.info = kwargs.pop('info', None)
if self.info is None:
raise NewEventError('The info field of the new event is required.')
2019-12-18 14:45:14 +01:00
# Default values for a valid event to send to a MISP instance
self.distribution = kwargs.pop('distribution', None)
if self.distribution is not None:
self.distribution = int(self.distribution)
if self.distribution not in [0, 1, 2, 3, 4]:
raise NewEventError(f'{self.info}: {self.distribution} is invalid, the distribution has to be in 0, 1, 2, 3, 4')
2019-12-18 14:45:14 +01:00
if kwargs.get('threat_level_id') is not None:
self.threat_level_id = int(kwargs.pop('threat_level_id'))
if self.threat_level_id not in [1, 2, 3, 4]:
raise NewEventError(f'{self.info}: {self.threat_level_id} is invalid, the threat_level_id has to be in 1, 2, 3, 4')
2019-12-18 14:45:14 +01:00
if kwargs.get('analysis') is not None:
self.analysis = int(kwargs.pop('analysis'))
if self.analysis not in [0, 1, 2]:
raise NewEventError(f'{self.info}: {self.analysis} is invalid, the analysis has to be in 0, 1, 2')
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
self.published = kwargs.pop('published', None)
if self.published is True:
self.publish()
else:
self.unpublish()
2019-12-18 14:45:14 +01:00
if kwargs.get('date'):
self.set_date(kwargs.pop('date'))
if kwargs.get('Attribute'):
[self.add_attribute(**a) for a in kwargs.pop('Attribute')]
2019-12-18 14:45:14 +01:00
# All other keys
if kwargs.get('id'):
self.id = int(kwargs.pop('id'))
if kwargs.get('orgc_id'):
self.orgc_id = int(kwargs.pop('orgc_id'))
if kwargs.get('org_id'):
self.org_id = int(kwargs.pop('org_id'))
if kwargs.get('timestamp'):
self.timestamp = datetime.fromtimestamp(int(kwargs.pop('timestamp')), timezone.utc)
2019-12-18 14:45:14 +01:00
if kwargs.get('publish_timestamp'):
self.publish_timestamp = datetime.fromtimestamp(int(kwargs.pop('publish_timestamp')), timezone.utc)
2019-12-18 14:45:14 +01:00
if kwargs.get('sighting_timestamp'):
self.sighting_timestamp = datetime.fromtimestamp(int(kwargs.pop('sighting_timestamp')), timezone.utc)
2019-12-18 14:45:14 +01:00
if kwargs.get('sharing_group_id'):
self.sharing_group_id = int(kwargs.pop('sharing_group_id'))
if kwargs.get('RelatedEvent'):
for rel_event in kwargs.pop('RelatedEvent'):
sub_event = MISPEvent()
sub_event.load(rel_event)
self.RelatedEvent.append({'Event': sub_event})
if kwargs.get('Tag'):
[self.add_tag(tag) for tag in kwargs.pop('Tag')]
if kwargs.get('Object'):
[self.add_object(obj) for obj in kwargs.pop('Object')]
if kwargs.get('Org'):
self.Org = MISPOrganisation()
self.Org.from_dict(**kwargs.pop('Org'))
if kwargs.get('Orgc'):
self.Orgc = MISPOrganisation()
self.Orgc.from_dict(**kwargs.pop('Orgc'))
2020-01-23 10:27:40 +01:00
if kwargs.get('SharingGroup'):
self.SharingGroup = MISPSharingGroup()
self.SharingGroup.from_dict(**kwargs.pop('SharingGroup'))
2019-12-18 14:45:14 +01:00
super(MISPEvent, self).from_dict(**kwargs)
def to_dict(self) -> Dict:
2019-12-18 14:45:14 +01:00
to_return = super().to_dict()
2019-12-18 14:45:14 +01:00
if to_return.get('date'):
if isinstance(self.date, datetime):
2019-12-18 14:45:14 +01:00
self.date = self.date.date()
to_return['date'] = self.date.isoformat()
if to_return.get('publish_timestamp'):
to_return['publish_timestamp'] = self._datetime_to_timestamp(self.publish_timestamp)
if to_return.get('sighting_timestamp'):
to_return['sighting_timestamp'] = self._datetime_to_timestamp(self.sighting_timestamp)
2019-12-18 14:45:14 +01:00
return to_return
2019-12-18 14:45:14 +01:00
def add_proposal(self, shadow_attribute=None, **kwargs) -> MISPShadowAttribute:
"""Alias for add_shadow_attribute"""
return self.add_shadow_attribute(shadow_attribute, **kwargs)
2017-12-26 17:13:57 +01:00
2019-12-18 14:45:14 +01:00
def add_shadow_attribute(self, shadow_attribute=None, **kwargs) -> MISPShadowAttribute:
"""Add a tag to the attribute (by name or a MISPTag object)"""
if isinstance(shadow_attribute, MISPShadowAttribute):
misp_shadow_attribute = shadow_attribute
elif isinstance(shadow_attribute, dict):
misp_shadow_attribute = MISPShadowAttribute()
misp_shadow_attribute.from_dict(**shadow_attribute)
elif kwargs:
misp_shadow_attribute = MISPShadowAttribute()
misp_shadow_attribute.from_dict(**kwargs)
else:
raise PyMISPError("The shadow_attribute is in an invalid format (can be either string, MISPShadowAttribute, or an expanded dict): {}".format(shadow_attribute))
self.shadow_attributes.append(misp_shadow_attribute)
self.edited = True
return misp_shadow_attribute
2017-12-26 17:13:57 +01:00
2019-12-18 14:45:14 +01:00
def get_attribute_tag(self, attribute_identifier: str) -> List[MISPTag]:
"""Return the tags associated to an attribute or an object attribute.
:attribute_identifier: can be an ID, UUID, or the value.
2017-12-26 17:13:57 +01:00
"""
2020-01-02 15:55:00 +01:00
tags: List[MISPTag] = []
2019-12-18 14:45:14 +01:00
for a in self.attributes + [attribute for o in self.objects for attribute in o.attributes]:
if ((hasattr(a, 'id') and a.id == attribute_identifier)
or (hasattr(a, 'uuid') and a.uuid == attribute_identifier)
or (hasattr(a, 'value') and attribute_identifier == a.value
or (isinstance(a.value, str) and attribute_identifier in a.value.split('|')))):
2019-12-18 14:45:14 +01:00
tags += a.tags
return tags
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
def add_attribute_tag(self, tag: Union[MISPTag, str], attribute_identifier: str) -> List[MISPAttribute]:
"""Add a tag to an existing attribute, raise an Exception if the attribute doesn't exists.
:tag: Tag name as a string, MISPTag instance, or dictionary
:attribute_identifier: can be an ID, UUID, or the value.
"""
attributes = []
for a in self.attributes + [attribute for o in self.objects for attribute in o.attributes]:
if ((hasattr(a, 'id') and a.id == attribute_identifier)
or (hasattr(a, 'uuid') and a.uuid == attribute_identifier)
or (hasattr(a, 'value') and attribute_identifier == a.value
or (isinstance(a.value, str) and attribute_identifier in a.value.split('|')))):
2019-12-18 14:45:14 +01:00
a.add_tag(tag)
attributes.append(a)
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
if not attributes:
raise PyMISPError('No attribute with identifier {} found.'.format(attribute_identifier))
self.edited = True
return attributes
2017-12-22 14:49:14 +01:00
2019-12-18 14:45:14 +01:00
def publish(self):
"""Mark the attribute as published"""
self.published = True
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
def unpublish(self):
"""Mark the attribute as un-published (set publish flag to false)"""
self.published = False
2019-12-18 14:45:14 +01:00
def delete_attribute(self, attribute_id: str):
"""Delete an attribute, you can search by ID or UUID"""
for a in self.attributes:
if ((hasattr(a, 'id') and a.id == attribute_id)
or (hasattr(a, 'uuid') and a.uuid == attribute_id)):
a.delete()
break
2020-05-14 12:43:10 +02:00
else:
2019-12-18 14:45:14 +01:00
raise PyMISPError('No attribute with UUID/ID {} found.'.format(attribute_id))
2020-01-02 15:55:00 +01:00
def add_attribute(self, type: str, value: Union[str, int, float], **kwargs) -> Union[MISPAttribute, List[MISPAttribute]]:
2019-12-18 14:45:14 +01:00
"""Add an attribute. type and value are required but you can pass all
other parameters supported by MISPAttribute"""
2020-01-02 15:55:00 +01:00
attr_list: List[MISPAttribute] = []
2019-12-18 14:45:14 +01:00
if isinstance(value, list):
attr_list = [self.add_attribute(type=type, value=a, **kwargs) for a in value]
else:
attribute = MISPAttribute(describe_types=self.describe_types)
attribute.from_dict(type=type, value=value, **kwargs)
self.attributes.append(attribute)
self.edited = True
if attr_list:
return attr_list
return attribute
2019-04-11 23:13:15 +02:00
2019-12-18 14:45:14 +01:00
def get_object_by_id(self, object_id: Union[str, int]) -> MISPObject:
"""Get an object by ID (the ID is the one set by the server when creating the new object)"""
for obj in self.objects:
if hasattr(obj, 'id') and int(obj.id) == int(object_id):
return obj
raise InvalidMISPObject('Object with {} does not exist in this event'.format(object_id))
2019-07-12 17:35:02 +02:00
2019-12-18 14:45:14 +01:00
def get_object_by_uuid(self, object_uuid: str) -> MISPObject:
"""Get an object by UUID (UUID is set by the server when creating the new object)"""
for obj in self.objects:
if hasattr(obj, 'uuid') and obj.uuid == object_uuid:
return obj
raise InvalidMISPObject('Object with {} does not exist in this event'.format(object_uuid))
2019-12-18 14:45:14 +01:00
def get_objects_by_name(self, object_name: str) -> List[MISPObject]:
"""Get an object by UUID (UUID is set by the server when creating the new object)"""
objects = []
for obj in self.objects:
if hasattr(obj, 'uuid') and obj.name == object_name:
objects.append(obj)
return objects
2019-08-29 18:08:53 +02:00
2020-07-28 20:05:42 +02:00
def add_object(self, obj: Union[MISPObject, dict, None] = None, **kwargs) -> MISPObject:
2019-12-18 14:45:14 +01:00
"""Add an object to the Event, either by passing a MISPObject, or a dictionary"""
if isinstance(obj, MISPObject):
misp_obj = obj
elif isinstance(obj, dict):
misp_obj = MISPObject(name=obj.pop('name'), strict=obj.pop('strict', False),
default_attributes_parameters=obj.pop('default_attributes_parameters', {}),
**obj)
misp_obj.from_dict(**obj)
elif kwargs:
misp_obj = MISPObject(name=kwargs.pop('name'), strict=kwargs.pop('strict', False),
default_attributes_parameters=kwargs.pop('default_attributes_parameters', {}),
**kwargs)
misp_obj.from_dict(**kwargs)
else:
raise InvalidMISPObject("An object to add to an existing Event needs to be either a MISPObject, or a plain python dictionary")
misp_obj.standalone = False
2019-12-18 14:45:14 +01:00
self.Object.append(misp_obj)
self.edited = True
return misp_obj
2019-08-29 18:08:53 +02:00
2019-12-18 14:45:14 +01:00
def run_expansions(self):
for index, attribute in enumerate(self.attributes):
if 'expand' not in attribute:
continue
# NOTE: Always make sure the attribute with the expand key is either completely removed,
# of the key is deleted to avoid seeing it processed again on MISP side
elif attribute.expand == 'binary':
try:
from .tools import make_binary_objects
except ImportError as e:
logger.info('Unable to load make_binary_objects: {}'.format(e))
continue
file_object, bin_type_object, bin_section_objects = make_binary_objects(pseudofile=attribute.malware_binary, filename=attribute.malware_filename)
self.add_object(file_object)
if bin_type_object:
self.add_object(bin_type_object)
if bin_section_objects:
for bin_section_object in bin_section_objects:
self.add_object(bin_section_object)
self.attributes.pop(index)
else:
logger.warning('No expansions for this data type ({}). Open an issue if needed.'.format(attribute.type))
2019-08-29 18:08:53 +02:00
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
if hasattr(self, 'info'):
return '<{self.__class__.__name__}(info={self.info})'.format(self=self)
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2019-08-29 18:08:53 +02:00
2019-12-18 14:45:14 +01:00
def _serialize(self): # pragma: no cover
return '{date}{threat_level_id}{info}{uuid}{analysis}{timestamp}'.format(
date=self.date, threat_level_id=self.threat_level_id, info=self.info,
uuid=self.uuid, analysis=self.analysis, timestamp=self.timestamp).encode()
2019-08-29 18:08:53 +02:00
2019-12-18 14:45:14 +01:00
def _serialize_sigs(self): # pragma: no cover
# Not used
all_sigs = self.sig
for a in self.attributes:
all_sigs += a.sig
return all_sigs.encode()
2019-10-16 17:22:19 +02:00
2019-12-18 14:45:14 +01:00
def sign(self, gpg_uid, passphrase=None): # pragma: no cover
# Not used
if not has_pyme:
raise PyMISPError('pyme is required, please install: pip install --pre pyme3. You will also need libgpg-error-dev and libgpgme11-dev.')
to_sign = self._serialize()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
c.signers = keys[:1]
if passphrase:
c.set_passphrase_cb(lambda *args: passphrase)
signed, _ = c.sign(to_sign, mode=mode.DETACH)
self.sig = base64.b64encode(signed).decode()
for a in self.attributes:
a.sign(gpg_uid, passphrase)
to_sign_global = self._serialize_sigs()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
c.signers = keys[:1]
if passphrase:
c.set_passphrase_cb(lambda *args: passphrase)
signed, _ = c.sign(to_sign_global, mode=mode.DETACH)
self.global_sig = base64.b64encode(signed).decode()
2019-10-16 17:22:19 +02:00
2019-12-18 14:45:14 +01:00
def verify(self, gpg_uid): # pragma: no cover
# Not used
if not has_pyme:
raise PyMISPError('pyme is required, please install: pip install --pre pyme3. You will also need libgpg-error-dev and libgpgme11-dev.')
to_return = {}
signed_data = self._serialize()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
try:
c.verify(signed_data, signature=base64.b64decode(self.sig), verify=keys[:1])
to_return[self.uuid] = True
except Exception:
to_return[self.uuid] = False
for a in self.attributes:
to_return.update(a.verify(gpg_uid))
to_verify_global = self._serialize_sigs()
with gpg.Context() as c:
keys = list(c.keylist(gpg_uid))
try:
c.verify(to_verify_global, signature=base64.b64decode(self.global_sig), verify=keys[:1])
to_return['global'] = True
except Exception:
to_return['global'] = False
return to_return
2019-10-16 17:22:19 +02:00
2019-12-18 14:45:14 +01:00
class MISPObjectTemplate(AbstractMISP):
2019-10-16 17:22:19 +02:00
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'ObjectTemplate' in kwargs:
kwargs = kwargs['ObjectTemplate']
super().from_dict(**kwargs)
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
return '<{self.__class__.__name__}(self.name)'.format(self=self)
2019-11-19 15:53:58 +01:00
2017-12-12 17:34:09 +01:00
2019-12-18 14:45:14 +01:00
class MISPUser(AbstractMISP):
2017-12-12 17:34:09 +01:00
2020-01-23 10:27:40 +01:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.email: str
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'User' in kwargs:
kwargs = kwargs['User']
super().from_dict(**kwargs)
if hasattr(self, 'password') and set(self.password) == set(['*']):
self.password = None
2017-12-12 17:34:09 +01:00
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
if hasattr(self, 'email'):
return '<{self.__class__.__name__}(email={self.email})'.format(self=self)
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2019-12-18 14:45:14 +01:00
class MISPFeed(AbstractMISP):
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Feed' in kwargs:
kwargs = kwargs['Feed']
super().from_dict(**kwargs)
if hasattr(self, 'settings'):
try:
self.settings = json.loads(self.settings)
except json.decoder.JSONDecodeError as e:
logger.error("Failed to parse feed settings: {}".format(self.settings))
raise e
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
class MISPWarninglist(AbstractMISP):
def from_dict(self, **kwargs):
if 'Warninglist' in kwargs:
kwargs = kwargs['Warninglist']
super().from_dict(**kwargs)
2019-12-18 14:45:14 +01:00
class MISPTaxonomy(AbstractMISP):
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Taxonomy' in kwargs:
kwargs = kwargs['Taxonomy']
super().from_dict(**kwargs)
2019-11-19 15:53:58 +01:00
2019-10-08 08:15:56 +02:00
2019-12-18 14:45:14 +01:00
class MISPGalaxy(AbstractMISP):
2019-10-08 08:15:56 +02:00
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Galaxy' in kwargs:
kwargs = kwargs['Galaxy']
super().from_dict(**kwargs)
2019-12-18 14:45:14 +01:00
class MISPNoticelist(AbstractMISP):
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Noticelist' in kwargs:
kwargs = kwargs['Noticelist']
super().from_dict(**kwargs)
2017-12-22 14:49:14 +01:00
2018-01-12 16:15:09 +01:00
2019-12-18 14:45:14 +01:00
class MISPRole(AbstractMISP):
2017-12-14 16:12:54 +01:00
2020-01-23 10:27:40 +01:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.perm_admin: int
self.perm_site_admin: int
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Role' in kwargs:
kwargs = kwargs['Role']
super().from_dict(**kwargs)
class MISPServer(AbstractMISP):
2018-01-12 16:15:09 +01:00
2017-08-30 12:47:32 +02:00
def from_dict(self, **kwargs):
2019-12-18 14:45:14 +01:00
if 'Server' in kwargs:
kwargs = kwargs['Server']
super().from_dict(**kwargs)
2017-08-30 12:47:32 +02:00
2019-12-18 14:45:14 +01:00
class MISPLog(AbstractMISP):
2017-08-30 12:47:32 +02:00
2020-01-23 10:27:40 +01:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.model: str
self.action: str
self.title: str
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'Log' in kwargs:
kwargs = kwargs['Log']
super().from_dict(**kwargs)
2018-01-12 16:15:09 +01:00
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
return '<{self.__class__.__name__}({self.model}, {self.action}, {self.title})'.format(self=self)
2017-12-12 17:34:09 +01:00
2019-12-18 14:45:14 +01:00
class MISPEventDelegation(AbstractMISP):
2017-12-22 14:49:14 +01:00
2020-01-23 10:27:40 +01:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.org_id: int
self.requester_org_id: int
self.event_id: int
2019-12-18 14:45:14 +01:00
def from_dict(self, **kwargs):
if 'EventDelegation' in kwargs:
kwargs = kwargs['EventDelegation']
super().from_dict(**kwargs)
2019-12-18 14:45:14 +01:00
def __repr__(self) -> str:
return '<{self.__class__.__name__}(org_id={self.org_id}, requester_org_id={self.requester_org_id}, {self.event_id})'.format(self=self)
2017-12-22 14:49:14 +01:00
2019-12-18 14:45:14 +01:00
class MISPObjectAttribute(MISPAttribute):
_fields_for_feed: set = {'uuid', 'value', 'category', 'type', 'comment', 'data',
'deleted', 'timestamp', 'to_ids', 'disable_correlation',
'first_seen', 'last_seen', 'object_relation'}
2019-12-18 14:45:14 +01:00
def __init__(self, definition):
super().__init__()
self._definition = definition
2020-01-23 10:27:40 +01:00
def from_dict(self, object_relation: str, value: Union[str, int, float], **kwargs): # type: ignore
# NOTE: Signature of "from_dict" incompatible with supertype "MISPAttribute"
2019-12-18 14:45:14 +01:00
self.object_relation = object_relation
self.value = value
if 'Attribute' in kwargs:
kwargs = kwargs['Attribute']
# Initialize the new MISPAttribute
# Get the misp attribute type from the definition
self.type = kwargs.pop('type', None)
if self.type is None:
self.type = self._definition.get('misp-attribute')
if 'category' not in kwargs and 'categories' in self._definition:
# Get first category in the list from the object template as default
self.category = self._definition['categories'][0]
self.disable_correlation = kwargs.pop('disable_correlation', None)
if self.disable_correlation is None:
# The correlation can be disabled by default in the object definition.
# Use this value if it isn't overloaded by the object
self.disable_correlation = self._definition.get('disable_correlation')
self.to_ids = kwargs.pop('to_ids', None)
if self.to_ids is None:
# Same for the to_ids flag
self.to_ids = self._definition.get('to_ids')
if not self.type:
raise NewAttributeError("The type of the attribute is required. Is the object template missing?")
super().from_dict(**{**self, **kwargs})
2017-12-22 14:49:14 +01:00
def __repr__(self):
2019-12-18 14:45:14 +01:00
if hasattr(self, 'value'):
return '<{self.__class__.__name__}(object_relation={self.object_relation}, value={self.value})'.format(self=self)
2017-12-22 14:49:14 +01:00
return '<{self.__class__.__name__}(NotInitialized)'.format(self=self)
2019-12-18 14:45:14 +01:00
class MISPCommunity(AbstractMISP):
def from_dict(self, **kwargs):
if 'Community' in kwargs:
kwargs = kwargs['Community']
super().from_dict(**kwargs)
def __repr__(self):
2020-04-30 10:20:21 +02:00
return f'<{self.__class__.__name__}(name={self.name}, uuid={self.uuid})'
2019-12-18 14:45:14 +01:00
class MISPUserSetting(AbstractMISP):
def from_dict(self, **kwargs):
if 'UserSetting' in kwargs:
kwargs = kwargs['UserSetting']
super().from_dict(**kwargs)
def __repr__(self):
2020-04-30 10:20:21 +02:00
return f'<{self.__class__.__name__}(name={self.setting}'
class MISPInbox(AbstractMISP):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.data: Dict
def from_dict(self, **kwargs):
if 'Inbox' in kwargs:
kwargs = kwargs['Inbox']
super().from_dict(**kwargs)
def __repr__(self):
return f'<{self.__class__.__name__}(name={self.type})>'
2020-08-03 15:59:54 +02:00
2020-09-01 19:29:12 +02:00
class MISPEventBlocklist(AbstractMISP):
2020-08-03 15:59:54 +02:00
2020-08-04 12:20:21 +02:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.event_uuid: str
2020-08-03 15:59:54 +02:00
def from_dict(self, **kwargs):
2020-09-01 19:29:12 +02:00
if 'EventBlocklist' in kwargs:
kwargs = kwargs['EventBlocklist']
2020-08-03 15:59:54 +02:00
super().from_dict(**kwargs)
def __repr__(self):
return f'<{self.__class__.__name__}(event_uuid={self.event_uuid}'
2020-09-01 19:29:12 +02:00
class MISPOrganisationBlocklist(AbstractMISP):
2020-08-03 15:59:54 +02:00
2020-08-04 12:20:21 +02:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.org_uuid: str
2020-08-03 15:59:54 +02:00
def from_dict(self, **kwargs):
2020-09-01 19:29:12 +02:00
if 'OrgBlocklist' in kwargs:
kwargs = kwargs['OrgBlocklist']
2020-08-03 15:59:54 +02:00
super().from_dict(**kwargs)
def __repr__(self):
return f'<{self.__class__.__name__}(org_uuid={self.org_uuid}'