array( 'userModel' => 'User', 'userKey' => 'user_id', 'change' => 'full'), 'Trim', 'Containable', ); public $displayField = 'id'; public $virtualFields = array(); public $mispVersion = '2.4.0'; public $fieldDescriptions = array( 'threat_level_id' => array('desc' => 'Risk levels: *low* means mass-malware, *medium* means APT malware, *high* means sophisticated APT malware or 0-day attack', 'formdesc' => 'Risk levels: low: mass-malware medium: APT malware high: sophisticated APT malware or 0-day attack'), 'classification' => array('desc' => 'Set the Traffic Light Protocol classification.

1. TLP:AMBER- Share only within the organization on a need-to-know basis
2. TLP:GREEN:NeedToKnow- Share within your constituency on the need-to-know basis.
3. TLP:GREEN- Share within your constituency.

'), 'submittedioc' => array('desc' => '', 'formdesc' => ''), 'analysis' => array('desc' => 'Analysis Levels: *Initial* means the event has just been created, *Ongoing* means that the event is being populated, *Complete* means that the event\'s creation is complete', 'formdesc' => 'Analysis levels: Initial: event has been started Ongoing: event population is in progress Complete: event creation has finished'), 'distribution' => array('desc' => 'Describes who will have access to the event.') ); public $analysisDescriptions = array( 0 => array('desc' => '*Initial* means the event has just been created', 'formdesc' => 'Event has just been created and is in an initial state'), 1 => array('desc' => '*Ongoing* means that the event is being populated', 'formdesc' => 'The analysis is still ongoing'), 2 => array('desc' => '*Complete* means that the event\'s creation is complete', 'formdesc' => 'The event creator considers the analysis complete') ); public $distributionDescriptions = array( 0 => array('desc' => 'This field determines the current distribution of the event', 'formdesc' => "This setting will only allow members of your organisation on this server to see it."), 1 => array('desc' => 'This field determines the current distribution of the event', 'formdesc' => "Organisations that are part of this MISP community will be able to see the event."), 2 => array('desc' => 'This field determines the current distribution of the event', 'formdesc' => "Organisations that are either part of this MISP community or part of a directly connected MISP community will be able to see the event."), 3 => array('desc' => 'This field determines the current distribution of the event', 'formdesc' => "This will share the event with all MISP communities, allowing the event to be freely propagated from one server to the next."), 4 => array('desc' => 'This field determines the current distribution of the event', 'formdesc' => "This distribution of this event will be handled by the selected sharing group."), ); public $analysisLevels = array( 0 => 'Initial', 1 => 'Ongoing', 2 => 'Completed' ); public $distributionLevels = array( 0 => 'Your organisation only', 1 => 'This community only', 2 => 'Connected communities', 3 => 'All communities', 4 => 'Sharing group' ); public $shortDist = array(0 => 'Organisation', 1 => 'Community', 2 => 'Connected', 3 => 'All', 4 => ' sharing Group'); public $export_types = []; public $validFormats = array( 'attack' => array('html', 'AttackExport', 'html'), 'attack-sightings' => array('json', 'AttackSightingsExport', 'json'), 'cache' => array('txt', 'CacheExport', 'cache'), 'count' => array('txt', 'CountExport', 'txt'), 'csv' => array('csv', 'CsvExport', 'csv'), 'hashes' => array('txt', 'HashesExport', 'txt'), 'json' => array('json', 'JsonExport', 'json'), 'netfilter' => array('txt', 'NetfilterExport', 'sh'), 'opendata' => array('txt', 'OpendataExport', 'txt'), 'openioc' => array('xml', 'OpeniocExport', 'ioc'), 'rpz' => array('txt', 'RPZExport', 'rpz'), 'snort' => array('txt', 'NidsSnortExport', 'rules'), 'stix' => array('xml', 'Stix1Export', 'xml'), 'stix-json' => array('json', 'Stix1Export', 'json'), 'stix2' => array('json', 'Stix2Export', 'json'), 'suricata' => array('txt', 'NidsSuricataExport', 'rules'), 'text' => array('text', 'TextExport', 'txt'), 'xml' => array('xml', 'XmlExport', 'xml'), 'yara' => array('txt', 'YaraExport', 'yara'), 'yara-json' => array('json', 'YaraExport', 'json') ); public $csv_event_context_fields_to_fetch = array( 'event_info' => array('object' => false, 'var' => 'info'), 'event_member_org' => array('object' => 'Org', 'var' => 'name'), 'event_source_org' => array('object' => 'Orgc', 'var' => 'name'), 'event_distribution' => array('object' => false, 'var' => 'distribution'), 'event_threat_level_id' => array('object' => 'ThreatLevel', 'var' => 'name'), 'event_analysis' => array('object' => false, 'var' => 'analysis'), 'event_date' => array('object' => false, 'var' => 'date'), 'event_tag' => array('object' => 'Tag', 'var' => 'name') ); public $validate = array( 'org_id' => array( 'valueNotEmpty' => array( 'rule' => array('valueNotEmpty'), ), 'numeric' => array( 'rule' => array('numeric'), ), ), 'orgc_id' => array( 'valueNotEmpty' => array( 'rule' => array('valueNotEmpty'), ), 'numeric' => array( 'rule' => array('numeric'), ), ), 'date' => array( 'date' => array( 'rule' => array('date'), 'message' => 'Expected date format: YYYY-MM-DD', //'allowEmpty' => false, 'required' => true, //'last' => false, // Stop validation after this rule //'on' => 'create', // Limit validation to 'create' or 'update' operations ), ), 'threat_level_id' => array( 'rule' => array('inList', array('1', '2', '3', '4')), 'message' => 'Options : 1, 2, 3, 4 (for High, Medium, Low, Undefined)', 'required' => true ), 'distribution' => array( 'not_empty_if_sg' => array( 'rule' => array('inList', array('0', '1', '2', '3', '4')), 'message' => 'Options : Your organisation only, This community only, Connected communities, All communities', //'allowEmpty' => false, 'required' => true, //'last' => false, // Stop validation after this rule //'on' => 'create', // Limit validation to 'create' or 'update' operations ) ), 'sharing_group_id' => array( 'rule' => array('sharingGroupRequired'), 'message' => 'If the distribution is set to "Sharing Group", a sharing group has to be selected.', //'required' => true, //'allowEmpty' => true ), 'analysis' => array( 'rule' => array('inList', array('0', '1', '2')), 'message' => 'Options : 0, 1, 2 (for Initial, Ongoing, Completed)', //'allowEmpty' => false, 'required' => true, //'last' => false, // Stop validation after this rule //'on' => 'create', // Limit validation to 'create' or 'update' operations ), 'info' => array( 'valueNotEmpty' => array( 'rule' => array('valueNotEmpty'), 'required' => true ), ), 'user_id' => array( 'numeric' => array( 'rule' => array('numeric') ) ), 'published' => array( 'boolean' => array( 'rule' => array('boolean'), //'message' => 'Your custom message here', //'allowEmpty' => false, //'required' => false, //'last' => false, // Stop validation after this rule //'on' => 'create', // Limit validation to 'create' or 'update' operations ), ), 'uuid' => array( 'uuid' => array( 'rule' => 'uuid', 'message' => 'Please provide a valid RFC 4122 UUID' ), ), 'extends_uuid' => array( 'uuid' => array( 'rule' => 'uuid', 'message' => 'Please provide a valid UUID', 'allowEmpty' => true ) ) ); // The Associations below have been created with all possible keys, those that are not needed can be removed public $belongsTo = array( 'User' => array( 'className' => 'User', 'foreignKey' => 'user_id', 'conditions' => '', 'fields' => '', 'order' => '' ), 'ThreatLevel' => array( 'className' => 'ThreatLevel', 'foreignKey' => 'threat_level_id' ), 'Org' => array( 'className' => 'Organisation', 'foreignKey' => 'org_id' ), 'Orgc' => array( 'className' => 'Organisation', 'foreignKey' => 'orgc_id' ), 'SharingGroup' => array( 'className' => 'SharingGroup', 'foreignKey' => 'sharing_group_id' ) ); public $hasMany = array( 'Attribute' => array( 'className' => 'Attribute', 'foreignKey' => 'event_id', 'dependent' => true, // cascade deletes 'conditions' => '', 'fields' => '', 'order' => array('Attribute.category ASC', 'Attribute.type ASC'), 'limit' => '', 'offset' => '', 'exclusive' => '', 'finderQuery' => '', 'counterQuery' => '' ), 'ShadowAttribute' => array( 'className' => 'ShadowAttribute', 'foreignKey' => 'event_id', 'dependent' => true, // cascade deletes 'conditions' => '', 'fields' => '', 'order' => array('ShadowAttribute.old_id DESC', 'ShadowAttribute.old_id DESC'), 'limit' => '', 'offset' => '', 'exclusive' => '', 'finderQuery' => '', 'counterQuery' => '' ), 'Object' => array( 'className' => 'MispObject', 'foreignKey' => 'event_id', 'dependent' => true, 'conditions' => '', 'fields' => '', 'order' => false, 'limit' => '', 'offset' => '', 'exclusive' => '', 'finderQuery' => '', 'counterQuery' => '' ), 'EventTag' => array( 'className' => 'EventTag', 'dependent' => true, ), 'Sighting' => array( 'className' => 'Sighting', 'dependent' => true, ), 'EventReport' => array( 'className' => 'EventReport', 'dependent' => true, ) ); public function __construct($id = false, $table = null, $ds = null) { parent::__construct($id, $table, $ds); $this->export_types = array( 'json' => array( 'extension' => '.json', 'type' => 'JSON', 'scope' => 'Event', 'requiresPublished' => 0, 'params' => array('includeAttachments' => 1, 'ignore' => 1, 'returnFormat' => 'json'), 'description' => __('Click this to download all events and attributes that you have access to in MISP JSON format.'), ), 'xml' => array( 'extension' => '.xml', 'type' => 'XML', 'scope' => 'Event', 'params' => array('includeAttachments' => 1, 'ignore' => 1, 'returnFormat' => 'xml'), 'requiresPublished' => 0, 'description' => __('Click this to download all events and attributes that you have access to in MISP XML format.'), ), 'csv_sig' => array( 'extension' => '.csv', 'type' => 'CSV_Sig', 'scope' => 'Event', 'requiresPublished' => 1, 'params' => array('published' => 1, 'to_ids' => 1, 'returnFormat' => 'csv'), 'description' => __('Click this to download all attributes that are indicators and that you have access to (except file attachments) in CSV format.'), ), 'csv_all' => array( 'extension' => '.csv', 'type' => 'CSV_All', 'scope' => 'Event', 'requiresPublished' => 0, 'params' => array('ignore' => 1, 'returnFormat' => 'csv'), 'description' => __('Click this to download all attributes that you have access to (except file attachments) in CSV format.'), ), 'suricata' => array( 'extension' => '.rules', 'type' => 'Suricata', 'scope' => 'Attribute', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'suricata'), 'description' => __('Click this to download all network related attributes that you have access to under the Suricata rule format. Only published events and attributes marked as IDS Signature are exported. Administration is able to maintain a allowedlist containing host, domain name and IP numbers to exclude from the NIDS export.'), ), 'snort' => array( 'extension' => '.rules', 'type' => 'Snort', 'scope' => 'Attribute', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'snort'), 'description' => __('Click this to download all network related attributes that you have access to under the Snort rule format. Only published events and attributes marked as IDS Signature are exported. Administration is able to maintain a allowedlist containing host, domain name and IP numbers to exclude from the NIDS export.'), ), 'bro' => array( 'extension' => '.intel', 'type' => 'Bro', 'scope' => 'Attribute', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'bro'), 'description' => __('Click this to download all network related attributes that you have access to under the Bro rule format. Only published events and attributes marked as IDS Signature are exported. Administration is able to maintain a allowedlist containing host, domain name and IP numbers to exclude from the NIDS export.'), ), 'stix' => array( 'extension' => '.xml', 'type' => 'STIX', 'scope' => 'Event', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'stix', 'includeAttachments' => 1), 'description' => __('Click this to download a STIX document containing the STIX version of all events and attributes that you have access to.') ), 'stix2' => array( 'extension' => '.json', 'type' => 'STIX2', 'scope' => 'Event', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'stix2', 'includeAttachments' => 1), 'description' => __('Click this to download a STIX2 document containing the STIX2 version of all events and attributes that you have access to.') ), 'rpz' => array( 'extension' => '.txt', 'type' => 'RPZ', 'scope' => 'Attribute', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'rpz'), 'description' => __('Click this to download an RPZ Zone file generated from all ip-src/ip-dst, hostname, domain attributes. This can be useful for DNS level firewalling. Only published events and attributes marked as IDS Signature are exported.') ), 'text' => array( 'extension' => '.txt', 'type' => 'TEXT', 'scope' => 'Attribute', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'text', 'includeAttachments' => 1), 'description' => __('Click on one of the buttons below to download all the attributes with the matching type. This list can be used to feed forensic software when searching for susipicious files. Only published events and attributes marked as IDS Signature are exported.') ), 'yara' => array( 'extension' => '.yara', 'type' => 'Yara', 'scope' => 'Event', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'yara'), 'description' => __('Click this to download Yara rules generated from all relevant attributes.') ), 'yara-json' => array( 'extension' => '.json', 'type' => 'Yara', 'scope' => 'Event', 'requiresPublished' => 1, 'params' => array('returnFormat' => 'yara-json'), 'description' => __('Click this to download Yara rules generated from all relevant attributes. Rules are returned in a JSON format with information about origin (generated or parsed) and validity.') ), ); } public function beforeDelete($cascade = true) { // blocklist the event UUID if the feature is enabled if (Configure::read('MISP.enableEventBlocklisting') !== false && empty($this->skipBlocklist)) { $this->EventBlocklist = ClassRegistry::init('EventBlocklist'); $orgc = $this->Orgc->find('first', array('conditions' => array('Orgc.id' => $this->data['Event']['orgc_id']), 'recursive' => -1, 'fields' => array('Orgc.name'))); $this->EventBlocklist->create(); $this->EventBlocklist->save(array( 'event_uuid' => $this->data['Event']['uuid'], 'event_info' => $this->data['Event']['info'], 'event_orgc' => $orgc['Orgc']['name'], 'comment' => __('Automatically blocked by deleting event'), )); if (!empty($this->data['Event']['id'])) { if (Configure::read('Plugin.ZeroMQ_enable') && Configure::read('Plugin.ZeroMQ_event_notifications_enable')) { $pubSubTool = $this->getPubSubTool(); $pubSubTool->event_save(array('Event' => $this->data['Event']), 'delete'); } if (Configure::read('Plugin.Kafka_enable')) { $kafkaEventTopic = Configure::read('Plugin.Kafka_event_notifications_topic'); if(Configure::read('Plugin.Kafka_event_notifications_enable') && !empty($kafkaEventTopic)) { $kafkaPubTool = $this->getKafkaPubTool(); $kafkaPubTool->publishJson($kafkaEventTopic, array('Event' => $this->data['Event']), 'delete'); } $kafkaPubTopic = Configure::read('Plugin.Kafka_event_publish_notifications_topic'); if (!empty($this->data['Event']['published']) && Configure::read('Plugin.Kafka_event_publish_notifications_enable') && !empty($kafkaPubTopic)) { $hostOrg = $this->Org->find('first', array('conditions' => array('name' => Configure::read('MISP.org')), 'fields' => array('id'))); if (!empty($hostOrg)) { $user = array('org_id' => $hostOrg['Org']['id'], 'Role' => array('perm_sync' => 0, 'perm_audit' => 0, 'perm_site_admin' => 0), 'Organisation' => $hostOrg['Org']); $params = array('eventid' => $this->data['Event']['id']); if (Configure::read('Plugin.Kafka_include_attachments')) { $params['includeAttachments'] = 1; } $fullEvent = $this->fetchEvent($user, $params); if (!empty($fullEvent)) { $kafkaPubTool = $this->getKafkaPubTool(); $kafkaPubTool->publishJson($kafkaPubTopic, $fullEvent[0], 'delete'); } } } } } } // delete all of the event->tag combinations that involve the deleted event $this->EventTag->deleteAll(array('event_id' => $this->id)); try { $this->loadAttachmentTool()->deleteAll($this->id); } catch (Exception $e) { $this->logException('Delete of event file directory failed.', $e); throw new InternalErrorException('Delete of event file directory failed. Please report to administrator.'); } } public function beforeValidate($options = array()) { parent::beforeValidate(); // analysis - setting correct vars if (isset($this->data['Event']['analysis'])) { switch ($this->data['Event']['analysis']) { case 'Initial': $this->data['Event']['analysis'] = 0; break; case 'Ongoing': $this->data['Event']['analysis'] = 1; break; case 'Completed': $this->data['Event']['analysis'] = 2; break; } } else { $this->data['Event']['analysis'] = 0; } if (!isset($this->data['Event']['threat_level_id'])) { $this->data['Event']['threat_level_id'] = Configure::read('MISP.default_event_threat_level') ? Configure::read('MISP.default_event_threat_level') : 4; } // generate UUID if it doesn't exist if (empty($this->data['Event']['uuid'])) { $this->data['Event']['uuid'] = CakeText::uuid(); } else { $this->data['Event']['uuid'] = strtolower($this->data['Event']['uuid'] ); } // Convert event ID to uuid if needed if (!empty($this->data['Event']['extends_uuid']) && is_numeric($this->data['Event']['extends_uuid'])) { $extended_event = $this->find('first', array( 'recursive' => -1, 'conditions' => array('Event.id' => $this->data['Event']['extends_uuid']), 'fields' => array('Event.uuid') )); if (empty($extended_event)) { $this->data['Event']['extends_uuid'] = ''; } else { $this->data['Event']['extends_uuid'] = $extended_event['Event']['uuid']; } } else if (!empty($this->data['Event']['extends_uuid'])) { $this->data['Event']['extends_uuid'] = strtolower($this->data['Event']['extends_uuid']); } // generate timestamp if it doesn't exist if (empty($this->data['Event']['timestamp'])) { $date = new DateTime(); $this->data['Event']['timestamp'] = $date->getTimestamp(); } if (isset($this->data['Event']['publish_timestamp']) && empty($this->data['Event']['publish_timestamp'])) { $this->data['Event']['publish_timestamp'] = 0; } if (empty($this->data['Event']['date'])) { $this->data['Event']['date'] = date('Y-m-d'); } if (!isset($this->data['Event']['distribution']) || $this->data['Event']['distribution'] != 4) { $this->data['Event']['sharing_group_id'] = 0; } } public function afterSave($created, $options = array()) { if (!Configure::read('MISP.completely_disable_correlation') && !$created) { $db = $this->getDataSource(); $updateCorrelation = array(); if (isset($this->data['Event']['date'])) { $updateCorrelation['Correlation.date'] = $db->value($this->data['Event']['date']); } if (isset($this->data['Event']['info'])) { $updateCorrelation['Correlation.info'] = $db->value($this->data['Event']['info']); } if (isset($this->data['Event']['distribution'])) { $updateCorrelation['Correlation.distribution'] = $db->value($this->data['Event']['distribution']); } if (isset($this->data['Event']['sharing_group_id'])) { $updateCorrelation['Correlation.sharing_group_id'] = $db->value($this->data['Event']['sharing_group_id']); } if (!empty($updateCorrelation)) { $this->Correlation = ClassRegistry::init('Correlation'); $this->Correlation->updateAll($updateCorrelation, array('Correlation.event_id' => intval($this->data['Event']['id']))); } } if (empty($this->data['Event']['unpublishAction']) && empty($this->data['Event']['skip_zmq']) && Configure::read('Plugin.ZeroMQ_enable') && Configure::read('Plugin.ZeroMQ_event_notifications_enable')) { $pubSubTool = $this->getPubSubTool(); $event = $this->quickFetchEvent($this->data['Event']['id']); if (!empty($event)) { $pubSubTool->event_save($event, $created ? 'add' : 'edit'); } } if (empty($this->data['Event']['unpublishAction']) && empty($this->data['Event']['skip_kafka'])) { $this->publishKafkaNotification('event', $this->quickFetchEvent($this->data['Event']['id']), $created ? 'add' : 'edit'); } } public function attachTagsToEvents(array $events) { $tagsToFetch = array(); foreach ($events as $event) { if (!empty($event['EventTag'])) { foreach ($event['EventTag'] as $et) { $tagsToFetch[$et['tag_id']] = $et['tag_id']; } } } $tags = $this->EventTag->Tag->find('all', array( 'conditions' => array('Tag.id' => $tagsToFetch), 'recursive' => -1, 'order' => false )); $tags = array_column(array_column($tags, 'Tag'), null, 'id'); foreach ($events as $k => $event) { if (!empty($event['EventTag'])) { foreach ($event['EventTag'] as $k2 => $et) { $events[$k]['EventTag'][$k2]['Tag'] = $tags[$et['tag_id']]; } } } return $events; } // gets the logged in user + an array of events, attaches the correlation count to each public function attachCorrelationCountToEvents($user, $events) { $sgids = $this->SharingGroup->fetchAllAuthorised($user); if (!isset($sgids) || empty($sgids)) { $sgids = array(-1); } $this->Correlation = ClassRegistry::init('Correlation'); $eventIds = array_column(array_column($events, 'Event'), 'id'); $conditionsCorrelation = $this->__buildEventConditionsCorrelation($user, $eventIds, $sgids); $correlations = $this->Correlation->find('all', array( 'fields' => array('Correlation.1_event_id', 'count(distinct(Correlation.event_id)) as count'), 'conditions' => $conditionsCorrelation, 'recursive' => -1, 'group' => array('Correlation.1_event_id'), )); $correlations = Hash::combine($correlations, '{n}.Correlation.1_event_id', '{n}.0.count'); foreach ($events as &$event) { $event['Event']['correlation_count'] = isset($correlations[$event['Event']['id']]) ? $correlations[$event['Event']['id']] : 0; } return $events; } public function attachSightingsCountToEvents($user, $events) { $eventIds = array_column(array_column($events, 'Event'), 'id'); $this->Sighting = ClassRegistry::init('Sighting'); $sightings = $this->Sighting->find('all', array( 'fields' => array('Sighting.event_id', 'count(distinct(Sighting.id)) as count'), 'conditions' => array('event_id' => $eventIds), 'recursive' => -1, 'group' => array('event_id') )); $sightings = Hash::combine($sightings, '{n}.Sighting.event_id', '{n}.0.count'); foreach ($events as $key => $event) { $events[$key]['Event']['sightings_count'] = isset($sightings[$event['Event']['id']]) ? $sightings[$event['Event']['id']] : 0; } return $events; } public function attachProposalsCountToEvents($user, $events) { $eventIds = array_column(array_column($events, 'Event'), 'id'); $proposals = $this->ShadowAttribute->find('all', array( 'fields' => array('ShadowAttribute.event_id', 'count(distinct(ShadowAttribute.id)) as count'), 'conditions' => array('event_id' => $eventIds, 'deleted' => 0), 'recursive' => -1, 'group' => array('event_id') )); $proposals = Hash::combine($proposals, '{n}.ShadowAttribute.event_id', '{n}.0.count'); foreach ($events as $key => $event) { $events[$key]['Event']['proposals_count'] = isset($proposals[$event['Event']['id']]) ? $proposals[$event['Event']['id']] : 0; } return $events; } public function attachDiscussionsCountToEvents($user, $events) { $eventIds = array_column(array_column($events, 'Event'), 'id'); $this->Thread = ClassRegistry::init('Thread'); $threads = $this->Thread->find('list', array( 'conditions' => array('Thread.event_id' => $eventIds), 'fields' => array('Thread.event_id', 'Thread.id') )); $posts = $this->Thread->Post->find('all', array( 'conditions' => array('Post.thread_id' => $threads), 'recursive' => -1, 'fields' => array('Count(id) AS post_count', 'thread_id', 'max(date_modified) as last_post'), 'group' => array('Post.thread_id') )); $event_threads = array(); foreach ($posts as $k => $v) { foreach ($threads as $k2 => $v2) { if ($v2 == $v['Post']['thread_id']) { $event_threads[$k2] = array( 'post_count' => $v[0]['post_count'], 'last_post' => strtotime($v[0]['last_post']) ); } } } foreach ($events as $k => $v) { $events[$k]['Event']['post_count'] = !empty($event_threads[$events[$k]['Event']['id']]) ? $event_threads[$events[$k]['Event']['id']]['post_count'] : 0; $events[$k]['Event']['last_post'] = !empty($event_threads[$events[$k]['Event']['id']]) ? $event_threads[$events[$k]['Event']['id']]['last_post'] : 0; } return $events; } private function __buildEventConditionsCorrelation($user, $eventIds, $sgids) { if (!is_array($eventIds)) { $eventIds = array($eventIds); } if (!$user['Role']['perm_site_admin']) { $conditionsCorrelation = array( 'AND' => array( 'Correlation.1_event_id' => $eventIds, array( 'OR' => array( 'Correlation.org_id' => $user['org_id'], 'AND' => array( array( 'OR' => array( array( 'AND' => array( 'Correlation.distribution >' => 0, 'Correlation.distribution <' => 4, ), ), array( 'AND' => array( 'Correlation.distribution' => 4, 'Correlation.sharing_group_id' => $sgids ), ), ), ), array( 'OR' => array( 'Correlation.a_distribution' => 5, array( 'AND' => array( 'Correlation.a_distribution >' => 0, 'Correlation.a_distribution <' => 4, ), ), array( 'AND' => array( 'Correlation.a_distribution' => 4, 'Correlation.a_sharing_group_id' => $sgids ), ), ), ), ), ), ), ), ); } else { $conditionsCorrelation = array('Correlation.1_event_id' => $eventIds); } return $conditionsCorrelation; } private function getRelatedEvents($user, $eventId, $sgids) { if (!isset($sgids) || empty($sgids)) { $sgids = array(-1); } $this->Correlation = ClassRegistry::init('Correlation'); // search the correlation table for the event ids of the related events // Rules: // 1. Event is owned by the user (org_id matches) // 2. User is allowed to see both the event and the org: // a. Event: // i. Event has a distribution between 1-3 (community only, connected communities, all orgs) // ii. Event has a sharing group that the user is accessible to view // b. Attribute: // i. Attribute has a distribution of 5 (inheritance of the event, for this the event check has to pass anyway) // ii. Atttibute has a distribution between 1-3 (community only, connected communities, all orgs) // iii. Attribute has a sharing group that the user is accessible to view $conditionsCorrelation = $this->__buildEventConditionsCorrelation($user, $eventId, $sgids); $relatedEventIds = $this->Correlation->find('column', array( 'fields' => array('Correlation.event_id'), 'conditions' => $conditionsCorrelation, 'unique' => true, )); if (empty($relatedEventIds)) { return []; } // now look up the event data for these attributes $conditions = $this->createEventConditions($user); $conditions['AND'][] = array('Event.id' => $relatedEventIds); $fields = array('id', 'date', 'threat_level_id', 'info', 'published', 'uuid', 'analysis', 'timestamp', 'distribution', 'org_id', 'orgc_id'); $orgfields = array('id', 'name', 'uuid'); $relatedEvents = $this->find( 'all', array('conditions' => $conditions, 'recursive' => -1, 'order' => 'Event.date DESC', 'fields' => $fields, 'contain' => array( 'Org' => array( 'fields' => $orgfields ), 'Orgc' => array( 'fields' => $orgfields ) ) ) ); $fieldsToRearrange = array('Org', 'Orgc'); foreach ($relatedEvents as $k => $relatedEvent) { foreach ($fieldsToRearrange as $field) { if (isset($relatedEvent[$field])) { $relatedEvents[$k]['Event'][$field] = $relatedEvent[$field]; unset($relatedEvents[$k][$field]); } } } return $relatedEvents; } public function getRelatedAttributes($user, $id, $sgids, $shadowAttribute = false, $scope = 'event') { if ($shadowAttribute) { $settings = array('model' => 'ShadowAttribute', 'correlationModel' => 'ShadowAttributeCorrelation', 'parentIdField' => '1_shadow_attribute_id'); } else { $settings = array('model' => 'Attribute', 'correlationModel' => 'Correlation', 'parentIdField' => '1_attribute_id'); } if (!isset($sgids) || empty($sgids)) { $sgids = array(-1); } $this->{$settings['correlationModel']} = ClassRegistry::init($settings['correlationModel']); if (!$user['Role']['perm_site_admin']) { $conditionsCorrelation = array( 'AND' => array( $settings['correlationModel'] . '.1_' . $scope . '_id' => $id, array( 'OR' => array( $settings['correlationModel'] . '.org_id' => $user['org_id'], 'AND' => array( array( 'OR' => array( array( 'AND' => array( $settings['correlationModel'] . '.distribution >' => 0, $settings['correlationModel'] . '.distribution <' => 4, ), ), array( 'AND' => array( $settings['correlationModel'] . '.distribution' => 4, $settings['correlationModel'] . '.sharing_group_id' => $sgids ), ), ), ), array( 'OR' => array( $settings['correlationModel'] . '.a_distribution' => 5, array( 'AND' => array( $settings['correlationModel'] . '.a_distribution >' => 0, $settings['correlationModel'] . '.a_distribution <' => 4, ), ), array( 'AND' => array( $settings['correlationModel'] . '.a_distribution' => 4, $settings['correlationModel'] . '.a_sharing_group_id' => $sgids ), ), ), ), ), ) ) ) ); } else { $conditionsCorrelation = array($settings['correlationModel'] . '.1_' . $scope . '_id' => $id); } $max_correlations = Configure::read('MISP.max_correlations_per_event') ?: 5000; $correlations = $this->{$settings['correlationModel']}->find('all', array( 'fields' => ['event_id', 'attribute_id', 'value', $settings['parentIdField']], 'conditions' => $conditionsCorrelation, 'recursive' => -1, 'order' => false, 'limit' => $max_correlations )); if (empty($correlations)) { return array(); } $eventIds = []; foreach ($correlations as $correlation) { $eventIds[] = $correlation[$settings['correlationModel']]['event_id']; } $conditions = $this->createEventConditions($user); $conditions['AND']['Event.id'] = array_unique($eventIds); $events = $this->find('all', array( 'recursive' => -1, 'conditions' => $conditions, 'fields' => array('Event.id', 'Event.orgc_id', 'Event.info', 'Event.date'), )); $eventInfos = array(); foreach ($events as $event) { $eventInfos[$event['Event']['id']] = $event['Event']; } $relatedAttributes = array(); foreach ($correlations as $correlation) { $correlation = $correlation[$settings['correlationModel']]; // User don't have access to correlated attribute event, skip. if (!isset($eventInfos[$correlation['event_id']])) { continue; } $eventInfo = $eventInfos[$correlation['event_id']]; $current = array( 'id' => $correlation['event_id'], 'attribute_id' => $correlation['attribute_id'], 'value' => $correlation['value'], 'org_id' => $eventInfo['orgc_id'], 'info' => $eventInfo['info'], 'date' => $eventInfo['date'], ); $parentId = $correlation[$settings['parentIdField']]; $relatedAttributes[$parentId][] = $current; } return $relatedAttributes; } /** * Clean up an Event Array that was received by an XML request. * The structure needs to be changed a little bit to be compatible with what CakePHP expects * * This function receives the reference of the variable, so no return is required as it directly * modifies the original data. */ public function cleanupEventArrayFromXML(&$data) { $objects = array('Attribute', 'ShadowAttribute', 'Object'); foreach ($objects as $object) { // Workaround for different structure in XML/array than what CakePHP expects if (isset($data['Event'][$object]) && is_array($data['Event'][$object]) && count($data['Event'][$object])) { if (!is_numeric(implode(array_keys($data['Event'][$object]), ''))) { // single attribute $data['Event'][$object] = array(0 => $data['Event'][$object]); } $data['Event'][$object] = array_values($data['Event'][$object]); } } $objects = array('Org', 'Orgc', 'SharingGroup'); foreach ($objects as $object) { if (isset($data['Event'][$object][0])) { $data['Event'][$object] = $data['Event'][$object][0]; } } return $data; } private function __resolveErrorCode($code, &$event, &$server) { $error = false; switch ($code) { case 403: return 'The distribution level of this event blocks it from being pushed.'; case 405: $error = 'The sync user on the remote instance does not have the required privileges to handle this event.'; break; } if ($error) { $newTextBody = 'Uploading Event (' . $event['Event']['id'] . ') to Server (' . $server['Server']['id'] . ')'; $this->__logUploadResult($server, $event, $newTextBody); } return $error; } private function __executeRestfulEventToServer($event, $server, $resourceId, &$newLocation, &$newTextBody, $HttpSocket, $scope) { $result = $this->restfulEventToServer($event, $server, $resourceId, $newLocation, $newTextBody, $HttpSocket, $scope); if (is_numeric($result)) { $error = $this->__resolveErrorCode($result, $event, $server); if ($error) { return $error . ' Error code: ' . $result; } } return true; } public function uploadSightingsToServer($sightings, $server, $event_uuid, $HttpSocket = null) { $HttpSocket = $this->setupHttpSocket($server, $HttpSocket); $request = $this->setupSyncRequest($server); $uri = $server['Server']['url'] . '/sightings/bulkSaveSightings/' . $event_uuid; foreach ($sightings as &$sighting) { if (!isset($sighting['org_id'])) { $sighting['org_id'] = '0'; } } $data = json_encode($sightings); if (!empty(Configure::read('Security.sync_audit'))) { $pushLogEntry = sprintf( "==============================================================\n\n[%s] Pushing Sightings for Event #%s to Server #%d:\n\n%s\n\n", date("Y-m-d H:i:s"), $event_uuid, $server['Server']['id'], $data ); file_put_contents(APP . 'files/scripts/tmp/debug_server_' . $server['Server']['id'] . '.log', $pushLogEntry, FILE_APPEND); } $response = $HttpSocket->post($uri, $data, $request); return $this->__handleRestfulEventToServerResponse($response, $newLocation, $newTextBody); } public function uploadEventToServer($event, $server, $HttpSocket = null, $scope = 'events') { $this->Server = ClassRegistry::init('Server'); $push = $this->Server->checkVersionCompatibility($server, false, $HttpSocket); if ($scope === 'events' && empty($push['canPush'])) { return 'The remote user is not a sync user - the upload of the event has been blocked.'; } elseif ($scope === 'sightings' && empty($push['canPush']) && empty($push['canSight'])) { return 'The remote user is not a sightings user - the upload of the sightings has been blocked.'; } if (!empty($server['Server']['unpublish_event'])) { $event['Event']['published'] = 0; } $updated = null; $newLocation = $newTextBody = ''; $result = $this->__executeRestfulEventToServer($event, $server, null, $newLocation, $newTextBody, $HttpSocket, $scope); if ($result !== true) { return $result; } if (strlen($newLocation)) { // HTTP/1.1 302 Found and Location: http:// $result = $this->__executeRestfulEventToServer($event, $server, $newLocation, $newLocation, $newTextBody, $HttpSocket, $scope); if ($result !== true) { return $result; } } try { $this->jsonDecode($newTextBody); } catch (Exception $e) { $this->logException("Invalid JSON returned when pushing to remote server {$server['Server']['id']}", $e); return $this->__logUploadResult($server, $event, $newTextBody); } return 'Success'; } private function __prepareForPushToServer($event, $server) { if ($event['Event']['distribution'] == 4) { if (!empty($event['SharingGroup']['SharingGroupServer'])) { $found = false; foreach ($event['SharingGroup']['SharingGroupServer'] as $sgs) { if ($sgs['server_id'] == $server['Server']['id']) { $found = true; } } if (!$found) { return 403; } } else if (empty($event['SharingGroup']['roaming'])) { return 403; } } $serverModel = ClassRegistry::init('Server'); $server = $serverModel->eventFilterPushableServers($event, array($server)); if (empty($server)) { return 403; } $server = $server[0]; if ($this->checkDistributionForPush($event, $server, 'Event')) { $event = $this->__updateEventForSync($event, $server); } else { return 403; } return $event; } private function __getLastUrlPathComponent($urlPath) { if (!empty($urlPath)) { $pieces = explode('/', $urlPath); return '/' . end($pieces); } return ''; } private function __handleRestfulEventToServerResponse($response, &$newLocation, &$newTextBody) { switch ($response->code) { case '200': // 200 (OK) + entity-action-result $newTextBody = $response->body(); return true; case '302': // Found $newLocation = $response->headers['Location']; $newTextBody = $response->body(); return true; case '404': // Not Found $newLocation = $response->headers['Location']; $newTextBody = $response->body(); return 404; case '405': $newTextBody = $response->body(); return 405; case '403': // Not authorised $newTextBody = $response->body(); return 403; } } // Uploads the event and the associated Attributes to another Server public function restfulEventToServer($event, $server, $urlPath, &$newLocation, &$newTextBody, $HttpSocket = null, $scope) { $event = $this->__prepareForPushToServer($event, $server); if (is_numeric($event)) { return $event; } $HttpSocket = $this->setupHttpSocket($server, $HttpSocket); $request = $this->setupSyncRequest($server); if ($scope === 'sightings') { $scope .= '/bulkSaveSightings'; $urlPath = $event['Event']['uuid']; } $url = $server['Server']['url']; $uri = $url . '/' . $scope . $this->__getLastUrlPathComponent($urlPath); if ($scope === 'event') { // After creating or editing event, it is not necessary to fetch full event $uri .= '/metadata:1'; } $data = json_encode($event); if (!empty(Configure::read('Security.sync_audit'))) { $pushLogEntry = sprintf( "==============================================================\n\n[%s] Pushing Event #%d to Server #%d:\n\n%s\n\n", date("Y-m-d H:i:s"), $event['Event']['id'], $server['Server']['id'], $data ); file_put_contents(APP . 'files/scripts/tmp/debug_server_' . $server['Server']['id'] . '.log', $pushLogEntry, FILE_APPEND); } $response = $HttpSocket->post($uri, $data, $request); return $this->__handleRestfulEventToServerResponse($response, $newLocation, $newTextBody); } private function __rearrangeEventStructureForSync($event) { // rearrange things to be compatible with the Xml::fromArray() $objectsToRearrange = array('Attribute', 'Object', 'Orgc', 'SharingGroup', 'EventTag', 'Org', 'ShadowAttribute', 'EventReport'); foreach ($objectsToRearrange as $o) { if (isset($event[$o])) { $event['Event'][$o] = $event[$o]; unset($event[$o]); } } // cleanup the array from things we do not want to expose foreach (array('Org', 'org_id', 'orgc_id', 'proposal_email_lock', 'org', 'orgc') as $field) { unset($event['Event'][$field]); } return $event; } // since we fetch the event and filter on tags after / server, we need to cull all of the non exportable tags public function __removeNonExportableTags($data, $dataType, $server = []) { if (isset($data[$dataType . 'Tag'])) { if (!empty($data[$dataType . 'Tag'])) { foreach ($data[$dataType . 'Tag'] as $k => $tag) { if (!$tag['Tag']['exportable'] || (!empty($tag['local']) && empty($server['Server']['internal']))) { unset($data[$dataType . 'Tag'][$k]); } else { unset($tag['org_id']); $data['Tag'][] = $tag['Tag']; } } } unset($data[$dataType . 'Tag']); } return $data; } private function __prepareAttributesForSync($data, $server) { // prepare attribute for sync if (!empty($data['Attribute'])) { foreach ($data['Attribute'] as $key => $attribute) { $data['Attribute'][$key] = $this->__updateAttributeForSync($attribute, $server); if (empty($data['Attribute'][$key])) { unset($data['Attribute'][$key]); } else { $data['Attribute'][$key] = $this->__removeNonExportableTags($data['Attribute'][$key], 'Attribute', $server); } } $data['Attribute'] = array_values($data['Attribute']); } return $data; } private function __prepareObjectsForSync($data, $server) { // prepare Object for sync if (!empty($data['Object'])) { foreach ($data['Object'] as $key => $object) { $data['Object'][$key] = $this->__updateObjectForSync($object, $server); if (empty($data['Object'][$key])) { unset($data['Object'][$key]); } else { $data['Object'][$key] = $this->__prepareAttributesForSync($data['Object'][$key], $server); } } $data['Object'] = array_values($data['Object']); } return $data; } private function __prepareEventReportForSync($data, $server) { if (!empty($data['EventReport'])) { foreach ($data['EventReport'] as $key => $report) { $data['EventReport'][$key] = $this->__updateEventReportForSync($report, $server); if (empty($data['EventReport'][$key])) { unset($data['EventReport'][$key]); } } $data['EventReport'] = array_values($data['EventReport']); } if (isset($data['EventReport']) && empty($data['EventReport'])) { unset($data['EventReport']); } return $data; } private function __updateEventForSync($event, $server) { $event = $this->__rearrangeEventStructureForSync($event); $event['Event'] = $this->__removeNonExportableTags($event['Event'], 'Event', $server); // Add the local server to the list of instances in the SG if (isset($event['Event']['SharingGroup']) && isset($event['Event']['SharingGroup']['SharingGroupServer'])) { foreach ($event['Event']['SharingGroup']['SharingGroupServer'] as &$s) { if ($s['server_id'] == 0) { $s['Server'] = array( 'id' => 0, 'url' => $this->__getAnnounceBaseurl(), 'name' => $this->__getAnnounceBaseurl() ); } } } $event['Event'] = $this->__prepareAttributesForSync($event['Event'], $server); $event['Event'] = $this->__prepareObjectsForSync($event['Event'], $server); $event['Event'] = $this->__prepareEventReportForSync($event['Event'], $server); // Downgrade the event from connected communities to community only if (!$server['Server']['internal'] && $event['Event']['distribution'] == 2) { $event['Event']['distribution'] = 1; } return $event; } private function __updateObjectForSync($object, $server) { if (!$server['Server']['internal'] && $object['distribution'] < 2) { return false; } // Downgrade the object from connected communities to community only if (!$server['Server']['internal'] && $object['distribution'] == 2) { $object['distribution'] = 1; } // If the object has a sharing group attached, make sure it can be transferred if ($object['distribution'] == 4) { if (!$server['Server']['internal'] && $this->checkDistributionForPush(array('Object' => $object), $server, 'Object') === false) { return false; } // Add the local server to the list of instances in the SG if (isset($object['SharingGroup']['SharingGroupServer'])) { foreach ($object['SharingGroup']['SharingGroupServer'] as &$s) { if ($s['server_id'] == 0) { $s['Server'] = array( 'id' => 0, 'url' => $this->__getAnnounceBaseurl(), 'name' => $this->__getAnnounceBaseurl() ); } } } } return $object; } public function __getAnnounceBaseurl() { $baseurl = ''; if (!empty(Configure::read('MISP.external_baseurl'))) { $baseurl = Configure::read('MISP.external_baseurl'); } else if (!empty(Configure::read('MISP.baseurl'))) { $baseurl = Configure::read('MISP.baseurl'); } return $baseurl; } private function __updateAttributeForSync($attribute, $server) { // do not keep attributes that are private, nor cluster if (!$server['Server']['internal'] && $attribute['distribution'] < 2) { return false; } // Downgrade the attribute from connected communities to community only if (!$server['Server']['internal'] && $attribute['distribution'] == 2) { $attribute['distribution'] = 1; } // If the attribute has a sharing group attached, make sure it can be transferred if ($attribute['distribution'] == 4) { if (!$server['Server']['internal'] && $this->checkDistributionForPush(array('Attribute' => $attribute), $server, 'Attribute') === false) { return false; } // Add the local server to the list of instances in the SG if (!empty($attribute['SharingGroup']['SharingGroupServer'])) { foreach ($attribute['SharingGroup']['SharingGroupServer'] as &$s) { if ($s['server_id'] == 0) { $s['Server'] = array( 'id' => 0, 'url' => $this->__getAnnounceBaseurl(), 'name' => $this->__getAnnounceBaseurl() ); } } } } // also add the encoded attachment if ($this->Attribute->typeIsAttachment($attribute['type'])) { $attribute['data'] = $this->Attribute->base64EncodeAttachment($attribute); } // Passing the attribute ID together with the attribute could cause the deletion of attributes after a publish/push // Basically, if the attribute count differed between two instances, and the instance with the lower attribute // count pushed, the old attributes with the same ID got overwritten. Unsetting the ID before pushing it // solves the issue and a new attribute is always created. unset($attribute['id']); // remove value1 and value2 from the output unset($attribute['value1']); unset($attribute['value2']); return $attribute; } private function __updateEventReportForSync($report, $server) { if (!$server['Server']['internal'] && $report['distribution'] < 2) { return false; } // check if remote version support event reports $eventReportSupportedByRemote = false; $uri = $server['Server']['url'] . '/eventReports/add'; $HttpSocket = $this->setupHttpSocket($server, null); $request = $this->setupSyncRequest($server); try { $response = $HttpSocket->get($uri, false, $request); if ($response->isOk()) { $apiDescription = json_decode($response->body, true); $eventReportSupportedByRemote = !empty($apiDescription['description']); } } catch (Exception $e) { $this->Log = ClassRegistry::init('Log'); $message = __('Remote version does not support event report.'); $this->Log->createLogEntry('SYSTEM', $action, 'Server', $id, $message); } if (!$eventReportSupportedByRemote) { return []; } // Downgrade the object from connected communities to community only if (!$server['Server']['internal'] && $report['distribution'] == 2) { $report['distribution'] = 1; } // If the object has a sharing group attached, make sure it can be transferred if ($report['distribution'] == 4) { if (!$server['Server']['internal'] && $this->checkDistributionForPush(array('EventReport' => $report), $server, 'EventReport') === false) { return false; } // Add the local server to the list of instances in the SG if (isset($object['SharingGroup']['SharingGroupServer'])) { foreach ($object['SharingGroup']['SharingGroupServer'] as &$s) { if ($s['server_id'] == 0) { $s['Server'] = array( 'id' => 0, 'url' => $this->__getAnnounceBaseurl(), 'name' => $this->__getAnnounceBaseurl() ); } } } } return $report; } /** * Download event from remote server. * * @param int $eventId * @param array $server * @param null|HttpSocket $HttpSocket * @param boolean $metadataOnly, if True, we only retrieve the metadata, without attributes and attachments which is much faster * @return array * @throws Exception */ public function downloadEventFromServer($eventId, $server, HttpSocket $HttpSocket=null, $metadataOnly=false) { $url = $server['Server']['url']; $HttpSocket = $this->setupHttpSocket($server, $HttpSocket); $request = $this->setupSyncRequest($server); if ($metadataOnly) { $uri = $url . '/events/index'; $data = json_encode(['eventid' => $eventId]); $response = $HttpSocket->post($uri, $data, $request); } else { $uri = $url . '/events/view/' . $eventId . '/deleted[]:0/deleted[]:1/excludeGalaxy:1'; if (empty($server['Server']['internal'])) { $uri = $uri . '/excludeLocalTags:1'; } $response = $HttpSocket->get($uri, [], $request); } if (!$response->isOk()) { throw new Exception("Fetching the '$uri' failed with HTTP error {$response->code}: {$response->reasonPhrase}"); } return $this->jsonDecode($response->body); } public function quickDelete($event) { $id = $event['Event']['id']; $this->Thread = ClassRegistry::init('Thread'); $thread = $this->Thread->find('first', array( 'conditions' => array('Thread.event_id' => $id), 'fields' => array('Thread.id'), 'recursive' => -1 )); $thread_id = !empty($thread) ? $thread['Thread']['id'] : false; $relations = array( array( 'table' => 'attributes', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'shadow_attributes', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'event_tags', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'attribute_tags', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'threads', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'sightings', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'event_delegations', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'objects', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'object_references', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'event_reports', 'foreign_key' => 'event_id', 'value' => $id ) ); if ($thread_id) { $relations[] = array( 'table' => 'posts', 'foreign_key' => 'thread_id', 'value' => $thread_id ); } if (!Configure::read('MISP.completely_disable_correlation')) { array_push( $relations, array( 'table' => 'correlations', 'foreign_key' => 'event_id', 'value' => $id ), array( 'table' => 'correlations', 'foreign_key' => '1_event_id', 'value' => $id ) ); } App::uses('QueryTool', 'Tools'); $queryTool = new QueryTool(); foreach ($relations as $relation) { $queryTool->quickDelete($relation['table'], $relation['foreign_key'], $relation['value'], $this); } return $this->delete($id, false); } public function createEventConditions($user) { $conditions = array(); if (!$user['Role']['perm_site_admin']) { $sgids = $this->cacheSgids($user, true); $unpublishedPrivate = Configure::read('MISP.unpublishedprivate'); $conditions['AND']['OR'] = array( 'Event.org_id' => $user['org_id'], array( 'AND' => array( 'Event.distribution >' => 0, 'Event.distribution <' => 4, $unpublishedPrivate ? array('Event.published' => 1) : array(), ), ), array( 'AND' => array( 'Event.sharing_group_id' => $sgids, 'Event.distribution' => 4, $unpublishedPrivate ? array('Event.published' => 1) : array(), ) ) ); } return $conditions; } public function set_filter_wildcard(&$params, $conditions, $options) { $tempConditions = array(); $tempConditions[] = array('Event.info LIKE' => $params['wildcard']); $attributeParams = array('value1', 'value2', 'comment'); foreach ($attributeParams as $attributeParam) { $subQueryOptions = array( 'conditions' => array('Attribute.' . $attributeParam . ' LIKE' => $params['wildcard']), 'fields' => array('event_id') ); $tempConditions[] = $this->subQueryGenerator($this->Attribute, $subQueryOptions, 'Event.id'); } $tagScopes = array('Event', 'Attribute'); $this->AttributeTag = ClassRegistry::init('AttributeTag'); $tagIds = $this->AttributeTag->Tag->find('list', array( 'recursive' => -1, 'conditions' => array('Tag.name LIKE' => $params['wildcard']), 'fields' => array('Tag.id') )); if (!empty($tagIds)) { foreach ($tagScopes as $tagScope) { $subQueryOptions = array( 'conditions' => array( 'tag_id' => $tagIds, ), 'fields' => array('event_id') ); $tempConditions[] = $this->subQueryGenerator($this->{$tagScope . 'Tag'}, $subQueryOptions, 'Event.id'); } } return $tempConditions; } public function set_filter_wildcard_attributes(&$params, $conditions, $options) { $tempConditions = array(); $tempConditions[] = array('Event.info LIKE' => $params['wildcard']); $attributeParams = array('value1', 'value2', 'comment'); foreach ($attributeParams as $attributeParam) { $tempConditions[] = array('Attribute.' . $attributeParam . ' LIKE' => $params['wildcard']); } $tagScopes = array('Event', 'Attribute'); $this->AttributeTag = ClassRegistry::init('AttributeTag'); $tagIds = $this->AttributeTag->Tag->find('list', array( 'recursive' => -1, 'conditions' => array('Tag.name LIKE' => $params['wildcard']), 'fields' => array('Tag.id') )); if (!empty($tagIds)) { $subQueryOptions = array( 'conditions' => array( 'tag_id' => $tagIds, ), 'fields' => array('event_id') ); $tempConditions[] = $this->subQueryGenerator($this->EventTag, $subQueryOptions, 'Attribute.event_id'); $subQueryOptions = array( 'conditions' => array( 'tag_id' => $tagIds, ), 'fields' => array('attribute_id') ); $tempConditions[] = $this->subQueryGenerator($this->AttributeTag, $subQueryOptions, 'Attribute.id'); } return $tempConditions; } /** * @param array $user * @param array $params * @param int $result_count * @return array Event IDs, when `include_attribute_count` is enabled, then it is Event ID => Attribute count */ public function filterEventIds($user, &$params = array(), &$result_count = 0) { $conditions = $this->createEventConditions($user); if (isset($params['wildcard'])) { $temp = array(); $options = array( 'filter' => 'wildcard', 'scope' => 'Event', 'pop' => false, 'context' => 'Event' ); $conditions['AND'][] = array('OR' => $this->set_filter_wildcard($params, $temp, $options)); } else { $simple_params = array( 'Event' => array( 'eventid' => array('function' => 'set_filter_eventid', 'pop' => true), 'eventinfo' => array('function' => 'set_filter_eventinfo'), 'ignore' => array('function' => 'set_filter_ignore'), 'tags' => array('function' => 'set_filter_tags'), 'from' => array('function' => 'set_filter_timestamp', 'pop' => true), 'to' => array('function' => 'set_filter_timestamp', 'pop' => true), 'date' => array('function' => 'set_filter_date', 'pop' => true), 'last' => array('function' => 'set_filter_timestamp', 'pop' => true), 'timestamp' => array('function' => 'set_filter_timestamp', 'pop' => true), 'event_timestamp' => array('function' => 'set_filter_timestamp', 'pop' => true), 'publish_timestamp' => array('function' => 'set_filter_timestamp', 'pop' => true), 'org' => array('function' => 'set_filter_org', 'pop' => true), 'uuid' => array('function' => 'set_filter_uuid', 'pop' => true), 'published' => array('function' => 'set_filter_published', 'pop' => true), 'threat_level_id' => array('function' => 'set_filter_threat_level_id', 'pop' => true) ), 'Object' => array( 'object_name' => array('function' => 'set_filter_object_name'), 'object_template_uuid' => array('function' => 'set_filter_object_template_uuid'), 'object_template_version' => array('function' => 'set_filter_object_template_version'), 'deleted' => array('function' => 'set_filter_deleted') ), 'Attribute' => array( 'value' => array('function' => 'set_filter_value'), 'category' => array('function' => 'set_filter_simple_attribute'), 'type' => array('function' => 'set_filter_type'), 'object_relation' => array('function' => 'set_filter_simple_attribute'), 'tags' => array('function' => 'set_filter_tags', 'pop' => true), 'ignore' => array('function' => 'set_filter_ignore'), 'deleted' => array('function' => 'set_filter_deleted'), 'to_ids' => array('function' => 'set_filter_to_ids'), 'comment' => array('function' => 'set_filter_comment') ) ); foreach ($params as $param => $paramData) { foreach ($simple_params as $scope => $simple_param_scoped) { if (isset($simple_param_scoped[$param]) && $params[$param] !== false) { $options = array( 'filter' => $param, 'scope' => $scope, 'pop' => !empty($simple_param_scoped[$param]['pop']), 'context' => 'Event' ); if ($scope === 'Event') { $conditions = $this->{$simple_param_scoped[$param]['function']}($params, $conditions, $options); } else { $temp = array(); $temp = $this->{$simple_param_scoped[$param]['function']}($params, $temp, $options); if (!empty($temp)) { $subQueryOptions = array( 'conditions' => $temp, 'fields' => array( 'event_id' ) ); $subQuery = $this->subQueryGenerator($this->{$scope}, $subQueryOptions, 'Event.id'); if ($param === 'value') { $subQuery[0] = explode('WHERE', $subQuery[0]); $subQuery[0][0] .= ' USE INDEX (value1, value2) '; $subQuery[0] = implode('WHERE', $subQuery[0]); } $conditions['AND'][] = $subQuery; } } } } } } $find_params = array( 'conditions' => $conditions, 'recursive' => -1, ); if (isset($params['order'])) { $find_params['order'] = $params['order']; } if (isset($params['limit'])) { // Get the count (but not the actual data) of results for paginators $result_count = $this->find('count', $find_params); $find_params['limit'] = $params['limit']; if (isset($params['page'])) { $find_params['page'] = $params['page']; } } if (!empty($params['include_attribute_count'])) { $find_params['fields'] = array('Event.id', 'Event.attribute_count'); $results = $this->find('list', $find_params); } else { $find_params['fields'] = array('Event.id'); $results = $this->find('column', $find_params); } if (!isset($params['limit'])) { $result_count = count($results); } return $results; } public function fetchSimpleEventIds($user, $params = array()) { $conditions = $this->createEventConditions($user); $conditions['AND'][] = $params['conditions']; $results = $this->find('column', array( 'conditions' => $conditions, 'fields' => array('Event.id') )); return $results; } /** * @param array $user * @param string|int $id Event ID or UUID * @param array $params * @return array|null */ public function fetchSimpleEvent(array $user, $id, array $params = array()) { $conditions = $this->createEventConditions($user); if (is_numeric($id)) { $conditions['AND'][]['Event.id'] = $id; } else if (Validation::uuid($id)) { $conditions['AND'][]['Event.uuid'] = $id; } else { return null; } if (isset($params['conditions'])) { $conditions['AND'][] = $params['conditions']; } $params['conditions'] = $conditions; $params['recursive'] = -1; return $this->find('first', $params); } /** * @param array $user * @param array $params * @param bool $includeOrgc * @return array */ public function fetchSimpleEvents(array $user, array $params, $includeOrgc = false) { $conditions = $this->createEventConditions($user); $conditions['AND'][] = $params['conditions']; $params = array( 'conditions' => $conditions, 'recursive' => -1 ); if ($includeOrgc) { $params['contain'] = array('Orgc.name'); } return $this->find('all', $params); } public function fetchEventIds($user, $from = false, $to = false, $last = false, $list = false, $timestamp = false, $publish_timestamp = false, $eventIdList = false) { // restricting to non-private or same org if the user is not a site-admin. $conditions = $this->createEventConditions($user); $fields = array('Event.id', 'Event.org_id', 'Event.distribution', 'Event.sharing_group_id'); if ($from) { $conditions['AND'][] = array('Event.date >=' => $from); } if ($to) { $conditions['AND'][] = array('Event.date <=' => $to); } if ($last) { $conditions['AND'][] = array('Event.publish_timestamp >=' => $last); } if ($timestamp) { $conditions['AND'][] = array('Event.timestamp >=' => $timestamp); } if ($publish_timestamp) { $conditions['AND'][] = array('Event.publish_timestamp >=' => $publish_timestamp); } if ($eventIdList) { $conditions['AND'][] = array('Event.id' => $eventIdList); } if ($list) { $params = array( 'conditions' => $conditions, 'fields' => ['Event.id'], ); $results = $this->find('column', $params); } else { $params = array( 'conditions' => $conditions, 'recursive' => -1, 'fields' => $fields, ); $results = $this->find('all', $params); } return $results; } /* * Unlike the other fetchers, this one foregoes any ACL checks. * the objective is simple: Fetch the given event with all related objects needed for the ZMQ output, * standardising on this function for fetching the event to be passed to the pubsub handler */ public function quickFetchEvent($id) { $event = $this->find('first', array( 'recursive' => -1, 'conditions' => array('Event.id' => $id), 'contain' => array( 'Orgc' => array( 'fields' => array('Orgc.id', 'Orgc.uuid', 'Orgc.name') ), 'EventTag' => array( 'Tag' => array('fields' => array('Tag.id', 'Tag.name', 'Tag.colour', 'Tag.exportable')) ) ) )); return $event; } //Once the data about the user is gathered from the appropriate sources, fetchEvent is called from the controller or background process. // Possible options: // eventid: single event ID // idList: array with event IDs // tags: string with the usual tag syntax // from: date string (YYYY-MM-DD) // to: date string (YYYY-MM-DD) // includeAllTags: true will include the tags that are marked as non-exportable // includeAttachments: true will attach the attachments to the attributes in the data field public function fetchEvent($user, $options = array(), $useCache = false) { if (isset($options['Event.id'])) { $options['eventid'] = $options['Event.id']; } $possibleOptions = array( 'eventid', 'idList', 'tags', 'from', 'to', 'last', 'to_ids', 'includeAllTags', // include also non exportable tags, default `false` 'includeAttachments', 'event_uuid', 'distribution', 'sharing_group_id', 'disableSiteAdmin', 'metadata', 'enforceWarninglist', // return just attributes that contains no warnings 'sgReferenceOnly', 'flatten', 'blockedAttributeTags', 'eventsExtendingUuid', 'extended', 'excludeGalaxy', 'includeCustomGalaxyCluster', // not used 'includeRelatedTags', 'excludeLocalTags', 'includeDecayScore', 'includeSightingdb', 'includeFeedCorrelations', 'includeServerCorrelations', 'includeWarninglistHits', 'noEventReports', // do not include event report in event data 'noShadowAttributes', // do not fetch proposals, 'limit', 'page', 'order' ); if (!isset($options['excludeLocalTags']) && !empty($user['Role']['perm_sync']) && empty($user['Role']['perm_site_admin'])) { $options['excludeLocalTags'] = 1; } if (!isset($options['includeEventCorrelations'])) { $options['includeEventCorrelations'] = true; } if (!isset($options['fetchFullClusters'])) { $options['fetchFullClusters'] = true; } foreach ($possibleOptions as $opt) { if (!isset($options[$opt])) { $options[$opt] = false; } } $conditions = $this->createEventConditions($user); if ($options['eventid']) { $conditions['AND'][] = array("Event.id" => $options['eventid']); } if ($options['eventsExtendingUuid']) { if (!is_array($options['eventsExtendingUuid'])) { $options['eventsExtendingUuid'] = array($options['eventsExtendingUuid']); } foreach ($options['eventsExtendingUuid'] as $extendedEvent) { $extendedUuids = array(); if (!Validation::uuid($extendedEvent)) { $eventUuid = $this->find('first', array( 'recursive' => -1, 'conditions' => array('Event.id' => $extendedEvent), 'fields' => array('Event.uuid') )); if (!empty($eventUuid)) { $extendedUuids[] = $eventUuid['Event']['uuid']; } } else { $extendedUuids[] = $extendedEvent; } } if (!empty($extendedUuids)) { $conditions['AND'][] = array('Event.extends_uuid' => $extendedUuids); } else { // We've set as a search pattern any event that extends an event and didn't find anything // valid, make sure we don't get everything thrown in our face that the user can see. $conditions['AND'][] = array('Event.id' => -1); } } if (!isset($user['org_id'])) { throw new Exception('There was an error with the user account.'); } $isSiteAdmin = $user['Role']['perm_site_admin']; if (isset($options['disableSiteAdmin']) && $options['disableSiteAdmin']) { $isSiteAdmin = false; } $conditionsAttributes = array(); $conditionsObjects = array(); $conditionsEventReport = array(); if ($options['flatten']) { $flatten = true; } else { $flatten = false; } $sgids = $this->cacheSgids($user, $useCache); // restricting to non-private or same org if the user is not a site-admin. if (!$isSiteAdmin) { // if delegations are enabled, check if there is an event that the current user might see because of the request itself if (Configure::read('MISP.delegation')) { $delegatedEventIDs = $this->__cachedelegatedEventIDs($user, $useCache); $conditions['AND']['OR']['Event.id'] = $delegatedEventIDs; } $attributeCondSelect = '(SELECT events.org_id FROM events WHERE events.id = Attribute.event_id)'; $objectCondSelect = '(SELECT events.org_id FROM events WHERE events.id = Object.event_id)'; $eventReportCondSelect = '(SELECT events.org_id FROM events WHERE events.id = EventReport.event_id)'; if ($this->getDataSource()->config['datasource'] == 'Database/Postgres') { $schemaName = $this->getDataSource()->config['schema']; $attributeCondSelect = sprintf('(SELECT "%s"."events"."org_id" FROM "%s"."events" WHERE "%s"."events"."id" = "Attribute"."event_id")', $schemaName, $schemaName, $schemaName); $objectCondSelect = sprintf('(SELECT "%s"."events"."org_id" FROM "%s"."events" WHERE "%s"."events"."id" = "Object"."event_id")', $schemaName, $schemaName, $schemaName); $eventReportCondSelect = sprintf('(SELECT "%s"."events"."org_id" FROM "%s"."events" WHERE "%s"."events"."id" = "EventReport"."event_id")', $schemaName, $schemaName, $schemaName); } $conditionsAttributes['AND'][0]['OR'] = array( array('AND' => array( 'Attribute.distribution >' => 0, 'Attribute.distribution !=' => 4, )), array('AND' => array( 'Attribute.distribution' => 4, 'Attribute.sharing_group_id' => $sgids, )), $attributeCondSelect => $user['org_id'] ); $conditionsObjects['AND'][0]['OR'] = array( array('AND' => array( 'Object.distribution >' => 0, 'Object.distribution !=' => 4, )), array('AND' => array( 'Object.distribution' => 4, 'Object.sharing_group_id' => $sgids, )), $objectCondSelect => $user['org_id'] ); $conditionsEventReport['AND'][0]['OR'] = array( array('AND' => array( 'EventReport.distribution >' => 0, 'EventReport.distribution !=' => 4, )), array('AND' => array( 'EventReport.distribution' => 4, 'EventReport.sharing_group_id' => $sgids, )), $eventReportCondSelect => $user['org_id'] ); } if ($options['distribution']) { $conditions['AND'][] = array('Event.distribution' => $options['distribution']); $conditionsAttributes['AND'][] = array('Attribute.distribution' => $options['distribution']); $conditionsObjects['AND'][] = array('Object.distribution' => $options['distribution']); $conditionsEventReport['AND'][] = array('EventReport.distribution' => $options['distribution']); } if ($options['sharing_group_id']) { $conditions['AND'][] = array('Event.sharing_group_id' => $options['sharing_group_id']); $conditionsAttributes['AND'][] = array('Attribute.sharing_group_id' => $options['sharing_group_id']); $conditionsObjects['AND'][] = array('Object.sharing_group_id' => $options['sharing_group_id']); $conditionsEventReport['AND'][] = array('EventReport.sharing_group_id' => $options['sharing_group_id']); } if ($options['from']) { $conditions['AND'][] = array('Event.date >=' => $options['from']); } if ($options['to']) { $conditions['AND'][] = array('Event.date <=' => $options['to']); } if ($options['last']) { $conditions['AND'][] = array('Event.publish_timestamp >=' => $options['last']); } if ($options['event_uuid']) { $conditions['AND'][] = array('Event.uuid' => $options['event_uuid']); } if (!empty($options['includeRelatedTags'])) { $options['includeGranularCorrelations'] = 1; } if (isset($options['ignore']) && empty($options['ignore'])) { $conditions['AND'][] = array('Event.published' => 1); $conditionsAttributes['AND'][] = array('Attribute.to_ids' => 1); } $softDeletables = array('Attribute', 'Object', 'ObjectReference', 'EventReport'); if (isset($options['deleted'])) { if (!is_array($options['deleted'])) { $options['deleted'] = array($options['deleted']); } foreach ($options['deleted'] as $deleted_key => $deleted_value) { if ($deleted_value === 'only') { $deleted_value = 1; } $options['deleted'][$deleted_key] = intval($deleted_value); } if (!$user['Role']['perm_sync']) { foreach ($softDeletables as $softDeletable) { if (in_array(0, $options['deleted'])) { $deletion_subconditions = array( sprintf('%s.deleted', $softDeletable) => 0 ); } else { $deletion_subconditions = array( '1=0' ); } ${'conditions' . $softDeletable . 's'}['AND'][] = array( 'OR' => array( 'AND' => array( sprintf('(SELECT events.org_id FROM events WHERE events.id = %s.event_id)', $softDeletable) => $user['org_id'], sprintf('%s.deleted', $softDeletable) => $options['deleted'] ), $deletion_subconditions ) ); } } else { foreach ($softDeletables as $softDeletable) { ${'conditions' . $softDeletable . 's'}['AND'][] = array( sprintf('%s.deleted', $softDeletable) => $options['deleted'] ); } } } else { foreach ($softDeletables as $softDeletable) { ${'conditions' . $softDeletable . 's'}['AND'][$softDeletable . '.deleted'] = 0; } } $proposal_conditions = array('OR' => array('ShadowAttribute.deleted' => 0)); if (isset($options['deleted_proposals'])) { if ($isSiteAdmin) { $proposal_conditions = array('OR' => array('ShadowAttribute.deleted' => 1)); } else { $proposal_conditions['OR'][] = array('(SELECT events.org_id FROM events WHERE events.id = ShadowAttribute.event_id)' => $user['org_id']); } } if ($options['idList'] && !$options['tags']) { $conditions['AND'][] = array('Event.id' => $options['idList']); } // If we sent any tags along, load the associated tag names for each attribute if ($options['tags']) { $temp = $this->__generateCachedTagFilters($options['tags']); foreach ($temp as $rules) { $conditions['AND'][] = $rules; } } if (!empty($options['to_ids']) || $options['to_ids'] === 0) { $conditionsAttributes['AND'][] = array('Attribute.to_ids' => $options['to_ids']); } // removing this for now, we export the to_ids == 0 attributes too, since there is a to_ids field indicating it in the .xml // $conditionsAttributes['AND'] = array('Attribute.to_ids =' => 1); // Same idea for the published. Just adjust the tools to check for this // $conditions['AND'][] = array('Event.published =' => 1); // do not expose all the data ... $fields = array('Event.id', 'Event.orgc_id', 'Event.org_id', 'Event.date', 'Event.threat_level_id', 'Event.info', 'Event.published', 'Event.uuid', 'Event.attribute_count', 'Event.analysis', 'Event.timestamp', 'Event.distribution', 'Event.proposal_email_lock', 'Event.user_id', 'Event.locked', 'Event.publish_timestamp', 'Event.sharing_group_id', 'Event.disable_correlation', 'Event.extends_uuid'); $fieldsAtt = array('Attribute.id', 'Attribute.type', 'Attribute.category', 'Attribute.value', 'Attribute.to_ids', 'Attribute.uuid', 'Attribute.event_id', 'Attribute.distribution', 'Attribute.timestamp', 'Attribute.comment', 'Attribute.sharing_group_id', 'Attribute.deleted', 'Attribute.disable_correlation', 'Attribute.object_id', 'Attribute.object_relation', 'Attribute.first_seen', 'Attribute.last_seen'); $fieldsObj = array('*'); $fieldsShadowAtt = array('ShadowAttribute.id', 'ShadowAttribute.type', 'ShadowAttribute.category', 'ShadowAttribute.value', 'ShadowAttribute.to_ids', 'ShadowAttribute.uuid', 'ShadowAttribute.event_uuid', 'ShadowAttribute.event_id', 'ShadowAttribute.old_id', 'ShadowAttribute.comment', 'ShadowAttribute.org_id', 'ShadowAttribute.proposal_to_delete', 'ShadowAttribute.timestamp', 'ShadowAttribute.first_seen', 'ShadowAttribute.last_seen'); $fieldsOrg = array('id', 'name', 'uuid', 'local'); $fieldsEventReport = array('*'); $params = array( 'conditions' => $conditions, 'recursive' => 0, 'fields' => $fields, 'contain' => array( 'ThreatLevel' => array( 'fields' => array('ThreatLevel.name') ), 'Attribute' => array( 'fields' => $fieldsAtt, 'conditions' => $conditionsAttributes, 'AttributeTag' => array( 'order' => false ), 'order' => false ), 'Object' => array( 'fields' => $fieldsObj, 'conditions' => $conditionsObjects, 'order' => false, 'ObjectReference' => array( 'order' => false ) ), 'ShadowAttribute' => array( 'fields' => $fieldsShadowAtt, 'conditions' => $proposal_conditions, 'Org' => array('fields' => $fieldsOrg), 'order' => false ), 'EventTag' => array( 'order' => false ), 'EventReport' => array( 'fields' => $fieldsEventReport, 'conditions' => $conditionsEventReport, 'order' => false ) ) ); if (!empty($options['excludeLocalTags'])) { $params['contain']['EventTag']['conditions'] = array( 'EventTag.local' => 0 ); $params['contain']['Attribute']['AttributeTag']['conditions'] = array( 'AttributeTag.local' => 0 ); } if ($flatten) { unset($params['contain']['Object']); } if ($options['noEventReports']) { unset($params['contain']['EventReport']); } if ($options['noShadowAttributes']) { unset($params['contain']['ShadowAttribute']); } if ($options['metadata']) { unset($params['contain']['Attribute']); unset($params['contain']['ShadowAttribute']); unset($params['contain']['Object']); unset($params['contain']['EventReport']); } if (!empty($options['limit'])) { $params['limit'] = $options['limit']; } if (!empty($options['page'])) { $params['page'] = $options['page']; } if (!empty($options['order'])) { $params['order'] = $options['order']; } $results = $this->find('all', $params); if (empty($results)) { return array(); } $sharingGroupData = $options['sgReferenceOnly'] ? [] : $this->__cacheSharingGroupData($user, $useCache); // Initialize classes that will be necessary during event fetching if ((empty($options['metadata']) && empty($options['noSightings'])) && !isset($this->Sighting)) { $this->Sighting = ClassRegistry::init('Sighting'); } if (!empty($options['includeDecayScore']) && !isset($this->DecayingModel)) { $this->DecayingModel = ClassRegistry::init('DecayingModel'); } if (($options['includeFeedCorrelations'] || $options['includeServerCorrelations']) && !isset($this->Feed)) { $this->Feed = ClassRegistry::init('Feed'); } if (($options['enforceWarninglist'] || $options['includeWarninglistHits']) && !isset($this->Warninglist)) { $this->Warninglist = ClassRegistry::init('Warninglist'); } // Precache current user email $userEmails = empty($user['id']) ? [] : [$user['id'] => $user['email']]; // Do some refactoring with the event $fields = array( 'common' => array('distribution', 'sharing_group_id', 'uuid'), 'Attribute' => array('value', 'type', 'category', 'to_ids'), 'Object' => array('name', 'meta-category') ); if (!$options['includeAllTags']) { $justExportableTags = true; } else { $justExportableTags = false; } foreach ($results as $eventKey => &$event) { if ($event['Event']['distribution'] == 4 && !in_array($event['Event']['sharing_group_id'], $sgids)) { $this->Log = ClassRegistry::init('Log'); $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => $event['Event']['id'], 'email' => $user['email'], 'action' => 'fetchEvent', 'user_id' => $user['id'], 'title' => 'User was able to fetch the event but not the sharing_group it belongs to', 'change' => '' )); unset($results[$eventKey]); // Current user cannot access sharing_group associated to this event continue; } if ($options['includeWarninglistHits'] || $options['enforceWarninglist']) { $eventWarnings = $this->Warninglist->attachWarninglistToAttributes($event['Attribute']); $this->Warninglist->attachWarninglistToAttributes($event['ShadowAttribute']); $event['warnings'] = $eventWarnings; } $this->__attachReferences($event, $fields); $this->__attachTags($event, $justExportableTags); $this->__attachGalaxies($event, $user, $options['excludeGalaxy'], $options['fetchFullClusters']); $event = $this->Orgc->attachOrgs($event, $fieldsOrg); if (!$options['sgReferenceOnly'] && $event['Event']['sharing_group_id']) { $event['SharingGroup'] = $sharingGroupData[$event['Event']['sharing_group_id']]['SharingGroup']; } // Include information about event creator user email. This information is included for: // - users from event creator org // - site admins // In export, this information will be included in `event_creator_email` field just for auditors of event creator org. $sameOrg = $event['Event']['orgc_id'] === $user['org_id']; if ($sameOrg || $user['Role']['perm_site_admin']) { if (!isset($userEmails[$event['Event']['user_id']])) { $userEmails[$event['Event']['user_id']] = $this->User->field('email', ['id' => $event['Event']['user_id']]); } $userEmail = $userEmails[$event['Event']['user_id']]; if ($sameOrg && $user['Role']['perm_audit']) { $event['Event']['event_creator_email'] = $userEmail; } $event['User']['email'] = $userEmail; } // Let's find all the related events and attach it to the event itself if ($options['includeEventCorrelations']) { $results[$eventKey]['RelatedEvent'] = $this->getRelatedEvents($user, $event['Event']['id'], $sgids); } // Let's also find all the relations for the attributes - this won't be in the xml export though if (!empty($options['includeGranularCorrelations'])) { $results[$eventKey]['RelatedAttribute'] = $this->getRelatedAttributes($user, $event['Event']['id'], $sgids); if (!empty($options['includeRelatedTags'])) { $results[$eventKey] = $this->includeRelatedTags($results[$eventKey], $options); } $results[$eventKey]['RelatedShadowAttribute'] = $this->getRelatedAttributes($user, $event['Event']['id'], $sgids, true); } if (isset($event['ShadowAttribute']) && !empty($event['ShadowAttribute']) && isset($options['includeAttachments']) && $options['includeAttachments']) { foreach ($event['ShadowAttribute'] as $k => $sa) { if ($this->ShadowAttribute->typeIsAttachment($sa['type'])) { $encodedFile = $this->ShadowAttribute->base64EncodeAttachment($sa); $event['ShadowAttribute'][$k]['data'] = $encodedFile; } } } if (isset($event['Attribute'])) { if ($options['includeFeedCorrelations']) { if (!empty($options['overrideLimit'])) { $overrideLimit = true; } else { $overrideLimit = false; } $event['Attribute'] = $this->Feed->attachFeedCorrelations($event['Attribute'], $user, $event['Event'], $overrideLimit); } if (!empty($options['includeServerCorrelations']) && ($user['Role']['perm_site_admin'] || $user['org_id'] == Configure::read('MISP.host_org_id'))) { if (!empty($options['overrideLimit'])) { $overrideLimit = true; } else { $overrideLimit = false; } $event['Attribute'] = $this->Feed->attachFeedCorrelations($event['Attribute'], $user, $event['Event'], $overrideLimit, 'Server'); } $event = $this->__filterBlockedAttributesByTags($event, $options, $user); $event['Attribute'] = $this->__attachSharingGroups(!$options['sgReferenceOnly'], $event['Attribute'], $sharingGroupData); $proposalBlockAttributes = Configure::read('MISP.proposals_block_attributes'); // move all object attributes to a temporary container $tempObjectAttributeContainer = array(); foreach ($event['Attribute'] as $key => $attribute) { if ($options['enforceWarninglist'] && !empty($attribute['warnings'])) { unset($event['Attribute'][$key]); continue; } if ($attribute['category'] === 'Financial fraud') { $event['Attribute'][$key] = $this->Attribute->attachValidationWarnings($event['Attribute'][$key]); } if ($options['includeAttachments'] && $this->Attribute->typeIsAttachment($attribute['type'])) { $encodedFile = $this->Attribute->base64EncodeAttachment($attribute); $event['Attribute'][$key]['data'] = $encodedFile; } if (!empty($options['includeDecayScore'])) { if (isset($event['EventTag'])) { // include EventTags for score computation $event['Attribute'][$key]['EventTag'] = $event['EventTag']; } $event['Attribute'][$key] = $this->DecayingModel->attachScoresToAttribute($user, $event['Attribute'][$key]); if (isset($event['EventTag'])) { // remove included EventTags unset($event['Attribute'][$key]['EventTag']); } } $event['Attribute'][$key]['ShadowAttribute'] = array(); // If a shadowattribute can be linked to an attribute, link it to it then remove it from the event // This is to differentiate between proposals that were made to an attribute for modification and between proposals for new attributes if (isset($event['ShadowAttribute'])) { foreach ($event['ShadowAttribute'] as $k => $sa) { if (!empty($sa['old_id'])) { if ($event['ShadowAttribute'][$k]['old_id'] == $attribute['id']) { $results[$eventKey]['Attribute'][$key]['ShadowAttribute'][] = $sa; unset($results[$eventKey]['ShadowAttribute'][$k]); } } } } if ($proposalBlockAttributes && !empty($options['allow_proposal_blocking'])) { foreach ($results[$eventKey]['Attribute'][$key]['ShadowAttribute'] as $sa) { if ($sa['proposal_to_delete'] || $sa['to_ids'] == 0) { unset($results[$eventKey]['Attribute'][$key]); continue; } } } if (!$flatten && $attribute['object_id'] != 0) { $tempObjectAttributeContainer[$attribute['object_id']][] = $event['Attribute'][$key]; unset($event['Attribute'][$key]); } } $event['Attribute'] = array_values($event['Attribute']); } if (!empty($event['Object'])) { $event['Object'] = $this->__attachSharingGroups(!$options['sgReferenceOnly'], $event['Object'], $sharingGroupData); foreach ($event['Object'] as $objectKey => $objectValue) { if (isset($tempObjectAttributeContainer[$objectValue['id']])) { $event['Object'][$objectKey]['Attribute'] = $tempObjectAttributeContainer[$objectValue['id']]; } } unset($tempObjectAttributeContainer); } if (!empty($event['EventReport'])) { $event['EventReport'] = $this->__attachSharingGroups(!$options['sgReferenceOnly'], $event['EventReport'], $sharingGroupData); } if (!empty($event['ShadowAttribute'])) { if ($isSiteAdmin && $options['includeFeedCorrelations']) { if (!empty($options['overrideLimit'])) { $overrideLimit = true; } else { $overrideLimit = false; } $event['ShadowAttribute'] = $this->Feed->attachFeedCorrelations($event['ShadowAttribute'], $user, $event['Event'], $overrideLimit); } if (!empty($options['includeServerCorrelations']) && $user['org_id'] == Configure::read('MISP.host_org_id')) { if (!empty($options['overrideLimit'])) { $overrideLimit = true; } else { $overrideLimit = false; } $event['ShadowAttribute'] = $this->Feed->attachFeedCorrelations($event['ShadowAttribute'], $user, $event['Event'], $overrideLimit, 'Server'); } } if (empty($options['metadata']) && empty($options['noSightings'])) { $event['Sighting'] = $this->Sighting->attachToEvent($event, $user); } if ($options['includeSightingdb']) { $this->Sightingdb = ClassRegistry::init('Sightingdb'); $event = $this->Sightingdb->attachToEvent($event, $user); } // remove proposals to attributes that we cannot see // if the shadow attribute wasn't moved within an attribute before, this is the case if (isset($event['ShadowAttribute'])) { foreach ($event['ShadowAttribute'] as $k => $sa) { if (!empty($sa['old_id'])) { unset($event['ShadowAttribute'][$k]); } } $event['ShadowAttribute'] = array_values($event['ShadowAttribute']); } } if ($options['extended']) { foreach ($results as $k => $result) { $results[$k] = $this->__mergeExtensions($user, $result, $options); } } return $results; } /** * Attach galaxy clusters to event and attributes. * @param array $event * @param array $user * @param bool $excludeGalaxy * @param bool $fetchFullCluster */ private function __attachGalaxies(array &$event, array $user, $excludeGalaxy, $fetchFullCluster) { $galaxyTags = []; $event['Galaxy'] = []; if (!$excludeGalaxy && isset($event['EventTag'])) { foreach ($event['EventTag'] as $eventTag) { if ($eventTag['Tag']['is_galaxy']) { $galaxyTags[$eventTag['Tag']['id']] = $eventTag['Tag']['name']; } } } if (isset($event['Attribute'])) { foreach ($event['Attribute'] as &$attribute) { $attribute['Galaxy'] = []; if (!$excludeGalaxy && isset($attribute['AttributeTag'])) { foreach ($attribute['AttributeTag'] as $attributeTag) { if ($attributeTag['Tag']['is_galaxy']) { $galaxyTags[$attributeTag['Tag']['id']] = $attributeTag['Tag']['name']; } } } } } if ($excludeGalaxy || empty($galaxyTags)) { return; } $this->GalaxyCluster = ClassRegistry::init('GalaxyCluster'); $clusters = $this->GalaxyCluster->getClusters($galaxyTags, $user, true, $fetchFullCluster); if (empty($clusters)) { return; } $clustersByTagNames = []; foreach ($clusters as $cluster) { $clustersByTagNames[mb_strtolower($cluster['GalaxyCluster']['tag_name'])] = $cluster['GalaxyCluster']; } unset($clusters); if (isset($event['EventTag'])) { foreach ($event['EventTag'] as $etk => $eventTag) { if (!$eventTag['Tag']['is_galaxy']) { continue; } $tagName = mb_strtolower($eventTag['Tag']['name']); if (isset($clustersByTagNames[$tagName])) { $cluster = $clustersByTagNames[$tagName]; $galaxyId = $cluster['Galaxy']['id']; $cluster['local'] = isset($eventTag['local']) ? $eventTag['local'] : false; if (isset($event['Galaxy'][$galaxyId])) { unset($cluster['Galaxy']); $event['Galaxy'][$galaxyId]['GalaxyCluster'][] = $cluster; } else { $event['Galaxy'][$galaxyId] = $cluster['Galaxy']; unset($cluster['Galaxy']); $event['Galaxy'][$galaxyId]['GalaxyCluster'] = [$cluster]; } } } $event['Galaxy'] = array_values($event['Galaxy']); } if (isset($event['Attribute'])) { foreach ($event['Attribute'] as &$attribute) { if (isset($attribute['AttributeTag'])) { foreach ($attribute['AttributeTag'] as $attributeTag) { if (!$attributeTag['Tag']['is_galaxy']) { continue; } $tagName = mb_strtolower($attributeTag['Tag']['name']); if (isset($clustersByTagNames[$tagName])) { $cluster = $clustersByTagNames[$tagName]; $galaxyId = $cluster['Galaxy']['id']; $cluster['local'] = isset($attributeTag['local']) ? $attributeTag['local'] : false; if (isset($attribute['Galaxy'][$galaxyId])) { unset($cluster['Galaxy']); $attribute['Galaxy'][$galaxyId]['GalaxyCluster'][] = $cluster; } else { $attribute['Galaxy'][$galaxyId] = $cluster['Galaxy']; unset($cluster['Galaxy']); $attribute['Galaxy'][$galaxyId]['GalaxyCluster'] = [$cluster]; } } } $attribute['Galaxy'] = array_values($attribute['Galaxy']); } } } } private function __cacheRelatedEventTags($eventTagCache, array $relatedAttribute, $excludeLocalTags) { if (!isset($eventTagCache[$relatedAttribute['id']])) { $params = array( 'contain' => array( 'Tag' => array( 'fields' => array( 'Tag.id', 'Tag.name', 'Tag.colour', 'Tag.numerical_value' ) ) ), 'recursive' => -1, 'conditions' => array( 'EventTag.event_id' => $relatedAttribute['id'] ) ); if ($excludeLocalTags) { $params['conditions']['EventTag.local'] = 0; } $eventTags = $this->EventTag->find('all', $params); $eventTagCache[$relatedAttribute['id']] = []; foreach ($eventTags as $et) { if (!isset($eventTagCache[$relatedAttribute['id']][$et['Tag']['id']])) { $eventTagCache[$relatedAttribute['id']][$et['Tag']['id']] = $et['Tag']; } } } return $eventTagCache; } private function includeRelatedTags(array $event, array $options) { $eventTagCache = array(); $excludeLocalTags = !empty($options['excludeLocalTags']); foreach ($event['RelatedAttribute'] as $attributeId => $relatedAttributes) { $tags = []; foreach ($relatedAttributes as $relatedAttribute) { $eventTagCache = $this->__cacheRelatedEventTags($eventTagCache, $relatedAttribute, $excludeLocalTags); foreach ($eventTagCache[$relatedAttribute['id']] as $tagId => $tag) { $tags[$tagId]= $tag; } $params = array( 'contain' => array( 'Tag' => array( 'fields' => array( 'Tag.id', 'Tag.name', 'Tag.colour', 'Tag.numerical_value' ) ) ), 'recursive' => -1, 'conditions' => array( 'AttributeTag.attribute_id' => $relatedAttribute['attribute_id'] ) ); if ($excludeLocalTags) { $params['conditions']['AttributeTag.local'] = 0; } $attributeTags = $this->Attribute->AttributeTag->find('all', $params); foreach ($attributeTags as $at) { $tags[$at['Tag']['id']] = $at['Tag']; } } if (!empty($tags)) { $attributePos = false; foreach ($event['Attribute'] as $k => $attribute) { if ($attribute['id'] == $attributeId) { $attributePos = $k; break; } } $event['Attribute'][$attributePos]['RelatedTags'] = array_values($tags); } } return $event; } /** * @param array $user * @param array $event * @param array $options * @return array * @throws Exception */ private function __mergeExtensions(array $user, array $event, array $options) { $extensions = $this->fetchEvent($user, [ 'eventsExtendingUuid' => $event['Event']['uuid'], 'includeEventCorrelations' => $options['includeEventCorrelations'], 'includeWarninglistHits' => $options['includeWarninglistHits'], 'noShadowAttributes' => $options['noShadowAttributes'], 'noEventReports' => $options['noEventReports'], 'noSightings' => isset($options['noSightings']) ? $options['noSightings'] : null, 'sgReferenceOnly' => $options['sgReferenceOnly'], ]); foreach ($extensions as $extensionEvent) { $eventMeta = array( 'id' => $extensionEvent['Event']['id'], 'info' => $extensionEvent['Event']['info'], 'Orgc' => array( 'id' => $extensionEvent['Orgc']['id'], 'name' => $extensionEvent['Orgc']['name'], 'uuid' => $extensionEvent['Orgc']['uuid'], ), ); $event['Event']['extensionEvents'][$eventMeta['id']] = $eventMeta; $thingsToMerge = array('Attribute', 'Object', 'ShadowAttribute', 'Galaxy'); foreach ($thingsToMerge as $thingToMerge) { if (!isset($event[$thingToMerge])) { $event[$thingToMerge] = []; } if (!isset($extensionEvent[$thingToMerge])) { $extensionEvent[$thingToMerge] = []; } $event[$thingToMerge] = array_merge($event[$thingToMerge], $extensionEvent[$thingToMerge]); } // Merge event reports if requested if (!$options['noEventReports']) { $event['EventReport'] = array_merge($event['EventReport'], $extensionEvent['EventReport']); } // Merge just tags that are not already in main event foreach ($extensionEvent['EventTag'] as $eventTag) { foreach ($event['EventTag'] as $eT) { if ($eT['Tag']['id'] == $eventTag['Tag']['id']) { continue 2; // tag already exists, skip } } $event['EventTag'][] = $eventTag; } if ($options['includeEventCorrelations']) { // Merge just related events that are not already in main event foreach ($extensionEvent['RelatedEvent'] as $relatedEvent) { foreach ($event['RelatedEvent'] as $rE) { if ($rE['Event']['id'] == $relatedEvent['Event']['id']) { continue 2; // event already exists, skip } } $event['RelatedEvent'][] = $relatedEvent; } } if ($options['includeWarninglistHits']) { // Merge just event warninglist that are not already in main event foreach ($extensionEvent['warnings'] as $warninglistId => $warning) { if (!isset($event['warnings'][$warninglistId])) { $event['warnings'][$warninglistId] = $warning; } } } } return $event; } private function __attachSharingGroups($doAttach, $data, $sharingGroupData) { if (!$doAttach) { return $data; } foreach ($data as $k => $v) { if ($v['distribution'] == 4) { if (isset($sharingGroupData[$v['sharing_group_id']])) { $data[$k]['SharingGroup'] = $sharingGroupData[$v['sharing_group_id']]['SharingGroup']; } else { unset($data[$k]); // current user could not fetch the sharing_group } } } return $data; } // Filter the attributes within an event based on the tag filter block rules private function __filterBlockedAttributesByTags($event, $options, $user) { if (!empty($options['blockedAttributeTags'])) { foreach ($options['blockedAttributeTags'] as $key => $blockedTag) { if (!is_numeric($blockedTag)) { $options['blockedAttributeTags'][$key] = $this->EventTag->Tag->lookupTagIdFromName($blockedTag); } else { $options['blockedAttributeTags'][$key] = $blockedTag; } } } if (!empty($user['Server']['push_rules'])) { $push_rules = json_decode($user['Server']['push_rules'], true); if (!empty($push_rules['tags']['NOT'])) { if (empty($options['blockedAttributeTags'])) { $options['blockedAttributeTags'] = array(); } $options['blockedAttributeTags'] = array_merge($options['blockedAttributeTags'], $push_rules['tags']['NOT']); } } if (!empty($options['blockedAttributeTags'])) { if (!empty($event['Attribute'])) { $event['Attribute'] = $this->__filterBlockedAttributesFromContainer($event['Attribute'], $options['blockedAttributeTags']); } } return $event; } // accepts an attribute array and a list of blocked tags. Returns the attribute array with the blocked attributes cleaned out. private function __filterBlockedAttributesFromContainer($container, $blockedTags) { foreach ($container as $key => $attribute) { if (!empty($attribute['AttributeTag'])) { foreach ($attribute['AttributeTag'] as $at) { if (in_array($at['tag_id'], $blockedTags)) { unset($container[$key]); } } } } $container = array_values($container); return $container; } public function set_filter_org(&$params, $conditions, $options) { if (!empty($params['org'])) { $params['org'] = $this->convert_filters($params['org']); if (!empty($params['org']['OR'])) { foreach ($params['org']['OR'] as $k => $org) { if (!is_numeric($org)) { $existingOrg = $this->Orgc->find('first', array( 'recursive' => -1, 'conditions' => array('Orgc.name' => $org), 'fields' => array('Orgc.id') )); if (empty($existingOrg)) { $params['org']['OR'][$k] = -1; } else { $params['org']['OR'][$k] = $existingOrg['Orgc']['id']; } } } } if (!empty($params['org']['NOT'])) { $temp = array(); foreach ($params['org']['NOT'] as $org) { if (!is_numeric($org)) { $existingOrg = $this->Orgc->find('first', array( 'recursive' => -1, 'conditions' => array('Orgc.name' => $org), 'fields' => array('Orgc.id') )); if (!empty($existingOrg)) { $temp[] = $existingOrg['Orgc']['id']; } } else { $temp[] = $org; } } if (!empty($temp)) { $params['org']['NOT'] = $temp; } else { unset($params['org']['NOT']); } } $conditions = $this->generic_add_filter($conditions, $params['org'], 'Event.orgc_id'); } return $conditions; } public function set_filter_eventid(&$params, $conditions, $options) { if (!empty($params['eventid']) && $params['eventid'] !== 'all') { $params['eventid'] = $this->convert_filters($params['eventid']); $keys = array( 'uuid' => 'Event.uuid', 'id' => 'Event.id' ); $id_params = array(); foreach ($params['eventid'] as $operand => $list) { foreach ($list as $id) { if ($operand === 'OR') { $id_params['AND']['OR'][$keys[Validation::uuid($id) ? 'uuid' : 'id']][] = $id; } else if ($operand === 'AND') { $id_params['AND']['AND'][$keys[Validation::uuid($id) ? 'uuid' : 'id']][] = $id; } else { $id_params['AND']['NOT'][$keys[Validation::uuid($id) ? 'uuid' : 'id']][] = $id; } } } $conditions['AND'][] = $id_params; } return $conditions; } public function set_filter_eventinfo(&$params, $conditions, $options) { if (!empty($params['eventinfo'])) { $params['eventinfo'] = $this->convert_filters($params['eventinfo']); $conditions = $this->generic_add_filter($conditions, $params['eventinfo'], 'Event.info'); } return $conditions; } public function set_filter_uuid(&$params, $conditions, $options) { if ($options['scope'] === 'Event') { if (!empty($params['uuid'])) { $params['uuid'] = $this->convert_filters($params['uuid']); if (!empty($params['uuid']['OR'])) { $subQueryOptions = array( 'conditions' => array('Attribute.uuid' => $params['uuid']['OR']), 'fields' => array('event_id') ); $attributeSubquery = $this->subQueryGenerator($this->Attribute, $subQueryOptions, 'Event.id'); $conditions['AND'][] = array( 'OR' => array( 'Event.uuid' => $params['uuid']['OR'], $attributeSubquery ) ); } if (!empty($params['uuid']['NOT'])) { $subQueryOptions = array( 'conditions' => array('Attribute.uuid' => $params['uuid']['NOT']), 'fields' => array('event_id') ); $attributeSubquery = $this->subQueryGenerator($this->Attribute, $subQueryOptions, 'Event.id'); $conditions['AND'][] = array( 'NOT' => array( 'Event.uuid' => $params['uuid']['NOT'], $attributeSubquery ) ); } } } else { $conditions = $this->{$options['scope']}->set_filter_uuid($params, $conditions, $options); } return $conditions; } public function set_filter_mixed_id(&$params, $conditions, $options) { if (!empty($params['mixed_id'])) { $params['mixed_id'] = $this->convert_filters($params['mixed_id']); if (!empty($options['scope']) && $options['scope'] === 'Event') { $conditions = $this->generic_add_filter($conditions, $params['uuid'], 'Event.uuid'); } if (!empty($options['scope']) && $options['scope'] === 'Attribute') { $conditions = $this->generic_add_filter($conditions, $params['uuid'], 'Attribute.uuid'); } } return $conditions; } public function set_filter_deleted(&$params, $conditions, $options) { if (!empty($params['deleted'])) { if (empty($options['scope'])) { $scope = 'Attribute'; } else { $scope = $options['scope']; } if ($params['deleted']) { $conditions = $this->generic_add_filter($conditions, $params['deleted'], $scope . '.deleted'); } } return $conditions; } public function set_filter_to_ids(&$params, $conditions, $options) { if (isset($params['to_ids'])) { if ($params['to_ids'] === 'exclude') { $params['to_ids'] = 0; } $conditions['AND']['Attribute.to_ids'] = $params['to_ids']; } return $conditions; } public function set_filter_ignore(&$params, $conditions, $options) { if (empty($params['ignore'])) { if (empty($options['scope'])) { $scope = 'Attribute'; } else { $scope = $options['scope']; } if ($scope === 'Attribute') { $conditions['AND']['Attribute.to_ids'] = 1; } else { $conditions['AND']['Event.published'] = 1; } } return $conditions; } public function set_filter_published(&$params, $conditions, $options) { if (isset($params['published'])) { $conditions['AND']['Event.published'] = $params['published']; } return $conditions; } public function set_filter_threat_level_id(&$params, $conditions, $options) { if (isset($params['threat_level_id'])) { $conditions['AND']['Event.threat_level_id'] = $params['threat_level_id']; } return $conditions; } public function set_filter_tags(&$params, $conditions, $options) { if (!empty($params['tags'])) { $conditions = $this->Attribute->set_filter_tags($params, $conditions, $options); } return $conditions; } public function set_filter_type(&$params, $conditions, $options) { if (!empty($params[$options['filter']])) { $params[$options['filter']] = $this->convert_filters($params[$options['filter']]); if (!empty(Configure::read('MISP.attribute_filters_block_only'))) { if ($options['context'] === 'Event' && !empty($params[$options['filter']]['OR'])) { unset($params[$options['filter']]['OR']); } } if (!empty($params[$options['filter']])) { foreach (['OR', 'NOT'] as $operator) { if ( !empty($params[$options['filter']][$operator]) && ( in_array('email-src', $params[$options['filter']][$operator]) || in_array('email-dst', $params[$options['filter']][$operator]) ) && ( !in_array('email', $params[$options['filter']][$operator]) ) ) { $params[$options['filter']][$operator][] = 'email'; } } } $conditions = $this->generic_add_filter($conditions, $params[$options['filter']], 'Attribute.' . $options['filter']); } return $conditions; } public function set_filter_simple_attribute(&$params, $conditions, $options) { if (!empty($params[$options['filter']])) { $params[$options['filter']] = $this->convert_filters($params[$options['filter']]); if (!empty(Configure::read('MISP.attribute_filters_block_only'))) { if ($options['context'] === 'Event' && !empty($params[$options['filter']]['OR'])) { unset($params[$options['filter']]['OR']); } } $conditions = $this->generic_add_filter($conditions, $params[$options['filter']], 'Attribute.' . $options['filter']); } return $conditions; } public function set_filter_attribute_id(&$params, $conditions, $options) { if (!empty($params[$options['filter']])) { $params[$options['filter']] = $this->convert_filters($params[$options['filter']]); $conditions = $this->generic_add_filter($conditions, $params[$options['filter']], 'Attribute.' . $options['filter']); } return $conditions; } public function set_filter_value(&$params, $conditions, $options, $keys = array('Attribute.value1', 'Attribute.value2')) { if (!empty($params['value'])) { $params[$options['filter']] = $this->convert_filters($params[$options['filter']]); $conditions = $this->generic_add_filter($conditions, $params[$options['filter']], $keys); } return $conditions; } public function set_filter_object_name(&$params, $conditions, $options) { if (!empty($params['object_name'])) { $params['object_name'] = $this->convert_filters($params['object_name']); $conditions = $this->generic_add_filter($conditions, $params['object_name'], 'Object.name'); } return $conditions; } public function set_filter_object_template_uuid(&$params, $conditions, $options) { if (!empty($params['object_template_uuid'])) { $params['object_template_uuid'] = $this->convert_filters($params['object_template_uuid']); $conditions = $this->generic_add_filter($conditions, $params['object_template_uuid'], 'Object.template_uuid'); } return $conditions; } public function set_filter_object_template_version(&$params, $conditions, $options) { if (!empty($params['object_template_version'])) { $params['object_template_version'] = $this->convert_filters($params['object_template_version']); $conditions = $this->generic_add_filter($conditions, $params['object_template_version'], 'Object.template_version'); } return $conditions; } public function set_filter_comment(&$params, $conditions, $options) { if (!empty($params['comment'])) { $params['comment'] = $this->convert_filters($params['comment']); $conditions = $this->generic_add_filter($conditions, $params['comment'], 'Attribute.comment'); } return $conditions; } public function set_filter_seen(&$params, $conditions, $options) { $f = $options['scope'] . '.' . $options['filter']; $conditions = $this->Attribute->setTimestampSeenConditions($params[$options['filter']], $conditions, $f); return $conditions; } public function set_filter_timestamp(&$params, $conditions, $options) { if ($options['filter'] == 'from') { if (is_numeric($params['from'])) { $conditions['AND']['Event.date >='] = date('Y-m-d', $params['from']); } else { $conditions['AND']['Event.date >='] = $params['from']; } } elseif ($options['filter'] == 'to') { if (is_numeric($params['to'])) { $conditions['AND']['Event.date <='] = date('Y-m-d', $params['to']); } else { $conditions['AND']['Event.date <='] = $params['to']; } } else { if (empty($options['scope'])) { $scope = 'Attribute'; } else { $scope = $options['scope']; } $filters = array( 'timestamp' => array( $scope . '.timestamp' ), 'publish_timestamp' => array( 'Event.publish_timestamp' ), 'last' => array( 'Event.publish_timestamp' ), 'event_timestamp' => array( 'Event.timestamp' ), 'attribute_timestamp' => array( 'Attribute.timestamp' ), ); foreach ($filters[$options['filter']] as $f) { $conditions = $this->Attribute->setTimestampConditions($params[$options['filter']], $conditions, $f); } } return $conditions; } public function set_filter_date(&$params, $conditions, $options) { $timestamp = $this->Attribute->setTimestampConditions($params[$options['filter']], $conditions, 'Event.date', true); if (!is_array($timestamp)) { $conditions['AND']['Event.date >='] = date('Y-m-d', $timestamp); } else { $conditions['AND']['Event.date >='] = date('Y-m-d', $timestamp[0]); $conditions['AND']['Event.date <='] = date('Y-m-d', $timestamp[1]); } return $conditions; } public function sendAlertEmailRouter($id, $user, $oldpublish = null) { if (Configure::read('MISP.block_old_event_alert')) { $oldest = time() - (Configure::read('MISP.block_old_event_alert_age') * 86400); $oldest_date = time() - (Configure::read('MISP.block_old_event_alert_by_date') * 86400); $event = $this->find('first', array( 'conditions' => array('Event.id' => $id), 'recursive' => -1, 'fields' => array('Event.timestamp', 'Event.date') )); if (empty($event)) { return false; } if (!empty(Configure::read('MISP.block_old_event_alert_age')) && is_numeric(Configure::read('MISP.block_old_event_alert_age'))) { if (intval($event['Event']['timestamp']) < $oldest) { return true; } } if (!empty(Configure::read('MISP.block_old_event_alert_by_date')) && is_numeric(Configure::read('MISP.block_old_event_alert_by_date'))) { if (strtotime($event['Event']['date']) < $oldest_date) { return true; } } } if (Configure::read('MISP.block_event_alert') && Configure::read('MISP.block_event_alert_tag') && !empty(Configure::read('MISP.block_event_alert_tag'))) { $noAlertTag = Configure::read('MISP.block_event_alert_tag'); $tagLen = strlen($noAlertTag); $event = $this->fetchEvent($user, array('eventid' => $id, 'includeAllTags' => true)); if (empty($event)) { return false; } foreach ($event[0]['EventTag'] as $k => $tag) { if (strcasecmp($noAlertTag, $tag['Tag']['name']) == 0) { return true; } } } if (Configure::read('MISP.disable_emailing')) { $this->Log = ClassRegistry::init('Log'); $this->Log->create(); $this->Log->save(array( 'org' => 'SYSTEM', 'model' => 'Event', 'model_id' => $id, 'email' => $user['email'], 'action' => 'publish', 'title' => 'E-mail alerts not sent out during publishing. Reason: Emailing is currently disabled on this instance.', 'change' => null, )); return true; } if (Configure::read('MISP.background_jobs')) { $job = ClassRegistry::init('Job'); $job->create(); $data = array( 'worker' => 'email', 'job_type' => 'publish_alert_email', 'job_input' => 'Event: ' . $id, 'status' => 0, 'retries' => 0, 'org_id' => $user['org_id'], 'org' => $user['Organisation']['name'], 'message' => 'Sending...', ); $job->save($data); $jobId = $job->id; $process_id = CakeResque::enqueue( 'email', 'EventShell', array('alertemail', $user['id'], $jobId, $id, $oldpublish), true ); $job->saveField('process_id', $process_id); return true; } else { return $this->sendAlertEmail($id, $user, $oldpublish); } } /** * @param int $id * @param array $senderUser Not used anymore. * @param int|null $oldpublish Timestamp of old publishing. * @param int|null $jobId * @return bool * @throws Exception */ public function sendAlertEmail($id, array $senderUser, $oldpublish = null, $jobId = null) { $event = $this->find('first', [ 'conditions' => ['Event.id' => $id], 'contain' => ['EventTag' => ['Tag'], 'ThreatLevel'], ]); if (empty($event)) { throw new NotFoundException('Invalid Event.'); } // Initialise the Job class if we have a background process ID // This will keep updating the process's progress bar if ($jobId) { $this->Job = ClassRegistry::init('Job'); } $this->NotificationLog = ClassRegistry::init('NotificationLog'); if (!$this->NotificationLog->check($event['Event']['orgc_id'], 'publish')) { if ($jobId) { $this->Job->saveStatus($jobId, true, __('Mails blocked by org alert threshold.')); } return true; } $userConditions = array('autoalert' => 1); $usersWithAccess = $this->User->getUsersWithAccess( $owners = array( $event['Event']['orgc_id'], $event['Event']['org_id'] ), $event['Event']['distribution'], $event['Event']['sharing_group_id'], $userConditions ); if (Configure::read('MISP.extended_alert_subject')) { $subject = preg_replace("/\r|\n/", "", $event['Event']['info']); if (strlen($subject) > 58) { $subject = substr($subject, 0, 55) . '... - '; } else { $subject .= " - "; } } else { $subject = ''; } $subjMarkingString = $this->getEmailSubjectMarkForEvent($event); if (Configure::read('MISP.threatlevel_in_email_subject') === false) { $threatLevel = ''; } else { $threatLevel = $event['ThreatLevel']['name'] . " - "; } $subject = "[" . Configure::read('MISP.org') . " MISP] Event $id - $subject$threatLevel" . strtoupper($subjMarkingString); $eventUrl = $this->__getAnnounceBaseurl() . "/events/view/" . $id; $bodyNoEnc = __("A new or modified event was just published on %s", $eventUrl) . "\n\n"; $bodyNoEnc .= __("If you would like to unsubscribe from receiving such alert e-mails, simply\ndisable publish alerts via %s", $this->__getAnnounceBaseurl() . '/users/edit'); $userCount = count($usersWithAccess); $this->UserSetting = ClassRegistry::init('UserSetting'); foreach ($usersWithAccess as $k => $user) { // Fetch event for user that will receive alert e-mail to respect all ACLs $eventForUser = $this->fetchEvent($user, [ 'eventid' => $id, 'includeAllTags' => true, 'includeEventCorrelations' => true, 'noEventReports' => true, 'noSightings' => true, ])[0]; if ($this->UserSetting->checkPublishFilter($user, $eventForUser)) { $body = $this->__buildAlertEmailBody($eventForUser, $user, $oldpublish); $this->User->sendEmail(['User' => $user], $body, $bodyNoEnc, $subject); } if ($jobId) { $this->Job->saveProgress($jobId, null, $k / $userCount * 100); } } if ($jobId) { $this->Job->saveStatus($jobId, true, __('Mails sent.')); } return true; } /** * @param string $body * @param string $bodyTempOther * @param array $objects * @param int|null $oldpublish Timestamp of latest publish */ private function __buildAlertEmailObject(&$body, &$bodyTempOther, array $objects, $oldpublish) { foreach ($objects as $object) { if (isset($oldpublish) && isset($object['timestamp']) && $object['timestamp'] > $oldpublish) { $body .= '* '; } else { $body .= ' '; } $body .= $object['name'] . '/' . $object['meta-category'] . "\n"; if (!empty($object['Attribute'])) { $body .= $this->__buildAlertEmailAttribute($body, $bodyTempOther, $object['Attribute'], $oldpublish, ' '); } } } /** * @param string $body * @param string $bodyTempOther * @param array $attributes * @param int|null $oldpublish Timestamp of latest publish * @param string $indent */ private function __buildAlertEmailAttribute(&$body, &$bodyTempOther, array $attributes, $oldpublish, $indent = ' ') { $appendlen = 20; foreach ($attributes as $attribute) { $ids = $attribute['to_ids'] ? ' (IDS)' : ''; // Defanging URLs (Not "links") emails domains/ips in notification emails $value = $attribute['value']; if ('url' == $attribute['type'] || 'uri' == $attribute['type']) { $value = str_ireplace("http", "hxxp", $value); $value = str_ireplace(".", "[.]", $value); } elseif (in_array($attribute['type'], array('email-src', 'email-dst', 'whois-registrant-email', 'dns-soa-email', 'email-reply-to'))) { $value = str_replace("@", "[at]", $value); } elseif (in_array($attribute['type'], array('hostname', 'domain', 'ip-src', 'ip-dst', 'domain|ip'))) { $value = str_replace(".", "[.]", $value); } $strRepeatCount = $appendlen - 2 - strlen($attribute['type']); $strRepeat = ($strRepeatCount > 0) ? str_repeat(' ', $strRepeatCount) : ''; if (isset($oldpublish) && isset($attribute['timestamp']) && $attribute['timestamp'] > $oldpublish) { $line = '* ' . $indent . $attribute['category'] . '/' . $attribute['type'] . $strRepeat . ': ' . $value . $ids . " *\n"; } else { $line = $indent . $attribute['category'] . '/' . $attribute['type'] . $strRepeat . ': ' . $value . $ids . "\n"; } if (!empty($attribute['AttributeTag'])) { $tags = []; foreach ($attribute['AttributeTag'] as $aT) { $tags[] = $aT['Tag']['name']; } $line .= ' - Tags: ' . implode(', ', $tags) . "\n"; } if ('other' == $attribute['type']) { // append the 'other' attribute types to the bottom. $bodyTempOther .= $line; } else { $body .= $line; } } } /** * @param array $event * @param array $user * @param int|null $oldpublish Timestamp of latest publish * @return string */ private function __buildAlertEmailBody(array $event, array $user, $oldpublish) { // The mail body, h() is NOT needed as we are sending plain-text mails. $body = ""; $body .= '==============================================' . "\n"; $body .= 'URL : ' . $this->__getAnnounceBaseurl() . '/events/view/' . $event['Event']['id'] . "\n"; $body .= 'Event ID : ' . $event['Event']['id'] . "\n"; $body .= 'Date : ' . $event['Event']['date'] . "\n"; if (Configure::read('MISP.showorg')) { $body .= 'Reported by : ' . $event['Orgc']['name'] . "\n"; $body .= 'Local owner of the event : ' . $event['Org']['name'] . "\n"; } $body .= 'Distribution: ' . $this->distributionLevels[$event['Event']['distribution']] . "\n"; if ($event['Event']['distribution'] == 4) { $body .= 'Sharing Group: ' . $event['SharingGroup']['name'] . "\n"; } $tags = []; foreach ($event['EventTag'] as $tag) { $tags[] = $tag['Tag']['name']; } $body .= 'Tags: ' . implode(', ', $tags) . "\n"; $body .= 'Threat Level: ' . $event['ThreatLevel']['name'] . "\n"; $body .= 'Analysis : ' . $this->analysisLevels[$event['Event']['analysis']] . "\n"; $body .= 'Description : ' . $event['Event']['info'] . "\n"; if (!empty($event['RelatedEvent'])) { $body .= '==============================================' . "\n"; $body .= 'Related to: '. "\n"; foreach ($event['RelatedEvent'] as $relatedEvent) { $body .= $this->__getAnnounceBaseurl() . '/events/view/' . $relatedEvent['Event']['id'] . ' (' . $relatedEvent['Event']['date'] . ') ' ."\n"; } $body .= '==============================================' . "\n"; } $bodyTempOther = ""; if (!empty($event['Attribute'])) { $body .= 'Attributes (* indicates a new or modified attribute):' . "\n"; $this->__buildAlertEmailAttribute($body, $bodyTempOther, $event['Attribute'], $oldpublish); } if (!empty($event['Object'])) { $body .= 'Objects (* indicates a new or modified object):' . "\n"; $this->__buildAlertEmailObject($body, $bodyTempOther, $event['Object'], $oldpublish); } if (!empty($bodyTempOther)) { $body .= "\n"; } $body .= $bodyTempOther; // append the 'other' attribute types to the bottom. $body .= '==============================================' . "\n"; $body .= sprintf( "You receive this e-mail because the e-mail address %s is set to receive publish alerts on the MISP instance at %s.%s%s", $user['email'], $this->__getAnnounceBaseurl(), PHP_EOL, PHP_EOL ); $body .= "If you would like to unsubscribe from receiving such alert e-mails, simply\ndisable publish alerts via " . $this->__getAnnounceBaseurl() . '/users/edit' . PHP_EOL; $body .= '==============================================' . "\n"; return $body; } /** * @param int $id Event ID * @param string $message Message that user want to send to event creator * @param bool $creator_only Should be contacted just event creator or all user from org owning given event? * @param array $user User that wanna know more * @return bool True if all e-mails was send correctly. * @throws Exception */ public function sendContactEmail($id, $message, $creator_only, array $user) { // fetch the event as user that requested more information. So if creators will reply to that email, no data // that requestor could not access would be leaked. $event = $this->fetchEvent($this->User->rearrangeToAuthForm($user), [ 'eventid' => $id, 'includeAllTags' => true, 'includeEventCorrelations' => true, ]); if (empty($event)) { throw new NotFoundException('Invalid Event.'); } $event = $event[0]; if (!$creator_only) { // Insert extra field here: alertOrg or something, then foreach all the org members // limit this array to users with contactalerts turned on! $orgMembers = array(); $this->User->recursive = 0; $temp = $this->User->find('all', array( 'fields' => array('email', 'gpgkey', 'certif_public', 'contactalert', 'id', 'org_id', 'disabled'), 'conditions' => array('disabled' => 0, 'User.org_id' => $event['Event']['orgc_id']), 'recursive' => -1 )); foreach ($temp as $tempElement) { if ($tempElement['User']['contactalert'] || $tempElement['User']['id'] == $event['Event']['user_id']) { array_push($orgMembers, $tempElement); } } } else { $temp = $this->User->find('first', array( 'conditions' => array( 'User.id' => $event['Event']['user_id'], 'User.disabled' => 0, 'User.org_id' => $event['Event']['orgc_id'], ), 'fields' => array('User.email', 'User.gpgkey', 'User.certif_public', 'User.id', 'User.disabled'), 'recursive' => -1 )); if (!empty($temp)) { $orgMembers = array($temp); } } if (empty($orgMembers)) { return false; } $tplColorString = $this->getEmailSubjectMarkForEvent($event); $subject = "[" . Configure::read('MISP.org') . " MISP] Need info about event $id - " . strtoupper($tplColorString); $result = true; foreach ($orgMembers as $reporter) { list($bodyevent, $body) = $this->__buildContactEventEmailBody($user, $message, $event); $result = $this->User->sendEmail($reporter, $bodyevent, $body, $subject, $user) && $result; } return $result; } private function __buildContactEventEmailBody(array $user, $message, array $event) { // The mail body, h() is NOT needed as we are sending plain-text mails. $body = ""; $body .= "Hello, \n"; $body .= "\n"; $body .= "Someone wants to get in touch with you concerning a MISP event. \n"; $body .= "\n"; $body .= "You can reach them at " . $user['User']['email'] . "\n"; if (!empty($user['User']['gpgkey'])) { $body .= "Their GnuPG key is added as attachment to this email. \n"; } if (!empty($user['User']['certif_public'])) { $body .= "Their Public certificate is added as attachment to this email. \n"; } $body .= "\n"; $body .= "They wrote the following message: \n"; $body .= $message . "\n"; $body .= "\n"; $body .= "\n"; $body .= "The event is the following: \n"; // print the event in mail-format // LATER place event-to-email-layout in a function $body .= 'URL : ' . $this->__getAnnounceBaseurl() . '/events/view/' . $event['Event']['id'] . "\n"; $bodyevent = $body; $bodyevent .= 'Event ID : ' . $event['Event']['id'] . "\n"; $bodyevent .= 'Date : ' . $event['Event']['date'] . "\n"; if (Configure::read('MISP.showorg')) { $bodyevent .= 'Reported by : ' . $event['Orgc']['name'] . "\n"; } $bodyevent .= 'Risk : ' . $event['ThreatLevel']['name'] . "\n"; $bodyevent .= 'Analysis : ' . $this->analysisLevels[$event['Event']['analysis']] . "\n"; foreach ($event['RelatedEvent'] as $relatedEvent) { $bodyevent .= 'Related to : ' . $this->__getAnnounceBaseurl() . '/events/view/' . $relatedEvent['Event']['id'] . ' (' . $relatedEvent['Event']['date'] . ')' . "\n"; } $bodyevent .= 'Info : ' . "\n"; $bodyevent .= $event['Event']['info'] . "\n"; $bodyTempOther = ""; if (!empty($event['Attribute'])) { $bodyevent .= 'Attributes:' . "\n"; $this->__buildAlertEmailAttribute($bodyevent, $bodyTempOther, $event['Attribute'], null); } if (!empty($event['Object'])) { $bodyevent .= 'Objects:' . "\n"; $this->__buildAlertEmailObject($bodyevent, $bodyTempOther, $event['Object'], null); } if (!empty($bodyTempOther)) { $bodyevent .= "\n"; } $bodyevent .= $bodyTempOther; // append the 'other' attribute types to the bottom. return array($bodyevent, $body); } public function captureSGForElement($element, $user, $server=false) { if (isset($element['SharingGroup'])) { $sg = $this->SharingGroup->captureSG($element['SharingGroup'], $user, $server); unset($element['SharingGroup']); } elseif (isset($element['sharing_group_id'])) { $sg = $this->SharingGroup->checkIfAuthorised($user, $element['sharing_group_id']) ? $element['sharing_group_id'] : false; } else { $sg = false; } if ($sg===false) { $sg = 0; $element['distribution'] = 0; } $element['sharing_group_id'] = $sg; return $element; } // When we receive an event via REST, we might end up with organisations, sharing groups, tags that we do not know // or which we need to update. All of that is controlled in this method. private function __captureObjects($data, $user, $server=false) { // First we need to check whether the event or any attributes are tied to a sharing group and whether the user is even allowed to create the sharing group / is part of it if (isset($data['Event']['distribution']) && $data['Event']['distribution'] == 4) { $data['Event'] = $this->captureSGForElement($data['Event'], $user, $server); } if (!empty($data['Event']['Attribute'])) { foreach ($data['Event']['Attribute'] as $k => $a) { unset($data['Event']['Attribute']['id']); if (isset($a['distribution']) && $a['distribution'] == 4) { $data['Event']['Attribute'][$k] = $this->captureSGForElement($a, $user, $server); if ($data['Event']['Attribute'][$k] === false) { unset($data['Event']['Attribute']); } } } } if (!empty($data['Event']['Object'])) { foreach ($data['Event']['Object'] as $k => $o) { if (isset($o['distribution']) && $o['distribution'] == 4) { $data['Event']['Object'][$k] = $this->captureSGForElement($o, $user, $server); if ($data['Event']['Object'][$k] === false) { unset($data['Event']['Object'][$k]); continue; } } foreach ($o['Attribute'] as $k2 => $a) { if (isset($a['distribution']) && $a['distribution'] == 4) { $data['Event']['Object'][$k]['Attribute'][$k2] = $this->captureSGForElement($a, $user, $server); if ($data['Event']['Object'][$k]['Attribute'][$k2] === false) { unset($data['Event']['Object'][$k]['Attribute'][$k2]); } } } } } // first we want to see how the creator organisation is encoded // The options here are either by passing an organisation object along or simply passing a string along if (isset($data['Event']['Orgc'])) { $data['Event']['orgc_id'] = $this->Orgc->captureOrg($data['Event']['Orgc'], $user); unset($data['Event']['Orgc']); } elseif (isset($data['Event']['orgc'])) { $data['Event']['orgc_id'] = $this->Orgc->captureOrg($data['Event']['orgc'], $user); unset($data['Event']['orgc']); } else { $data['Event']['orgc_id'] = $user['org_id']; } $event_tag_ids = array(); if (isset($data['Event']['EventTag'])) { if (isset($data['Event']['EventTag']['id'])) { $data['Event']['EventTag'] = array($data['Event']['EventTag']); } $eventTags = array(); foreach ($data['Event']['EventTag'] as $k => $tag) { $temp = $this->EventTag->Tag->captureTag($data['Event']['EventTag'][$k]['Tag'], $user); if ($temp && !in_array($temp, $event_tag_ids)) { $eventTags[] = array('tag_id' => $temp); $event_tag_ids[] = $temp; } unset($data['Event']['EventTag'][$k]); } $data['Event']['EventTag'] = $eventTags; } else { $data['Event']['EventTag'] = array(); } if (isset($data['Event']['Tag'])) { if (isset($data['Event']['Tag']['name'])) { $data['Event']['Tag'] = array($data['Event']['Tag']); } foreach ($data['Event']['Tag'] as $tag) { $tag_id = $this->EventTag->Tag->captureTag($tag, $user); if ($tag_id && !in_array($tag_id, $event_tag_ids)) { $data['Event']['EventTag'][] = array('tag_id' => $tag_id); $event_tag_ids[] = $tag_id; } } unset($data['Event']['Tag']); } if (!empty($data['Event']['Attribute'])) { $data['Event']['Attribute'] = $this->__captureAttributeTags($data['Event']['Attribute'], $user); } if (!empty($data['Event']['Object'])) { foreach ($data['Event']['Object'] as $k => $object) { if (!empty($data['Event']['Object'][$k]['Attribute'])) { $data['Event']['Object'][$k]['Attribute'] = $this->__captureAttributeTags($data['Event']['Object'][$k]['Attribute'], $user); } } } return $data; } private function __captureAttributeTags($attributes, $user) { foreach ($attributes as $k => $a) { if (isset($attributes[$k]['AttributeTag'])) { if (isset($attributes[$k]['AttributeTag']['id'])) { $attributes[$k]['AttributeTag'] = array($attributes[$k]['AttributeTag']); } $attributeTags = array(); foreach ($attributes[$k]['AttributeTag'] as $tk => $tag) { $attributeTags[] = array('tag_id' => $this->Attribute->AttributeTag->Tag->captureTag($attributes[$k]['AttributeTag'][$tk]['Tag'], $user)); unset($attributes[$k]['AttributeTag'][$tk]); } $attributes[$k]['AttributeTag'] = $attributeTags; } else { $attributes[$k]['AttributeTag'] = array(); } if (isset($attributes[$k]['Tag'])) { if (isset($attributes[$k]['Tag']['name'])) { $attributes[$k]['Tag'] = array($attributes[$k]['Tag']); } foreach ($attributes[$k]['Tag'] as $tag) { $tag_id = $this->Attribute->AttributeTag->Tag->captureTag($tag, $user); if ($tag_id) { $attributes[$k]['AttributeTag'][] = array('tag_id' => $tag_id); } } unset($attributes[$k]['Tag']); } } return $attributes; } public function checkEventBlockRules($event) { $this->AdminSetting = ClassRegistry::init('AdminSetting'); $setting = $this->AdminSetting->find('first', [ 'conditions' => ['setting' => 'eventBlockRule'], 'recursive' => -1 ]); if (empty($setting) || empty($setting['AdminSetting']['value'])) { return true; } $rules = json_decode($setting['AdminSetting']['value'], true); if (empty($rules)) { return true; } if (!empty($rules['tags'])) { if (!is_array($rules['tags'])) { $rules['tags'] = [$rules['tags']]; } $eventTags = Hash::extract($event, 'Event.Tag.{n}.name'); if (empty($eventTags)) { $eventTags = Hash::extract($event, 'Event.EventTag.{n}.Tag.name'); } if (!empty($eventTags)) { foreach ($rules['tags'] as $blockTag) { if (in_array($blockTag, $eventTags)) { return false; } } } } return true; } /** * @param array $user * @param string $data * @param bool $isXml * @param bool $takeOwnership * @param bool $publish * @return array[] * @throws Exception */ public function addMISPExportFile(array $user, $data, $isXml = false, $takeOwnership = false, $publish = false) { if (empty($data)) { throw new Exception("File is empty"); } if ($isXml) { App::uses('Xml', 'Utility'); $dataArray = Xml::toArray(Xml::build($data)); } else { $dataArray = $this->jsonDecode($data); if (isset($dataArray['response'][0])) { foreach ($dataArray['response'] as $k => $temp) { $dataArray['Event'][] = $temp['Event']; unset($dataArray['response'][$k]); } } } // In case we receive an event that is not encapsulated in a response. This should never happen (unless it's a copy+paste fail), // but just in case, let's clean it up anyway. if (isset($dataArray['Event'])) { $dataArray['response']['Event'] = $dataArray['Event']; unset($dataArray['Event']); } if (!isset($dataArray['response']) || !isset($dataArray['response']['Event'])) { $exception = $isXml ? __('This is not a valid MISP XML file.') : __('This is not a valid MISP JSON file.'); throw new Exception($exception); } $dataArray = $this->updateXMLArray($dataArray); $results = array(); $validationIssues = array(); if (isset($dataArray['response']['Event'][0])) { foreach ($dataArray['response']['Event'] as $event) { $result = array('info' => $event['info']); if ($takeOwnership) { $event['orgc_id'] = $user['org_id']; unset($event['Orgc']); } $event = array('Event' => $event); $created_id = 0; $event['Event']['locked'] = 1; $event['Event']['published'] = $publish; $result['result'] = $this->_add($event, true, $user, '', null, false, null, $created_id, $validationIssues); $result['id'] = $created_id; $result['validationIssues'] = $validationIssues; $results[] = $result; } } else { $temp['Event'] = $dataArray['response']['Event']; if ($takeOwnership) { $temp['Event']['orgc_id'] = $user['org_id']; unset($temp['Event']['Orgc']); } $created_id = 0; $temp['Event']['locked'] = 1; $temp['Event']['published'] = $publish; $result = $this->_add($temp, true, $user, '', null, false, null, $created_id, $validationIssues); $results = array(array( 'info' => $temp['Event']['info'], 'result' => $result, 'id' => $created_id, 'validationIssues' => $validationIssues, )); } return $results; } // Low level function to add an Event based on an Event $data array public function _add(array &$data, $fromXml, array $user, $org_id = 0, $passAlong = null, $fromPull = false, $jobId = null, &$created_id = 0, &$validationErrors = array()) { if (Configure::read('MISP.enableEventBlocklisting') !== false && isset($data['Event']['uuid'])) { $this->EventBlocklist = ClassRegistry::init('EventBlocklist'); if ($this->EventBlocklist->isBlocked($data['Event']['uuid'])) { return 'Blocked by blocklist'; } } if (!$this->checkEventBlockRules($data)) { return 'Blocked by event block rules'; } $breakOnDuplicate = !empty($data['Event']['breakOnDuplicate']); $this->Log = ClassRegistry::init('Log'); if (empty($data['Event']['Attribute']) && empty($data['Event']['Object']) && !empty($data['Event']['published']) && empty($data['Event']['EventReport'])) { $this->Log->create(); $validationErrors['Event'] = 'Received a published event that was empty. Event add process blocked.'; $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => 0, 'email' => $user['email'], 'action' => 'add', 'user_id' => $user['id'], 'title' => $validationErrors['Event'], 'change' => '' )); return json_encode($validationErrors); } $this->create(); // force check userid and orgname to be from yourself $data['Event']['user_id'] = $user['id']; if ($fromPull) { $data['Event']['org_id'] = $org_id; } else { $data['Event']['org_id'] = $user['Organisation']['id']; } // set these fields if the event is freshly created and not pushed from another instance. // Moved out of if (!$fromXML), since we might get a restful event without the orgc/timestamp set if (!isset($data['Event']['orgc_id']) && !isset($data['Event']['orgc'])) { $data['Event']['orgc_id'] = $data['Event']['org_id']; } else { if (!isset($data['Event']['Orgc'])) { if (isset($data['Event']['orgc_id']) && $data['Event']['orgc_id'] != $user['org_id'] && !$user['Role']['perm_sync'] && !$user['Role']['perm_site_admin']) { throw new MethodNotAllowedException('Event cannot be created as you are not a member of the creator organisation.'); } } else { if ($data['Event']['Orgc']['uuid'] != $user['Organisation']['uuid'] && !$user['Role']['perm_sync'] && !$user['Role']['perm_site_admin']) { throw new MethodNotAllowedException('Event cannot be created as you are not a member of the creator organisation.'); } if (isset($data['Event']['orgc']) && $data['Event']['orgc'] != $user['Organisation']['name'] && !$user['Role']['perm_sync'] && !$user['Role']['perm_site_admin']) { throw new MethodNotAllowedException('Event cannot be created as you are not a member of the creator organisation.'); } } if (isset($data['Event']['orgc_id']) && $data['Event']['orgc_id'] != $user['org_id'] && !$user['Role']['perm_sync'] && !$user['Role']['perm_site_admin']) { throw new MethodNotAllowedException('Event cannot be created as you are not a member of the creator organisation.'); } } if (!Configure::check('MISP.enableOrgBlocklisting') || Configure::read('MISP.enableOrgBlocklisting') !== false) { $this->OrgBlocklist = ClassRegistry::init('OrgBlocklist'); if (!isset($data['Event']['Orgc']['uuid'])) { $orgc = $this->Orgc->find('first', array('conditions' => array('Orgc.id' => $data['Event']['orgc_id']), 'fields' => array('Orgc.uuid'), 'recursive' => -1)); } else { $orgc = array('Orgc' => array('uuid' => $data['Event']['Orgc']['uuid'])); } if ($this->OrgBlocklist->hasAny(array('OrgBlocklist.org_uuid' => $orgc['Orgc']['uuid']))) { return 'blocked'; } } if ($passAlong) { $this->Server = ClassRegistry::init('Server'); $server = $this->Server->find('first', array( 'conditions' => array( 'Server.id' => $passAlong ), 'recursive' => -1, 'fields' => array( 'Server.name', 'Server.id', 'Server.unpublish_event', 'Server.publish_without_email', 'Server.internal' ) )); } else { $server['Server']['internal'] = false; } if ($fromXml) { // Workaround for different structure in XML/array than what CakePHP expects $data = $this->cleanupEventArrayFromXML($data); // the event_id field is not set (normal) so make sure no validation errors are thrown // LATER do this with $this->validator()->remove('event_id'); unset($this->Attribute->validate['event_id']); // otherwise gives bugs because event_id is not set unset($this->Attribute->validate['value']['uniqueValue']); // unset this - we are saving a new event, there are no values to compare against and event_id is not set in the attributes } unset($data['Event']['id']); if (isset($data['Event']['published']) && $data['Event']['published'] && $user['Role']['perm_publish'] == 0) { $data['Event']['published'] = 0; } if (isset($data['Event']['uuid'])) { // check if the uuid already exists $existingEvent = $this->find('first', array('conditions' => array('Event.uuid' => $data['Event']['uuid']))); if ($existingEvent) { // RESTful, set response location header so client can find right URL to edit if ($fromPull) { return false; } if ($fromXml) { $created_id = $existingEvent['Event']['id']; } return $existingEvent['Event']['id']; } else { if ($fromXml) { $data = $this->__captureObjects($data, $user, $server); } if ($data === false) { $failedCapture = true; } } } else { if ($fromXml) { $data = $this->__captureObjects($data, $user, $server); } if ($data === false) { $failedCapture = true; } } if (!empty($failedCapture)) { $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => 0, 'email' => $user['email'], 'action' => 'add', 'user_id' => $user['id'], 'title' => 'Event could not be saved due to a failed sharing group capture.', 'change' => '' )); $validationErrors['Event'] = 'Issues saving a Sharing Group.'; return json_encode($validationErrors); } $fieldList = array( 'Event' => array( 'org_id', 'orgc_id', 'date', 'threat_level_id', 'analysis', 'info', 'user_id', 'published', 'uuid', 'timestamp', 'distribution', 'sharing_group_id', 'locked', 'disable_correlation', 'extends_uuid' ), 'Attribute' => $this->Attribute->captureFields, 'Object' => array( 'name', 'meta-category', 'description', 'template_uuid', 'template_version', 'event_id', 'uuid', 'timestamp', 'distribution', 'sharing_group_id', 'comment', 'deleted' ), 'ObjectRelation' => array(), 'EventReport' => $this->EventReport->captureFields, ); $saveResult = $this->save(array('Event' => $data['Event']), array('fieldList' => $fieldList['Event'])); if ($saveResult) { if ($jobId) { /** @var EventLock $eventLock */ $eventLock = ClassRegistry::init('EventLock'); $eventLock->insertLockBackgroundJob($this->id, $jobId); } if ($passAlong) { if ($server['Server']['publish_without_email'] == 0) { $st = "enabled"; } else { $st = "disabled"; } $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => $saveResult['Event']['id'], 'email' => $user['email'], 'action' => 'add', 'user_id' => $user['id'], 'title' => 'Event pulled from Server(' . $server['Server']['id'] . ') - "' . $server['Server']['name'] . '" - Notification by mail ' . $st, 'change' => '' )); } if (isset($data['Event']['EventTag'])) { foreach ($data['Event']['EventTag'] as $et) { $this->EventTag->create(); $et['event_id'] = $this->id; $this->EventTag->save($et); } } $parentEvent = $this->find('first', array( 'conditions' => array('Event.id' => $this->id), 'recursive' => -1 )); if (!empty($data['Event']['Attribute'])) { foreach ($data['Event']['Attribute'] as $k => $attribute) { $block = false; for ($i = 0; $i < $k; $i++) { if (empty($data['Event']['Attribute'][$i])) { continue; } if ( $data['Event']['Attribute'][$i]['value'] == $attribute['value'] && $data['Event']['Attribute'][$i]['type'] == $attribute['type'] && $data['Event']['Attribute'][$i]['category'] == $attribute['category'] ) { $block = true; unset($data['Event']['Attribute'][$i]); break; } } if (!$block) { $data['Event']['Attribute'][$k] = $this->Attribute->captureAttribute($attribute, $this->id, $user, 0, $this->Log, $parentEvent); } } $data['Event']['Attribute'] = array_values($data['Event']['Attribute']); } $referencesToCapture = array(); if (!empty($data['Event']['Object'])) { $objectDuplicateCache = []; foreach ($data['Event']['Object'] as $k => $object) { $result = $this->Object->captureObject($object, $this->id, $user, $this->Log, false, $breakOnDuplicate); } foreach ($data['Event']['Object'] as $object) { if (isset($object['ObjectReference'])) { foreach ($object['ObjectReference'] as $objectRef) { $objectRef['source_uuid'] = $object['uuid']; $referencesToCapture[] = $objectRef; } } } } foreach ($referencesToCapture as $referenceToCapture) { $result = $this->Object->ObjectReference->captureReference( $referenceToCapture, $this->id, $user, $this->Log ); } if (!empty($data['Event']['EventReport'])) { foreach ($data['Event']['EventReport'] as $report) { $result = $this->EventReport->captureReport($user, $report, $this->id); } } // zeroq: check if sightings are attached and add to event if (isset($data['Sighting']) && !empty($data['Sighting'])) { $this->Sighting = ClassRegistry::init('Sighting'); foreach ($data['Sighting'] as $s) { $result = $this->Sighting->saveSightings($s['attribute_uuid'], false, $s['date_sighting'], $user, $s['type'], $s['source'], $s['uuid']); } } if ($fromXml) { $created_id = $this->id; } if (!empty($data['Event']['published']) && 1 == $data['Event']['published']) { // do the necessary actions to publish the event (email, upload,...) if (('true' != Configure::read('MISP.disablerestalert')) && (empty($server) || empty($server['Server']['publish_without_email']))) { $this->sendAlertEmailRouter($this->getID(), $user); } $this->publish($this->getID(), $passAlong); } if (empty($data['Event']['locked']) && !empty(Configure::read('MISP.default_event_tag_collection'))) { $this->TagCollection = ClassRegistry::init('TagCollection'); $tagCollection = $this->TagCollection->fetchTagCollection($user, array('conditions' => array('TagCollection.id' => Configure::read('MISP.default_event_tag_collection')))); if (!empty($tagCollection)) { $tag_id_list = array(); foreach ($tagCollection[0]['TagCollectionTag'] as $tagCollectionTag) { $tag_id_list[] = $tagCollectionTag['tag_id']; } foreach ($tag_id_list as $tag_id) { $tag = $this->EventTag->Tag->find('first', array( 'conditions' => array('Tag.id' => $tag_id), 'recursive' => -1, 'fields' => array('Tag.name') )); if (!empty($tag)) { $found = $this->EventTag->find('first', array( 'conditions' => array( 'event_id' => $this->id, 'tag_id' => $tag_id ), 'recursive' => -1, )); if (empty($found)) { $this->EventTag->create(); if ($this->EventTag->save(array('event_id' => $this->id, 'tag_id' => $tag_id))) { $this->Log->createLogEntry($user, 'tag', 'Event', $this->id, 'Attached tag (' . $tag_id . ') "' . $tag['Tag']['name'] . '" to event (' . $this->id . ')', 'Event (' . $this->id . ') tagged as Tag (' . $tag_id . ')'); } } } } } } if ($jobId) { $eventLock->deleteBackgroundJobLock($this->id, $jobId); } return true; } else { $validationErrors['Event'] = $this->validationErrors; return json_encode($validationErrors); } } public function _edit(array &$data, array $user, $id = null, $jobId = null, $passAlong = null, $force = false) { $data = $this->cleanupEventArrayFromXML($data); unset($this->Attribute->validate['event_id']); unset($this->Attribute->validate['value']['unique']); // otherwise gives bugs because event_id is not set // reposition to get the event.id with given uuid if (isset($data['Event']['uuid'])) { $conditions = ['Event.uuid' => $data['Event']['uuid']]; } elseif ($id) { $conditions = ['Event.id' => $id]; } else { throw new InvalidArgumentException("No event UUID or ID provided."); } $existingEvent = $this->find('first', ['conditions' => $conditions, 'recursive' => -1]); if ($passAlong) { $this->Server = ClassRegistry::init('Server'); $server = $this->Server->find('first', array( 'conditions' => array( 'Server.id' => $passAlong ), 'recursive' => -1, 'fields' => array( 'Server.name', 'Server.id', 'Server.unpublish_event', 'Server.publish_without_email', 'Server.internal', ) )); } else { $server['Server']['internal'] = false; } // If the event exists... $dateObj = new DateTime(); $date = $dateObj->getTimestamp(); if (count($existingEvent)) { $data['Event']['id'] = $existingEvent['Event']['id']; $id = $existingEvent['Event']['id']; // Conditions affecting all: // user.org == event.org // edit timestamp newer than existing event timestamp if ($force || !isset($data['Event']['timestamp']) || $data['Event']['timestamp'] > $existingEvent['Event']['timestamp']) { if (!isset($data['Event']['timestamp'])) { $data['Event']['timestamp'] = $date; } if (isset($data['Event']['distribution']) && $data['Event']['distribution'] == 4) { if (!isset($data['Event']['SharingGroup'])) { if (!isset($data['Event']['sharing_group_id'])) { return(array('error' => 'Event could not be saved: Sharing group chosen as the distribution level, but no sharing group specified. Make sure that the event includes a valid sharing_group_id or change to a different distribution level.')); } if (!$this->SharingGroup->checkIfAuthorised($user, $data['Event']['sharing_group_id'])) { return(array('error' => 'Event could not be saved: Invalid sharing group or you don\'t have access to that sharing group.')); } } else { $data['Event']['sharing_group_id'] = $this->SharingGroup->captureSG($data['Event']['SharingGroup'], $user, $server); unset($data['Event']['SharingGroup']); if ($data['Event']['sharing_group_id'] === false) { return (array('error' => 'Event could not be saved: User not authorised to create the associated sharing group.')); } } } // If the above is true, we have two more options: // For users that are of the creating org of the event, always allow the edit // For users that are sync users, only allow the edit if the event is locked if ($existingEvent['Event']['orgc_id'] === $user['org_id'] || ($user['Role']['perm_sync'] && $existingEvent['Event']['locked']) || $user['Role']['perm_site_admin']) { if ($user['Role']['perm_sync']) { if (isset($data['Event']['distribution']) && $data['Event']['distribution'] == 4 && !$this->SharingGroup->checkIfAuthorised($user, $data['Event']['sharing_group_id'])) { return (array('error' => 'Event could not be saved: The sync user has to have access to the sharing group in order to be able to edit it.')); } } } else { return (array('error' => 'Event could not be saved: The user used to edit the event is not authorised to do so. This can be caused by the user not being of the same organisation as the original creator of the event whilst also not being a site administrator.')); } } else { return (array('error' => 'Event could not be saved: Event in the request not newer than the local copy.')); } $changed = false; // If a field is not set in the request, just reuse the old value // Also, compare the event to the existing event and see whether this is a meaningful change $recoverFields = array('analysis', 'threat_level_id', 'info', 'distribution', 'date'); foreach ($recoverFields as $rF) { if (!isset($data['Event'][$rF])) { $data['Event'][$rF] = $existingEvent['Event'][$rF]; } else { if ($data['Event'][$rF] != $existingEvent['Event'][$rF]) { $changed = true; } } } } else { return (array('error' => 'Event could not be saved: Could not find the local event.')); } if (!empty($data['Event']['published']) && !$user['Role']['perm_publish']) { $data['Event']['published'] = 0; } if (!isset($data['Event']['published'])) { $data['Event']['published'] = 0; } $fieldList = array( 'date', 'threat_level_id', 'analysis', 'info', 'published', 'uuid', 'distribution', 'timestamp', 'sharing_group_id', 'disable_correlation', 'extends_uuid' ); $saveResult = $this->save(array('Event' => $data['Event']), array('fieldList' => $fieldList)); $this->Log = ClassRegistry::init('Log'); if ($saveResult) { if ($jobId) { /** @var EventLock $eventLock */ $eventLock = ClassRegistry::init('EventLock'); $eventLock->insertLockBackgroundJob($data['Event']['id'], $jobId); } $validationErrors = array(); if (isset($data['Event']['Attribute'])) { $data['Event']['Attribute'] = array_values($data['Event']['Attribute']); foreach ($data['Event']['Attribute'] as $k => $attribute) { $nothingToChange = false; $result = $this->Attribute->editAttribute($attribute, $this->id, $user, 0, $this->Log, $force, $nothingToChange); if ($result !== true) { $validationErrors['Attribute'][] = $result; } if (!$nothingToChange) { $changed = true; } } } if (isset($data['Event']['Object'])) { $data['Event']['Object'] = array_values($data['Event']['Object']); foreach ($data['Event']['Object'] as $k => $object) { $nothingToChange = false; $result = $this->Object->editObject($object, $this->id, $user, $this->Log, $force, $nothingToChange); if ($result !== true) { $validationErrors['Object'][] = $result; } if (!$nothingToChange) { $changed = true; } } foreach ($data['Event']['Object'] as $object) { if (isset($object['ObjectReference'])) { foreach ($object['ObjectReference'] as $objectRef) { $nothingToChange = false; $objectRef['source_uuid'] = $object['uuid']; $result = $this->Object->ObjectReference->captureReference($objectRef, $this->id, $user, $this->Log, $force, $nothingToChange); if ($result && !$nothingToChange) { $changed = true; } } } } } if (isset($data['Event']['EventReport'])) { foreach ($data['Event']['EventReport'] as $i => $report) { $nothingToChange = false; $result = $this->EventReport->editReport($user, ['EventReport' => $report], $this->id, true, $nothingToChange); if (!empty($result)) { $validationErrors['EventReport'][] = $result; } if (!$nothingToChange) { $changed = true; } } } if (isset($data['Event']['Tag']) && $user['Role']['perm_tagger']) { foreach ($data['Event']['Tag'] as $tag) { $tag_id = $this->EventTag->Tag->captureTag($tag, $user); if ($tag_id) { $nothingToChange = false; $tag['id'] = $tag_id; $result = $this->EventTag->handleEventTag($this->id, $tag, $nothingToChange); if ($result && !$nothingToChange) { $changed = true; } } else { // If we couldn't attach the tag it is most likely because we couldn't create it - which could have many reasons // However, if a tag couldn't be added, it could also be that the user is a tagger but not a tag editor // In which case if no matching tag is found, no tag ID is returned. Logging these is pointless as it is the correct behaviour. if ($user['Role']['perm_tag_editor']) { $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => $this->id, 'email' => $user['email'], 'action' => 'edit', 'user_id' => $user['id'], 'title' => 'Failed create or attach Tag ' . $tag['name'] . ' to the event.', 'change' => '' )); } } } } // zeroq: if sightings then attach to event if (isset($data['Sighting']) && !empty($data['Sighting'])) { $this->Sighting = ClassRegistry::init('Sighting'); foreach ($data['Sighting'] as $s) { $result = $this->Sighting->saveSightings($s['attribute_uuid'], false, $s['date_sighting'], $user, $s['type'], $s['source'], $s['uuid']); } } // if published -> do the actual publishing if ($changed && (!empty($data['Event']['published']) && 1 == $data['Event']['published'])) { // The edited event is from a remote server ? if ($passAlong) { if ($server['Server']['publish_without_email'] == 0) { $st = "enabled"; } else { $st = "disabled"; } $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => $saveResult['Event']['id'], 'email' => $user['email'], 'action' => 'add', 'user_id' => $user['id'], 'title' => 'Event edited from Server(' . $server['Server']['id'] . ') - "' . $server['Server']['name'] . '" - Notification by mail ' . $st, 'change' => '' )); } else { $this->Log->create(); $this->Log->save(array( 'org' => $user['Organisation']['name'], 'model' => 'Event', 'model_id' => $saveResult['Event']['id'], 'email' => $user['email'], 'action' => 'add', 'user_id' => $user['id'], 'title' => 'Event edited (locally)', 'change' => '' )); } // do the necessary actions to publish the event (email, upload,...) if ((true != Configure::read('MISP.disablerestalert')) && (empty($server) || empty($server['Server']['publish_without_email']))) { $this->sendAlertEmailRouter($id, $user, $existingEvent['Event']['publish_timestamp']); } $this->publish($existingEvent['Event']['id']); } if ($jobId) { $eventLock->deleteBackgroundJobLock($data['Event']['id'], $jobId); } return true; } return $this->validationErrors; } // format has to be: // array('Event' => array(), 'Attribute' => array('ShadowAttribute' => array()), 'EventTag' => array(), 'ShadowAttribute' => array()); public function savePreparedEvent($event) { unset($event['Event']['id']); $this->create(); $this->save($event['Event']); $event['Event']['id'] = $this->id; $objects = array('Attribute', 'ShadowAttribute', 'EventTag', 'Object'); foreach ($objects as $object_type) { if (!empty($event[$object_type])) { $saveMethod = '__savePrepared' . $object_type; foreach ($event[$object_type] as $object) { $this->$saveMethod($object, $event); } } } if (!empty($event['Object'])) { $objectRefTypes = array('Attribute', 'Object'); foreach ($event['Object'] as $k => $object) { foreach ($object['ObjectReference'] as $k2 => $objectRef) { $savedObjectRef = $this->Object->ObjectReference->find('first', array( 'recursive' => -1, 'conditions' => array('ObjectReference.uuid' => $objectRef['uuid']) )); $objectRefType = intval($savedObjectRef['ObjectReference']['referenced_type']); $element = $this->{$objectRefTypes[$objectRefType]}->find('first', array( 'conditions' => array($objectRefTypes[$objectRefType] . '.uuid' => $objectRef['referenced_uuid']), 'recursive' => -1, 'fields' => array($objectRefTypes[$objectRefType] . '.id') )); $savedObjectRef['ObjectReference']['referenced_id'] = $element[$objectRefTypes[$objectRefType]]['id']; $result = $this->Object->ObjectReference->save($savedObjectRef); } } } return $event['Event']['id']; } private function __savePreparedAttribute(&$attribute, $event, $object_id = 0) { unset($attribute['id']); $attribute['event_id'] = $event['Event']['id']; $attribute['object_id'] = $object_id; $this->Attribute->create(); $this->Attribute->save($attribute); foreach ($attribute['ShadowAttribute'] as $k => $sa) { $this->__savePreparedShadowAttribute($sa, $event, $this->Attribute->id); } foreach ($attribute['AttributeTag'] as $k => $at) { $this->__savePreparedAttributeTag($at, $event, $this->Attribute->id); } return true; } private function __savePreparedObject(&$object, $event) { unset($object['id']); $object['event_id'] = $event['Event']['id']; $this->Object->create(); $this->Object->save($object); foreach ($object['Attribute'] as $k => $a) { $this->__savePreparedAttribute($a, $event, $this->Object->id); } foreach ($object['ObjectReference'] as $objectRef) { $this->__savePreparedObjectReference($objectRef, $event, $this->Object->id, $object['uuid']); } return true; } #referenced IDs have to be updated after everything else is done! private function __savePreparedObjectReference($objectRef, $event, $object_id, $object_uuid) { unset($objectRef['id']); $objectRef['event_id'] = $event['Event']['id']; $objectRef['object_id'] = $object_id; $objectRef['object_uuid'] = $object_uuid; $this->Object->ObjectReference->create(); $this->Object->ObjectReference->save($objectRef); return true; } private function __savePreparedShadowAttribute($shadow_attribute, $event, $old_id = 0) { unset($shadow_attribute['id']); $shadow_attribute['event_id'] = $event['Event']['id']; $shadow_attribute['old_id'] = $old_id; $this->ShadowAttribute->create(); $this->ShadowAttribute->save($shadow_attribute); return true; } private function __savePreparedEventTag($event_tag, $event) { unset($event_tag['id']); $event_tag['event_id'] = $event['Event']['id']; $this->EventTag->create(); $this->EventTag->save($event_tag); return true; } private function __savePreparedAttributeTag($attribute_tag, $event, $attribute_id) { unset($attribute_tag['id']); $attribute_tag['event_id'] = $event['Event']['id']; $attribute_tag['attribute_id'] = $attribute_id; $this->Attribute->AttributeTag->create(); $this->Attribute->AttributeTag->save($attribute_tag); return true; } // pass an event or an attribute together with the server id. // If the distribution of the object outright allows for it to be shared, return true // If the distribution is org only / comm only, return false // If the distribution is sharing group only, check if the sync user is in the sharing group or not, return true if yes, false if no public function checkDistributionForPush($object, $server, $context = 'Event') { if (empty(Configure::read('MISP.host_org_id')) || !$server['Server']['internal'] || Configure::read('MISP.host_org_id') != $server['Server']['remote_org_id']) { if ($object[$context]['distribution'] < 2) { return false; } } if ($object[$context]['distribution'] == 4) { if ($context === 'Event') { return $this->SharingGroup->checkIfServerInSG($object['SharingGroup'], $server); } else { return $this->SharingGroup->checkIfServerInSG($object[$context]['SharingGroup'], $server); } } return true; } // Uploads this specific event or sightings to all remote servers public function uploadEventToServersRouter($id, $passAlong = null, $scope = 'events') { $eventOrgcId = $this->find('first', array( 'conditions' => array('Event.id' => $id), 'recursive' => -1, 'fields' => array('Event.orgc_id') )); // we create a fake site admin user object to fetch the event with everything included // This replaces the old method of manually just fetching everything, staying consistent // with the fetchEvent() output $elevatedUser = array( 'Role' => array( 'perm_site_admin' => 1, 'perm_sync' => 1 ), 'org_id' => $eventOrgcId['Event']['orgc_id'] ); $elevatedUser['Role']['perm_site_admin'] = 1; $elevatedUser['Role']['perm_sync'] = 1; $elevatedUser['Role']['perm_audit'] = 0; $event = $this->fetchEvent($elevatedUser, array('eventid' => $id, 'metadata' => 1)); if (empty($event)) { return true; } $event = $event[0]; $event['Event']['locked'] = 1; // get a list of the servers $this->Server = ClassRegistry::init('Server'); if ($scope === 'sightings') { $conditions = array('push_sightings' => 1); } else { $conditions = array('push' => 1); } if ($passAlong) { $conditions[] = array('Server.id !=' => $passAlong); } $servers = $this->Server->find('all', array( 'conditions' => $conditions, 'order' => array('Server.priority ASC', 'Server.id ASC') )); // iterate over the servers and upload the event if (empty($servers)) { return true; } $uploaded = true; $failedServers = array(); App::uses('SyncTool', 'Tools'); foreach ($servers as &$server) { if ( ($scope === 'events' && (!isset($server['Server']['internal']) || !$server['Server']['internal']) && $event['Event']['distribution'] < 2) || ($scope === 'sightings' && (!isset($server['Server']['push_sightings']) || !$server['Server']['push_sightings'])) ) { continue; } $syncTool = new SyncTool(); $HttpSocket = $syncTool->setupHttpSocket($server); // Skip servers where the event has come from. if (($passAlong != $server['Server']['id'])) { $params = array(); if (!empty($server['Server']['push_rules'])) { $push_rules = json_decode($server['Server']['push_rules'], true); if (!empty($push_rules['tags']['NOT'])) { $params['blockedAttributeTags'] = $push_rules['tags']['NOT']; } } $params = array_merge($params, array( 'eventid' => $id, 'includeAttachments' => true, 'includeAllTags' => true, 'deleted' => array(0,1), 'excludeGalaxy' => 1 )); if (!empty($server['Server']['internal'])) { $params['excludeLocalTags'] = 0; } $event = $this->fetchEvent($elevatedUser, $params); $event = $event[0]; $event['Event']['locked'] = 1; // attach sightings if needed if ($scope === 'sightings') { $this->Sighting = ClassRegistry::init('Sighting'); $fakeSyncUser = array( 'org_id' => $server['Server']['remote_org_id'], 'Role' => array( 'perm_site_admin' => 0 ) ); $sightings = $this->Sighting->attachToEvent($event, $fakeSyncUser, null, false, true); if (!empty($sightings)) { $thisUploaded = $this->uploadSightingsToServer($sightings, $server, $event['Event']['uuid'], $HttpSocket); } else { $thisUploaded = true; } } else { $fakeSyncUser = array( 'org_id' => $server['Server']['remote_org_id'], 'Role' => array( 'perm_site_admin' => 0 ) ); $this->Server->syncGalaxyClusters($HttpSocket, $server, $fakeSyncUser, $technique=$event['Event']['id'], $event=$event); $thisUploaded = $this->uploadEventToServer($event, $server, $HttpSocket, $scope); if (isset($this->data['ShadowAttribute'])) { $this->Server->syncProposals($HttpSocket, $server, null, $id, $this); } } if (!$thisUploaded) { $uploaded = !$uploaded ? $uploaded : $thisUploaded; $failedServers[] = $server['Server']['url']; } } } if (!$uploaded) { if (empty($failedServers)) { return true; } return $failedServers; } else { return true; } } public function __getPrioWorkerIfPossible() { $this->ResqueStatus = new ResqueStatus\ResqueStatus(Resque::redis()); $workers = $this->ResqueStatus->getWorkers(); $workerType = 'default'; foreach ($workers as $worker) { if ($worker['queue'] === 'prio') { $workerType = 'prio'; } } return $workerType; } public function publishRouter($id, $passAlong = null, $user, $scope = 'events') { if (Configure::read('MISP.background_jobs')) { $job_type = 'publish_' . $scope; $function = 'publish'; $message = 'Publishing.'; if ($scope === 'sightings') { $message = 'Publishing sightings.'; $function = 'publish_sightings'; } $job = ClassRegistry::init('Job'); $job->create(); $data = array( 'worker' => $this->__getPrioWorkerIfPossible(), 'job_type' => 'publish_event', 'job_input' => 'Event ID: ' . $id, 'status' => 0, 'retries' => 0, 'org_id' => $user['org_id'], 'org' => $user['Organisation']['name'], 'message' => $message ); $job->save($data); $jobId = $job->id; $process_id = CakeResque::enqueue( 'prio', 'EventShell', array($function, $id, $passAlong, $jobId, $user['id']), true ); $job->saveField('process_id', $process_id); return $process_id; } elseif ($scope === 'sightings') { $result = $this->publish_sightings($id, $passAlong); return $result; } else { $result = $this->publish($id, $passAlong); return $result; } } public function publish_sightings($id, $passAlong = null, $jobId = null) { if (is_numeric($id)) { $condition = array('Event.id' => $id); } else { $condition = array('Event.uuid' => $id); } $event = $this->find('first', array( 'recursive' => -1, 'conditions' => $condition )); if (empty($event)) { return false; } if ($jobId) { $this->Behaviors->unload('SysLogLogable.SysLogLogable'); } else { // update the DB to set the sightings timestamp // for background jobs, this should be done already $fieldList = array('id', 'info', 'sighting_timestamp'); $event['Event']['sighting_timestamp'] = time(); $event['Event']['skip_zmq'] = 1; $event['Event']['skip_kafka'] = 1; $this->save($event, array('fieldList' => $fieldList)); } $uploaded = $this->uploadEventToServersRouter($id, $passAlong, 'sightings'); return $uploaded; } // Performs all the actions required to publish an event public function publish($id, $passAlong = null, $jobId = null) { $event = $this->find('first', array( 'recursive' => -1, 'conditions' => array('Event.id' => $id) )); if (empty($event)) { return false; } if ($jobId) { $this->Behaviors->unload('SysLogLogable.SysLogLogable'); } else { // update the DB to set the published flag // for background jobs, this should be done already $fieldList = array('published', 'id', 'info', 'publish_timestamp'); $event['Event']['published'] = 1; $event['Event']['publish_timestamp'] = time(); $event['Event']['skip_zmq'] = 1; $event['Event']['skip_kafka'] = 1; $this->save($event, array('fieldList' => $fieldList)); } $pubToZmq = Configure::read('Plugin.ZeroMQ_enable'); $kafkaTopic = Configure::read('Plugin.Kafka_event_publish_notifications_topic'); $pubToKafka = Configure::read('Plugin.Kafka_enable') && Configure::read('Plugin.Kafka_event_publish_notifications_enable') && !empty($kafkaTopic); if ($pubToZmq || $pubToKafka) { $hostOrgId = Configure::read('MISP.host_org_id'); if (!empty($hostOrgId)) { $hostOrg = $this->Org->find('first', [ 'recursive' => -1, 'conditions' => [ 'id' => $hostOrgId ] ] ); } if (empty($hostOrg)) { $hostOrg = $this->Org->find('first', [ 'recursive' => -1, 'order' => ['id ASC'] ] ); $hostOrgId = $hostOrg['Org']['id']; } $user = array('org_id' => $hostOrgId, 'Role' => array('perm_sync' => 0, 'perm_audit' => 0, 'perm_site_admin' => 0), 'Organisation' => $hostOrg['Org']); if ($pubToZmq) { $params = array('eventid' => $id); if (Configure::read('Plugin.ZeroMQ_include_attachments')) { $params['includeAttachments'] = 1; } $fullEvent = $this->fetchEvent($user, $params); if (!empty($fullEvent)) { $pubSubTool = $this->getPubSubTool(); $pubSubTool->publishEvent($fullEvent[0], 'publish'); } } if ($pubToKafka) { $params = array('eventid' => $id); if (Configure::read('Plugin.Kafka_include_attachments')) { $params['includeAttachments'] = 1; } $fullEvent = $this->fetchEvent($user, $params); if (!empty($fullEvent)) { $kafkaPubTool = $this->getKafkaPubTool(); $kafkaPubTool->publishJson($kafkaTopic, $fullEvent[0], 'publish'); } } } $uploaded = $this->uploadEventToServersRouter($id, $passAlong); return $uploaded; } // Sends out an email to all people within the same org with the request to be contacted about a specific event. public function sendContactEmailRouter($id, $message, $creator_only, $user) { if (Configure::read('MISP.background_jobs')) { $job = ClassRegistry::init('Job'); $job->create(); $data = array( 'worker' => 'email', 'job_type' => 'contact_alert', 'job_input' => 'Owner ' . ($creator_only ? 'user' : 'org') . ' of event #' . $id, 'status' => 0, 'retries' => 0, 'org_id' => $user['org_id'], 'message' => 'Contacting.', ); $job->save($data); $jobId = $job->id; $process_id = CakeResque::enqueue( 'email', 'EventShell', array('contactemail', $id, $message, $creator_only, $user['id'], $jobId), true ); $job->saveField('process_id', $process_id); return true; } else { return $this->sendContactEmail($id, $message, $creator_only, array('User' => $user)); } } public function generateLocked() { $this->User = ClassRegistry::init('User'); $this->User->recursive = -1; $localOrgs = array(); $conditions = array(); $orgs = $this->User->find('all', array('fields' => array('DISTINCT org_id'))); foreach ($orgs as $k => $org) { $orgs[$k]['User']['count'] = $this->User->getOrgMemberCount($orgs[$k]['User']['org_id']); if ($orgs[$k]['User']['count'] > 1) { $localOrgs[] = $orgs[$k]['User']['org_id']; $conditions['AND'][] = array('orgc !=' => $orgs[$k]['User']['org_id']); } elseif ($orgs[$k]['User']['count'] == 1) { // If we only have a single user for an org, check if that user is a sync user. If not, then it is a valid local org and the events created by him/her should be unlocked. $this->User->recursive = 1; $user = ($this->User->find('first', array( 'fields' => array('id', 'role_id'), 'conditions' => array('org_id' => $org['User']['org_id']), 'contain' => array('Role' => array( 'fields' => array('id', 'perm_sync'), )) ))); if (!$user['Role']['perm_sync']) { $conditions['AND'][] = array('orgc !=' => $orgs[$k]['User']['org_id']); } } } // Don't lock stuff that's already locked $conditions['AND'][] = array('locked !=' => true); $this->recursive = -1; $toBeUpdated = $this->find('count', array( 'conditions' => $conditions )); $this->updateAll( array('Event.locked' => 1), $conditions ); return $toBeUpdated; } public function reportValidationIssuesEvents() { $this->Behaviors->detach('Regexp'); // get all events.. $events = $this->find('all', array('recursive' => -1)); // for all events.. $result = array(); $k = 0; $i = 0; foreach ($events as $k => $event) { $this->set($event); if (!$this->validates()) { $errors = $this->validationErrors; $result[$i]['id'] = $event['Event']['id']; $result[$i]['error'] = $errors; $result[$i]['details'] = $event; $i++; } } return array($result, $k); } public function generateThreatLevelFromRisk() { $risk = array('Undefined' => 4, 'Low' => 3, 'Medium' => 2, 'High' => 1); $events = $this->find('all', array('recursive' => -1)); $k = 0; foreach ($events as $k => $event) { if ($event['Event']['threat_level_id'] == 0 && isset($event['Event']['risk'])) { $event['Event']['threat_level_id'] = $risk[$event['Event']['risk']]; $this->save($event); } } return $k; } // check two version strings. If version 1 is older than 2, return -1, if they are the same return 0, if version 2 is older return 1 public function compareVersions($version1, $version2) { $version1Array = explode('.', $version1); $version2Array = explode('.', $version2); if ($version1Array[0] != $version2Array[0]) { if ($version1Array[0] > $version2Array[0]) { return 1; } else { return -1; } } if ($version1Array[1] != $version2Array[1]) { if ($version1Array[1] > $version2Array[1]) { return 1; } else { return -1; } } if ($version1Array[2] != $version2Array[2]) { if ($version1Array[2] > $version2Array[2]) { return 1; } else { return -1; } } } // main dispatch method for updating an incoming xmlArray - pass xmlArray to all of the appropriate transformation methods to make all the changes necessary to save the imported event public function updateXMLArray($xmlArray, $response = true) { if (isset($xmlArray['xml_version']) && $response) { $xmlArray['response']['xml_version'] = $xmlArray['xml_version']; unset($xmlArray['xml_version']); } if (!$response) { $xmlArray = array('response' => $xmlArray); } // if a version is set, it must be at least 2.2.0 - check the version and save the result of the comparison if (isset($xmlArray['response']['xml_version'])) { $version = $this->compareVersions($xmlArray['response']['xml_version'], $this->mispVersion); } // if no version is set, set the version to older (-1) manually else { $version = -1; } // same version, proceed normally if ($version != 0) { // The xml is from an instance that is newer than the local instance, let the user know that the admin needs to upgrade before it could be imported if ($version == 1) { throw new Exception('This XML file is from a MISP instance that is newer than the current instance. Please contact your administrator about upgrading this instance.'); } // if the xml contains an event or events from an older MISP instance, let's try to upgrade it! // Let's manually set the version to something below 2.2.0 if there is no version set in the xml if (!isset($xmlArray['response']['xml_version'])) { $xmlArray['response']['xml_version'] = '2.1.0'; } // Upgrade from versions below 2.2.0 will need to replace the risk field with threat level id if ($this->compareVersions($xmlArray['response']['xml_version'], '2.2.0') < 0) { if ($response) { $xmlArray['response'] = $this->__updateXMLArray220($xmlArray['response']); } else { $xmlArray = $this->__updateXMLArray220($xmlArray); } } } unset($xmlArray['response']['xml_version']); if ($response) { return $xmlArray; } else { return $xmlArray['response']; } } // replaces the old risk value with the new threat level id private function __updateXMLArray220($xmlArray) { $risk = array('Undefined' => 4, 'Low' => 3, 'Medium' => 2, 'High' => 1); if (isset($xmlArray['Event'][0])) { foreach ($xmlArray['Event'] as &$event) { if (!isset($event['threat_level_id'])) { $event['threat_level_id'] = $risk[$event['risk']]; } } } else { if (!isset($xmlArray['Event']['threat_level_id']) && isset($xmlArray['Event']['risk'])) { $xmlArray['Event']['threat_level_id'] = $risk[$xmlArray['Event']['risk']]; } } return $xmlArray; } public function checkIfNewer($incomingEvent) { $localEvent = $this->find('first', array('conditions' => array('uuid' => $incomingEvent['uuid']), 'recursive' => -1, 'fields' => array('Event.uuid', 'Event.timestamp'))); if (empty($localEvent) || $incomingEvent['timestamp'] > $localEvent['Event']['timestamp']) { return true; } return false; } public function removeOlder(array &$events, $scope = 'events') { $field = $scope === 'sightings' ? 'sighting_timestamp' : 'timestamp'; $localEvents = $this->find('all', [ 'recursive' => -1, 'fields' => ['Event.uuid', 'Event.' . $field, 'Event.locked'], ]); $localEvents = array_column(array_column($localEvents, 'Event'), null, 'uuid'); foreach ($events as $k => $event) { // remove all events for the sighting sync if the remote is not aware of the new field yet if (!isset($event[$field])) { unset($events[$k]); } else { $uuid = $event['uuid']; if (isset($localEvents[$uuid]) && ($localEvents[$uuid][$field] >= $event[$field] || ($scope === 'events' && !$localEvents[$uuid]['locked']))) { unset($events[$k]); } } } } public function sharingGroupRequired($field) { if ($this->data[$this->alias]['distribution'] == 4) { return (!empty($field)); } return true; } // convenience method to check whether a user can see an event public function checkIfAuthorised($user, $id) { if (!isset($user['id'])) { throw new MethodNotAllowedException('Invalid user.'); } $this->id = $id; if (!$this->exists()) { return false; } if ($user['Role']['perm_site_admin']) { return true; } $event = $this->find('first', array( 'conditions' => array('id' => $id), 'recursive' => -1, 'fields' => array('id', 'sharing_group_id', 'distribution', 'org_id') )); if ($event['Event']['org_id'] == $user['org_id'] || ($event['Event']['distribution'] > 0 && $event['Event']['distribution'] < 4)) { return true; } if ($event['Event']['distribution'] == 4 && $this->SharingGroup->checkIfAuthorised($user, $event['Event']['sharing_group_id'])) { return true; } return false; } // expects a date string in the YYYY-MM-DD format // returns the passed string or false if the format is invalid // based on the fix provided by stevengoosensB public function dateFieldCheck($date) { // regex check for from / to field by stevengoossensB return (preg_match('/^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|1[0-9]|2[0-9]|3[01])$/', $date)) ? $date : false; } private function __prepareAttributeForView( $attribute, $correlatedAttributes, $correlatedShadowAttributes, $filterType = false, $sightingsData ) { $attribute['objectType'] = 'attribute'; $include = true; if ($filterType) { /* proposal */ if ($filterType['proposal'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($attribute['ShadowAttribute'])) { // `include only` $include = $include && ($filterType['proposal'] == 1); } else { // `exclude` $include = $include && ($filterType['proposal'] == 2); } /* correlation */ if ($filterType['correlation'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (in_array($attribute['id'], $correlatedAttributes)) { // `include only` $include = $include && ($filterType['correlation'] == 1); } else { // `exclude` $include = $include && ($filterType['correlation'] == 2); } /* feed */ if ($filterType['feed'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($attribute['Feed'])) { // `include only` $include = $include && ($filterType['feed'] == 1); } else { // `exclude` $include = $include && ($filterType['feed'] == 2); } /* server */ if ($filterType['server'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($attribute['Server'])) { // `include only` $include = $include && ($filterType['server'] == 1); } else { // `exclude` $include = $include && ($filterType['server'] == 2); } /* sightings */ if ($filterType['sighting'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (isset($sightingsData['data'][$attribute['id']])) { // `include only` $include = $include && ($filterType['sighting'] == 1); } else { // `exclude` $include = $include && ($filterType['sighting'] == 2); } /* TypeGroupings */ if ( $filterType['attributeFilter'] != 'all' && isset($this->Attribute->typeGroupings[$filterType['attributeFilter']]) && !in_array($attribute['type'], $this->Attribute->typeGroupings[$filterType['attributeFilter']]) ) { $include = false; } if ($filterType['warning'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($attribute['warnings']) || !empty($attribute['validationIssue'])) { // `include only` $include = $include && ($filterType['warning'] == 1); } else { // `exclude` $include = $include && ($filterType['warning'] == 2); } } if (!$include) { return null; } if (!empty($attribute['ShadowAttribute'])) { $temp = array(); foreach ($attribute['ShadowAttribute'] as $k => $proposal) { $result = $this->__prepareProposalForView($proposal, $correlatedShadowAttributes, $filterType); if ($result) { $temp[] = $result; } } $attribute['ShadowAttribute'] = $temp; } return $this->__prepareGenericForView($attribute); } private function __prepareProposalForView($proposal, $correlatedShadowAttributes, $filterType = false) { if ($proposal['proposal_to_delete']) { $proposal['objectType'] = 'proposal_delete'; } else { $proposal['objectType'] = 'proposal'; } $include = true; if ($filterType) { $include = $filterType['proposal'] != 2; /* correlation */ if ($filterType['correlation'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (in_array($proposal['id'], $correlatedShadowAttributes)) { // `include only` $include = $include && ($filterType['correlation'] == 1); } else { // `exclude` $include = $include && ($filterType['correlation'] == 2); } /* feed */ if ($filterType['feed'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($proposal['Feed'])) { // `include only` $include = $include && ($filterType['feed'] == 1); } else { // `exclude` $include = $include && ($filterType['feed'] == 2); } /* server */ if ($filterType['server'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($attribute['Server'])) { // `include only` $include = $include && ($filterType['server'] == 1); } else { // `exclude` $include = $include && ($filterType['server'] == 2); } /* TypeGroupings */ if ( $filterType['attributeFilter'] != 'all' && isset($this->Attribute->typeGroupings[$filterType['attributeFilter']]) && !in_array($proposal['type'], $this->Attribute->typeGroupings[$filterType['attributeFilter']]) ) { $include = false; } /* warning */ if ($filterType['warning'] == 0) { // `both` // pass, do not consider as `both` is selected } else if (!empty($proposal['warnings']) || !empty($proposal['validationIssue'])) { // `include only` $include = $include && ($filterType['warning'] == 1); } else { // `exclude` $include = $include && ($filterType['warning'] == 2); } } if (!$include) { return null; } return $this->__prepareGenericForView($proposal); } private function __prepareObjectForView( $object, $correlatedAttributes, $correlatedShadowAttributes, $filterType = false, $sightingsData ) { $object['category'] = $object['meta-category']; $include = empty($filterType['attributeFilter']) || $filterType['attributeFilter'] == 'object' || $filterType['attributeFilter'] == 'all' || $object['meta-category'] === $filterType['attributeFilter']; if (!$include) { return null; } if (!empty($object['Attribute'])) { $temp = array(); foreach ($object['Attribute'] as $attribute) { $result = $this->__prepareAttributeForView( $attribute, $correlatedAttributes, $correlatedShadowAttributes, false, $sightingsData ); if ($result) { $temp[] = $result; } } $object['Attribute'] = $temp; } // filters depend on child objects if (in_array($filterType['attributeFilter'], array('correlation', 'proposal', 'warning')) || $filterType['correlation'] != 0 || $filterType['proposal'] != 0 || $filterType['warning'] != 0 || $filterType['sighting'] != 0 || $filterType['feed'] != 0 || $filterType['server'] != 0 ) { $include = $this->__checkObjectByFilter($object, $filterType, $correlatedAttributes, $correlatedShadowAttributes, $sightingsData); if (!$include) { return null; } } return $object; } private function __checkObjectByFilter($object, $filterType, $correlatedAttributes, $correlatedShadowAttributes, $sightingsData) { if (empty($object['Attribute'])) { // reject empty object return false; } /* proposal */ if ($filterType['proposal'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['proposal'] == 1 || $filterType['proposal'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $k => $attribute) { // check if object contains at least 1 proposal if (!empty($attribute['ShadowAttribute'])) { $flagKeep = ($filterType['proposal'] == 1); // keep if proposal are included break; } } if (!$flagKeep) { return false; } } /* warning */ if ($filterType['warning'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['warning'] == 1 || $filterType['warning'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $k => $attribute) { // check if object contains at least 1 warning if (!empty($attribute['warnings'])) { $flagKeep = ($filterType['warning'] == 1); // keep if warnings are included } else { $flagKeep = ($filterType['warning'] == 2); // keep if warnings are excluded } if (!$flagKeep && !empty($attribute['ShadowAttribute'])) { foreach ($attribute['ShadowAttribute'] as $shadowAttribute) { if (!empty($shadowAttribute['warnings'])) { $flagKeep = ($filterType['warning'] == 1); // do not keep if warning are excluded break; } } } if ($flagKeep) { break; } } if (!$flagKeep) { return false; } } /* correlation */ if ($filterType['correlation'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['correlation'] == 1 || $filterType['correlation'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $attribute) { // check if object contains at least 1 warning if (in_array($attribute['id'], $correlatedAttributes)) { $flagKeep = ($filterType['correlation'] == 1); // keep if correlations are included } else { $flagKeep = ($filterType['correlation'] == 2); // keep if correlations are excluded } if (!$flagKeep && !empty($attribute['ShadowAttribute'])) { foreach ($attribute['ShadowAttribute'] as $shadowAttribute) { if (in_array($shadowAttribute['id'], $correlatedShadowAttributes)) { $flagKeep = ($filterType['correlation'] == 1); // keep if correlations are included break; } } } if ($flagKeep) { break; } } if (!$flagKeep) { return false; } } /* sighting */ if ($filterType['sighting'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['sighting'] == 1 || $filterType['sighting'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $k => $attribute) { // check if object contains at least 1 warning if (isset($sightingsData['data'][$attribute['id']])) { $flagKeep = ($filterType['sighting'] == 1); // keep if server are included } else { $flagKeep = ($filterType['sighting'] == 2); // keep if server are excluded } if (!$flagKeep && !empty($attribute['ShadowAttribute'])) { foreach ($attribute['ShadowAttribute'] as $shadowAttribute) { if (isset($sightingsData['data'][$attribute['id']])) { $flagKeep = ($filterType['sighting'] == 1); // do not keep if server are excluded break; } } } if ($flagKeep) { break; } } if (!$flagKeep) { return false; } } /* feed */ if ($filterType['feed'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['feed'] == 1 || $filterType['feed'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $k => $attribute) { // check if object contains at least 1 warning if (!empty($attribute['Feed'])) { $flagKeep = ($filterType['feed'] == 1); // keep if feed are included } else { $flagKeep = ($filterType['feed'] == 2); // keep if feed are excluded } if (!$flagKeep && !empty($attribute['ShadowAttribute'])) { foreach ($attribute['ShadowAttribute'] as $shadowAttribute) { if (!empty($shadowAttribute['Feed'])) { $flagKeep = ($filterType['feed'] == 1); // do not keep if feed are excluded break; } } } if ($flagKeep) { break; } } if (!$flagKeep) { return false; } } /* server */ if ($filterType['server'] == 0) { // `both` // pass, do not consider as `both` is selected } else if ($filterType['server'] == 1 || $filterType['server'] == 2) { $flagKeep = false; foreach ($object['Attribute'] as $k => $attribute) { // check if object contains at least 1 warning if (!empty($attribute['Server'])) { $flagKeep = ($filterType['server'] == 1); // keep if server are included } else { $flagKeep = ($filterType['server'] == 2); // keep if server are excluded } if (!$flagKeep && !empty($attribute['ShadowAttribute'])) { foreach ($attribute['ShadowAttribute'] as $shadowAttribute) { if (!empty($shadowAttribute['Server'])) { $flagKeep = ($filterType['server'] == 1); // do not keep if server are excluded break; } } } if ($flagKeep) { break; } } if (!$flagKeep) { return false; } } return true; } private function __prepareGenericForView($object) { if ($this->Attribute->isImage($object)) { if (!empty($object['data'])) { $object['image'] = $object['data']; } else { if (extension_loaded('gd')) { // if extension is loaded, the data is not passed to the view because it is asynchronously fetched $object['image'] = true; // tell the view that it is an image despite not having the actual data } else { if ($object['objectType'] === 'proposal') { $object['image'] = $this->ShadowAttribute->base64EncodeAttachment($object); } else { $object['image'] = $this->Attribute->base64EncodeAttachment($object); } } } } if ($object['type'] === 'attachment' && $this->loadAttachmentScan()->isEnabled()) { $type = $object['objectType'] === 'attribute' ? AttachmentScan::TYPE_ATTRIBUTE : AttachmentScan::TYPE_SHADOW_ATTRIBUTE; $object['infected'] = $this->loadAttachmentScan()->isInfected($type, $object['id']);; } return $object; } public function rearrangeEventForView(&$event, $passedArgs = array(), $all = false, $sightingsData=array()) { foreach ($event['Event'] as $k => $v) { if (is_array($v)) { $event[$k] = $v; unset($event['Event'][$k]); } } $filterType = array( 'attributeFilter' => isset($passedArgs['attributeFilter']) ? $passedArgs['attributeFilter'] : 'all', 'proposal' => isset($passedArgs['proposal']) ? $passedArgs['proposal'] : 0, 'correlation' => isset($passedArgs['correlation']) ? $passedArgs['correlation'] : 0, 'warning' => isset($passedArgs['warning']) ? $passedArgs['warning'] : 0, 'deleted' => isset($passedArgs['deleted']) ? $passedArgs['deleted'] : 0, 'toIDS' => isset($passedArgs['toIDS']) ? $passedArgs['toIDS'] : 0, 'sighting' => isset($passedArgs['sighting']) ? $passedArgs['sighting'] : 0, 'feed' => isset($passedArgs['feed']) ? $passedArgs['feed'] : 0, 'server' => isset($passedArgs['server']) ? $passedArgs['server'] : 0 ); // update proposal, correlation and warning accordingly if (in_array($filterType['attributeFilter'], array('proposal', 'correlation', 'warning'))) { $filterType[$filterType['attributeFilter']] = 1; } $correlatedAttributes = isset($event['RelatedAttribute']) ? array_keys($event['RelatedAttribute']) : array(); $correlatedShadowAttributes = isset($event['RelatedShadowAttribute']) ? array_keys($event['RelatedShadowAttribute']) : array(); $objects = array(); if (isset($event['Attribute'])) { foreach ($event['Attribute'] as $attribute) { $result = $this->__prepareAttributeForView( $attribute, $correlatedAttributes, $correlatedShadowAttributes, $filterType, $sightingsData ); if ($result) { $objects[] = $result; } } unset($event['Attribute']); } if (isset($event['ShadowAttribute'])) { foreach ($event['ShadowAttribute'] as $proposal) { $result = $this->__prepareProposalForView( $proposal, $correlatedShadowAttributes, $filterType ); if ($result) { $objects[] = $result; } } unset($event['ShadowAttribute']); } if (isset($event['Object'])) { foreach ($event['Object'] as $object) { $object['objectType'] = 'object'; $result = $this->__prepareObjectForView( $object, $correlatedAttributes, $correlatedShadowAttributes, $filterType, $sightingsData ); if ($result) { $objects[] = $result; } } unset($event['Object']); } $event['objects'] = $objects; $referencedByArray = array(); foreach ($event['objects'] as $object) { if (!in_array($object['objectType'], array('attribute', 'object'))) { continue; } if (!empty($object['ObjectReference'])) { foreach ($object['ObjectReference'] as $reference) { if (isset($reference['referenced_uuid'])) { $referencedByArray[$reference['referenced_uuid']][$object['objectType']][] = array( 'meta-category' => $object['meta-category'], 'name' => $object['name'], 'uuid' => $object['uuid'], 'id' => isset($object['id']) ? $object['id'] : 0, 'object_type' => $object['objectType'], 'relationship_type' => $reference['relationship_type'] ); } } } } App::uses('CustomPaginationTool', 'Tools'); $customPagination = new CustomPaginationTool(); if ($all) { $passedArgs['page'] = 0; } $params = $customPagination->applyRulesOnArray($event['objects'], $passedArgs, 'events', 'category'); foreach ($event['objects'] as $k => $object) { if (isset($referencedByArray[$object['uuid']])) { foreach ($referencedByArray[$object['uuid']] as $objectType => $references) { $event['objects'][$k]['referenced_by'][$objectType] = $references; } } } $params['total_elements'] = count($event['objects']); return $params; } // pass along a json from the server filter rules // returns a conditions set to be merged into pagination / event fetch / etc public function filterRulesToConditions($rules) { $rules = json_decode($rules, true); $operators = array('OR', 'NOT'); foreach ($operators as $op) { if (!empty($rules['tags'][$op])) { $event_ids = $this->EventTag->find('list', array( 'recursive' => -1, 'conditions' => array('EventTag.tag_id' => $rules['tags'][$op]), 'fields' => array('EventTag.event_id') )); $rules['events'][$op] = $event_ids; } } $conditions = array(); $fields = array('events' => 'Event.id', 'orgs' => 'Event.orgc_id'); foreach ($fields as $k => $field) { $temp = array(); if (!empty($rules[$k]['OR'])) { $temp['OR'][$field] = $rules[$k]['OR']; } if (!empty($rules[$k]['NOT'])) { $temp['AND'][$field . ' !='] = $rules[$k]['NOT']; } $conditions['AND'][] = $temp; } return $conditions; } public function fetchInitialObject($event_id, $object_id) { $initial_object = $this->Object->find('first', array( 'conditions' => array('Object.id' => $object_id, 'Object.event_id' => $event_id, 'Object.deleted' => 0), 'recursive' => -1, 'fields' => array('Object.id', 'Object.uuid', 'Object.name') )); if (!empty($initial_object)) { $initial_attributes = $this->Attribute->find('all', array( 'conditions' => array('Attribute.object_id' => $object_id, 'Attribute.deleted' => 0), 'recursive' => -1, 'fields' => array('Attribute.id', 'Attribute.uuid', 'Attribute.type', 'Attribute.object_relation', 'Attribute.value') )); if (!empty($initial_attributes)) { $initial_object['Attribute'] = array(); foreach ($initial_attributes as $initial_attribute) { array_push($initial_object['Attribute'], $initial_attribute['Attribute']); } } $initial_references = $this->Object->ObjectReference->find('all', array( 'conditions' => array('ObjectReference.object_id' => $object_id, 'ObjectReference.event_id' => $event_id, 'ObjectReference.deleted' => 0), 'recursive' => -1, 'fields' => array('ObjectReference.referenced_uuid', 'ObjectReference.relationship_type') )); if (!empty($initial_references)) { $initial_object['ObjectReference'] = array(); foreach ($initial_references as $initial_reference) { array_push($initial_object['ObjectReference'], $initial_reference['ObjectReference']); } } } return $initial_object; } public function handleModuleResult($result, $event_id) { $resultArray = array(); $freetextResults = array(); App::uses('ComplexTypeTool', 'Tools'); $complexTypeTool = new ComplexTypeTool(); if (isset($result['results']) && !empty($result['results'])) { foreach ($result['results'] as $k => &$r) { if (!is_array($r['values'])) { $r['values'] = array($r['values']); } if (!isset($r['types']) && isset($r['type'])) { $r['types'] = array($r['type']); } if (!is_array($r['types'])) { $r['types'] = array($r['types']); } if (isset($r['categories']) && !is_array($r['categories'])) { $r['categories'] = array($r['categories']); } if (isset($r['tags']) && !is_array($r['tags'])) { $r['tags'] = array($r['tags']); } foreach ($r['values'] as &$value) { if (!is_array($r['values']) || !isset($r['values'][0])) { $r['values'] = array($r['values']); } } foreach ($r['values'] as $valueKey => &$value) { if (empty($value)) { unset($r['values'][$valueKey]); continue; } if (in_array('freetext', $r['types'])) { if (is_array($value)) { $value = json_encode($value); } $this->Warninglist = ClassRegistry::init('Warninglist'); $complexTypeTool->setTLDs($this->Warninglist->fetchTLDLists()); $freetextResults = array_merge($freetextResults, $complexTypeTool->checkComplexRouter($value, 'FreeText')); if (!empty($freetextResults)) { foreach ($freetextResults as &$ft) { $temp = array(); foreach ($ft['types'] as $type) { $temp[$type] = $type; } $ft['event_id'] = $event_id; $ft['types'] = $temp; $ft['comment'] = isset($r['comment']) ? $r['comment'] : false; } } $r['types'] = array_diff($r['types'], array('freetext')); // if we just removed the only type in the result then more on to the next result if (empty($r['types'])) { continue 2; } $r['types'] = array_values($r['types']); } } foreach ($r['values'] as &$value) { $temp = array( 'event_id' => $event_id, 'types' => $r['types'], 'default_type' => $r['types'][0], 'comment' => isset($r['comment']) ? $r['comment'] : false, 'to_ids' => isset($r['to_ids']) ? $r['to_ids'] : false, 'value' => $value, 'tags' => isset($r['tags']) ? $r['tags'] : false ); if (isset($r['categories'])) { $temp['categories'] = $r['categories']; $temp['default_category'] = $r['categories'][0]; } if (isset($r['data'])) { $temp['data'] = $r['data']; } if (isset($r['distribution'])) { $temp['distribution'] = $r['distribution']; } // if data_is_handled is set then MISP assumes that the sample is already zipped and encrypted // in this case it will not try to do this by itself - however it also won't create additional hashes if (isset($r['data_is_handled'])) { $temp['data_is_handled'] = $r['data_is_handled']; } $resultArray[] = $temp; } } $resultArray = array_merge($resultArray, $freetextResults); } return $resultArray; } public function handleMispFormatFromModuleResult(&$result) { $defaultDistribution = 5; if (!empty(Configure::read('MISP.default_attribute_distribution'))) { $defaultDistribution = Configure::read('MISP.default_attribute_distribution'); if ($defaultDistribution == 'event') { $defaultDistribution = 5; } } $event = array(); if (!empty($result['results']['Attribute'])) { $attributes = array(); foreach ($result['results']['Attribute'] as &$tmp_attribute) { $tmp_attribute = $this->__fillAttribute($tmp_attribute, $defaultDistribution); $attributes[] = $tmp_attribute; } $event['Attribute'] = $attributes; } if (!empty($result['results']['Object'])) { $object = array(); foreach ($result['results']['Object'] as $tmp_object) { $tmp_object['distribution'] = (isset($tmp_object['distribution']) ? (int)$tmp_object['distribution'] : $defaultDistribution); $tmp_object['sharing_group_id'] = (isset($tmp_object['sharing_group_id']) ? (int)$tmp_object['sharing_group_id'] : 0); if (!empty($tmp_object['Attribute'])) { foreach ($tmp_object['Attribute'] as &$tmp_attribute) { $tmp_attribute = $this->__fillAttribute($tmp_attribute, $defaultDistribution); } } $objects[] = $tmp_object; } $event['Object'] = $objects; } if (!empty($result['results']['EventReport'])) { $event['EventReport'] = $result['results']['EventReport']; } foreach (array('Tag', 'Galaxy') as $field) { if (!empty($result['results'][$field])) { $event[$field] = $result['results'][$field]; } } return $event; } private function __fillAttribute($attribute, $defaultDistribution) { if (is_array($attribute['type'])) { $attribute_type = $attribute['type'][0]; if (empty($attribute['category'])) { $categories = array(); foreach ($attribute['type'] as $type) { $category = $this->Attribute->typeDefinitions[$type]['default_category']; if (!in_array($category, $categories)) { $categories[] = $category; } } $attribute['category'] = count($categories) === 1 ? $categories[0] : $categories; } } else { $attribute_type = $attribute['type']; if (empty($attribute['category'])) { $attribute['category'] = $this->Attribute->typedefinitions[$attribute_type]['default_category']; } } if (!isset($attribute['to_ids'])) { $attribute['to_ids'] = $this->Attribute->typeDefinitions[$attribute_type]['to_ids']; } $attribute['value'] = $this->Attribute->runRegexp($attribute['type'], $attribute['value']); $attribute['distribution'] = (isset($attribute['distribution']) ? (int)$attribute['distribution'] : $defaultDistribution); $attribute['sharing_group_id'] = (isset($attribute['sharing_group_id']) ? (int)$attribute['sharing_group_id'] : 0); return $attribute; } /** * @param array $user * @param string $module * @param array $options * @return array * @throws Exception */ public function export(array $user, $module, array $options = array()) { if (empty($module)) { throw new InvalidArgumentException('Invalid module.'); } $this->Module = ClassRegistry::init('Module'); $module = $this->Module->getEnabledModule($module, 'Export'); if (!is_array($module)) { throw new NotFoundException('Invalid module.'); } // Export module can specify additional options for event fetch if (isset($module['meta']['fetch_options'])) { $options = array_merge($options, $module['meta']['fetch_options']); } $events = $this->fetchEvent($user, $options); if (empty($events)) { throw new NotFoundException('Invalid event.'); } $modulePayload = array('module' => $module['name']); if (isset($module['meta']['config'])) { foreach ($module['meta']['config'] as $conf) { $modulePayload['config'][$conf] = Configure::read('Plugin.Export_' . $module['name'] . '_' . $conf); } } $standard_format = !empty($module['meta']['require_standard_format']); if ($standard_format) { App::uses('JSONConverterTool', 'Tools'); $converter = new JSONConverterTool(); foreach ($events as $k => $event) { $events[$k] = $converter->convert($event, false, true); } } $modulePayload['data'] = $events; $result = $this->Module->queryModuleServer($modulePayload, false, 'Export'); return [ 'data' => $result['data'], 'extension' => $module['mispattributes']['outputFileExtension'], 'response' => $module['mispattributes']['responseType'] ]; } public function cacheSgids($user, $useCache = false) { if ($useCache && isset($this->assetCache['sgids'])) { return $this->assetCache['sgids']; } else { $sgids = $this->SharingGroup->fetchAllAuthorised($user); if (empty($sgids)) { $sgids = array(-1); } if ($useCache) { $this->assetCache['sgids'] = $sgids; } return $sgids; } } public function __cacheSharingGroupData($user, $useCache = false) { if ($useCache && isset($this->assetCache['sharingGroupData'])) { return $this->assetCache['sharingGroupData']; } else { $sharingGroupDataTemp = $this->SharingGroup->fetchAllAuthorised($user, 'simplified'); $sharingGroupData = array(); foreach ($sharingGroupDataTemp as $k => $v) { if (isset($v['Organisation'])) { $v['SharingGroup']['Organisation'] = $v['Organisation']; } if (isset($v['SharingGroupOrg'])) { $v['SharingGroup']['SharingGroupOrg'] = $v['SharingGroupOrg']; } if (isset($v['SharingGroupServer'])) { $v['SharingGroup']['SharingGroupServer'] = $v['SharingGroupServer']; foreach ($v['SharingGroup']['SharingGroupServer'] as &$sgs) { if ($sgs['server_id'] == 0) { $sgs['Server'] = array( 'id' => '0', 'url' => $this->__getAnnounceBaseurl(), 'name' => $this->__getAnnounceBaseurl() ); } } } $sharingGroupData[$v['SharingGroup']['id']] = array('SharingGroup' => $v['SharingGroup']); } if ($useCache) { $this->assetCache['sharingGroupData'] = $sharingGroupData; } return $sharingGroupData; } } private function __cachedelegatedEventIDs($user, $useCache = false) { if ($useCache && isset($this->assetCache['delegatedEventIDs'])) { return $this->assetCache['delegatedEventIDs']; } else { $this->EventDelegation = ClassRegistry::init('EventDelegation'); $delegatedEventIDs = $this->EventDelegation->find('list', array( 'conditions' => array('EventDelegation.org_id' => $user['org_id']), 'fields' => array('event_id') )); if ($useCache) { $this->assetCache['delegationEventIDs'] = $delegatedEventIDs; } return $delegatedEventIDs; } } private function __generateCachedTagFilters($tagRules, $useCache = false) { if ($useCache && isset($this->assetCache['tagFilters'])) { return $this->assetCache['tagFilters']; } else { $filters = array(); $args = $this->Attribute->dissectArgs($tagRules); $tagArray = $this->EventTag->Tag->fetchEventTagIds($args[0], $args[1]); if (!empty($tagArray[0])) { $filters[] = ['OR' => ['Event.id' => $tagArray[0]]]; } else { $filters[] = ['AND' => ['Event.id NOT IN' => $tagArray[1]]]; } if ($useCache) { $this->assetCache['tagFilters'] = $filters; } return $filters; } } public function unpublishEvent($id, $proposalLock = false) { $event = $this->find('first', array( 'recursive' => -1, 'conditions' => array('Event.id' => $id) )); if (empty($event)) { return false; } $event['Event']['published'] = 0; $date = new DateTime(); $event['Event']['timestamp'] = $date->getTimestamp(); if ($proposalLock) { $event['Event']['proposal_email_lock'] = 0; } $event['Event']['unpublishAction'] = true; return $this->save($event); } public function upload_stix($user, $scriptDir, $filename, $stix_version, $original_file, $publish) { App::uses('Folder', 'Utility'); App::uses('File', 'Utility'); $tempFilePath = $scriptDir . DS . 'tmp' . DS . $filename; if ($stix_version == '2') { $scriptFile = $scriptDir . DS . 'stix2' . DS . 'stix2misp.py'; $shell_command = $this->getPythonVersion() . ' ' . $scriptFile . ' ' . $tempFilePath; $output_path = $tempFilePath . '.stix2'; $stix_version = "STIX 2.0"; } elseif ($stix_version == '1' || $stix_version == '1.1' || $stix_version == '1.2') { $scriptFile = $scriptDir . DS . 'stix2misp.py'; $shell_command = $this->getPythonVersion() . ' ' . $scriptFile . ' ' . $filename; $output_path = $tempFilePath . '.json'; $stix_version = "STIX 1.1"; } else { throw new MethodNotAllowedException('Invalid STIX version'); } $shell_command .= ' ' . escapeshellarg(Configure::read('MISP.default_event_distribution')) . ' ' . escapeshellarg(Configure::read('MISP.default_attribute_distribution')); $synonymsToTagNames = $this->__getTagNamesFromSynonyms($scriptDir); if ($synonymsToTagNames) { $shell_command .= ' ' . $synonymsToTagNames; } $shell_command .= ' 2>' . APP . 'tmp/logs/exec-errors.log'; $result = shell_exec($shell_command); $result = preg_split("/\r\n|\n|\r/", trim($result)); $result = end($result); $tempFile = file_get_contents($tempFilePath); unlink($tempFilePath); if (trim($result) == '1') { $data = file_get_contents($output_path); $data = json_decode($data, true); if (empty($data['Event'])) { $data = array('Event' => $data); } unlink($output_path); $created_id = false; $validationIssues = false; $result = $this->_add($data, true, $user, '', null, false, null, $created_id, $validationIssues); if ($result) { if ($original_file && !is_numeric($result)) { $this->add_original_file($tempFile, $original_file, $created_id, $stix_version); } if ($publish && $user['Role']['perm_publish']) { $this->publish($this->getID(), null); } return $created_id; } return $validationIssues; } else { if (trim($result) == '2') { $response = __('Issues while loading the stix file. '); } elseif (trim($result) == '3') { $response = __('Issues with the maec library. '); } else { $response = __('Issues executing the ingestion script or invalid input. '); } if (!$user['Role']['perm_site_admin']) { $response .= __('Please ask your administrator to '); } else { $response .= __('Please '); } $response .= ' ' . __('check whether the dependencies for STIX are met via the diagnostic tool.'); return $response; } } private function __getTagNamesFromSynonyms($scriptDir) { $synonymsToTagNames = $scriptDir . DS . 'tmp' . DS . 'synonymsToTagNames.json'; if (!file_exists($synonymsToTagNames) || (time() - filemtime($synonymsToTagNames)) > 600) { if (empty($this->GalaxyCluster)) { $this->GalaxyCluster = ClassRegistry::init('GalaxyCluster'); } $clusters = $this->GalaxyCluster->find('all', array( 'recursive' => -1, 'fields' => array( 'GalaxyCluster.value', 'MAX(GalaxyCluster.version)', 'GalaxyCluster.tag_name', 'GalaxyCluster.id' ), 'group' => array('GalaxyCluster.tag_name') )); $synonyms = $this->GalaxyCluster->GalaxyElement->find('all', array( 'recursive' => -1, 'fields' => array('galaxy_cluster_id', 'value'), 'conditions' => array('key' => 'synonyms') )); $idToSynonyms = array(); foreach($synonyms as $synonym) { $idToSynonyms[$synonym['GalaxyElement']['galaxy_cluster_id']][] = $synonym['GalaxyElement']['value']; } $mapping = array(); foreach($clusters as $cluster) { $mapping[$cluster['GalaxyCluster']['value']][] = $cluster['GalaxyCluster']['tag_name']; if (!empty($idToSynonyms[$cluster['GalaxyCluster']['id']])) { foreach($idToSynonyms[$cluster['GalaxyCluster']['id']] as $synonym) { $mapping[$synonym][] = $cluster['GalaxyCluster']['tag_name']; } } } $file = new File($synonymsToTagNames, true, 0644); $file->write(json_encode($mapping)); $file->close(); } return $synonymsToTagNames; } public function enrichmentRouter($options) { if (Configure::read('MISP.background_jobs')) { $job = ClassRegistry::init('Job'); $job->create(); $data = array( 'worker' => $this->__getPrioWorkerIfPossible(), 'job_type' => 'enrichment', 'job_input' => 'Event ID: ' . $options['event_id'] . ' modules: ' . json_encode($options['modules']), 'status' => 0, 'retries' => 0, 'org_id' => $options['user']['org_id'], 'org' => $options['user']['Organisation']['name'], 'message' => 'Enriching event.', ); $job->save($data); $jobId = $job->id; $process_id = CakeResque::enqueue( 'prio', 'EventShell', array('enrichment', $options['user']['id'], $options['event_id'], json_encode($options['modules']), $jobId), true ); $job->saveField('process_id', $process_id); return true; } else { $result = $this->enrichment($options); return __('#' . $result . ' attributes have been created during the enrichment process.'); } } public function enrichment($params) { $option_fields = array('user', 'event_id', 'modules'); foreach ($option_fields as $option_field) { if (empty($params[$option_field])) { throw new MethodNotAllowedException(__('%s not set', $option_field)); } } $event = $this->fetchEvent($params['user'], array('eventid' => $params['event_id'], 'includeAttachments' => 1, 'flatten' => 1)); $this->Module = ClassRegistry::init('Module'); $enabledModules = $this->Module->getEnabledModules($params['user']); if (empty($enabledModules)) { return true; } $options = array(); foreach ($enabledModules['modules'] as $k => $temp) { if (isset($temp['meta']['config'])) { $settings = array(); foreach ($temp['meta']['config'] as $conf) { $settings[$conf] = Configure::read('Plugin.Enrichment_' . $temp['name'] . '_' . $conf); } $enabledModules['modules'][$k]['config'] = $settings; } } if (empty($event)) { throw new MethodNotAllowedException('Invalid event.'); } $attributes_added = 0; $initial_objects = array(); $event_id = $event[0]['Event']['id']; foreach ($event[0]['Attribute'] as $attribute) { $object_id = $attribute['object_id']; foreach ($enabledModules['modules'] as $module) { if (in_array($module['name'], $params['modules'])) { if (in_array($attribute['type'], $module['mispattributes']['input'])) { $data = array('module' => $module['name'], 'event_id' => $event_id, 'attribute_uuid' => $attribute['uuid']); if (!empty($module['config'])) { $data['config'] = $module['config']; } if (!empty($module['mispattributes']['format']) && $module['mispattributes']['format'] == 'misp_standard') { $data['attribute'] = $attribute; if ($object_id != '0' && empty($initial_objects[$object_id])) { $initial_objects[$object_id] = $this->fetchInitialObject($event_id, $object_id); } } else { $data[$attribute['type']] = $attribute['value']; } $result = $this->Module->queryModuleServer($data, false, 'Enrichment'); if (!$result) { throw new MethodNotAllowedException(h($module['name']) . ' service not reachable.'); } //if (isset($result['error'])) $this->Session->setFlash($result['error']); if (!is_array($result)) { throw new Exception($result); } if (!empty($module['mispattributes']['format']) && $module['mispattributes']['format'] == 'misp_standard') { if ($object_id != '0' && !empty($initial_objects[$object_id])) { $result['initialObject'] = $initial_objects[$object_id]; } $default_comment = $attribute['value'] . ': enriched via the ' . $module['name'] . ' module.'; $attributes_added += $this->processModuleResultsData($params['user'], $result['results'], $event_id, $default_comment, false, false, true); } else { $attributes = $this->handleModuleResult($result, $event_id); foreach ($attributes as $a) { $this->Attribute->create(); $a['distribution'] = $attribute['distribution']; $a['sharing_group_id'] = $attribute['sharing_group_id']; $comment = 'Attribute #' . $attribute['id'] . ' enriched by ' . $module['name'] . '.'; if (!empty($a['comment'])) { $a['comment'] .= PHP_EOL . $comment; } else { $a['comment'] = $comment; } $a['type'] = empty($a['default_type']) ? $a['types'][0] : $a['default_type']; $result = $this->Attribute->save($a); if ($result) { $attributes_added++; } } } } } } } return $attributes_added; } public function massageTags($user, $data, $dataType = 'Event', $excludeGalaxy = false, $cullGalaxyTags = false) { $data['Galaxy'] = array(); // unset empty event tags that got added because the tag wasn't exportable if (!empty($data[$dataType . 'Tag'])) { if (!isset($this->GalaxyCluster)) { $this->GalaxyCluster = ClassRegistry::init('GalaxyCluster'); } foreach ($data[$dataType . 'Tag'] as $k => &$dataTag) { if (empty($dataTag['Tag'])) { unset($data[$dataType . 'Tag'][$k]); continue; } $dataTag['Tag']['local'] = empty($dataTag['local']) ? 0 : 1; if (!isset($excludeGalaxy) || !$excludeGalaxy) { if (substr($dataTag['Tag']['name'], 0, strlen('misp-galaxy:')) === 'misp-galaxy:') { $cluster = $this->GalaxyCluster->getCluster($dataTag['Tag']['name'], $user); if ($cluster) { $found = false; $cluster['GalaxyCluster']['local'] = isset($dataTag['local']) ? $dataTag['local'] : false; foreach ($data['Galaxy'] as $j => $galaxy) { if ($galaxy['id'] == $cluster['GalaxyCluster']['Galaxy']['id']) { $found = true; $temp = $cluster; unset($temp['GalaxyCluster']['Galaxy']); $data['Galaxy'][$j]['GalaxyCluster'][] = $temp['GalaxyCluster']; continue; } } if (!$found) { $data['Galaxy'][] = $cluster['GalaxyCluster']['Galaxy']; $temp = $cluster; unset($temp['GalaxyCluster']['Galaxy']); $data['Galaxy'][count($data['Galaxy']) - 1]['GalaxyCluster'][] = $temp['GalaxyCluster']; } if ($cullGalaxyTags) { unset($data[$dataType . 'Tag'][$k]); } } } } } $data[$dataType . 'Tag'] = array_values($data[$dataType . 'Tag']); } return $data; } public function insertLock($user, $id) { $eventLock = ClassRegistry::init('EventLock'); $eventLock->insertLock($user, $id); } private function __logUploadResult($server, $event, $newTextBody) { $this->Log = ClassRegistry::init('Log'); $this->Log->create(); $this->Log->save(array( 'org' => 'SYSTEM', 'model' => 'Server', 'model_id' => $server['Server']['id'], 'email' => 'SYSTEM', 'action' => 'warning', 'user_id' => 0, 'title' => 'Uploading Event (' . $event['Event']['id'] . ') to Server (' . $server['Server']['id'] . ')', 'change' => 'Returned message: ' . $newTextBody, )); return false; } public function processFreeTextData(array $user, $attributes, $id, $default_comment = '', $proposals = false, $adhereToWarninglists = false, $jobId = false, $returnRawResults = false) { $event = $this->find('first', array( 'conditions' => array('id' => $id), 'recursive' => -1, 'fields' => array('orgc_id', 'id', 'uuid'), )); if (empty($event)) { return false; } $results = array(); $objectType = $proposals ? 'ShadowAttribute' : 'Attribute'; if ($adhereToWarninglists) { $this->Warninglist = ClassRegistry::init('Warninglist'); } $saved = 0; $failed = 0; $attributeSources = array('attributes', 'ontheflyattributes'); $ontheflyattributes = array(); $i = 0; if ($jobId) { /** @var EventLock $eventLock */ $eventLock = ClassRegistry::init('EventLock'); $eventLock->insertLockBackgroundJob($event['Event']['id'], $jobId); $this->Job = ClassRegistry::init('Job'); $total = count($attributeSources); } foreach ($attributeSources as $sourceKey => $source) { foreach (${$source} as $k => $attribute) { if ($attribute['type'] == 'ip-src/ip-dst') { $types = array('ip-src', 'ip-dst'); } elseif ($attribute['type'] == 'ip-src|port/ip-dst|port') { $types = array('ip-src|port', 'ip-dst|port'); } elseif ($attribute['type'] == 'malware-sample') { if (!isset($attribute['data_is_handled']) || !$attribute['data_is_handled']) { $result = $this->Attribute->handleMaliciousBase64($id, $attribute['value'], $attribute['data'], array('md5', 'sha1', 'sha256'), $objectType == 'ShadowAttribute' ? true : false); if (!$result['success']) { $failed++; continue; } $attribute['data'] = $result['data']; $shortValue = $attribute['value']; $attribute['value'] = $shortValue . '|' . $result['md5']; $additionalHashes = array('sha1', 'sha256'); foreach ($additionalHashes as $hash) { $temp = $attribute; $temp['type'] = 'filename|' . $hash; $temp['value'] = $shortValue . '|' . $result[$hash]; unset($temp['data']); $ontheflyattributes[] = $temp; } } $types = array($attribute['type']); } else { $types = array($attribute['type']); } foreach ($types as $type) { $this->$objectType->create(); $attribute['type'] = $type; if (empty($attribute['comment'])) { $attribute['comment'] = $default_comment; } $attribute['event_id'] = $id; if ($objectType == 'ShadowAttribute') { $attribute['org_id'] = $user['org_id']; $attribute['event_org_id'] = $event['Event']['orgc_id']; $attribute['email'] = $user['email']; $attribute['event_uuid'] = $event['Event']['uuid']; } // adhere to the warninglist if ($adhereToWarninglists) { if (!$this->Warninglist->filterWarninglistAttribute($attribute)) { if ($adhereToWarninglists === 'soft') { $attribute['to_ids'] = 0; } else { // just ignore the attribute continue; } } } $saved_attribute = $this->$objectType->save($attribute); if ($saved_attribute) { $results[] = $saved_attribute; // If Tags, attach each tags to attribute if (!empty($attribute['tags'])) { foreach (explode(",", $attribute['tags']) as $tagName) { $tagId = $this->Attribute->AttributeTag->Tag->captureTag(array('name' => trim($tagName)), array('Role' => $user['Role'])); if ($tagId === false) { continue; // user don't have permission to use that tag } if (!$this->Attribute->AttributeTag->attachTagToAttribute($saved_attribute['Attribute']['id'], $id, $tagId)) { throw new MethodNotAllowedException(__('Could not add tags.')); } } } $saved++; } else { $lastError = $this->$objectType->validationErrors; $failed++; } } if ($jobId) { if ($i % 20 === 0) { $this->Job->saveProgress($jobId, 'Attribute ' . $i . '/' . $total, $i * 80 / $total); } } } } $emailResult = ''; $messageScope = $objectType == 'ShadowAttribute' ? 'proposals' : 'attributes'; if ($saved > 0) { if ($objectType != 'ShadowAttribute') { $this->unpublishEvent($id); } else { if (!$this->ShadowAttribute->sendProposalAlertEmail($id)) { $emailResult = " but sending out the alert e-mails has failed for at least one recipient"; } } } $messageScopeSaved = $this->__apply_inflector($saved, $messageScope); if ($failed > 0) { if ($failed == 1) { $messageScopeFailed = Inflector::singularize($messageScope); $message = $saved . ' ' . $messageScopeSaved . ' created' . $emailResult . '. ' . $failed . ' ' . $messageScopeFailed . ' could not be saved. Reason for the failure: ' . json_encode($lastError); } else { $message = $saved . ' ' . $messageScopeSaved . ' created' . $emailResult . '. ' . $failed . ' ' . $messageScope . ' could not be saved. This may be due to attributes with similar values already existing.'; } } else { $message = $saved . ' ' . $messageScopeSaved . ' created' . $emailResult . '.'; } if ($jobId) { $eventLock->deleteBackgroundJobLock($event['Event']['id'], $jobId); $this->Job->saveStatus($jobId, true, __('Processing complete. %s', $message)); } if (!empty($returnRawResults)) { return $results; } return $message; } public function processModuleResultsData($user, $resolved_data, $id, $default_comment = '', $jobId = false, $adhereToWarninglists = false, $event_level = false) { if ($jobId) { $this->Job = ClassRegistry::init('Job'); $this->Job->id = $jobId; } $failed_attributes = $failed_objects = $failed_object_attributes = $failed_reports = 0; $saved_attributes = $saved_objects = $saved_object_attributes = $saved_reports = 0; $items_count = 0; $failed = array(); $recovered_uuids = array(); foreach (array('Attribute', 'Object', 'EventReport') as $feature) { if (isset($resolved_data[$feature])) { $items_count += count($resolved_data[$feature]); } } if (!empty($resolved_data['Tag'])) { foreach ($resolved_data['Tag'] as $tag) { $tag_id = $this->EventTag->Tag->captureTag($tag, $user); if ($tag_id) { $this->EventTag->attachTagToEvent($id, $tag_id); } } } if (!empty($resolved_data['Attribute'])) { $total_attributes = count($resolved_data['Attribute']); foreach ($resolved_data['Attribute'] as $a => $attribute) { $this->Attribute->create(); if (empty($attribute['comment'])) { $attribute['comment'] = $default_comment; } if (!empty($attribute['data']) && !empty($attribute['encrypt'])) { $attribute = $this->Attribute->onDemandEncrypt($attribute); } $attribute['event_id'] = $id; if ($this->Attribute->save($attribute)) { $saved_attributes++; if (!empty($attribute['Tag'])) { foreach ($attribute['Tag'] as $tag) { $tag_id = $this->Attribute->AttributeTag->Tag->captureTag($tag, $user); if ($tag_id) { $this->Attribute->AttributeTag->attachTagToAttribute($this->Attribute->id, $id, $tag_id); } } } } else { $failed_attributes++; $lastAttributeError = $this->Attribute->validationErrors; $original_uuid = $this->Object->Attribute->find('first', array( 'conditions' => array('Attribute.event_id' => $id, 'Attribute.object_id' => 0, 'Attribute.deleted' => 0, 'Attribute.type' => $attribute['type'], 'Attribute.value' => $attribute['value']), 'recursive' => -1, 'fields' => array('Attribute.uuid') )); if (!empty($original_uuid)) { $recovered_uuids[$attribute['uuid']] = $original_uuid['Attribute']['uuid']; } else { $failed[] = $attribute['uuid']; } } if ($jobId) { $current = ($a + 1); $this->Job->saveField('message', 'Attribute ' . $current . '/' . $total_attributes); $this->Job->saveField('progress', ($current * 100 / $items_count)); } } } else { $total_attributes = 0; } if (!empty($resolved_data['Object'])) { $initial_object_id = isset($resolved_data['initialObject']) ? $resolved_data['initialObject']['Object']['id'] : "0"; $total_objects = count($resolved_data['Object']); $references = array(); foreach ($resolved_data['Object'] as $o => $object) { if (isset($object['meta_category']) && !isset($object['meta-category'])) { $object['meta-category'] = $object['meta_category']; unset($object['meta_category']); } if (empty($object['comment'])) { $object['comment'] = $default_comment; } $object['event_id'] = $id; if (isset($object['id']) && $object['id'] == $initial_object_id) { $initial_object = $resolved_data['initialObject']; $recovered_uuids[$object['uuid']] = $initial_object['Object']['uuid']; if ($object['name'] != $initial_object['Object']['name']) { throw new NotFoundException(__('Invalid object.')); } $initial_attributes = array(); if (!empty($initial_object['Attribute'])) { foreach ($initial_object['Attribute'] as $initial_attribute) { $initial_attributes[$initial_attribute['object_relation']][] = $initial_attribute['value']; } } $initial_references = array(); if (!empty($initial_object['ObjectReference'])) { foreach ($initial_object['ObjectReference'] as $initial_reference) { $initial_references[$initial_reference['relationship_type']][] = $initial_reference['referenced_uuid']; } } if (!empty($object['Attribute'])) { foreach ($object['Attribute'] as $object_attribute) { $object_relation = $object_attribute['object_relation']; if (isset($initial_attributes[$object_relation]) && in_array($object_attribute['value'], $initial_attributes[$object_relation])) { continue; } if ($this->__saveObjectAttribute($object_attribute, $default_comment, $id, $initial_object_id, $user)) { $saved_object_attributes++; } else { $failed_object_attributes++; $lastObjectAttributeError = $this->Attribute->validationErrors; } } } if (!empty($object['ObjectReference'])) { foreach ($object['ObjectReference'] as $object_reference) { array_push($references, array('objectId' => $initial_object_id, 'reference' => $object_reference)); } } $saved_objects++; } else { if (!empty($object['Attribute'])) { $current_object_id = $this->__findCurrentObjectId($id, $object['Attribute']); if ($current_object_id) { $original_uuid = $this->Object->find('first', array( 'conditions' => array('Object.id' => $current_object_id, 'Object.event_id' => $id, 'Object.name' => $object['name'], 'Object.deleted' => 0), 'recursive' => -1, 'fields' => array('Object.uuid') )); if (!empty($original_uuid)) { $recovered_uuids[$object['uuid']] = $original_uuid['Object']['uuid']; } $object_id = $current_object_id; } else { $this->Object->create(); if ($this->Object->save($object)) { $object_id = $this->Object->id; foreach ($object['Attribute'] as $object_attribute) { if ($this->__saveObjectAttribute($object_attribute, $default_comment, $id, $object_id, $user)) { $saved_object_attributes++; } else { $failed_object_attributes++; $lastObjectAttributeError = $this->Attribute->validationErrors; } } $saved_objects++; } else { $failed_objects++; $lastObjectError = $this->Object->validationErrors; $failed[] = $object['uuid']; continue; } } } else { $this->Object->create(); if ($this->Object->save($object)) { $object_id = $this->Object->id; $saved_objects++; } else { $failed_objects++; $lastObjectError = $this->Object->validationErrors; $failed[] = $object['uuid']; continue; } } if (!empty($object['ObjectReference'])) { foreach($object['ObjectReference'] as $object_reference) { array_push($references, array('objectId' => $object_id, 'reference' => $object_reference)); } } } if ($jobId) { $current = ($o + 1); $this->Job->saveField('message', 'Object ' . $current . '/' . $total_objects); $this->Job->saveField('progress', (($current + $total_attributes) * 100 / $items_count)); } } } if (!empty($references)) { $reference_errors = array(); foreach($references as $reference) { $object_id = $reference['objectId']; $reference = $reference['reference']; if (in_array($reference['object_uuid'], $failed) || in_array($reference['referenced_uuid'], $failed)) { continue; } if (isset($recovered_uuids[$reference['object_uuid']])) { $reference['object_uuid'] = $recovered_uuids[$reference['object_uuid']]; } if (isset($recovered_uuids[$reference['referenced_uuid']])) { $reference['referenced_uuid'] = $recovered_uuids[$reference['referenced_uuid']]; } $current_reference = $this->Object->ObjectReference->find('all', array( 'conditions' => array('ObjectReference.object_id' => $object_id, 'ObjectReference.referenced_uuid' => $reference['referenced_uuid'], 'ObjectReference.relationship_type' => $reference['relationship_type'], 'ObjectReference.event_id' => $id, 'ObjectReference.deleted' => 0), 'recursive' => -1, 'fields' => ('ObjectReference.uuid') )); if (!empty($current_reference)) { continue; } list($referenced_id, $referenced_uuid, $referenced_type) = $this->Object->ObjectReference->getReferencedInfo( $reference['referenced_uuid'], array('Event' => array('id' => $id)), false, $user ); if (!$referenced_id && !$referenced_uuid && !$referenced_type) { continue; } $reference = array( 'event_id' => $id, 'referenced_id' => $referenced_id, 'referenced_uuid' => $referenced_uuid, 'referenced_type' => $referenced_type, 'object_id' => $object_id, 'object_uuid' => $reference['object_uuid'], 'relationship_type' => $reference['relationship_type'] ); $this->Object->ObjectReference->create(); if (!$this->Object->ObjectReference->save($reference)) { $reference_errors[] = $this->Object->ObjectReference->validationErrors; } } } if (!empty($resolved_data['EventReport'])) { $total_reports = count($resolved_data['EventReport']); foreach ($resolved_data['EventReport'] as $i => $report) { $this->EventReport->create(); $report['event_id'] = $id; if ($this->EventReport->save($report)) { $saved_reports++; } else { $failed_reports++; $lastReportError = $this->EventReport->validationErrors; } if ($jobId) { $current = ($i + 1); $this->Job->saveField('message', 'EventReport ' . $current . '/' . $total_reports); $this->Job->saveField('progress', ($current * 100 / $items_count)); } } } else { $total_reports = 0; } if ($saved_attributes > 0 || $saved_objects > 0 || $saved_reports > 0) { $event = $this->find('first', array( 'conditions' => array('Event.id' => $id), 'recursive' => -1 )); if ($event['Event']['published'] == 1) { $event['Event']['published'] = 0; } $date = new DateTime(); $event['Event']['timestamp'] = $date->getTimestamp(); $this->save($event); } if ($event_level) { return $saved_attributes + $saved_object_attributes + $saved_reports; } $message = ''; if ($saved_attributes > 0) { $message .= $saved_attributes . ' ' . $this->__apply_inflector($saved_attributes, 'attribute') . ' created. '; } if ($failed_attributes > 0) { if ($failed_attributes == 1) { $reason = ' attribute could not be saved. Reason for the failure: ' . json_encode($lastAttributeError) . ' '; } else { $reason = ' attributes could not be saved. This may be due to attributes with similar values already existing. '; } $message .= $failed_attributes . $reason; } if ($saved_objects > 0) { $message .= $saved_objects . ' ' . $this->__apply_inflector($saved_objects, 'object') . ' created'; if ($saved_object_attributes > 0) { $message .= ' (including a total of ' . $saved_object_attributes . ' object ' . $this->__apply_inflector($saved_object_attributes, 'attribute') . '). '; } else { $message .= '. '; } } if ($failed_objects > 0) { if ($failed_objects == 1) { $reason = ' object could not be saved. Reason for the failure: '; } else { $reason = ' objects could not be saved. An example of reason for the failure: '; } $message .= $failed_objects . $reason . json_encode($lastObjectError) . ' '; } if ($failed_object_attributes > 0) { if ($failed_object_attributes == 1) { $reason = 'object attribute could not be saved. Reason for the failure: '; } else { $reason = 'object attributes could not be saved. An example of reason for the failure: '; } $message .= 'By the way, ' . $failed_object_attributes . $reason . json_encode($lastObjectAttributeError) . '.'; } if (!empty($reference_errors)) { $reference_error = sizeof($reference_errors) == 1 ? 'a reference is' : 'some references are'; $message .= ' Also, be aware that ' . $reference_error . ' missing: '; foreach ($reference_errors as $error) { $message .= $error; } $message .= 'you can have a look at the module results view you just left, to compare.'; } if ($saved_reports > 0) { $message .= $saved_reports . ' ' . $this->__apply_inflector($saved_reports, 'eventReport') . ' created. '; } if ($failed_reports > 0) { if ($failed_reports == 1) { $reason = ' eventReport could not be saved. Reason for the failure: ' . json_encode($lastReportError) . ' '; } else { $reason = ' eventReport could not be saved. '; } $message .= $failed_reports . $reason; } if ($jobId) { $this->Job->saveField('message', 'Processing complete. ' . $message); $this->Job->saveField('progress', 100); } return $message; } private function __apply_inflector($count, $scope) { return ($count == 1 ? Inflector::singularize($scope) : Inflector::pluralize($scope)); } private function __findCurrentObjectId($event_id, $attributes) { $conditions = array(); foreach($attributes as $attribute) { $conditions[] = array('AND' => array( 'Attribute.object_relation' => $attribute['object_relation'], 'Attribute.value' => $attribute['value'], 'Attribute.type' => $attribute['type'] )); } $ids = array(); foreach ($this->Object->Attribute->find('all', array( 'conditions' => array( 'Attribute.event_id' => $event_id, 'Attribute.object_id !=' => 0, 'Attribute.deleted' => 0, 'OR' => $conditions ), 'recursive' => -1, 'fields' => array('Attribute.object_id'))) as $found_id) { $ids[] = $found_id['Attribute']['object_id']; } $attributes_count = sizeof($attributes); foreach (array_count_values($ids) as $id => $count) { if ($count >= $attributes_count) { return $id; } } return 0; } private function __saveObjectAttribute($attribute, $default_comment, $event_id, $object_id, $user) { $attribute['object_id'] = $object_id; $attribute['event_id'] = $event_id; if (empty($attribute['comment'])) { $attribute['comment'] = $default_comment; } if (!empty($attribute['data']) && !empty($attribute['encrypt'])) { $attribute = $this->Attribute->onDemandEncrypt($attribute); } $this->Attribute->create(); $attribute_save = $this->Attribute->save($attribute); if ($attribute_save) { if (!empty($attribute['Tag'])) { foreach ($attribute['Tag'] as $tag) { $tag_id = $this->Attribute->AttributeTag->Tag->captureTag($tag, $user); if ($tag_id) { $this->Attribute->AttributeTag->attachTagToAttribute($this->Attribute->id, $event_id, $tag_id); } } } } return $attribute_save; } public function processFreeTextDataRouter($user, $attributes, $id, $default_comment = '', $proposals = false, $adhereToWarninglists = false, $returnRawResults = false) { if (Configure::read('MISP.background_jobs') && count($attributes) > 5) { // on background process just big attributes batch list($job, $randomFileName, $tempFile) = $this->__initiateProcessJob($user, $id); $tempData = array( 'user' => $user, 'attributes' => $attributes, 'id' => $id, 'default_comment' => $default_comment, 'proposals' => $proposals, 'adhereToWarninglists' => $adhereToWarninglists, 'jobId' => $job->id, ); $writeResult = $tempFile->write(json_encode($tempData)); if (!$writeResult) { return $this->processFreeTextData($user, $attributes, $id, $default_comment, $proposals, $adhereToWarninglists, false, $returnRawResults); } $tempFile->close(); $process_id = CakeResque::enqueue( 'prio', 'EventShell', array('processfreetext', $randomFileName), true ); $job->saveField('process_id', $process_id); return 'Freetext ingestion queued for background processing. Attributes will be added to the event as they are being processed.'; } else { return $this->processFreeTextData($user, $attributes, $id, $default_comment, $proposals, $adhereToWarninglists, false, $returnRawResults); } } public function processModuleResultsDataRouter($user, $resolved_data, $id, $default_comment = '', $adhereToWarninglists = false) { if (Configure::read('MISP.background_jobs')) { list($job, $randomFileName, $tempFile) = $this->__initiateProcessJob($user, $id, 'module_results'); $tempData = array( 'user' => $user, 'misp_format' => $resolved_data, 'id' => $id, 'default_comment' => $default_comment, 'jobId' => $job->id ); $writeResult = $tempFile->write(json_encode($tempData)); if ($writeResult) { $tempFile->close(); $process_id = CakeResque::enqueue( 'prio', 'EventShell', array('processmoduleresult', $randomFileName), true ); $job->saveField('process_id', $process_id); return 'Module results ingestion queued for background processing. Related data will be added to the event as it is being processed.'; } $tempFile->delete(); } return $this->processModuleResultsData($user, $resolved_data, $id, $default_comment = ''); } private function __initiateProcessJob($user, $id, $format = 'freetext') { $job = ClassRegistry::init('Job'); $job->create(); $data = array( 'worker' => 'default', 'job_type' => __('process_' . $format . '_data'), 'job_input' => 'Event: ' . $id, 'status' => 0, 'retries' => 0, 'org_id' => $user['org_id'], 'org' => $user['Organisation']['name'], 'message' => 'Processing...' ); $job->save($data); $randomFileName = $this->generateRandomFileName() . '.json'; App::uses('Folder', 'Utility'); App::uses('File', 'Utility'); $tempdir = new Folder(APP . 'tmp/cache/ingest', true, 0755); $tempFile = new File(APP . 'tmp/cache/ingest' . DS . $randomFileName, true, 0644); return array($job, $randomFileName, $tempFile); } /** * Get tag from cache by given ID. * * @param int $tagId * @param bool $justExportable If true, return just exportable tags. * @return array|null */ private function __getCachedTag($tagId, $justExportable) { if (!isset($this->assetCache['tags'][$tagId])) { return null; } $tag = $this->assetCache['tags'][$tagId]; if ($justExportable && !$tag['exportable']) { return null; } return $tag; } /** * Fetches all tags for event and event attributes in one query and save to cache. * * @param array $event * @param bool $justExportable If true, cache just exportable tags. */ private function __precacheTagsForEvent(array $event, $justExportable) { $tagIds = []; if (!empty($event['EventTag'])) { foreach ($event['EventTag'] as $eventTag) { $tagIds[$eventTag['tag_id']] = true; } } if (!empty($event['Attribute'])) { foreach ($event['Attribute'] as $attribute) { if (!empty($attribute['AttributeTag'])) { foreach ($attribute['AttributeTag'] as $attributeTag) { $tagIds[$attributeTag['tag_id']] = true; } } } } $notCachedTags = array_diff(array_keys($tagIds), isset($this->assetCache['tags']) ? array_keys($this->assetCache['tags']) : []); if (empty($notCachedTags)) { return; } $conditions = ['id' => $notCachedTags]; if ($justExportable) { $conditions['exportable'] = 1; } $tags = $this->EventTag->Tag->find('all', [ 'recursive' => -1, 'conditions' => $conditions, ]); foreach ($tags as $tag) { $this->assetCache['tags'][$tag['Tag']['id']] = $tag['Tag']; } } /** * Attach tags to attributes and event. * * @param array $event * @param bool $justExportable If true, attach just exportable tags. */ private function __attachTags(array &$event, $justExportable) { $this->__precacheTagsForEvent($event, $justExportable); if (!empty($event['EventTag'])) { foreach ($event['EventTag'] as $etk => $eventTag) { $tag = $this->__getCachedTag($eventTag['tag_id'], $justExportable); if ($tag !== null) { $tag['local'] = empty($eventTag['local']) ? 0 : 1; $event['EventTag'][$etk]['Tag'] = $tag; } else { unset($event['EventTag'][$etk]); } } $event['EventTag'] = array_values($event['EventTag']); } if (!empty($event['Attribute'])) { foreach ($event['Attribute'] as $ak => $attribute) { if (!empty($attribute['AttributeTag'])) { foreach ($attribute['AttributeTag'] as $atk => $attributeTag) { $tag = $this->__getCachedTag($attributeTag['tag_id'], $justExportable); if ($tag !== null) { $tag['local'] = empty($attributeTag['local']) ? 0 : 1; $event['Attribute'][$ak]['AttributeTag'][$atk]['Tag'] = $tag; } else { unset($event['Attribute'][$ak]['AttributeTag'][$atk]); } } $event['Attribute'][$ak]['AttributeTag'] = array_values($event['Attribute'][$ak]['AttributeTag']); } } } } /** * Attach referenced object to ObjectReference. Since reference can be just to attribute or object in the same event, * we just find proper element in event. * * @param array $event * @param array $fields */ private function __attachReferences(array &$event, array $fields) { if (!isset($event['Object'])) { return; } foreach ($event['Object'] as $k => $object) { foreach ($object['ObjectReference'] as $k2 => $reference) { // find referenced object in current event $type = $reference['referenced_type'] == 0 ? 'Attribute' : 'Object'; $found = null; foreach ($event[$type] as $o) { if ($o['id'] == $reference['referenced_id']) { $found = $o; break; } } if ($found) { // copy requested fields $reference = []; foreach (array_merge($fields['common'], $fields[$type]) as $field) { $reference[$field] = $found[$field]; } $event['Object'][$k]['ObjectReference'][$k2][$type] = $reference; } else { // object / attribute might be from an extended event $otherEventText = __('%s from another event', $reference['referenced_type'] == 0 ? 'Attribute' : 'Object'); $event['Object'][$k]['ObjectReference'][$k2][$type] = [ 'name' => '', 'meta-category' => $otherEventText, 'category' => $otherEventText, 'type' => '', 'value' => '', 'uuid' => $reference['referenced_uuid'] ]; } } } } public function restSearch($user, $returnFormat, $filters, $paramsOnly = false, $jobId = false, &$elementCounter = 0, &$renderView = false) { if (!isset($this->validFormats[$returnFormat][1])) { throw new NotFoundException('Invalid output format.'); } App::uses($this->validFormats[$returnFormat][1], 'Export'); $exportTool = new $this->validFormats[$returnFormat][1](); if ($jobId) { $this->Job = ClassRegistry::init('Job'); $this->Job->id = $jobId; } if (!empty($exportTool->use_default_filters)) { $exportTool->setDefaultFilters($filters); } if (empty($exportTool->non_restrictive_export)) { if (!isset($filters['to_ids'])) { $filters['to_ids'] = 1; } if (!isset($filters['published'])) { $filters['published'] = 1; } $filters['allow_proposal_blocking'] = 1; } if (!empty($exportTool->renderView)) { $renderView = $exportTool->renderView; } if (!empty($filters['ignore'])) { $filters['to_ids'] = array(0, 1); $filters['published'] = array(0, 1); } if (!empty($filters['quickFilter'])) { $filters['searchall'] = $filters['quickFilter']; if (!empty($filters['value'])) { unset($filters['value']); } } if (isset($filters['searchall'])) { if (!empty($filters['value'])) { $filters['wildcard'] = $filters['value']; } else { $filters['wildcard'] = $filters['searchall']; } } if (isset($filters['tag']) and !isset($filters['tags'])) { $filters['tags'] = $filters['tag']; } $subqueryElements = $this->harvestSubqueryElements($filters); $filters = $this->addFiltersFromSubqueryElements($filters, $subqueryElements, $user); $filters = $this->addFiltersFromUserSettings($user, $filters); if (empty($exportTool->mock_query_only)) { $filters['include_attribute_count'] = 1; $eventid = $this->filterEventIds($user, $filters, $elementCounter); $eventCount = count($eventid); $eventids_chunked = $this->__clusterEventIds($exportTool, $eventid); unset($eventid); } else { $eventids_chunked = array(); } if (!empty($exportTool->additional_params)) { $filters = array_merge($filters, $exportTool->additional_params); } $exportToolParams = array( 'user' => $user, 'params' => array(), 'returnFormat' => $returnFormat, 'scope' => 'Event', 'filters' => $filters ); if (empty($exportTool->non_restrictive_export)) { if (!isset($filters['to_ids'])) { $filters['to_ids'] = 1; } if (!isset($filters['published'])) { $filters['published'] = 1; } } $tmpfile = new TmpFileTool(); $tmpfile->write($exportTool->header($exportToolParams)); $i = 0; if (!empty($filters['withAttachments'])) { $filters['includeAttachments'] = 1; } $this->Allowedlist = ClassRegistry::init('Allowedlist'); $separator = $exportTool->separator($exportToolParams); unset($filters['page']); unset($filters['limit']); foreach ($eventids_chunked as $chunk) { $filters['eventid'] = $chunk; if (!empty($filters['tags']['NOT'])) { $filters['blockedAttributeTags'] = $filters['tags']['NOT']; unset($filters['tags']['NOT']); } $result = $this->fetchEvent($user, $filters, true); $result = $this->Allowedlist->removeAllowedlistedFromArray($result, false); foreach ($result as $event) { if ($jobId && $i % 10 == 0) { $this->Job->saveField('progress', intval((100 * $i) / $eventCount)); $this->Job->saveField('message', 'Converting Event ' . $i . '/' . $eventCount . '.'); } $temp = $exportTool->handler($event, $exportToolParams); if ($temp !== '') { $tmpfile->writeWithSeparator($temp, $separator); $i++; } } } unset($result); unset($temp); $tmpfile->write($exportTool->footer($exportToolParams)); return $tmpfile; } /* * Receive a list of eventids in the id=>count format * Chunk them by the attribute count to fit the memory limits * */ private function __clusterEventIds($exportTool, $eventIds) { $memory_in_mb = $this->Attribute->convert_to_memory_limit_to_mb(ini_get('memory_limit')); $default_attribute_memory_coefficient = Configure::check('MISP.default_attribute_memory_coefficient') ? Configure::read('MISP.default_attribute_memory_coefficient') : 80; $default_event_memory_divisor = Configure::check('MISP.default_event_memory_multiplier') ? Configure::read('MISP.default_event_memory_divisor') : 3; $memory_scaling_factor = isset($exportTool->memory_scaling_factor) ? $exportTool->memory_scaling_factor : $default_attribute_memory_coefficient; // increase the cost per attribute to account for the overhead of object metadata $memory_scaling_factor = $memory_scaling_factor / $default_event_memory_divisor; $limit = $memory_in_mb * $memory_scaling_factor; $eventIdList = array(); $continue = true; $i = 0; $current_chunk_size = 0; $largest_event = 0; $largest_event_id = 0; foreach ($eventIds as $id => $count) { if ($count > $largest_event) { $largest_event = $count; $largest_event_id = $id; } if ($current_chunk_size == 0 && $count > $limit) { $eventIdList[$i][] = $id; $current_chunk_size = $count; $i++; } else { if (($current_chunk_size + $count) > $limit) { $i++; $eventIdList[$i][] = $id; $current_chunk_size = $count; } else { $current_chunk_size += $count; $eventIdList[$i][] = $id; } } } if ($largest_event/$memory_scaling_factor > $memory_in_mb) { $this->Log = ClassRegistry::init('Log'); $this->Log->create(); $this->Log->save(array( 'org' => 'SYSTEM', 'model' => 'Event', 'model_id' => 0, 'email' => 'SYSTEM', 'action' => 'error', 'title' => sprintf('Event fetch potential memory exhaustion.' . PHP_EOL . 'During the fetching of events, a large event (#%s) was detected that exceeds the available PHP memory.' . PHP_EOL . 'Consider raising the PHP max_memory setting to at least %sM', $largest_event_id, ceil($largest_event/$memory_scaling_factor)), 'change' => null, )); } return $eventIdList; } public function add_original_file($file, $original_filename, $event_id, $format) { if (!Configure::check('MISP.default_attribute_distribution') || Configure::read('MISP.default_attribute_distribution') === 'event') { $distribution = 5; } else { $distribution = Configure::read('MISP.default_attribute_distribution'); } $this->Object->create(); $object = array( 'name' => 'original-imported-file', 'meta-category' => 'file', 'description' => 'Object describing the original file used to import data in MISP.', 'template_uuid' => '4cd560e9-2cfe-40a1-9964-7b2e797ecac5', 'template_version' => '2', 'event_id' => $event_id, 'distribution' => $distribution ); $this->Object->save($object); $object_id = $this->Object->id; $attributes = array( array( 'type' => 'attachment', 'category' => 'External analysis', 'to_ids' => false, 'event_id' => $event_id, 'distribution' => $distribution, 'object_relation' => 'imported-sample', 'value' => $original_filename, 'data' => base64_encode($file), 'object_id' => $object_id, 'disable_correlation' => true ), array( 'type' => 'text', 'category' => 'Other', 'to_ids' => false, 'event_id' => $event_id, 'distribution' => $distribution, 'object_id' => $object_id, 'object_relation' => 'format', 'value' => $format, 'disable_correlation' => true ) ); foreach ($attributes as $attribute) { $this->Attribute->create(); $this->Attribute->save($attribute); } return true; } private function getRequiredTaxonomies() { $this->Taxonomy = ClassRegistry::init('Taxonomy'); return $this->Taxonomy->find('column', array( 'conditions' => array('Taxonomy.required' => 1, 'Taxonomy.enabled' => 1), 'fields' => array('Taxonomy.namespace') )); } public function missingTaxonomies(array $event) { $requiredTaxonomies = $this->getRequiredTaxonomies(); return $this->checkMissingTaxonomies($requiredTaxonomies, $event['EventTag']); } public function checkIfPublishable($id) { $requiredTaxonomies = $this->getRequiredTaxonomies(); if (!empty($requiredTaxonomies)) { $eventTags = $this->EventTag->find('all', array( 'conditions' => array('EventTag.event_id' => $id), 'recursive' => -1, 'contain' => array('Tag' => ['fields' => ['name']]) )); $missing = $this->checkMissingTaxonomies($requiredTaxonomies, $eventTags); if (!empty($missing)) { return $missing; } } return true; } /** * @param array $requiredTaxonomies * @param array $eventTags * @return array */ private function checkMissingTaxonomies(array $requiredTaxonomies, array $eventTags) { $missing = []; foreach ($requiredTaxonomies as $requiredTaxonomy) { $found = false; foreach ($eventTags as $tag) { $splits = $this->Taxonomy->splitTagToComponents($tag['Tag']['name']); if ($splits !== null && $splits['namespace'] === $requiredTaxonomy) { $found = true; break; } } if (!$found) { $missing[] = $requiredTaxonomy; } } return $missing; } public function harvestSubqueryElements($options) { $acceptedRules = array( 'galaxy' => 1, 'org' => array('sector', 'local', 'nationality') ); $subqueryElement = array( 'galaxy' => array(), 'org' => array(), ); foreach($options as $rule => $value) { $split = explode(".", $rule, 2); if (count($split) > 1) { $scope = $split[0]; $element = $split[1]; if (isset($acceptedRules[$scope])) { if (is_array($acceptedRules[$scope]) && !in_array($element, $acceptedRules[$scope])) { continue; } else { $subqueryElement[$scope][$element] = $value; } } } } return $subqueryElement; } public function addFiltersFromSubqueryElements($filters, $subqueryElements, $user) { if (!empty($subqueryElements['galaxy'])) { $this->GalaxyCluster = ClassRegistry::init('GalaxyCluster'); $tagsFromGalaxyMeta = $this->GalaxyCluster->getClusterTagsFromMeta($subqueryElements['galaxy'], $user); if (empty($tagsFromGalaxyMeta)) { $filters['eventid'] = -1; } if (!empty($filters['tags'])) { $filters['tags'][] = $tagsFromGalaxyMeta; } else { $filters['tags'] = $tagsFromGalaxyMeta; } } if (!empty($subqueryElements['org'])) { $Organisation = ClassRegistry::init('Organisation'); $orgcIdsFromMeta = $Organisation->getOrgIdsFromMeta($subqueryElements['org']); if (!empty($filters['org'])) { $filters['org'][] = $orgcIdsFromMeta; } else { $filters['org'] = $orgcIdsFromMeta; } } return $filters; } public function addFiltersFromUserSettings($user, $filters) { $this->UserSetting = ClassRegistry::init('UserSetting'); $defaultParameters = $this->UserSetting->getDefaulRestSearchParameters($user); $filters = array_replace_recursive($defaultParameters, $filters); return $filters; } /** * @param array $event */ public function removeGalaxyClusterTags(array &$event) { $galaxyTagIds = array(); foreach ($event['Galaxy'] as $galaxy) { foreach ($galaxy['GalaxyCluster'] as $galaxyCluster) { $galaxyTagIds[$galaxyCluster['tag_id']] = true; } } if (empty($galaxyTagIds)) { return; } foreach ($event['EventTag'] as $k => $eventTag) { if (isset($galaxyTagIds[$eventTag['tag_id']])) { unset($event['EventTag'][$k]); } } } /** * extractAllTagNames Returns all tag names attached to any elements in an event * * @param mixed $event * @return array All tag names in the event */ public function extractAllTagNames(array $event) { $tags = array(); if (!empty($event['EventTag'])) { foreach ($event['EventTag'] as $eventTag) { $tagName = $eventTag['Tag']['name']; $tags[$tagName] = $tagName; } } if (!empty($event['Attribute'])) { foreach ($event['Attribute'] as $attribute) { foreach ($attribute['AttributeTag'] as $attributeTag) { $tagName = $attributeTag['Tag']['name']; $tags[$tagName] = $tagName; } } } if (!empty($event['ShadowAttribute'])) { foreach ($event['ShadowAttribute'] as $attribute) { foreach ($attribute['AttributeTag'] as $attributeTag) { $tagName = $attributeTag['Tag']['name']; $tags[$tagName] = $tagName; } } } if (!empty($event['Object'])) { foreach ($event['Object'] as $object) { foreach ($object['Attribute'] as $attribute) { foreach ($attribute['AttributeTag'] as $attributeTag) { $tagName = $attributeTag['Tag']['name']; $tags[$tagName] = $tagName; } } } } return $tags; } public function recoverEvent($id) { $this->Log = ClassRegistry::init('Log'); $result = $this->Log->recoverDeletedEvent($id); return $result; } /** * @param array $event Event with assigned `EventTag` * @return string */ private function getEmailSubjectMarkForEvent(array $event) { $subjTag = Configure::read('MISP.email_subject_tag') ?: "tlp"; $tagLen = strlen($subjTag); foreach ($event['EventTag'] as $tag) { $tagName = $tag['Tag']['name']; if (strncasecmp($subjTag, $tagName, $tagLen) === 0 && strlen($tagName) > $tagLen && ($tagName[$tagLen] === ':' || $tagName[$tagLen] === '=')) { if (Configure::read('MISP.email_subject_include_tag_name') === false) { return trim(substr($tagName, $tagLen + 1), '"'); } else { return $tagName; } } } // default value if no match found return Configure::read('MISP.email_subject_TLP_string') ?: "tlp:amber"; } public function getExtendingEventIdsFromEvent($user, $eventID) { $event = $this->fetchSimpleEvent($user, $eventID); if (!empty($event)) { $extendingEventIds = $this->fetchSimpleEventIds($user, ['conditions' => [ 'extends_uuid' => $event['Event']['uuid'] ]]); return $extendingEventIds; } return []; } }