2018-08-09 18:11:45 +02:00
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
2019-01-22 11:49:01 +01:00
from typing import TypeVar , Optional , Tuple , List , Dict , Union
2018-08-09 18:11:45 +02:00
from datetime import date , datetime
2018-09-18 03:37:07 +02:00
import csv
2019-05-21 16:47:10 +02:00
from pathlib import Path
2018-08-09 18:11:45 +02:00
import logging
from urllib . parse import urljoin
2019-07-12 17:35:02 +02:00
import json
import requests
from requests . auth import AuthBase
import re
2019-07-17 15:37:14 +02:00
from uuid import UUID
2019-08-01 13:19:21 +02:00
import warnings
import sys
2019-07-12 17:35:02 +02:00
from . import __version__
from . exceptions import MISPServerError , PyMISPUnexpectedResponse , PyMISPNotImplementedYet , PyMISPError , NoURL , NoKey
from . api import everything_broken , PyMISP
from . mispevent import MISPEvent , MISPAttribute , MISPSighting , MISPLog , MISPObject , MISPUser , MISPOrganisation , MISPShadowAttribute , MISPWarninglist , MISPTaxonomy , MISPGalaxy , MISPNoticelist , MISPObjectReference , MISPObjectTemplate , MISPSharingGroup , MISPRole , MISPServer , MISPFeed
from . abstract import MISPEncode , MISPTag , AbstractMISP
2018-08-09 18:11:45 +02:00
SearchType = TypeVar ( ' SearchType ' , str , int )
# str: string to search / list: values to search (OR) / dict: {'OR': [list], 'NOT': [list], 'AND': [list]}
SearchParameterTypes = TypeVar ( ' SearchParameterTypes ' , str , List [ SearchType ] , Dict [ str , SearchType ] )
DateTypes = TypeVar ( ' DateTypes ' , datetime , date , SearchType , float )
DateInterval = TypeVar ( ' DateInterval ' , DateTypes , Tuple [ DateTypes , DateTypes ] )
2019-01-22 11:49:01 +01:00
ToIDSType = TypeVar ( ' ToIDSType ' , str , int , bool )
2018-08-09 18:11:45 +02:00
logger = logging . getLogger ( ' pymisp ' )
class ExpandedPyMISP ( PyMISP ) :
2019-07-12 17:35:02 +02:00
""" Python API for MISP
: param url : URL of the MISP instance you want to connect to
: param key : API key of the user you want to use
: param ssl : can be True or False ( to check ot not the validity of the certificate . Or a CA_BUNDLE in case of self signed certificate ( the concatenation of all the * . crt of the chain )
: param debug : Write all the debug information to stderr
: param proxies : Proxy dict as describes here : http : / / docs . python - requests . org / en / master / user / advanced / #proxies
: param cert : Client certificate , as described there : http : / / docs . python - requests . org / en / master / user / advanced / #client-side-certificates
: param auth : The auth parameter is passed directly to requests , as described here : http : / / docs . python - requests . org / en / master / user / authentication /
: param tool : The software using PyMISP ( string ) , used to set a unique user - agent
"""
def __init__ ( self , url : str , key : str , ssl = True , debug : bool = False , proxies : dict = { } ,
cert : Tuple [ str , tuple ] = None , auth : AuthBase = None , tool : str = ' ' ) :
if not url :
raise NoURL ( ' Please provide the URL of your MISP instance. ' )
if not key :
raise NoKey ( ' Please provide your authorization key. ' )
self . root_url = url
self . key = key
self . ssl = ssl
self . proxies = proxies
self . cert = cert
self . auth = auth
self . tool = tool
2019-07-22 11:28:24 +02:00
self . global_pythonify = False
2019-07-12 17:35:02 +02:00
self . resources_path = Path ( __file__ ) . parent / ' data '
if debug :
logger . setLevel ( logging . DEBUG )
logger . info ( ' To configure logging in your script, leave it to None and use the following: import logging; logging.getLogger( \' pymisp \' ).setLevel(logging.DEBUG) ' )
2018-08-09 18:11:45 +02:00
2019-07-12 17:35:02 +02:00
try :
# Make sure the MISP instance is working and the URL is valid
response = self . recommended_pymisp_version
if response . get ( ' errors ' ) :
logger . warning ( response . get ( ' errors ' ) [ 0 ] )
else :
pymisp_version_tup = tuple ( int ( x ) for x in __version__ . split ( ' . ' ) )
recommended_version_tup = tuple ( int ( x ) for x in response [ ' version ' ] . split ( ' . ' ) )
if recommended_version_tup < pymisp_version_tup [ : 3 ] :
logger . info ( f " The version of PyMISP recommended by the MISP instance (response[ ' version ' ]) is older than the one you ' re using now ( { __version__ } ). If you have a problem, please upgrade the MISP instance or use an older PyMISP version. " )
elif pymisp_version_tup [ : 3 ] < recommended_version_tup :
logger . warning ( f " The version of PyMISP recommended by the MI)SP instance ( { response [ ' version ' ] } ) is newer than the one you ' re using now ( { __version__ } ). Please upgrade PyMISP. " )
2019-08-01 13:19:21 +02:00
misp_version = self . misp_instance_version
if ' version ' in misp_version :
self . _misp_version = tuple ( int ( v ) for v in misp_version [ ' version ' ] . split ( ' . ' ) )
2019-07-12 17:35:02 +02:00
except Exception as e :
raise PyMISPError ( f ' Unable to connect to MISP ( { self . root_url } ). Please make sure the API key and the URL are correct (http/https is required): { e } ' )
try :
self . describe_types = self . describe_types_remote
except Exception :
self . describe_types = self . describe_types_local
self . categories = self . describe_types [ ' categories ' ]
self . types = self . describe_types [ ' types ' ]
self . category_type_mapping = self . describe_types [ ' category_type_mappings ' ]
self . sane_default = self . describe_types [ ' sane_defaults ' ]
@property
def remote_acl ( self ) :
""" This should return an empty list, unless the ACL is outdated. """
response = self . _prepare_request ( ' GET ' , ' events/queryACL.json ' )
return self . _check_response ( response , expect_json = True )
@property
def describe_types_local ( self ) :
''' Returns the content of describe types from the package '''
with ( self . resources_path / ' describeTypes.json ' ) . open ( ) as f :
describe_types = json . load ( f )
return describe_types [ ' result ' ]
@property
def describe_types_remote ( self ) :
''' Returns the content of describe types from the remote instance '''
response = self . _prepare_request ( ' GET ' , ' attributes/describeTypes.json ' )
describe_types = self . _check_response ( response , expect_json = True )
return describe_types [ ' result ' ]
@property
def recommended_pymisp_version ( self ) :
""" Returns the recommended API version from the server """
response = self . _prepare_request ( ' GET ' , ' servers/getPyMISPVersion.json ' )
return self . _check_response ( response , expect_json = True )
@property
def version ( self ) :
""" Returns the version of PyMISP you ' re curently using """
return { ' version ' : __version__ }
@property
def pymisp_version_master ( self ) :
""" Get the most recent version of PyMISP from github """
r = requests . get ( ' https://raw.githubusercontent.com/MISP/PyMISP/master/pymisp/__init__.py ' )
if r . status_code == 200 :
version = re . findall ( " __version__ = ' (.*) ' " , r . text )
return { ' version ' : version [ 0 ] }
return { ' error ' : ' Impossible to retrieve the version of the master branch. ' }
@property
def misp_instance_version ( self ) :
""" Returns the version of the instance. """
response = self . _prepare_request ( ' GET ' , ' servers/getVersion.json ' )
return self . _check_response ( response , expect_json = True )
@property
def misp_instance_version_master ( self ) :
""" Get the most recent version from github """
r = requests . get ( ' https://raw.githubusercontent.com/MISP/MISP/2.4/VERSION.json ' )
if r . status_code == 200 :
master_version = json . loads ( r . text )
return { ' version ' : ' {} . {} . {} ' . format ( master_version [ ' major ' ] , master_version [ ' minor ' ] , master_version [ ' hotfix ' ] ) }
return { ' error ' : ' Impossible to retrieve the version of the master branch. ' }
2019-07-22 11:28:24 +02:00
def toggle_global_pythonify ( self ) :
self . global_pythonify = not self . global_pythonify
2019-08-01 13:19:21 +02:00
def _old_misp ( self , minimal_version_required : tuple , removal_date : Union [ str , date , datetime ] , method : str = None , message : str = None ) :
if self . _misp_version > = minimal_version_required :
return False
if isinstance ( removal_date , ( datetime , date ) ) :
removal_date = removal_date . isoformat ( )
to_print = f ' The instance of MISP you are using is outdated. Unless you update your MISP instance, { method } will stop working after { removal_date } . '
if message :
to_print + = f ' { message } '
warnings . warn ( to_print , DeprecationWarning )
return True
2019-07-17 15:37:14 +02:00
# ## BEGIN Event ##
2019-07-12 17:35:02 +02:00
2019-08-01 13:19:21 +02:00
def events ( self , pythonify : bool = False ) :
events = self . _prepare_request ( ' GET ' , ' events ' )
events = self . _check_response ( events , expect_json = True )
if not ( self . global_pythonify or pythonify ) or ' errors ' in events :
return events
to_return = [ ]
for event in events :
e = MISPEvent ( )
e . from_dict ( * * event )
to_return . append ( e )
return to_return
2019-07-22 11:28:24 +02:00
def get_event ( self , event : Union [ MISPEvent , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Get an event from a MISP instance '''
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
event = self . _prepare_request ( ' GET ' , f ' events/ { event_id } ' )
event = self . _check_response ( event , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in event :
2019-07-12 17:35:02 +02:00
return event
2018-09-29 21:11:42 +02:00
e = MISPEvent ( )
e . load ( event )
return e
2019-07-22 11:28:24 +02:00
def add_event ( self , event : MISPEvent , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
''' Add a new event on a MISP instance '''
new_event = self . _prepare_request ( ' POST ' , ' events ' , data = event )
new_event = self . _check_response ( new_event , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_event :
2019-07-12 17:35:02 +02:00
return new_event
e = MISPEvent ( )
e . load ( new_event )
return e
2019-04-03 16:28:26 +02:00
2019-07-22 11:28:24 +02:00
def update_event ( self , event : MISPEvent , event_id : int = None , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
''' Update an event on a MISP instance '''
if event_id is None :
2019-07-17 15:37:14 +02:00
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
updated_event = self . _prepare_request ( ' POST ' , f ' events/ { event_id } ' , data = event )
updated_event = self . _check_response ( updated_event , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_event :
2019-07-12 17:35:02 +02:00
return updated_event
e = MISPEvent ( )
e . load ( updated_event )
return e
2019-04-03 17:46:52 +02:00
2019-07-17 15:37:14 +02:00
def delete_event ( self , event : Union [ MISPEvent , int , str , UUID ] ) :
''' Delete an event from a MISP instance '''
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' DELETE ' , f ' events/delete/ { event_id } ' )
return self . _check_response ( response , expect_json = True )
2019-04-04 10:42:37 +02:00
2019-07-12 17:35:02 +02:00
def publish ( self , event_id : int , alert : bool = False ) :
""" Publish the event with one single HTTP POST.
The default is to not send a mail as it is assumed this method is called on update .
2019-04-04 10:42:37 +02:00
"""
2019-07-12 17:35:02 +02:00
if alert :
response = self . _prepare_request ( ' POST ' , f ' events/alert/ { event_id } ' )
else :
response = self . _prepare_request ( ' POST ' , f ' events/publish/ { event_id } ' )
return self . _check_response ( response , expect_json = True )
# ## END Event ###
# ## BEGIN Object ###
2019-07-22 11:28:24 +02:00
def get_object ( self , misp_object : Union [ MISPObject , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Get an object from the remote MISP instance '''
object_id = self . __get_uuid_or_id_from_abstract_misp ( misp_object )
2019-07-12 17:35:02 +02:00
misp_object = self . _prepare_request ( ' GET ' , f ' objects/view/ { object_id } ' )
misp_object = self . _check_response ( misp_object , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in misp_object :
2019-04-04 10:42:37 +02:00
return misp_object
o = MISPObject ( misp_object [ ' Object ' ] [ ' name ' ] )
o . from_dict ( * * misp_object )
return o
2019-07-22 11:28:24 +02:00
def add_object ( self , event : Union [ MISPEvent , int , str , UUID ] , misp_object : MISPObject , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
''' Add a MISP Object to an existing MISP event '''
2019-07-17 15:37:14 +02:00
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
new_object = self . _prepare_request ( ' POST ' , f ' objects/add/ { event_id } ' , data = misp_object )
new_object = self . _check_response ( new_object , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_object :
2019-07-12 17:35:02 +02:00
return new_object
o = MISPObject ( new_object [ ' Object ' ] [ ' name ' ] )
o . from_dict ( * * new_object )
return o
2018-08-20 18:27:06 +02:00
2019-07-22 11:28:24 +02:00
def update_object ( self , misp_object : MISPObject , object_id : int = None , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Update an object on a MISP instance '''
2019-07-12 17:35:02 +02:00
if object_id is None :
2019-07-17 15:37:14 +02:00
object_id = self . __get_uuid_or_id_from_abstract_misp ( misp_object )
2019-07-12 17:35:02 +02:00
updated_object = self . _prepare_request ( ' POST ' , f ' objects/edit/ { object_id } ' , data = misp_object )
updated_object = self . _check_response ( updated_object , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_object :
2019-07-12 17:35:02 +02:00
return updated_object
o = MISPObject ( updated_object [ ' Object ' ] [ ' name ' ] )
o . from_dict ( * * updated_object )
return o
2018-08-21 00:32:27 +02:00
2019-07-17 15:37:14 +02:00
def delete_object ( self , misp_object : Union [ MISPObject , int , str , UUID ] ) :
''' Delete an object from a MISP instance '''
object_id = self . __get_uuid_or_id_from_abstract_misp ( misp_object )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' objects/delete/ { object_id } ' )
return self . _check_response ( response , expect_json = True )
def add_object_reference ( self , misp_object_reference : MISPObjectReference , pythonify : bool = False ) :
""" Add a reference to an object """
object_reference = self . _prepare_request ( ' POST ' , ' object_references/add ' , misp_object_reference )
object_reference = self . _check_response ( object_reference , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in object_reference :
2019-07-12 17:35:02 +02:00
return object_reference
r = MISPObjectReference ( )
r . from_dict ( * * object_reference )
return r
2019-07-17 15:37:14 +02:00
def delete_object_reference ( self , object_reference : Union [ MISPObjectReference , int , str , UUID ] ) :
""" Delete a reference to an object """
object_reference_id = self . __get_uuid_or_id_from_abstract_misp ( object_reference )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' object_references/delete/ { object_reference_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
# Object templates
2019-07-22 11:28:24 +02:00
def object_templates ( self , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
""" Get all the object templates. """
object_templates = self . _prepare_request ( ' GET ' , ' objectTemplates ' )
object_templates = self . _check_response ( object_templates , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in object_templates :
2019-07-12 17:35:02 +02:00
return object_templates
to_return = [ ]
for object_template in object_templates :
o = MISPObjectTemplate ( )
o . from_dict ( * * object_template )
to_return . append ( o )
return to_return
2019-07-22 11:28:24 +02:00
def get_object_template ( self , object_template : Union [ MISPObjectTemplate , int , str , UUID ] , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
""" Gets the full object template corresponting the UUID passed as parameter """
2019-07-17 15:37:14 +02:00
object_template_id = self . __get_uuid_or_id_from_abstract_misp ( object_template )
object_template = self . _prepare_request ( ' GET ' , f ' objectTemplates/view/ { object_template_id } ' )
2019-07-12 17:35:02 +02:00
object_template = self . _check_response ( object_template , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in object_template :
2019-07-12 17:35:02 +02:00
return object_template
t = MISPObjectTemplate ( )
t . from_dict ( * * object_template )
return t
def update_object_templates ( self ) :
2019-07-17 15:37:14 +02:00
""" Trigger an update of the object templates """
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , ' objectTemplates/update ' )
return self . _check_response ( response , expect_json = True )
# ## END Object ###
# ## BEGIN Attribute ###
2019-08-01 13:19:21 +02:00
def attributes ( self , pythonify : bool = False ) :
attributes = self . _prepare_request ( ' GET ' , f ' attributes/index ' )
attributes = self . _check_response ( attributes , expect_json = True )
if not ( self . global_pythonify or pythonify ) or ' errors ' in attributes :
return attributes
to_return = [ ]
for attribute in attributes :
a = MISPAttribute ( )
a . from_dict ( * * attribute )
to_return . append ( a )
return to_return
2019-07-22 11:28:24 +02:00
def get_attribute ( self , attribute : Union [ MISPAttribute , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Get an attribute from a MISP instance '''
attribute_id = self . __get_uuid_or_id_from_abstract_misp ( attribute )
2019-07-12 17:35:02 +02:00
attribute = self . _prepare_request ( ' GET ' , f ' attributes/view/ { attribute_id } ' )
attribute = self . _check_response ( attribute , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in attribute :
2019-07-12 17:35:02 +02:00
return attribute
2019-04-11 23:13:15 +02:00
a = MISPAttribute ( )
a . from_dict ( * * attribute )
return a
2019-07-22 11:28:24 +02:00
def add_attribute ( self , event : Union [ MISPEvent , int , str , UUID ] , attribute : MISPAttribute , pythonify : bool = False ) :
2019-08-06 14:14:28 +02:00
''' Add an attribute to an existing MISP event
NOTE MISP 2.4 .113 + : you can pass a list of attributes .
In that case , the pythonified response is the following : { ' attributes ' : [ MISPAttribute ] , ' errors ' : { errors by attributes } } '''
2019-07-17 15:37:14 +02:00
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
new_attribute = self . _prepare_request ( ' POST ' , f ' attributes/add/ { event_id } ' , data = attribute )
2019-07-19 16:26:11 +02:00
new_attribute = self . _check_response ( new_attribute , expect_json = True )
2019-08-06 14:14:28 +02:00
if isinstance ( attribute , list ) :
# Multiple attributes were passed at once, the handling is totally different
if self . _old_misp ( ( 2 , 4 , 113 ) , ' 2020-01-01 ' , sys . _getframe ( ) . f_code . co_name ) :
return new_attribute
if not ( self . global_pythonify or pythonify ) :
return new_attribute
to_return = { ' attributes ' : [ ] }
if ' errors ' in new_attribute :
to_return [ ' errors ' ] = new_attribute [ ' errors ' ]
for attribute in new_attribute [ ' Attribute ' ] :
a = MISPAttribute ( )
a . from_dict ( * * attribute )
to_return [ ' attributes ' ] . append ( a )
return to_return
else :
if ( ' errors ' in new_attribute and new_attribute [ ' errors ' ] [ 0 ] == 403
and new_attribute [ ' errors ' ] [ 1 ] [ ' message ' ] == ' You do not have permission to do that. ' ) :
# At this point, we assume the user tried to add an attribute on an event they don't own
# Re-try with a proposal
return self . add_attribute_proposal ( event_id , attribute , pythonify )
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_attribute :
return new_attribute
a = MISPAttribute ( )
a . from_dict ( * * new_attribute )
return a
2019-04-11 23:13:15 +02:00
2019-07-22 11:28:24 +02:00
def update_attribute ( self , attribute : MISPAttribute , attribute_id : int = None , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Update an attribute on a MISP instance '''
2019-07-12 17:35:02 +02:00
if attribute_id is None :
2019-07-17 15:37:14 +02:00
attribute_id = self . __get_uuid_or_id_from_abstract_misp ( attribute )
2019-07-12 17:35:02 +02:00
updated_attribute = self . _prepare_request ( ' POST ' , f ' attributes/edit/ { attribute_id } ' , data = attribute )
2019-07-19 16:26:11 +02:00
updated_attribute = self . _check_response ( updated_attribute , expect_json = True )
if ( ' errors ' in updated_attribute and updated_attribute [ ' errors ' ] [ 0 ] == 403
and updated_attribute [ ' errors ' ] [ 1 ] [ ' message ' ] == ' Invalid attribute. ' ) :
# FIXME: https://github.com/MISP/MISP/issues/4913
# At this point, we assume the user tried to update an attribute on an event they don't own
2019-07-12 17:35:02 +02:00
# Re-try with a proposal
return self . update_attribute_proposal ( attribute_id , attribute , pythonify )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_attribute :
2018-11-28 17:34:38 +01:00
return updated_attribute
2018-08-21 00:32:27 +02:00
a = MISPAttribute ( )
a . from_dict ( * * updated_attribute )
return a
2019-07-17 15:37:14 +02:00
def delete_attribute ( self , attribute : Union [ MISPAttribute , int , str , UUID ] ) :
''' Delete an attribute from a MISP instance '''
attribute_id = self . __get_uuid_or_id_from_abstract_misp ( attribute )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' attributes/delete/ { attribute_id } ' )
2019-07-19 16:26:11 +02:00
response = self . _check_response ( response , expect_json = True )
if ( ' errors ' in response and response [ ' errors ' ] [ 0 ] == 403
and response [ ' errors ' ] [ 1 ] [ ' message ' ] == ' Attribute not found or not authorised. ' ) :
# FIXME: https://github.com/MISP/MISP/issues/4913
# At this point, we assume the user tried to delete an attribute on an event they don't own
2019-07-12 17:35:02 +02:00
# Re-try with a proposal
return self . delete_attribute_proposal ( attribute_id )
2019-07-19 16:26:11 +02:00
return response
2019-07-12 17:35:02 +02:00
# ## END Attribute ###
# ## BEGIN Attribute Proposal ###
2019-08-01 13:19:21 +02:00
def attribute_proposals ( self , event : Union [ MISPEvent , int , str , UUID ] = None , pythonify : bool = False ) :
if event :
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
attribute_proposals = self . _prepare_request ( ' GET ' , f ' shadow_attributes/index/ { event_id } ' )
else :
attribute_proposals = self . _prepare_request ( ' GET ' , f ' shadow_attributes ' )
attribute_proposals = self . _check_response ( attribute_proposals , expect_json = True )
if not ( self . global_pythonify or pythonify ) or ' errors ' in attribute_proposals :
return attribute_proposals
to_return = [ ]
for attribute_proposal in attribute_proposals :
a = MISPShadowAttribute ( )
a . from_dict ( * * attribute_proposal )
to_return . append ( a )
return to_return
2019-07-22 11:28:24 +02:00
def get_attribute_proposal ( self , proposal : Union [ MISPShadowAttribute , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
proposal_id = self . __get_uuid_or_id_from_abstract_misp ( proposal )
2019-07-12 17:35:02 +02:00
attribute_proposal = self . _prepare_request ( ' GET ' , f ' shadow_attributes/view/ { proposal_id } ' )
attribute_proposal = self . _check_response ( attribute_proposal , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in attribute_proposal :
2019-04-11 23:13:15 +02:00
return attribute_proposal
a = MISPShadowAttribute ( )
a . from_dict ( * * attribute_proposal )
return a
2019-07-12 17:35:02 +02:00
# NOTE: the tree following method have a very specific meaning, look at the comments
2019-07-22 11:28:24 +02:00
def add_attribute_proposal ( self , event : Union [ MISPEvent , int , str , UUID ] , attribute : MISPAttribute , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
''' Propose a new attribute in an event '''
2019-07-17 15:37:14 +02:00
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
new_attribute_proposal = self . _prepare_request ( ' POST ' , f ' shadow_attributes/add/ { event_id } ' , data = attribute )
new_attribute_proposal = self . _check_response ( new_attribute_proposal , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_attribute_proposal :
2019-07-12 17:35:02 +02:00
return new_attribute_proposal
2019-04-11 23:13:15 +02:00
a = MISPShadowAttribute ( )
2019-07-12 17:35:02 +02:00
a . from_dict ( * * new_attribute_proposal )
return a
2019-07-22 11:28:24 +02:00
def update_attribute_proposal ( self , initial_attribute : Union [ MISPAttribute , int , str , UUID ] , attribute : MISPAttribute , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
''' Propose a change for an attribute '''
2019-07-17 15:37:14 +02:00
initial_attribute_id = self . __get_uuid_or_id_from_abstract_misp ( initial_attribute )
2019-08-01 13:19:21 +02:00
if self . _old_misp ( ( 2 , 4 , 112 ) , ' 2020-01-01 ' , sys . _getframe ( ) . f_code . co_name ) :
# Inconsistency in MISP: https://github.com/MISP/MISP/issues/4857
# Fix: https://github.com/MISP/MISP/commit/d6a15438f7a53f589ddeabe2b14e65c92baf43d3
attribute = { ' ShadowAttribute ' : attribute }
2019-07-17 15:37:14 +02:00
update_attribute_proposal = self . _prepare_request ( ' POST ' , f ' shadow_attributes/edit/ { initial_attribute_id } ' , data = attribute )
2019-07-12 17:35:02 +02:00
update_attribute_proposal = self . _check_response ( update_attribute_proposal , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in update_attribute_proposal :
2019-07-12 17:35:02 +02:00
return update_attribute_proposal
a = MISPShadowAttribute ( )
a . from_dict ( * * update_attribute_proposal )
2019-04-11 23:13:15 +02:00
return a
2019-07-17 15:37:14 +02:00
def delete_attribute_proposal ( self , attribute : Union [ MISPAttribute , int , str , UUID ] ) :
2019-07-12 17:35:02 +02:00
''' Propose the deletion of an attribute '''
2019-07-17 15:37:14 +02:00
attribute_id = self . __get_uuid_or_id_from_abstract_misp ( attribute )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' shadow_attributes/delete/ { attribute_id } ' )
return self . _check_response ( response , expect_json = True )
# NOTE: You cannot modify an existing proposal, only accept/discard
2019-07-17 15:37:14 +02:00
def accept_attribute_proposal ( self , proposal : Union [ MISPShadowAttribute , int , str , UUID ] ) :
2019-07-12 17:35:02 +02:00
''' Accept a proposal '''
2019-07-17 15:37:14 +02:00
proposal_id = self . __get_uuid_or_id_from_abstract_misp ( proposal )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' shadow_attributes/accept/ { proposal_id } ' )
return self . _check_response ( response , expect_json = True )
2019-04-11 23:13:15 +02:00
2019-07-17 15:37:14 +02:00
def discard_attribute_proposal ( self , proposal : Union [ MISPShadowAttribute , int , str , UUID ] ) :
2019-07-12 17:35:02 +02:00
''' Discard a proposal '''
2019-07-17 15:37:14 +02:00
proposal_id = self . __get_uuid_or_id_from_abstract_misp ( proposal )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' shadow_attributes/discard/ { proposal_id } ' )
return self . _check_response ( response , expect_json = True )
# ## END Attribute Proposal ###
2019-07-17 15:37:14 +02:00
# ## BEGIN Sighting ###
2019-04-11 23:13:15 +02:00
2019-07-22 11:28:24 +02:00
def sightings ( self , misp_entity : AbstractMISP , org : Union [ MISPOrganisation , int , str , UUID ] = None , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get the list of sighting related to a MISPEvent or a MISPAttribute (depending on type of misp_entity) """
if isinstance ( misp_entity , MISPEvent ) :
2019-08-01 13:19:21 +02:00
context = ' event '
2019-07-17 15:37:14 +02:00
elif isinstance ( misp_entity , MISPAttribute ) :
2019-08-01 13:19:21 +02:00
context = ' attribute '
2019-07-17 15:37:14 +02:00
else :
raise PyMISPError ( ' misp_entity can only be a MISPEvent or a MISPAttribute ' )
if org is not None :
org_id = self . __get_uuid_or_id_from_abstract_misp ( org )
else :
2019-08-01 13:19:21 +02:00
org_id = None
if self . _old_misp ( ( 2 , 4 , 112 ) , ' 2020-01-01 ' , sys . _getframe ( ) . f_code . co_name ) :
url = f ' sightings/listSightings/ { misp_entity . id } / { context } '
if org_id :
url = f ' { url } / { org_id } '
sightings = self . _prepare_request ( ' POST ' , url )
else :
to_post = { ' id ' : misp_entity . id , ' context ' : context }
if org_id :
to_post [ ' org_id ' ] = org_id
sightings = self . _prepare_request ( ' POST ' , ' sightings/listSightings ' , data = to_post )
2019-07-17 15:37:14 +02:00
sightings = self . _check_response ( sightings , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in sightings :
2019-07-17 15:37:14 +02:00
return sightings
2019-07-12 17:35:02 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for sighting in sightings :
s = MISPSighting ( )
s . from_dict ( * * sighting )
to_return . append ( s )
2019-07-12 17:35:02 +02:00
return to_return
2019-07-17 15:37:14 +02:00
def add_sighting ( self , sighting : MISPSighting , attribute : Union [ MISPAttribute , int , str , UUID ] = None ) :
''' Add a new sighting (globally, or to a specific attribute) '''
# FIXME: no pythonify possible: https://github.com/MISP/MISP/issues/4867
pythonify = False
if attribute :
attribute_id = self . __get_uuid_or_id_from_abstract_misp ( attribute )
new_sighting = self . _prepare_request ( ' POST ' , f ' sightings/add/ { attribute_id } ' , data = sighting )
else :
# Either the ID/UUID is in the sighting, or we want to add a sighting on all the attributes with the given value
new_sighting = self . _prepare_request ( ' POST ' , f ' sightings/add ' , data = sighting )
new_sighting = self . _check_response ( new_sighting , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_sighting :
2019-07-17 15:37:14 +02:00
return new_sighting
s = MISPSighting ( )
s . from_dict ( * * new_sighting )
return s
2019-07-12 17:35:02 +02:00
2019-07-19 11:41:56 +02:00
def delete_sighting ( self , sighting : Union [ MISPSighting , int , str , UUID ] ) :
''' Delete a sighting from a MISP instance '''
sighting_id = self . __get_uuid_or_id_from_abstract_misp ( sighting )
response = self . _prepare_request ( ' POST ' , f ' sightings/delete/ { sighting_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
# ## END Sighting ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Tags ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def tags ( self , pythonify : bool = False ) :
""" Get the list of existing tags. """
tags = self . _prepare_request ( ' GET ' , ' tags ' )
tags = self . _check_response ( tags , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in tags :
2019-07-17 15:37:14 +02:00
return tags [ ' Tag ' ]
2019-07-12 17:35:02 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for tag in tags [ ' Tag ' ] :
t = MISPTag ( )
t . from_dict ( * * tag )
to_return . append ( t )
2019-07-12 17:35:02 +02:00
return to_return
2019-07-17 15:37:14 +02:00
def get_tag ( self , tag : Union [ MISPTag , int , str , UUID ] , pythonify : bool = False ) :
""" Get a tag by id. """
tag_id = self . __get_uuid_or_id_from_abstract_misp ( tag )
tag = self . _prepare_request ( ' GET ' , f ' tags/view/ { tag_id } ' )
tag = self . _check_response ( tag , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in tag :
2019-07-17 15:37:14 +02:00
return tag
t = MISPTag ( )
t . from_dict ( * * tag )
return t
2019-07-12 17:35:02 +02:00
2019-07-22 11:28:24 +02:00
def add_tag ( self , tag : MISPTag , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Add a new tag on a MISP instance '''
new_tag = self . _prepare_request ( ' POST ' , ' tags/add ' , data = tag )
new_tag = self . _check_response ( new_tag , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_tag :
2019-07-17 15:37:14 +02:00
return new_tag
t = MISPTag ( )
t . from_dict ( * * new_tag )
return t
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def enable_tag ( self , tag : MISPTag , pythonify : bool = False ) :
""" Enable a tag. """
tag . hide_tag = False
return self . update_tag ( tag , pythonify = pythonify )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def disable_tag ( self , tag : MISPTag , pythonify : bool = False ) :
""" Disable a tag. """
tag . hide_tag = True
return self . update_tag ( tag , pythonify = pythonify )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def update_tag ( self , tag : MISPTag , tag_id : int = None , pythonify : bool = False ) :
""" Edit only the provided parameters of a tag. """
if tag_id is None :
tag_id = self . __get_uuid_or_id_from_abstract_misp ( tag )
# FIXME: inconsistency in MISP: https://github.com/MISP/MISP/issues/4852
tag = { ' Tag ' : tag }
updated_tag = self . _prepare_request ( ' POST ' , f ' tags/edit/ { tag_id } ' , data = tag )
updated_tag = self . _check_response ( updated_tag , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_tag :
2019-07-17 15:37:14 +02:00
return updated_tag
t = MISPTag ( )
t . from_dict ( * * updated_tag )
return t
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def delete_tag ( self , tag : Union [ MISPTag , int , str , UUID ] ) :
''' Delete an attribute from a MISP instance '''
tag_id = self . __get_uuid_or_id_from_abstract_misp ( tag )
response = self . _prepare_request ( ' POST ' , f ' tags/delete/ { tag_id } ' )
return self . _check_response ( response , expect_json = True )
2019-04-04 14:37:13 +02:00
2019-07-17 15:37:14 +02:00
# ## END Tags ###
2019-04-04 14:37:13 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Taxonomies ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def taxonomies ( self , pythonify : bool = False ) :
""" Get all the taxonomies. """
taxonomies = self . _prepare_request ( ' GET ' , ' taxonomies ' )
taxonomies = self . _check_response ( taxonomies , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in taxonomies :
2019-07-17 15:37:14 +02:00
return taxonomies
2019-07-12 17:35:02 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for taxonomy in taxonomies :
t = MISPTaxonomy ( )
t . from_dict ( * * taxonomy )
to_return . append ( t )
2019-07-12 17:35:02 +02:00
return to_return
2019-07-17 15:37:14 +02:00
def get_taxonomy ( self , taxonomy : Union [ MISPTaxonomy , int , str , UUID ] , pythonify : bool = False ) :
""" Get a taxonomy from a MISP instance. """
taxonomy_id = self . __get_uuid_or_id_from_abstract_misp ( taxonomy )
taxonomy = self . _prepare_request ( ' GET ' , f ' taxonomies/view/ { taxonomy_id } ' )
taxonomy = self . _check_response ( taxonomy , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in taxonomy :
2019-07-17 15:37:14 +02:00
return taxonomy
t = MISPTaxonomy ( )
t . from_dict ( * * taxonomy )
return t
2019-04-04 14:37:13 +02:00
2019-07-17 15:37:14 +02:00
def enable_taxonomy ( self , taxonomy : Union [ MISPTaxonomy , int , str , UUID ] ) :
""" Enable a taxonomy. """
taxonomy_id = self . __get_uuid_or_id_from_abstract_misp ( taxonomy )
response = self . _prepare_request ( ' POST ' , f ' taxonomies/enable/ { taxonomy_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def disable_taxonomy ( self , taxonomy : Union [ MISPTaxonomy , int , str , UUID ] ) :
""" Disable a taxonomy. """
taxonomy_id = self . __get_uuid_or_id_from_abstract_misp ( taxonomy )
self . disable_taxonomy_tags ( taxonomy_id )
response = self . _prepare_request ( ' POST ' , f ' taxonomies/disable/ { taxonomy_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def disable_taxonomy_tags ( self , taxonomy : Union [ MISPTaxonomy , int , str , UUID ] ) :
""" Disable all the tags of a taxonomy. """
taxonomy_id = self . __get_uuid_or_id_from_abstract_misp ( taxonomy )
response = self . _prepare_request ( ' POST ' , f ' taxonomies/disableTag/ { taxonomy_id } ' )
2019-07-12 17:35:02 +02:00
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def enable_taxonomy_tags ( self , taxonomy : Union [ MISPTaxonomy , int , str , UUID ] ) :
""" Enable all the tags of a taxonomy.
NOTE : this automatically done when you call enable_taxonomy . """
taxonomy_id = self . __get_uuid_or_id_from_abstract_misp ( taxonomy )
taxonomy = self . get_taxonomy ( taxonomy_id )
if not taxonomy [ ' Taxonomy ' ] [ ' enabled ' ] :
raise PyMISPError ( f " The taxonomy { taxonomy [ ' Taxonomy ' ] [ ' name ' ] } is not enabled. " )
url = urljoin ( self . root_url , ' taxonomies/addTag/ {} ' . format ( taxonomy_id ) )
response = self . _prepare_request ( ' POST ' , url )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-08-01 15:10:48 +02:00
def update_taxonomies ( self ) :
""" Update all the taxonomies. """
response = self . _prepare_request ( ' POST ' , ' taxonomies/update ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
# ## END Taxonomies ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Warninglists ###
def warninglists ( self , pythonify : bool = False ) :
""" Get all the warninglists. """
warninglists = self . _prepare_request ( ' GET ' , ' warninglists ' )
warninglists = self . _check_response ( warninglists , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in warninglists :
2019-07-17 15:37:14 +02:00
return warninglists [ ' Warninglists ' ]
2019-07-12 17:35:02 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for warninglist in warninglists [ ' Warninglists ' ] :
w = MISPWarninglist ( )
w . from_dict ( * * warninglist )
to_return . append ( w )
2019-07-12 17:35:02 +02:00
return to_return
2019-07-17 15:37:14 +02:00
def get_warninglist ( self , warninglist : Union [ MISPWarninglist , int , str , UUID ] , pythonify : bool = False ) :
""" Get a warninglist. """
warninglist_id = self . __get_uuid_or_id_from_abstract_misp ( warninglist )
warninglist = self . _prepare_request ( ' GET ' , f ' warninglists/view/ { warninglist_id } ' )
warninglist = self . _check_response ( warninglist , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in warninglist :
2019-07-17 15:37:14 +02:00
return warninglist
w = MISPWarninglist ( )
w . from_dict ( * * warninglist )
return w
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def toggle_warninglist ( self , warninglist_id : List [ int ] = None , warninglist_name : List [ str ] = None ,
force_enable : bool = False ) :
''' Toggle (enable/disable) the status of a warninglist by ID.
: param warninglist_id : ID of the WarningList
: param force_enable : Force the warning list in the enabled state ( does nothing is already enabled )
'''
if warninglist_id is None and warninglist_name is None :
raise PyMISPError ( ' Either warninglist_id or warninglist_name is required. ' )
query = { }
if warninglist_id is not None :
if not isinstance ( warninglist_id , list ) :
warninglist_id = [ warninglist_id ]
query [ ' id ' ] = warninglist_id
if warninglist_name is not None :
if not isinstance ( warninglist_name , list ) :
warninglist_name = [ warninglist_name ]
query [ ' name ' ] = warninglist_name
if force_enable :
query [ ' enabled ' ] = force_enable
response = self . _prepare_request ( ' POST ' , ' warninglists/toggleEnable ' , data = json . dumps ( query ) )
2019-07-12 17:35:02 +02:00
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def enable_warninglist ( self , warninglist : Union [ MISPWarninglist , int , str , UUID ] ) :
""" Enable a warninglist. """
warninglist_id = self . __get_uuid_or_id_from_abstract_misp ( warninglist )
return self . toggle_warninglist ( warninglist_id = warninglist_id , force_enable = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def disable_warninglist ( self , warninglist : Union [ MISPWarninglist , int , str , UUID ] ) :
""" Disable a warninglist. """
warninglist_id = self . __get_uuid_or_id_from_abstract_misp ( warninglist )
return self . toggle_warninglist ( warninglist_id = warninglist_id , force_enable = False )
def values_in_warninglist ( self , value : list ) :
""" Check if IOC values are in warninglist """
response = self . _prepare_request ( ' POST ' , ' warninglists/checkValue ' , data = json . dumps ( value ) )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-08-01 15:10:48 +02:00
def update_warninglists ( self ) :
""" Update all the warninglists. """
response = self . _prepare_request ( ' POST ' , ' warninglists/update ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
# ## END Warninglists ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Noticelist ###
2019-07-12 17:35:02 +02:00
2019-07-22 11:28:24 +02:00
def noticelists ( self , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get all the noticelists. """
noticelists = self . _prepare_request ( ' GET ' , ' noticelists ' )
noticelists = self . _check_response ( noticelists , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in noticelists :
2019-07-17 15:37:14 +02:00
return noticelists
2019-07-12 17:35:02 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for noticelist in noticelists :
n = MISPNoticelist ( )
n . from_dict ( * * noticelist )
to_return . append ( n )
2019-07-12 17:35:02 +02:00
return to_return
2019-07-22 11:28:24 +02:00
def get_noticelist ( self , noticelist : Union [ MISPNoticelist , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get a noticelist by id. """
noticelist_id = self . __get_uuid_or_id_from_abstract_misp ( noticelist )
noticelist = self . _prepare_request ( ' GET ' , f ' noticelists/view/ { noticelist_id } ' )
noticelist = self . _check_response ( noticelist , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in noticelist :
2019-07-17 15:37:14 +02:00
return noticelist
n = MISPNoticelist ( )
n . from_dict ( * * noticelist )
return n
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def enable_noticelist ( self , noticelist : Union [ MISPNoticelist , int , str , UUID ] ) :
""" Enable a noticelist by id. """
# FIXME: https://github.com/MISP/MISP/issues/4856
# response = self._prepare_request('POST', f'noticelists/enable/{noticelist_id}')
noticelist_id = self . __get_uuid_or_id_from_abstract_misp ( noticelist )
response = self . _prepare_request ( ' POST ' , f ' noticelists/enableNoticelist/ { noticelist_id } /true ' )
2019-07-12 17:35:02 +02:00
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def disable_noticelist ( self , noticelist : Union [ MISPNoticelist , int , str , UUID ] ) :
""" Disable a noticelist by id. """
# FIXME: https://github.com/MISP/MISP/issues/4856
# response = self._prepare_request('POST', f'noticelists/disable/{noticelist_id}')
noticelist_id = self . __get_uuid_or_id_from_abstract_misp ( noticelist )
response = self . _prepare_request ( ' POST ' , f ' noticelists/enableNoticelist/ { noticelist_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def update_noticelists ( self ) :
""" Update all the noticelists. """
response = self . _prepare_request ( ' POST ' , ' noticelists/update ' )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## END Noticelist ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Galaxy ###
2019-07-12 17:35:02 +02:00
2019-07-22 11:28:24 +02:00
def galaxies ( self , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get all the galaxies. """
galaxies = self . _prepare_request ( ' GET ' , ' galaxies ' )
galaxies = self . _check_response ( galaxies , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in galaxies :
2019-07-17 15:37:14 +02:00
return galaxies
to_return = [ ]
for galaxy in galaxies :
g = MISPGalaxy ( )
g . from_dict ( * * galaxy )
to_return . append ( g )
return to_return
2019-07-22 11:28:24 +02:00
def get_galaxy ( self , galaxy : Union [ MISPGalaxy , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get a galaxy by id. """
galaxy_id = self . __get_uuid_or_id_from_abstract_misp ( galaxy )
galaxy = self . _prepare_request ( ' GET ' , f ' galaxies/view/ { galaxy_id } ' )
galaxy = self . _check_response ( galaxy , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in galaxy :
2019-07-17 15:37:14 +02:00
return galaxy
g = MISPGalaxy ( )
g . from_dict ( * * galaxy )
return g
def update_galaxies ( self ) :
""" Update all the galaxies. """
response = self . _prepare_request ( ' POST ' , ' galaxies/update ' )
return self . _check_response ( response , expect_json = True )
# ## END Galaxy ###
2019-07-12 17:35:02 +02:00
# ## BEGIN Feed ###
def feeds ( self , pythonify : bool = False ) :
""" Get the list of existing feeds. """
feeds = self . _prepare_request ( ' GET ' , ' feeds ' )
feeds = self . _check_response ( feeds , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in feeds :
2019-07-12 17:35:02 +02:00
return feeds
to_return = [ ]
for feed in feeds :
f = MISPFeed ( )
f . from_dict ( * * feed )
to_return . append ( f )
return to_return
2019-07-17 15:37:14 +02:00
def get_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] , pythonify : bool = False ) :
2019-07-12 17:35:02 +02:00
""" Get a feed by id. """
2019-07-17 15:37:14 +02:00
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed )
2019-07-12 17:35:02 +02:00
feed = self . _prepare_request ( ' GET ' , f ' feeds/view/ { feed_id } ' )
feed = self . _check_response ( feed , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in feed :
2019-07-12 17:35:02 +02:00
return feed
f = MISPFeed ( )
f . from_dict ( * * feed )
return f
def add_feed ( self , feed : MISPFeed , pythonify : bool = False ) :
''' Add a new feed on a MISP instance '''
# FIXME: https://github.com/MISP/MISP/issues/4834
feed = { ' Feed ' : feed }
new_feed = self . _prepare_request ( ' POST ' , ' feeds/add ' , data = feed )
new_feed = self . _check_response ( new_feed , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_feed :
2019-07-12 17:35:02 +02:00
return new_feed
f = MISPFeed ( )
f . from_dict ( * * new_feed )
return f
2019-07-17 15:37:14 +02:00
def enable_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] , pythonify : bool = False ) :
''' Enable a feed (fetching it will create event(s) '''
if not isinstance ( feed , MISPFeed ) :
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed ) # In case we have a UUID
feed = MISPFeed ( )
feed . id = feed_id
feed . enabled = True
2019-07-12 17:35:02 +02:00
return self . update_feed ( feed = feed , pythonify = pythonify )
2019-07-17 15:37:14 +02:00
def disable_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] , pythonify : bool = False ) :
''' Disable a feed '''
if not isinstance ( feed , MISPFeed ) :
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed ) # In case we have a UUID
feed = MISPFeed ( )
feed . id = feed_id
feed . enabled = False
2019-07-12 17:35:02 +02:00
return self . update_feed ( feed = feed , pythonify = pythonify )
2019-07-17 15:37:14 +02:00
def enable_feed_cache ( self , feed : Union [ MISPFeed , int , str , UUID ] , pythonify : bool = False ) :
''' Enable the caching of a feed '''
if not isinstance ( feed , MISPFeed ) :
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed ) # In case we have a UUID
feed = MISPFeed ( )
feed . id = feed_id
feed . caching_enabled = True
2019-07-12 17:35:02 +02:00
return self . update_feed ( feed = feed , pythonify = pythonify )
2019-07-17 15:37:14 +02:00
def disable_feed_cache ( self , feed : Union [ MISPFeed , int , str , UUID ] , pythonify : bool = False ) :
''' Disable the caching of a feed '''
if not isinstance ( feed , MISPFeed ) :
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed ) # In case we have a UUID
feed = MISPFeed ( )
feed . id = feed_id
feed . caching_enabled = False
2019-07-12 17:35:02 +02:00
return self . update_feed ( feed = feed , pythonify = pythonify )
def update_feed ( self , feed : MISPFeed , feed_id : int = None , pythonify : bool = False ) :
''' Update a feed on a MISP instance '''
if feed_id is None :
2019-07-17 15:37:14 +02:00
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed )
2019-07-12 17:35:02 +02:00
# FIXME: https://github.com/MISP/MISP/issues/4834
feed = { ' Feed ' : feed }
updated_feed = self . _prepare_request ( ' POST ' , f ' feeds/edit/ { feed_id } ' , data = feed )
updated_feed = self . _check_response ( updated_feed , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_feed :
2019-07-12 17:35:02 +02:00
return updated_feed
f = MISPFeed ( )
f . from_dict ( * * updated_feed )
return f
2019-07-17 15:37:14 +02:00
def delete_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] ) :
''' Delete a feed from a MISP instance '''
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' feeds/delete/ { feed_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def fetch_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] ) :
2019-07-12 17:35:02 +02:00
""" Fetch one single feed """
2019-07-17 15:37:14 +02:00
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' GET ' , f ' feeds/fetchFromFeed/ { feed_id } ' )
return self . _check_response ( response )
def cache_all_feeds ( self ) :
""" Cache all the feeds """
response = self . _prepare_request ( ' GET ' , ' feeds/cacheFeeds/all ' )
return self . _check_response ( response )
2019-07-17 15:37:14 +02:00
def cache_feed ( self , feed : Union [ MISPFeed , int , str , UUID ] ) :
2019-07-12 17:35:02 +02:00
""" Cache a specific feed """
2019-07-17 15:37:14 +02:00
feed_id = self . __get_uuid_or_id_from_abstract_misp ( feed )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' GET ' , f ' feeds/cacheFeeds/ { feed_id } ' )
return self . _check_response ( response )
def cache_freetext_feeds ( self ) :
""" Cache all the freetext feeds """
response = self . _prepare_request ( ' GET ' , ' feeds/cacheFeeds/freetext ' )
return self . _check_response ( response )
def cache_misp_feeds ( self ) :
""" Cache all the MISP feeds """
response = self . _prepare_request ( ' GET ' , ' feeds/cacheFeeds/misp ' )
return self . _check_response ( response )
def compare_feeds ( self ) :
""" Generate the comparison matrix for all the MISP feeds """
response = self . _prepare_request ( ' GET ' , ' feeds/compareFeeds ' )
return self . _check_response ( response )
# ## END Feed ###
# ## BEGIN Server ###
2019-07-22 11:28:24 +02:00
def servers ( self , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get the existing servers the MISP instance can synchronise with """
2019-07-12 17:35:02 +02:00
servers = self . _prepare_request ( ' GET ' , ' servers ' )
servers = self . _check_response ( servers , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in servers :
2019-07-12 17:35:02 +02:00
return servers
to_return = [ ]
for server in servers :
s = MISPServer ( )
s . from_dict ( * * server )
to_return . append ( s )
return to_return
2019-07-22 11:28:24 +02:00
def add_server ( self , server : MISPServer , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Add a server to synchronise with """
2019-07-12 17:35:02 +02:00
server = self . _prepare_request ( ' POST ' , f ' servers/add ' , data = server )
server = self . _check_response ( server , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in server :
2019-07-12 17:35:02 +02:00
return server
s = MISPServer ( )
s . from_dict ( * * server )
return s
2019-07-22 11:28:24 +02:00
def update_server ( self , server : MISPServer , server_id : int = None , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Update a server to synchronise with '''
2019-07-12 17:35:02 +02:00
if server_id is None :
2019-07-17 15:37:14 +02:00
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
2019-07-12 17:35:02 +02:00
updated_server = self . _prepare_request ( ' POST ' , f ' servers/edit/ { server_id } ' , data = server )
updated_server = self . _check_response ( updated_server , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_server :
2019-07-12 17:35:02 +02:00
return updated_server
s = MISPServer ( )
s . from_dict ( * * updated_server )
return s
2019-07-17 15:37:14 +02:00
def delete_server ( self , server : Union [ MISPServer , int , str , UUID ] ) :
''' Delete a sync server '''
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , f ' servers/delete/ { server_id } ' )
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def server_pull ( self , server : Union [ MISPServer , int , str , UUID ] , event : Union [ MISPEvent , int , str , UUID ] = None ) :
''' Initialize a pull from a sync server '''
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
if event :
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
url = f ' servers/pull/ { server_id } / { event_id } '
else :
url = f ' servers/pull/ { server_id } '
response = self . _prepare_request ( ' GET ' , url )
# FIXME: can we pythonify?
return self . _check_response ( response )
2019-07-17 15:37:14 +02:00
def server_push ( self , server : Union [ MISPServer , int , str , UUID ] , event : Union [ MISPEvent , int , str , UUID ] = None ) :
''' Initialize a push to a sync server '''
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
if event :
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
2019-07-12 17:35:02 +02:00
url = f ' servers/push/ { server_id } / { event_id } '
else :
url = f ' servers/push/ { server_id } '
response = self . _prepare_request ( ' GET ' , url )
# FIXME: can we pythonify?
return self . _check_response ( response )
# ## END Server ###
2019-07-17 15:37:14 +02:00
# ## BEGIN Sharing group ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def sharing_groups ( self , pythonify : bool = False ) :
""" Get the existing sharing groups """
sharing_groups = self . _prepare_request ( ' GET ' , ' sharing_groups ' )
sharing_groups = self . _check_response ( sharing_groups , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in sharing_groups :
2019-07-17 15:37:14 +02:00
return sharing_groups
to_return = [ ]
for sharing_group in sharing_groups :
s = MISPSharingGroup ( )
s . from_dict ( * * sharing_group )
to_return . append ( s )
return to_return
2019-07-12 17:35:02 +02:00
2019-07-22 11:28:24 +02:00
def add_sharing_group ( self , sharing_group : MISPSharingGroup , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Add a new sharing group """
sharing_group = self . _prepare_request ( ' POST ' , f ' sharing_groups/add ' , data = sharing_group )
sharing_group = self . _check_response ( sharing_group , expect_json = True )
2019-08-01 13:19:21 +02:00
if self . _old_misp ( ( 2 , 4 , 112 ) , ' 2020-01-01 ' , sys . _getframe ( ) . f_code . co_name ) and isinstance ( sharing_group , list ) :
# https://github.com/MISP/MISP/issues/4882
# https://github.com/MISP/MISP/commit/d75c6c9e3b7874fd0f083445126743873e5c53c4
sharing_group = sharing_group [ 0 ]
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in sharing_group :
2019-07-17 15:37:14 +02:00
return sharing_group
s = MISPSharingGroup ( )
s . from_dict ( * * sharing_group )
return s
def delete_sharing_group ( self , sharing_group : Union [ MISPSharingGroup , int , str , UUID ] ) :
""" Delete a sharing group """
sharing_group_id = self . __get_uuid_or_id_from_abstract_misp ( sharing_group )
response = self . _prepare_request ( ' POST ' , f ' sharing_groups/delete/ { sharing_group_id } ' )
2019-07-12 17:35:02 +02:00
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
def add_org_to_sharing_group ( self , sharing_group : Union [ MISPSharingGroup , int , str , UUID ] ,
organisation : Union [ MISPOrganisation , int , str , UUID ] , extend : bool = False ) :
''' Add an organisation to a sharing group.
: sharing_group : Sharing group ' s local instance ID, or Sharing group ' s global UUID
: organisation : Organisation ' s local instance ID, or Organisation ' s global UUID , or Organisation ' s name as known to the curent instance
: extend : Allow the organisation to extend the group
'''
sharing_group_id = self . __get_uuid_or_id_from_abstract_misp ( sharing_group )
organisation_id = self . __get_uuid_or_id_from_abstract_misp ( organisation )
to_jsonify = { ' sg_id ' : sharing_group_id , ' org_id ' : organisation_id , ' extend ' : extend }
response = self . _prepare_request ( ' POST ' , ' sharingGroups/addOrg ' , data = to_jsonify )
return self . _check_response ( response )
def remove_org_from_sharing_group ( self , sharing_group : Union [ MISPSharingGroup , int , str , UUID ] ,
organisation : Union [ MISPOrganisation , int , str , UUID ] ) :
''' Remove an organisation from a sharing group.
: sharing_group : Sharing group ' s local instance ID, or Sharing group ' s global UUID
: organisation : Organisation ' s local instance ID, or Organisation ' s global UUID , or Organisation ' s name as known to the curent instance
'''
sharing_group_id = self . __get_uuid_or_id_from_abstract_misp ( sharing_group )
organisation_id = self . __get_uuid_or_id_from_abstract_misp ( organisation )
to_jsonify = { ' sg_id ' : sharing_group_id , ' org_id ' : organisation_id }
response = self . _prepare_request ( ' POST ' , ' sharingGroups/removeOrg ' , data = to_jsonify )
return self . _check_response ( response )
def add_server_to_sharing_group ( self , sharing_group : Union [ MISPSharingGroup , int , str , UUID ] ,
server : Union [ MISPServer , int , str , UUID ] , all_orgs : bool = False ) :
''' Add a server to a sharing group.
: sharing_group : Sharing group ' s local instance ID, or Sharing group ' s global UUID
: server : Server ' s local instance ID, or URL of the Server, or Server ' s name as known to the curent instance
: all_orgs : Add all the organisations of the server to the group
'''
sharing_group_id = self . __get_uuid_or_id_from_abstract_misp ( sharing_group )
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
to_jsonify = { ' sg_id ' : sharing_group_id , ' server_id ' : server_id , ' all_orgs ' : all_orgs }
response = self . _prepare_request ( ' POST ' , ' sharingGroups/addServer ' , data = to_jsonify )
return self . _check_response ( response )
def remove_server_from_sharing_group ( self , sharing_group : Union [ MISPSharingGroup , int , str , UUID ] ,
server : Union [ MISPServer , int , str , UUID ] ) :
''' Remove a server from a sharing group.
: sharing_group : Sharing group ' s local instance ID, or Sharing group ' s global UUID
: server : Server ' s local instance ID, or URL of the Server, or Server ' s name as known to the curent instance
'''
sharing_group_id = self . __get_uuid_or_id_from_abstract_misp ( sharing_group )
server_id = self . __get_uuid_or_id_from_abstract_misp ( server )
to_jsonify = { ' sg_id ' : sharing_group_id , ' server_id ' : server_id }
response = self . _prepare_request ( ' POST ' , ' sharingGroups/removeServer ' , data = to_jsonify )
return self . _check_response ( response )
# ## END Sharing groups ###
# ## BEGIN Organisation ###
2019-07-22 11:28:24 +02:00
def organisations ( self , scope = " local " , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get all the organisations. """
organisations = self . _prepare_request ( ' GET ' , f ' organisations/index/scope: { scope } ' )
organisations = self . _check_response ( organisations , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in organisations :
2019-07-17 15:37:14 +02:00
return organisations
to_return = [ ]
for organisation in organisations :
o = MISPOrganisation ( )
o . from_dict ( * * organisation )
to_return . append ( o )
return to_return
2019-07-22 11:28:24 +02:00
def get_organisation ( self , organisation : Union [ MISPOrganisation , int , str , UUID ] , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Get an organisation. '''
organisation_id = self . __get_uuid_or_id_from_abstract_misp ( organisation )
organisation = self . _prepare_request ( ' GET ' , f ' organisations/view/ { organisation_id } ' )
organisation = self . _check_response ( organisation , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in organisation :
2019-07-17 15:37:14 +02:00
return organisation
o = MISPOrganisation ( )
o . from_dict ( * * organisation )
return o
2019-07-22 11:28:24 +02:00
def add_organisation ( self , organisation : MISPOrganisation , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Add an organisation '''
new_organisation = self . _prepare_request ( ' POST ' , f ' admin/organisations/add ' , data = organisation )
new_organisation = self . _check_response ( new_organisation , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in new_organisation :
2019-07-17 15:37:14 +02:00
return new_organisation
o = MISPOrganisation ( )
o . from_dict ( * * new_organisation )
return o
2019-07-22 11:28:24 +02:00
def update_organisation ( self , organisation : MISPOrganisation , organisation_id : int = None , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
''' Update an organisation '''
if organisation_id is None :
organisation_id = self . __get_uuid_or_id_from_abstract_misp ( organisation )
updated_organisation = self . _prepare_request ( ' POST ' , f ' admin/organisations/edit/ { organisation_id } ' , data = organisation )
updated_organisation = self . _check_response ( updated_organisation , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_organisation :
2019-07-17 15:37:14 +02:00
return updated_organisation
o = MISPOrganisation ( )
o . from_dict ( * * organisation )
return o
def delete_organisation ( self , organisation : Union [ MISPOrganisation , int , str , UUID ] ) :
''' Delete an organisation '''
# NOTE: MISP in inconsistent and currently require "delete" in the path and doesn't support HTTP DELETE
organisation_id = self . __get_uuid_or_id_from_abstract_misp ( organisation )
response = self . _prepare_request ( ' POST ' , f ' admin/organisations/delete/ { organisation_id } ' )
2019-07-12 17:35:02 +02:00
return self . _check_response ( response , expect_json = True )
2019-07-17 15:37:14 +02:00
# ## END Organisation ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## BEGIN User ###
2019-07-12 17:35:02 +02:00
2019-07-22 11:28:24 +02:00
def users ( self , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Get all the users. """
users = self . _prepare_request ( ' GET ' , ' admin/users ' )
users = self . _check_response ( users , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in users :
2019-07-17 15:37:14 +02:00
return users
to_return = [ ]
for user in users :
u = MISPUser ( )
u . from_dict ( * * user )
to_return . append ( u )
return to_return
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
def get_user ( self , user : Union [ MISPUser , int , str , UUID ] = ' me ' , pythonify : bool = False ) :
''' Get a user. `me` means the owner of the API key doing the query. '''
user_id = self . __get_uuid_or_id_from_abstract_misp ( user )
user = self . _prepare_request ( ' GET ' , f ' users/view/ { user_id } ' )
user = self . _check_response ( user , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in user :
2019-07-17 15:37:14 +02:00
return user
u = MISPUser ( )
u . from_dict ( * * user )
return u
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
def add_user ( self , user : MISPUser , pythonify : bool = False ) :
''' Add a new user '''
user = self . _prepare_request ( ' POST ' , f ' admin/users/add ' , data = user )
user = self . _check_response ( user , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in user :
2019-07-17 15:37:14 +02:00
return user
u = MISPUser ( )
u . from_dict ( * * user )
return u
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
def update_user ( self , user : MISPUser , user_id : int = None , pythonify : bool = False ) :
''' Update an event on a MISP instance '''
if user_id is None :
user_id = self . __get_uuid_or_id_from_abstract_misp ( user )
updated_user = self . _prepare_request ( ' POST ' , f ' admin/users/edit/ { user_id } ' , data = user )
updated_user = self . _check_response ( updated_user , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in updated_user :
2019-07-17 15:37:14 +02:00
return updated_user
e = MISPUser ( )
e . from_dict ( * * updated_user )
return e
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
def delete_user ( self , user : Union [ MISPUser , int , str , UUID ] ) :
''' Delete a user '''
# NOTE: MISP in inconsistent and currently require "delete" in the path and doesn't support HTTP DELETE
user_id = self . __get_uuid_or_id_from_abstract_misp ( user )
response = self . _prepare_request ( ' POST ' , f ' admin/users/delete/ { user_id } ' )
return self . _check_response ( response , expect_json = True )
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
# ## END User ###
2018-10-31 16:42:01 +01:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Role ###
def roles ( self , pythonify : bool = False ) :
""" Get the existing roles """
roles = self . _prepare_request ( ' GET ' , ' roles ' )
roles = self . _check_response ( roles , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in roles :
2019-07-17 15:37:14 +02:00
return roles
to_return = [ ]
for role in roles :
r = MISPRole ( )
r . from_dict ( * * role )
to_return . append ( r )
return to_return
def set_default_role ( self , role : Union [ MISPRole , int , str , UUID ] ) :
role_id = self . __get_uuid_or_id_from_abstract_misp ( role )
url = urljoin ( self . root_url , f ' /admin/roles/set_default/ { role_id } ' )
response = self . _prepare_request ( ' POST ' , url )
return self . _check_response ( response , expect_json = True )
# ## END Role ###
# ## BEGIN Search methods ###
2018-10-31 16:42:01 +01:00
2018-08-09 18:11:45 +02:00
def search ( self , controller : str = ' events ' , return_format : str = ' json ' ,
2018-10-31 16:42:01 +01:00
limit : Optional [ int ] = None , page : Optional [ int ] = None ,
2018-08-09 18:11:45 +02:00
value : Optional [ SearchParameterTypes ] = None ,
type_attribute : Optional [ SearchParameterTypes ] = None ,
category : Optional [ SearchParameterTypes ] = None ,
org : Optional [ SearchParameterTypes ] = None ,
tags : Optional [ SearchParameterTypes ] = None ,
2018-11-20 14:59:58 +01:00
quick_filter : Optional [ str ] = None , quickFilter : Optional [ str ] = None ,
2018-09-19 06:58:20 +02:00
date_from : Optional [ DateTypes ] = None ,
date_to : Optional [ DateTypes ] = None ,
2018-08-09 18:11:45 +02:00
eventid : Optional [ SearchType ] = None ,
2018-09-19 06:58:20 +02:00
with_attachments : Optional [ bool ] = None , withAttachments : Optional [ bool ] = None ,
2018-08-09 18:11:45 +02:00
metadata : Optional [ bool ] = None ,
uuid : Optional [ str ] = None ,
2018-09-19 06:58:20 +02:00
publish_timestamp : Optional [ DateInterval ] = None , last : Optional [ DateInterval ] = None ,
timestamp : Optional [ DateInterval ] = None ,
2018-08-09 18:11:45 +02:00
published : Optional [ bool ] = None ,
enforce_warninglist : Optional [ bool ] = None , enforceWarninglist : Optional [ bool ] = None ,
2019-01-22 11:49:01 +01:00
to_ids : Optional [ Union [ ToIDSType , List [ ToIDSType ] ] ] = None ,
2018-09-19 06:58:20 +02:00
deleted : Optional [ str ] = None ,
2019-08-02 17:08:25 +02:00
include_event_uuid : Optional [ bool ] = None , includeEventUuid : Optional [ bool ] = None ,
2018-09-19 06:58:20 +02:00
event_timestamp : Optional [ DateTypes ] = None ,
2018-09-30 14:22:44 +02:00
sg_reference_only : Optional [ bool ] = None ,
2018-09-19 06:58:20 +02:00
eventinfo : Optional [ str ] = None ,
searchall : Optional [ bool ] = None ,
2018-10-31 16:42:01 +01:00
requested_attributes : Optional [ str ] = None ,
2018-10-22 04:58:07 +02:00
include_context : Optional [ bool ] = None , includeContext : Optional [ bool ] = None ,
2018-10-31 16:42:01 +01:00
headerless : Optional [ bool ] = None ,
2019-08-02 17:08:25 +02:00
include_sightings : Optional [ bool ] = None , includeSightings : Optional [ bool ] = None ,
include_correlations : Optional [ bool ] = None , includeCorrelations : Optional [ bool ] = None ,
2018-09-19 06:58:20 +02:00
pythonify : Optional [ bool ] = False ,
2018-08-09 18:11:45 +02:00
* * kwargs ) :
2018-10-31 16:42:01 +01:00
''' Search in the MISP instance
2018-09-19 06:58:20 +02:00
: param returnFormat : Set the return format of the search ( Currently supported : json , xml , openioc , suricata , snort - more formats are being moved to restSearch with the goal being that all searches happen through this API ) . Can be passed as the first parameter after restSearch or via the JSON payload .
2018-10-31 16:42:01 +01:00
: param limit : Limit the number of results returned , depending on the scope ( for example 10 attributes or 10 full events ) .
: param page : If a limit is set , sets the page to be returned . page 3 , limit 100 will return records 201 - > 300 ) .
2018-09-19 06:58:20 +02:00
: param value : Search for the given value in the attributes ' value field.
: param type_attribute : The attribute type , any valid MISP attribute type is accepted .
: param category : The attribute category , any valid MISP attribute category is accepted .
: param org : Search by the creator organisation by supplying the organisation identifier .
: param tags : Tags to search or to exclude . You can pass a list , or the output of ` build_complex_query `
2018-11-20 14:59:20 +01:00
: param quick_filter : The string passed to this field will ignore all of the other arguments . MISP will return an xml / json ( depending on the header sent ) of all events that have a sub - string match on value in the event info , event orgc , or any of the attribute value1 / value2 fields , or in the attribute comment .
2018-09-19 06:58:20 +02:00
: param date_from : Events with the date set to a date after the one specified . This filter will use the date of the event .
: param date_to : Events with the date set to a date before the one specified . This filter will use the date of the event .
: param eventid : The events that should be included / excluded from the search
: param with_attachments : If set , encodes the attachments / zipped malware samples as base64 in the data field within each attribute
: param metadata : Only the metadata ( event , tags , relations ) is returned , attributes and proposals are omitted .
: param uuid : Restrict the results by uuid .
: param publish_timestamp : Restrict the results by the last publish timestamp ( newer than ) .
: param timestamp : Restrict the results by the timestamp ( last edit ) . Any event with a timestamp newer than the given timestamp will be returned . In case you are dealing with / attributes as scope , the attribute ' s timestamp will be used for the lookup.
: param published : Set whether published or unpublished events should be returned . Do not set the parameter if you want both .
: param enforce_warninglist : Remove any attributes from the result that would cause a hit on a warninglist entry .
2019-01-22 11:49:01 +01:00
: param to_ids : By default all attributes are returned that match the other filter parameters , irregardless of their to_ids setting . To restrict the returned data set to to_ids only attributes set this parameter to 1. 0 for the ones with to_ids set to False .
2018-09-19 06:58:20 +02:00
: param deleted : If this parameter is set to 1 , it will return soft - deleted attributes along with active ones . By using " only " as a parameter it will limit the returned data set to soft - deleted data only .
: param include_event_uuid : Instead of just including the event ID , also include the event UUID in each of the attributes .
: param event_timestamp : Only return attributes from events that have received a modification after the given timestamp .
2018-09-30 14:22:44 +02:00
: param sg_reference_only : If this flag is set , sharing group objects will not be included , instead only the sharing group ID is set .
: param eventinfo : Filter on the event ' s info field.
: param searchall : Search for a full or a substring ( delimited by % for substrings ) in the event info , event tags , attribute tags , attribute values or attribute comment fields .
2018-10-31 16:42:01 +01:00
: param requested_attributes : [ CSV only ] Select the fields that you wish to include in the CSV export . By setting event level fields additionally , includeContext is not required to get event metadata .
2019-08-02 17:08:25 +02:00
: param include_context : [ Attribute only ] Include the event data with each attribute .
2018-10-31 16:42:01 +01:00
: param headerless : [ CSV Only ] The CSV created when this setting is set to true will not contain the header row .
2019-08-02 17:08:25 +02:00
: param include_sightings : [ JSON Only - Attribute ] Include the sightings of the matching attributes .
: param include_correlations : [ JSON Only - attribute ] Include the correlations of the matching attributes .
2018-11-22 14:29:07 +01:00
: param pythonify : Returns a list of PyMISP Objects instead of the plain json output . Warning : it might use a lot of RAM
2018-09-19 06:58:20 +02:00
Deprecated :
2018-11-20 14:59:20 +01:00
: param quickFilter : synponym for quick_filter
2018-09-19 06:58:20 +02:00
: param withAttachments : synonym for with_attachments
: param last : synonym for publish_timestamp
: param enforceWarninglist : synonym for enforce_warninglist
: param includeEventUuid : synonym for include_event_uuid
2018-10-22 04:58:07 +02:00
: param includeContext : synonym for include_context
2018-09-19 06:58:20 +02:00
'''
2018-08-09 18:11:45 +02:00
2019-02-01 11:07:42 +01:00
return_formats = [ ' openioc ' , ' json ' , ' xml ' , ' suricata ' , ' snort ' , ' text ' , ' rpz ' , ' csv ' , ' cache ' , ' stix ' , ' stix2 ' ]
2018-10-22 00:49:38 +02:00
2018-10-31 16:42:01 +01:00
if controller not in [ ' events ' , ' attributes ' , ' objects ' , ' sightings ' ] :
2018-08-09 18:11:45 +02:00
raise ValueError ( ' controller has to be in {} ' . format ( ' , ' . join ( [ ' events ' , ' attributes ' , ' objects ' ] ) ) )
2018-09-19 06:58:20 +02:00
# Deprecated stuff / synonyms
2018-11-20 14:59:20 +01:00
if quickFilter is not None :
quick_filter = quickFilter
2018-09-19 06:58:20 +02:00
if withAttachments is not None :
with_attachments = withAttachments
if last is not None :
publish_timestamp = last
if enforceWarninglist is not None :
enforce_warninglist = enforceWarninglist
if includeEventUuid is not None :
include_event_uuid = includeEventUuid
2018-10-22 04:58:07 +02:00
if includeContext is not None :
include_context = includeContext
2019-08-02 17:08:25 +02:00
if includeCorrelations is not None :
include_correlations = includeCorrelations
if includeSightings is not None :
include_sightings = includeSightings
2018-08-09 18:11:45 +02:00
# Add all the parameters in kwargs are aimed at modules, or other 3rd party components, and cannot be sanitized.
# They are passed as-is.
query = kwargs
2018-10-31 16:42:01 +01:00
if return_format not in return_formats :
raise ValueError ( ' return_format has to be in {} ' . format ( ' , ' . join ( return_formats ) ) )
query [ ' returnFormat ' ] = return_format
query [ ' page ' ] = page
query [ ' limit ' ] = limit
query [ ' value ' ] = value
query [ ' type ' ] = type_attribute
query [ ' category ' ] = category
query [ ' org ' ] = org
query [ ' tags ' ] = tags
2018-11-20 14:59:20 +01:00
query [ ' quickFilter ' ] = quick_filter
2019-07-17 15:37:14 +02:00
query [ ' from ' ] = self . _make_timestamp ( date_from )
query [ ' to ' ] = self . _make_timestamp ( date_to )
2018-10-31 16:42:01 +01:00
query [ ' eventid ' ] = eventid
2019-08-02 17:08:25 +02:00
query [ ' withAttachments ' ] = self . _make_misp_bool ( with_attachments )
query [ ' metadata ' ] = self . _make_misp_bool ( metadata )
2018-10-31 16:42:01 +01:00
query [ ' uuid ' ] = uuid
2018-08-09 18:11:45 +02:00
if publish_timestamp is not None :
if isinstance ( publish_timestamp , ( list , tuple ) ) :
2019-07-17 15:37:14 +02:00
query [ ' publish_timestamp ' ] = ( self . _make_timestamp ( publish_timestamp [ 0 ] ) , self . _make_timestamp ( publish_timestamp [ 1 ] ) )
2018-08-09 18:11:45 +02:00
else :
2019-07-17 15:37:14 +02:00
query [ ' publish_timestamp ' ] = self . _make_timestamp ( publish_timestamp )
2018-08-09 18:11:45 +02:00
if timestamp is not None :
if isinstance ( timestamp , ( list , tuple ) ) :
2019-07-17 15:37:14 +02:00
query [ ' timestamp ' ] = ( self . _make_timestamp ( timestamp [ 0 ] ) , self . _make_timestamp ( timestamp [ 1 ] ) )
2018-08-09 18:11:45 +02:00
else :
2019-07-17 15:37:14 +02:00
query [ ' timestamp ' ] = self . _make_timestamp ( timestamp )
2018-10-31 16:42:01 +01:00
query [ ' published ' ] = published
2019-08-02 17:08:25 +02:00
query [ ' enforceWarninglist ' ] = self . _make_misp_bool ( enforce_warninglist )
2018-09-19 06:58:20 +02:00
if to_ids is not None :
2019-01-22 11:49:01 +01:00
if int ( to_ids ) not in [ 0 , 1 ] :
raise ValueError ( ' to_ids has to be in {} ' . format ( ' , ' . join ( [ 0 , 1 ] ) ) )
2018-09-19 06:58:20 +02:00
query [ ' to_ids ' ] = to_ids
2018-10-31 16:42:01 +01:00
query [ ' deleted ' ] = deleted
2019-08-02 17:08:25 +02:00
query [ ' includeEventUuid ' ] = self . _make_misp_bool ( include_event_uuid )
2018-09-19 06:58:20 +02:00
if event_timestamp is not None :
if isinstance ( event_timestamp , ( list , tuple ) ) :
2019-07-17 15:37:14 +02:00
query [ ' event_timestamp ' ] = ( self . _make_timestamp ( event_timestamp [ 0 ] ) , self . _make_timestamp ( event_timestamp [ 1 ] ) )
2018-09-19 06:58:20 +02:00
else :
2019-07-17 15:37:14 +02:00
query [ ' event_timestamp ' ] = self . _make_timestamp ( event_timestamp )
2019-08-02 17:08:25 +02:00
query [ ' sgReferenceOnly ' ] = self . _make_misp_bool ( sg_reference_only )
2018-10-31 16:42:01 +01:00
query [ ' eventinfo ' ] = eventinfo
query [ ' searchall ' ] = searchall
query [ ' requested_attributes ' ] = requested_attributes
2019-08-02 17:08:25 +02:00
query [ ' includeContext ' ] = self . _make_misp_bool ( include_context )
query [ ' headerless ' ] = self . _make_misp_bool ( headerless )
query [ ' includeSightings ' ] = self . _make_misp_bool ( include_sightings )
query [ ' includeCorrelations ' ] = self . _make_misp_bool ( include_correlations )
2018-08-09 18:11:45 +02:00
url = urljoin ( self . root_url , f ' { controller } /restSearch ' )
2018-12-18 11:04:36 +01:00
response = self . _prepare_request ( ' POST ' , url , data = query )
2019-07-12 17:35:02 +02:00
if return_format == ' json ' :
normalized_response = self . _check_response ( response , expect_json = True )
else :
2019-07-17 15:37:14 +02:00
normalized_response = self . _check_response ( response )
2019-07-22 11:28:24 +02:00
if return_format == ' csv ' and ( self . global_pythonify or pythonify ) and not headerless :
2019-07-17 15:37:14 +02:00
return self . _csv_to_dict ( normalized_response )
2019-08-06 14:14:28 +02:00
if ' errors ' in normalized_response :
2019-07-17 15:37:14 +02:00
return normalized_response
2019-08-06 14:14:28 +02:00
if return_format == ' json ' and self . global_pythonify or pythonify :
2019-07-17 15:37:14 +02:00
# The response is in json, we can convert it to a list of pythonic MISP objects
to_return = [ ]
if controller == ' events ' :
for e in normalized_response :
me = MISPEvent ( )
me . load ( e )
to_return . append ( me )
elif controller == ' attributes ' :
2019-08-02 17:08:25 +02:00
# FIXME: obvs, this is hurting my soul. We need something generic.
2019-07-17 15:37:14 +02:00
for a in normalized_response . get ( ' Attribute ' ) :
ma = MISPAttribute ( )
ma . from_dict ( * * a )
2019-08-02 17:08:25 +02:00
if ' Event ' in ma :
me = MISPEvent ( )
me . from_dict ( * * ma . Event )
ma . Event = me
if ' RelatedAttribute ' in ma :
related_attributes = [ ]
for ra in ma . RelatedAttribute :
r_attribute = MISPAttribute ( )
r_attribute . from_dict ( * * ra )
if ' Event ' in r_attribute :
me = MISPEvent ( )
me . from_dict ( * * r_attribute . Event )
r_attribute . Event = me
related_attributes . append ( r_attribute )
ma . RelatedAttribute = related_attributes
if ' Sighting ' in ma :
sightings = [ ]
for sighting in ma . Sighting :
s = MISPSighting ( )
s . from_dict ( * * sighting )
sightings . append ( s )
ma . Sighting = sightings
2019-07-17 15:37:14 +02:00
to_return . append ( ma )
elif controller == ' objects ' :
raise PyMISPNotImplementedYet ( ' Not implemented yet ' )
return to_return
2019-08-06 14:14:28 +02:00
return normalized_response
2019-07-17 15:37:14 +02:00
def search_index ( self , published : Optional [ bool ] = None , eventid : Optional [ SearchType ] = None ,
tags : Optional [ SearchParameterTypes ] = None ,
date_from : Optional [ DateTypes ] = None ,
date_to : Optional [ DateTypes ] = None ,
eventinfo : Optional [ str ] = None ,
threatlevel : Optional [ List [ SearchType ] ] = None ,
distribution : Optional [ List [ SearchType ] ] = None ,
analysis : Optional [ List [ SearchType ] ] = None ,
org : Optional [ SearchParameterTypes ] = None ,
timestamp : Optional [ DateInterval ] = None ,
pythonify : Optional [ bool ] = None ) :
""" Search only at the index level. Using ! in front of a value means NOT (default is OR)
: param published : Set whether published or unpublished events should be returned . Do not set the parameter if you want both .
: param eventid : The events that should be included / excluded from the search
: param tags : Tags to search or to exclude . You can pass a list , or the output of ` build_complex_query `
: param date_from : Events with the date set to a date after the one specified . This filter will use the date of the event .
: param date_to : Events with the date set to a date before the one specified . This filter will use the date of the event .
: param eventinfo : Filter on the event ' s info field.
: param threatlevel : Threat level ( s ) ( 1 , 2 , 3 , 4 ) | list
: param distribution : Distribution level ( s ) ( 0 , 1 , 2 , 3 ) | list
: param analysis : Analysis level ( s ) ( 0 , 1 , 2 ) | list
: param org : Search by the creator organisation by supplying the organisation identifier .
: param timestamp : Restrict the results by the timestamp ( last edit ) . Any event with a timestamp newer than the given timestamp will be returned . In case you are dealing with / attributes as scope , the attribute ' s timestamp will be used for the lookup.
: param pythonify : Returns a list of PyMISP Objects instead or the plain json output . Warning : it might use a lot of RAM
"""
query = locals ( )
query . pop ( ' self ' )
query . pop ( ' pythonify ' )
if query . get ( ' date_from ' ) :
query [ ' datefrom ' ] = self . _make_timestamp ( query . pop ( ' date_from ' ) )
if query . get ( ' date_to ' ) :
query [ ' dateuntil ' ] = self . _make_timestamp ( query . pop ( ' date_to ' ) )
if query . get ( ' timestamp ' ) is not None :
timestamp = query . pop ( ' timestamp ' )
if isinstance ( timestamp , ( list , tuple ) ) :
query [ ' timestamp ' ] = ( self . _make_timestamp ( timestamp [ 0 ] ) , self . _make_timestamp ( timestamp [ 1 ] ) )
else :
query [ ' timestamp ' ] = self . _make_timestamp ( timestamp )
url = urljoin ( self . root_url , ' events/index ' )
response = self . _prepare_request ( ' POST ' , url , data = query )
normalized_response = self . _check_response ( response , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) :
2019-07-17 15:37:14 +02:00
return normalized_response
to_return = [ ]
for e_meta in normalized_response :
me = MISPEvent ( )
me . from_dict ( * * e_meta )
to_return . append ( me )
return to_return
def search_sightings ( self , context : Optional [ str ] = None ,
context_id : Optional [ SearchType ] = None ,
type_sighting : Optional [ str ] = None ,
date_from : Optional [ DateTypes ] = None ,
date_to : Optional [ DateTypes ] = None ,
publish_timestamp : Optional [ DateInterval ] = None , last : Optional [ DateInterval ] = None ,
org : Optional [ SearchType ] = None ,
source : Optional [ str ] = None ,
include_attribute : Optional [ bool ] = None ,
include_event_meta : Optional [ bool ] = None ,
pythonify : Optional [ bool ] = False
) :
''' Search sightings
: param context : The context of the search . Can be either " attribute " , " event " , or nothing ( will then match on events and attributes ) .
: param context_id : Only relevant if context is either " attribute " or " event " . Then it is the relevant ID .
: param type_sighting : Type of sighting
: param date_from : Events with the date set to a date after the one specified . This filter will use the date of the event .
: param date_to : Events with the date set to a date before the one specified . This filter will use the date of the event .
: param publish_timestamp : Restrict the results by the last publish timestamp ( newer than ) .
: param org : Search by the creator organisation by supplying the organisation identifier .
: param source : Source of the sighting
: param include_attribute : Include the attribute .
: param include_event_meta : Include the meta information of the event .
Deprecated :
: param last : synonym for publish_timestamp
: Example :
>> > misp . search_sightings ( publish_timestamp = ' 30d ' ) # search sightings for the last 30 days on the instance
[ . . . ]
>> > misp . search_sightings ( context = ' attribute ' , context_id = 6 , include_attribute = True ) # return list of sighting for attribute 6 along with the attribute itself
[ . . . ]
>> > misp . search_sightings ( context = ' event ' , context_id = 17 , include_event_meta = True , org = 2 ) # return list of sighting for event 17 filtered with org id 2
'''
query = { ' returnFormat ' : ' json ' }
if context is not None :
if context not in [ ' attribute ' , ' event ' ] :
raise ValueError ( ' context has to be in {} ' . format ( ' , ' . join ( [ ' attribute ' , ' event ' ] ) ) )
url_path = f ' sightings/restSearch/ { context } '
else :
url_path = ' sightings/restSearch '
query [ ' id ' ] = context_id
query [ ' type ' ] = type_sighting
query [ ' from ' ] = date_from
query [ ' to ' ] = date_to
query [ ' last ' ] = publish_timestamp
query [ ' org_id ' ] = org
query [ ' source ' ] = source
query [ ' includeAttribute ' ] = include_attribute
query [ ' includeEvent ' ] = include_event_meta
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
url = urljoin ( self . root_url , url_path )
response = self . _prepare_request ( ' POST ' , url , data = query )
normalized_response = self . _check_response ( response , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in normalized_response :
2018-08-19 14:35:32 +02:00
return normalized_response
2019-08-06 14:14:28 +02:00
if self . global_pythonify or pythonify :
2018-09-19 06:58:20 +02:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for s in normalized_response :
entries = { }
s_data = s [ ' Sighting ' ]
if include_event_meta :
e = s_data . pop ( ' Event ' )
2018-09-19 06:58:20 +02:00
me = MISPEvent ( )
2019-07-17 15:37:14 +02:00
me . from_dict ( * * e )
entries [ ' event ' ] = me
if include_attribute :
a = s_data . pop ( ' Attribute ' )
2018-09-19 06:58:20 +02:00
ma = MISPAttribute ( )
ma . from_dict ( * * a )
2019-07-17 15:37:14 +02:00
entries [ ' attribute ' ] = ma
ms = MISPSighting ( )
ms . from_dict ( * * s_data )
entries [ ' sighting ' ] = ms
to_return . append ( entries )
2018-09-19 06:58:20 +02:00
return to_return
2019-08-06 14:14:28 +02:00
return normalized_response
2018-09-18 03:37:07 +02:00
2018-11-20 01:21:06 +01:00
def search_logs ( self , limit : Optional [ int ] = None , page : Optional [ int ] = None ,
log_id : Optional [ int ] = None , title : Optional [ str ] = None ,
created : Optional [ DateTypes ] = None , model : Optional [ str ] = None ,
action : Optional [ str ] = None , user_id : Optional [ int ] = None ,
change : Optional [ str ] = None , email : Optional [ str ] = None ,
org : Optional [ str ] = None , description : Optional [ str ] = None ,
2018-11-22 14:29:07 +01:00
ip : Optional [ str ] = None , pythonify : Optional [ bool ] = False ) :
2018-11-20 01:21:06 +01:00
''' Search in logs
Note : to run substring queries simply append / prepend / encapsulate the search term with %
: param limit : Limit the number of results returned , depending on the scope ( for example 10 attributes or 10 full events ) .
: param page : If a limit is set , sets the page to be returned . page 3 , limit 100 will return records 201 - > 300 ) .
: param log_id : Log ID
: param title : Log Title
: param created : Creation timestamp
: param model : Model name that generated the log entry
: param action : The thing that was done
: param user_id : ID of the user doing the action
: param change : Change that occured
: param email : Email of the user
: param org : Organisation of the User doing the action
: param description : Description of the action
: param ip : Origination IP of the User doing the action
2018-11-22 14:29:07 +01:00
: param pythonify : Returns a list of PyMISP Objects instead or the plain json output . Warning : it might use a lot of RAM
2018-11-20 01:21:06 +01:00
'''
query = locals ( )
query . pop ( ' self ' )
2018-11-22 14:29:07 +01:00
query . pop ( ' pythonify ' )
2018-11-20 01:21:06 +01:00
if log_id is not None :
query [ ' id ' ] = query . pop ( ' log_id ' )
2019-07-12 17:35:02 +02:00
response = self . _prepare_request ( ' POST ' , ' admin/logs/index ' , data = query )
normalized_response = self . _check_response ( response , expect_json = True )
2019-07-22 11:28:24 +02:00
if not ( self . global_pythonify or pythonify ) or ' errors ' in normalized_response :
2018-11-22 14:29:07 +01:00
return normalized_response
to_return = [ ]
for l in normalized_response :
ml = MISPLog ( )
2019-07-12 17:35:02 +02:00
ml . from_dict ( * * l )
2018-11-22 14:29:07 +01:00
to_return . append ( ml )
return to_return
2019-07-17 15:37:14 +02:00
# ## END Search methods ###
2018-11-22 14:29:07 +01:00
2019-07-17 15:37:14 +02:00
# ## BEGIN Others ###
2018-11-22 14:29:07 +01:00
2019-07-17 15:37:14 +02:00
def push_event_to_ZMQ ( self , event : Union [ MISPEvent , int , str , UUID ] ) :
""" Force push an event on ZMQ """
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
response = self . _prepare_request ( ' POST ' , f ' events/pushEventToZMQ/ { event_id } .json ' )
return self . _check_response ( response , expect_json = True )
2018-11-22 14:29:07 +01:00
2019-08-01 13:19:21 +02:00
def direct_call ( self , url : str , data : dict = None , params : dict = { } , kw_params : dict = { } ) :
2019-07-17 15:37:14 +02:00
''' Very lightweight call that posts a data blob (python dictionary or json string) on the URL '''
if data is None :
2019-08-01 13:19:21 +02:00
response = self . _prepare_request ( ' GET ' , url , params = params , kw_params = kw_params )
2019-07-17 15:37:14 +02:00
else :
2019-08-01 13:19:21 +02:00
response = self . _prepare_request ( ' POST ' , url , data = data , params = params , kw_params = kw_params )
2019-07-17 15:37:14 +02:00
return self . _check_response ( response , lenient_response_type = True )
2018-11-22 14:29:07 +01:00
2019-07-17 15:37:14 +02:00
def freetext ( self , event : Union [ MISPEvent , int , str , UUID ] , string : str , adhereToWarninglists : Union [ bool , str ] = False ,
2019-08-01 13:19:21 +02:00
distribution : int = None , returnMetaAttributes : bool = False , pythonify : bool = False , * * kwargs ) :
2019-07-17 15:37:14 +02:00
""" Pass a text to the freetext importer """
event_id = self . __get_uuid_or_id_from_abstract_misp ( event )
query = { " value " : string }
wl_params = [ False , True , ' soft ' ]
if adhereToWarninglists in wl_params :
query [ ' adhereToWarninglists ' ] = adhereToWarninglists
else :
raise Exception ( ' Invalid parameter, adhereToWarninglists Can only be {} ' . format ( ' , ' . join ( wl_params ) ) )
if distribution is not None :
query [ ' distribution ' ] = distribution
if returnMetaAttributes :
query [ ' returnMetaAttributes ' ] = returnMetaAttributes
2019-08-01 13:19:21 +02:00
attributes = self . _prepare_request ( ' POST ' , f ' events/freeTextImport/ { event_id } ' , data = query , * * kwargs )
2019-07-17 15:37:14 +02:00
attributes = self . _check_response ( attributes , expect_json = True )
2019-07-22 11:28:24 +02:00
if returnMetaAttributes or not ( self . global_pythonify or pythonify ) or ' errors ' in attributes :
2019-07-17 15:37:14 +02:00
return attributes
2018-11-22 14:29:07 +01:00
to_return = [ ]
2019-07-17 15:37:14 +02:00
for attribute in attributes :
a = MISPAttribute ( )
a . from_dict ( * * attribute )
to_return . append ( a )
2018-11-22 14:29:07 +01:00
return to_return
2019-04-04 16:39:17 +02:00
2019-05-21 16:47:10 +02:00
def upload_stix ( self , path , version : str = ' 2 ' ) :
""" Upload a STIX file to MISP.
: param path : Path to the STIX on the disk ( can be a path - like object , or a pseudofile )
: param version : Can be 1 or 2
"""
if isinstance ( path , ( str , Path ) ) :
with open ( path , ' rb ' ) as f :
to_post = f . read ( )
else :
to_post = path . read ( )
if isinstance ( to_post , bytes ) :
to_post = to_post . decode ( )
if str ( version ) == ' 1 ' :
url = urljoin ( self . root_url , ' /events/upload_stix ' )
response = self . _prepare_request ( ' POST ' , url , data = to_post , output_type = ' xml ' )
else :
url = urljoin ( self . root_url , ' /events/upload_stix/2 ' )
response = self . _prepare_request ( ' POST ' , url , data = to_post )
return response
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
# ## END Others ###
# ## BEGIN Statistics ###
def attributes_statistics ( self , context : str = ' type ' , percentage : bool = False ) :
""" Get attributes statistics from the MISP instance. """
# FIXME: https://github.com/MISP/MISP/issues/4874
if context not in [ ' type ' , ' category ' ] :
raise PyMISPError ( ' context can only be " type " or " category " ' )
if percentage :
path = f ' attributes/attributeStatistics/ { context } /true '
else :
path = f ' attributes/attributeStatistics/ { context } '
response = self . _prepare_request ( ' GET ' , path )
return self . _check_response ( response , expect_json = True )
def tags_statistics ( self , percentage : bool = False , name_sort : bool = False ) :
""" Get tags statistics from the MISP instance """
# FIXME: https://github.com/MISP/MISP/issues/4874
# NOTE: https://github.com/MISP/MISP/issues/4879
if percentage :
percentage = ' true '
else :
percentage = ' false '
if name_sort :
name_sort = ' true '
else :
name_sort = ' false '
response = self . _prepare_request ( ' GET ' , f ' tags/tagStatistics/ { percentage } / { name_sort } ' )
return self . _check_response ( response )
def users_statistics ( self , context : str = ' data ' ) :
""" Get users statistics from the MISP instance """
availables_contexts = [ ' data ' , ' orgs ' , ' users ' , ' tags ' , ' attributehistogram ' , ' sightings ' , ' galaxyMatrix ' ]
if context not in availables_contexts :
raise PyMISPError ( " context can only be { ' , ' .join(availables_contexts)} " )
2019-08-01 15:10:48 +02:00
response = self . _prepare_request ( ' GET ' , f ' users/statistics/ { context } ' )
2019-07-17 15:37:14 +02:00
return self . _check_response ( response )
# ## END Statistics ###
# ## BEGIN Global helpers ###
2019-07-22 11:28:24 +02:00
def change_sharing_group_on_entity ( self , misp_entity : AbstractMISP , sharing_group_id , pythonify : bool = False ) :
2019-07-17 15:37:14 +02:00
""" Change the sharing group of an event, an attribute, or an object """
misp_entity . distribution = 4 # Needs to be 'Sharing group'
if ' SharingGroup ' in misp_entity : # Delete former SharingGroup information
del misp_entity . SharingGroup
misp_entity . sharing_group_id = sharing_group_id # Set new sharing group id
if isinstance ( misp_entity , MISPEvent ) :
2019-07-22 11:28:24 +02:00
return self . update_event ( misp_entity , pythonify = pythonify )
2019-08-06 14:14:28 +02:00
if isinstance ( misp_entity , MISPObject ) :
2019-07-22 11:28:24 +02:00
return self . update_object ( misp_entity , pythonify = pythonify )
2019-08-06 14:14:28 +02:00
if isinstance ( misp_entity , MISPAttribute ) :
2019-07-22 11:28:24 +02:00
return self . update_attribute ( misp_entity , pythonify = pythonify )
2019-08-06 14:14:28 +02:00
raise PyMISPError ( ' The misp_entity must be MISPEvent, MISPObject or MISPAttribute ' )
2019-07-17 15:37:14 +02:00
def tag ( self , misp_entity : Union [ AbstractMISP , str ] , tag : str ) :
""" Tag an event or an attribute. misp_entity can be a UUID """
if ' uuid ' in misp_entity :
uuid = misp_entity . uuid
else :
uuid = misp_entity
to_post = { ' uuid ' : uuid , ' tag ' : tag }
response = self . _prepare_request ( ' POST ' , ' tags/attachTagToObject ' , data = to_post )
return self . _check_response ( response , expect_json = True )
def untag ( self , misp_entity : Union [ AbstractMISP , str ] , tag : str ) :
""" Untag an event or an attribute. misp_entity can be a UUID """
if ' uuid ' in misp_entity :
uuid = misp_entity . uuid
else :
uuid = misp_entity
to_post = { ' uuid ' : uuid , ' tag ' : tag }
response = self . _prepare_request ( ' POST ' , ' tags/removeTagFromObject ' , data = to_post )
return self . _check_response ( response , expect_json = True )
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def build_complex_query ( self , or_parameters : Optional [ List [ SearchType ] ] = None ,
and_parameters : Optional [ List [ SearchType ] ] = None ,
not_parameters : Optional [ List [ SearchType ] ] = None ) :
''' Build a complex search query. MISP expects a dictionary with AND, OR and NOT keys. '''
to_return = { }
if and_parameters :
to_return [ ' AND ' ] = and_parameters
if not_parameters :
to_return [ ' NOT ' ] = not_parameters
if or_parameters :
to_return [ ' OR ' ] = or_parameters
return to_return
# ## END Global helpers ###
# ## Internal methods ###
2019-07-12 17:35:02 +02:00
2019-07-17 15:37:14 +02:00
def __get_uuid_or_id_from_abstract_misp ( self , obj : Union [ AbstractMISP , int , str , UUID ] ) :
if isinstance ( obj , UUID ) :
return str ( obj )
if isinstance ( obj , ( int , str ) ) :
return obj
2019-08-06 14:14:28 +02:00
if ' id ' in obj :
2019-07-17 15:37:14 +02:00
return obj [ ' id ' ]
return obj [ ' uuid ' ]
2019-08-02 17:08:25 +02:00
def _make_misp_bool ( self , parameter : Union [ bool , str , None ] ) :
''' MISP wants 0 or 1 for bool, so we avoid True/False ' 0 ' , ' 1 ' '''
if parameter is None :
return 0
return 1 if int ( parameter ) else 0
2019-07-17 15:37:14 +02:00
def _make_timestamp ( self , value : DateTypes ) :
2019-07-12 17:35:02 +02:00
''' Catch-all method to normalize anything that can be converted to a timestamp '''
if isinstance ( value , datetime ) :
2019-07-30 01:13:08 +02:00
return value . timestamp ( )
2019-08-06 14:14:28 +02:00
if isinstance ( value , date ) :
2019-07-12 17:35:02 +02:00
return datetime . combine ( value , datetime . max . time ( ) ) . timestamp ( )
2019-08-06 14:14:28 +02:00
if isinstance ( value , str ) :
2019-07-12 17:35:02 +02:00
if value . isdigit ( ) :
return value
2019-08-06 14:14:28 +02:00
try :
float ( value )
return value
except ValueError :
# The value can also be '1d', '10h', ...
return value
return value
2019-07-12 17:35:02 +02:00
def _check_response ( self , response , lenient_response_type = False , expect_json = False ) :
""" Check if the response from the server is not an unexpected error """
if response . status_code > = 500 :
logger . critical ( everything_broken . format ( response . request . headers , response . request . body , response . text ) )
raise MISPServerError ( f ' Error code 500: \n { response . text } ' )
2019-08-06 14:14:28 +02:00
if 400 < = response . status_code < 500 :
2019-07-12 17:35:02 +02:00
# The server returns a json message with the error details
error_message = response . json ( )
logger . error ( f ' Something went wrong ( { response . status_code } ): { error_message } ' )
return { ' errors ' : ( response . status_code , error_message ) }
# At this point, we had no error.
try :
response = response . json ( )
if logger . isEnabledFor ( logging . DEBUG ) :
logger . debug ( response )
if isinstance ( response , dict ) and response . get ( ' response ' ) is not None :
# Cleanup.
response = response [ ' response ' ]
return response
except Exception :
if logger . isEnabledFor ( logging . DEBUG ) :
logger . debug ( response . text )
if expect_json :
raise PyMISPUnexpectedResponse ( f ' Unexpected response from server: { response . text } ' )
if lenient_response_type and not response . headers . get ( ' content-type ' ) . startswith ( ' application/json ' ) :
return response . text
2019-08-06 14:14:28 +02:00
if not response . content :
2019-07-12 17:35:02 +02:00
# Empty response
logger . error ( ' Got an empty response. ' )
return { ' errors ' : ' The response is empty. ' }
return response . text
def __repr__ ( self ) :
return f ' < { self . __class__ . __name__ } (url= { self . root_url } ) '
2019-08-01 13:19:21 +02:00
def _prepare_request ( self , request_type : str , url : str , data : dict = { } , params : dict = { } ,
kw_params : dict = { } , output_type : str = ' json ' ) :
2019-07-12 17:35:02 +02:00
''' Prepare a request for python-requests '''
url = urljoin ( self . root_url , url )
if logger . isEnabledFor ( logging . DEBUG ) :
logger . debug ( f ' { request_type } - { url } ' )
if data is not None :
logger . debug ( data )
if data :
if not isinstance ( data , str ) : # Else, we already have a text blob to send
if isinstance ( data , dict ) : # Else, we can directly json encode.
# Remove None values.
data = { k : v for k , v in data . items ( ) if v is not None }
data = json . dumps ( data , cls = MISPEncode )
2019-08-01 13:19:21 +02:00
if kw_params :
# CakePHP params in URL
to_append_url = ' / ' . join ( [ f ' { k } : { v } ' for k , v in kw_params . items ( ) ] )
url = f ' { url } / { to_append_url } '
2019-07-12 17:35:02 +02:00
req = requests . Request ( request_type , url , data = data , params = params )
with requests . Session ( ) as s :
2019-08-01 15:45:43 +02:00
user_agent = f ' PyMISP { __version__ } - Python { " . " . join ( str ( x ) for x in sys . version_info [ : 2 ] ) } '
2019-07-12 17:35:02 +02:00
if self . tool :
user_agent = f ' { user_agent } - { self . tool } '
req . auth = self . auth
prepped = s . prepare_request ( req )
prepped . headers . update (
{ ' Authorization ' : self . key ,
' Accept ' : f ' application/ { output_type } ' ,
' content-type ' : f ' application/ { output_type } ' ,
' User-Agent ' : user_agent } )
if logger . isEnabledFor ( logging . DEBUG ) :
logger . debug ( prepped . headers )
settings = s . merge_environment_settings ( req . url , proxies = self . proxies or { } , stream = None , verify = self . ssl , cert = self . cert )
return s . send ( prepped , * * settings )
2019-07-17 15:37:14 +02:00
def _csv_to_dict ( self , csv_content : str ) :
2019-07-12 17:35:02 +02:00
''' Makes a list of dict out of a csv file (requires headers) '''
fieldnames , lines = csv_content . split ( ' \n ' , 1 )
fieldnames = fieldnames . split ( ' , ' )
to_return = [ ]
for line in csv . reader ( lines . split ( ' \n ' ) ) :
if line :
to_return . append ( { fname : value for fname , value in zip ( fieldnames , line ) } )
return to_return