mirror of https://github.com/MISP/MISP
367 lines
14 KiB
PHP
367 lines
14 KiB
PHP
<?php
|
|
App::uses('AppModel', 'Model');
|
|
|
|
/**
|
|
* @property MispObject $Object
|
|
*/
|
|
class ObjectReference extends AppModel
|
|
{
|
|
public $actsAs = array(
|
|
'AuditLog',
|
|
'Containable',
|
|
'SysLogLogable.SysLogLogable' => array( // TODO Audit, logable
|
|
'userModel' => 'User',
|
|
'userKey' => 'user_id',
|
|
'change' => 'full'),
|
|
);
|
|
|
|
public $belongsTo = array(
|
|
'Object' => array(
|
|
'className' => 'MispObject',
|
|
'foreignKey' => 'object_id'
|
|
),
|
|
'ReferencedObject' => array(
|
|
'className' => 'MispObject',
|
|
'foreignKey' => false,
|
|
'conditions' => array(
|
|
'ReferencedObject.id' => 'ObjectReference.referenced_id',
|
|
1 => 'ObjectReference.referenced_type'
|
|
),
|
|
),
|
|
'ReferencedAttribute' => array(
|
|
'className' => 'Attribute',
|
|
'foreignKey' => false,
|
|
'conditions' => array(
|
|
'ReferencedAttribute.id' => 'ObjectReference.referenced_id',
|
|
0 => 'ObjectReference.referenced_type'
|
|
),
|
|
)
|
|
);
|
|
|
|
public $validate = [
|
|
'uuid' => 'uuid',
|
|
'object_id' => [
|
|
'rule' => 'numeric',
|
|
'required' => true,
|
|
'on' => 'create',
|
|
],
|
|
'event_id' => [
|
|
'rule' => 'numeric',
|
|
'required' => true,
|
|
'on' => 'create',
|
|
],
|
|
'source_uuid' => 'uuid',
|
|
'referenced_uuid' => 'uuid',
|
|
'referenced_id' => 'numeric',
|
|
'referenced_type' => [
|
|
'rule' => ['inList', ['0', '1']],
|
|
],
|
|
'deleted' => 'boolean',
|
|
];
|
|
|
|
public function beforeValidate($options = array())
|
|
{
|
|
$reference = &$this->data['ObjectReference'];
|
|
if (empty($reference['uuid'])) {
|
|
$reference['uuid'] = CakeText::uuid();
|
|
}
|
|
if (empty($reference['timestamp'])) {
|
|
$reference['timestamp'] = time();
|
|
}
|
|
if (!isset($reference['comment'])) {
|
|
$reference['comment'] = '';
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function afterSave($created, $options = array())
|
|
{
|
|
$pubToZmq = Configure::read('Plugin.ZeroMQ_enable') && Configure::read('Plugin.ZeroMQ_object_reference_notifications_enable');
|
|
$kafkaTopic = $this->kafkaTopic('object_reference');
|
|
if ($pubToZmq || $kafkaTopic) {
|
|
$object_reference = $this->find('first', array(
|
|
'conditions' => array('ObjectReference.id' => $this->id),
|
|
'recursive' => -1
|
|
));
|
|
$action = $created ? 'add' : 'edit';
|
|
if (!empty($this->data['ObjectReference']['deleted'])) {
|
|
$action = 'soft-delete';
|
|
}
|
|
if ($pubToZmq) {
|
|
$pubSubTool = $this->getPubSubTool();
|
|
$pubSubTool->object_reference_save($object_reference, $action);
|
|
}
|
|
if ($kafkaTopic) {
|
|
$kafkaPubTool = $this->getKafkaPubTool();
|
|
$kafkaPubTool->publishJson($kafkaTopic, $object_reference, $action);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param int|array $objectReference
|
|
* @return false|void
|
|
* @throws Exception
|
|
*/
|
|
public function updateTimestamps($objectReference)
|
|
{
|
|
if (is_numeric($objectReference)) {
|
|
$objectReference = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('ObjectReference.id' => $objectReference),
|
|
'fields' => array('event_id', 'object_id')
|
|
));
|
|
if (empty($objectReference)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (!isset($objectReference['ObjectReference'])) {
|
|
$objectReference = array('ObjectReference' => $objectReference);
|
|
}
|
|
$this->Object->updateTimestamp($objectReference['ObjectReference']['object_id']);
|
|
$this->Object->Event->unpublishEvent($objectReference['ObjectReference']['event_id']);
|
|
}
|
|
|
|
public function smartDelete($id, $hard = false)
|
|
{
|
|
if ($hard) {
|
|
$result = $this->delete($id);
|
|
if ($result) {
|
|
$this->updateTimestamps($id);
|
|
}
|
|
return $result;
|
|
} else {
|
|
$reference = $this->find('first', array(
|
|
'conditions' => array('ObjectReference.id' => $id),
|
|
'recursive' => -1
|
|
));
|
|
if (empty($reference)) {
|
|
return array('Invalid object reference.');
|
|
}
|
|
$reference['ObjectReference']['deleted'] = 1;
|
|
$result = $this->save($reference);
|
|
if ($result) {
|
|
$this->updateTimestamps($id);
|
|
return true;
|
|
}
|
|
return $this->validationErrors;
|
|
}
|
|
}
|
|
|
|
public function smartSave($objectReference, $eventId)
|
|
{
|
|
$sides = array('object', 'referenced');
|
|
$data = array();
|
|
foreach ($sides as $side) {
|
|
$data[$side] = $this->Object->find('first', array(
|
|
'conditions' => array(
|
|
'Object.uuid' => $objectReference[$side . '_uuid'],
|
|
'Object.event_id' => $eventId
|
|
),
|
|
'recursive' => -1,
|
|
'fields' => array('Object.id')
|
|
));
|
|
if (empty($data[$side]) && $side == 'referenced') {
|
|
$data[$side] = $this->Attribute->find('first', array(
|
|
'conditions' => array(
|
|
'Attribute.uuid' => $objectReference[$side . '_uuid'],
|
|
'Attribute.event_id' => $eventId
|
|
),
|
|
'recursive' => -1,
|
|
'fields' => array('Attribute.id')
|
|
));
|
|
$referenced_id = $data[$side]['Attribute']['id'];
|
|
$referenced_type = 0;
|
|
} elseif (!empty($data[$side]) && $side == 'referenced') {
|
|
$referenced_id = $data[$side]['Object']['id'];
|
|
$referenced_type = 1;
|
|
} elseif (!empty($data[$side]) && $side = 'object') {
|
|
$object_id = $data[$side]['Object']['id'];
|
|
} else {
|
|
return 'Invalid ' . $side . ' uuid';
|
|
}
|
|
}
|
|
$this->create();
|
|
$objectReference['referenced_type'] = $referenced_type;
|
|
$objectReference['referenced_id'] = $referenced_id;
|
|
$objectReference['object_id'] = $object_id;
|
|
$objectReference['event_id'] = $eventId;
|
|
$result = $this->save(array('ObjectReference' => $objectReference));
|
|
if (!$result) {
|
|
return $this->validationErrors;
|
|
} else {
|
|
$this->updateTimestamps($objectReference);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param array $reference
|
|
* @param int $eventId
|
|
* @return array|bool
|
|
* @throws Exception
|
|
*/
|
|
public function captureReference(array $reference, $eventId)
|
|
{
|
|
if (isset($reference['uuid'])) {
|
|
$existingReference = $this->find('first', array(
|
|
'conditions' => array('ObjectReference.uuid' => $reference['uuid']),
|
|
'recursive' => -1
|
|
));
|
|
if (!empty($existingReference)) {
|
|
// ObjectReference not newer than existing one
|
|
if (isset($reference['timestamp']) && $reference['timestamp'] <= $existingReference['ObjectReference']['timestamp']) {
|
|
return true;
|
|
}
|
|
$fieldsToUpdate = array('timestamp', 'relationship_type', 'comment', 'deleted');
|
|
foreach ($fieldsToUpdate as $field) {
|
|
if (isset($reference[$field])) {
|
|
$existingReference['ObjectReference'][$field] = $reference[$field];
|
|
}
|
|
}
|
|
$result = $this->save($existingReference);
|
|
if ($result) {
|
|
return true;
|
|
} else {
|
|
return $this->validationErrors;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($reference['source_uuid'])) {
|
|
$sourceObjectConditions = array('Object.uuid' => $reference['source_uuid']);
|
|
} elseif (isset($reference['object_uuid'])) {
|
|
$sourceObjectConditions = array('Object.uuid' => $reference['object_uuid']);
|
|
} elseif (isset($reference['object_id'])) {
|
|
$sourceObjectConditions = array('Object.id' => $reference['object_id']);
|
|
} else {
|
|
return true;
|
|
}
|
|
$sourceObjectConditions['Object.event_id'] = $eventId;
|
|
$sourceObject = $this->Object->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => $sourceObjectConditions,
|
|
'fields' => ['Object.id', 'Object.uuid'],
|
|
));
|
|
if (empty($sourceObject)) {
|
|
return true; // Source object not found or is part of different event
|
|
}
|
|
if (isset($reference['referenced_uuid'])) {
|
|
$conditions[0] = array('Attribute.uuid' => $reference['referenced_uuid']);
|
|
$conditions[1] = array('Object.uuid' => $reference['referenced_uuid']);
|
|
} elseif (isset($reference['object_id'])) {
|
|
if ($reference['referenced_type'] == 1) {
|
|
$conditions[0] = array('Attribute.id' => $reference['referenced_id']);
|
|
$conditions[1] = array('Object.id' => $reference['referenced_id']);
|
|
} else {
|
|
$conditions = false;
|
|
}
|
|
} else {
|
|
return true;
|
|
}
|
|
if ($conditions) {
|
|
$referencedObject = $this->Object->find('first', array(
|
|
'recursive' => -1,
|
|
'fields' => ['Object.id', 'Object.uuid', 'Object.event_id'],
|
|
'conditions' => $conditions[1]
|
|
));
|
|
}
|
|
if (empty($referencedObject)) {
|
|
$referencedObject = $this->Object->Attribute->find('first', array(
|
|
'recursive' => -1,
|
|
'fields' => ['Attribute.id', 'Attribute.uuid', 'Attribute.event_id'],
|
|
'conditions' => $conditions[0]
|
|
));
|
|
if (empty($referencedObject)) {
|
|
return true;
|
|
}
|
|
$referencedObject = $referencedObject['Attribute'];
|
|
$referenced_type = 0;
|
|
} else {
|
|
$referencedObject = $referencedObject['Object'];
|
|
$referenced_type = 1;
|
|
}
|
|
if ($referencedObject['event_id'] != $eventId) {
|
|
return true;
|
|
}
|
|
$this->create();
|
|
unset($reference['id']);
|
|
$reference['referenced_type'] = $referenced_type;
|
|
$reference['object_id'] = $sourceObject['Object']['id'];
|
|
$reference['object_uuid'] = $sourceObject['Object']['uuid'];
|
|
$reference['referenced_id'] = $referencedObject['id'];
|
|
$reference['referenced_uuid'] = $referencedObject['uuid'];
|
|
$reference['event_id'] = $eventId;
|
|
$result = $this->save(array('ObjectReference' => $reference));
|
|
if (!$result) {
|
|
return $this->validationErrors;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param string $referencedUuid
|
|
* @param array $object
|
|
* @param bool $strict When true, throw exception when referenced object not found.
|
|
* @param array $user
|
|
* @return array|int[]
|
|
*/
|
|
public function getReferencedInfo($referencedUuid, $object, $strict = true, $user = [])
|
|
{
|
|
$referenced_type = 1;
|
|
$target_object = $this->Object->find('first', array(
|
|
'conditions' => array('Object.uuid' => $referencedUuid, 'Object.deleted' => 0),
|
|
'recursive' => -1,
|
|
'fields' => array('Object.id', 'Object.uuid', 'Object.event_id')
|
|
));
|
|
if (!empty($target_object)) {
|
|
$referenced_id = $target_object['Object']['id'];
|
|
$referenced_uuid = $target_object['Object']['uuid'];
|
|
if ($target_object['Object']['event_id'] != $object['Event']['id']) {
|
|
if (!$this->isValidExtendedEventForReference($object, $target_object['Object']['event_id'], $user)) {
|
|
throw new NotFoundException('Invalid target. Target has to be within the same event or extending it.');
|
|
}
|
|
}
|
|
} else {
|
|
$target_attribute = $this->Object->Attribute->find('first', array(
|
|
'conditions' => array('Attribute.uuid' => $referencedUuid, 'Attribute.deleted' => 0),
|
|
'recursive' => -1,
|
|
'fields' => array('Attribute.id', 'Attribute.uuid', 'Attribute.event_id')
|
|
));
|
|
if (empty($target_attribute)) {
|
|
if ($strict) {
|
|
throw new NotFoundException('Invalid target.');
|
|
} else {
|
|
return array(0, 0, 0);
|
|
}
|
|
}
|
|
if ($target_attribute['Attribute']['event_id'] != $object['Event']['id']) {
|
|
if (!$this->isValidExtendedEventForReference($object, $target_attribute['Attribute']['event_id'], $user)) {
|
|
throw new NotFoundException('Invalid target. Target has to be within the same event or extending it.');
|
|
}
|
|
}
|
|
$referenced_id = $target_attribute['Attribute']['id'];
|
|
$referenced_uuid = $target_attribute['Attribute']['uuid'];
|
|
$referenced_type = 0;
|
|
}
|
|
return array($referenced_id, $referenced_uuid, $referenced_type);
|
|
}
|
|
|
|
private function isValidExtendedEventForReference(array $sourceEvent, $targetEventID, array $user)
|
|
{
|
|
if ($sourceEvent['Event']['orgc_id'] != $user['org_id']) {
|
|
return false;
|
|
}
|
|
$targetEventFromExtension = $this->Object->Event->find('first', [
|
|
'conditions' => [
|
|
'Event.uuid' => $sourceEvent['Event']['extends_uuid'],
|
|
],
|
|
'recursive' => -1,
|
|
'fields' => ['id']
|
|
]);
|
|
return !empty($targetEventFromExtension) && $targetEventFromExtension['Event']['id'] == $targetEventID;
|
|
}
|
|
}
|