mirror of https://github.com/MISP/MISP
374 lines
15 KiB
PHP
374 lines
15 KiB
PHP
<?php
|
|
|
|
App::uses('AppModel', 'Model');
|
|
|
|
class ObjectTemplate extends AppModel
|
|
{
|
|
public $actsAs = array(
|
|
'AuditLog',
|
|
'Containable',
|
|
'SysLogLogable.SysLogLogable' => array( // TODO Audit, logable
|
|
'userModel' => 'User',
|
|
'userKey' => 'user_id',
|
|
'change' => 'full'),
|
|
);
|
|
|
|
public $belongsTo = array(
|
|
'User' => array(
|
|
'className' => 'User',
|
|
'foreignKey' => 'user_id'
|
|
),
|
|
'Organisation' => array(
|
|
'className' => 'Organisation',
|
|
'foreignKey' => 'org_id'
|
|
)
|
|
);
|
|
public $hasMany = array(
|
|
'ObjectTemplateElement' => array(
|
|
'className' => 'ObjectTemplateElement',
|
|
'dependent' => true,
|
|
)
|
|
);
|
|
public $validate = array(
|
|
);
|
|
|
|
public $objectsDir = APP . 'files/misp-objects/objects';
|
|
|
|
public function afterFind($results, $primary = false)
|
|
{
|
|
foreach ($results as $k => $result) {
|
|
if (isset($results[$k]['ObjectTemplate']['requirements'])) {
|
|
$results[$k]['ObjectTemplate']['requirements'] = json_decode($results[$k]['ObjectTemplate']['requirements'], true);
|
|
}
|
|
}
|
|
return $results;
|
|
}
|
|
|
|
public function beforeSave($options = array())
|
|
{
|
|
$this->data['ObjectTemplate']['requirements'] = empty($this->data['ObjectTemplate']['requirements']) ? '[]' : json_encode($this->data['ObjectTemplate']['requirements']);
|
|
return true;
|
|
}
|
|
|
|
public function update($user = false, $type = false, $force = false)
|
|
{
|
|
$directories = $this->getTemplateDirectoryPaths();
|
|
foreach ($directories as $k => $dir) {
|
|
$dir = str_replace($this->objectsDir, '', $dir);
|
|
$directories[$k] = $dir;
|
|
}
|
|
$updated = array();
|
|
foreach ($directories as $dir) {
|
|
if ($type && '/' . $type != $dir) {
|
|
continue;
|
|
}
|
|
if (!file_exists($this->objectsDir . DS . $dir . DS . 'definition.json')) {
|
|
continue;
|
|
}
|
|
$file = new File($this->objectsDir . DS . $dir . DS . 'definition.json');
|
|
$template = json_decode($file->read(), true);
|
|
$file->close();
|
|
if (!isset($template['version'])) {
|
|
$template['version'] = 1;
|
|
}
|
|
$current = $this->find('first', array(
|
|
'fields' => array('MAX(version) AS version', 'uuid'),
|
|
'conditions' => array('uuid' => $template['uuid']),
|
|
'recursive' => -1,
|
|
'group' => array('uuid')
|
|
));
|
|
if (!empty($current)) {
|
|
$current['ObjectTemplate']['version'] = $current[0]['version'];
|
|
}
|
|
if ($force || empty($current) || $template['version'] > $current['ObjectTemplate']['version']) {
|
|
$result = $this->__updateObjectTemplate($template, $current, $user);
|
|
if ($result === true) {
|
|
$temp = array('name' => $template['name'], 'new' => $template['version']);
|
|
if (!empty($current)) {
|
|
$temp['old'] = $current['ObjectTemplate']['version'];
|
|
}
|
|
$updated['success'][] = $temp;
|
|
} else {
|
|
$updated['fails'][] = array('name' => $template['name'], 'fail' => json_encode($result));
|
|
}
|
|
}
|
|
}
|
|
return $updated;
|
|
}
|
|
|
|
private function __updateObjectTemplate($template, $current, $user = false)
|
|
{
|
|
$success = false;
|
|
$template['requirements'] = array();
|
|
$requirementFields = array('required', 'requiredOneOf');
|
|
foreach ($requirementFields as $field) {
|
|
if (isset($template[$field])) {
|
|
$template['requirements'][$field] = $template[$field];
|
|
}
|
|
}
|
|
if (!empty($user)) {
|
|
$template['user_id'] = $user['id'];
|
|
$template['org_id'] = $user['org_id'];
|
|
} else {
|
|
$template['user_id'] = 0;
|
|
$template['org_id'] = 0;
|
|
}
|
|
$template['fixed'] = 1;
|
|
$this->create();
|
|
$result = $this->save($template);
|
|
if (!$result) {
|
|
return $this->validationErrors;
|
|
}
|
|
$id = $this->id;
|
|
$this->setActive($id);
|
|
$fieldsToCompare = array('object_relation', 'type', 'ui-priority', 'categories', 'sane_default', 'values_list', 'multiple', 'disable_correlation');
|
|
foreach ($template['attributes'] as $k => $attribute) {
|
|
$attribute['object_relation'] = $k;
|
|
$attribute = $this->__convertJSONToElement($attribute);
|
|
$this->ObjectTemplateElement->create();
|
|
$attribute['object_template_id'] = $id;
|
|
$result = $this->ObjectTemplateElement->save(array('ObjectTemplateElement' => $attribute));
|
|
}
|
|
return true;
|
|
}
|
|
|
|
private function __convertJSONToElement($attribute)
|
|
{
|
|
$result = array();
|
|
$translation_table = array(
|
|
'misp-usage-frequency' => 'frequency',
|
|
'misp-attribute' => 'type',
|
|
'description' => 'description',
|
|
'ui-priority' => 'ui-priority',
|
|
'type' => 'type',
|
|
'disable_correlation' => 'disable_correlation',
|
|
'object_relation' => 'object_relation',
|
|
'categories' => 'categories',
|
|
'sane_default' => 'sane_default',
|
|
'values_list' => 'values_list',
|
|
'multiple' => 'multiple'
|
|
);
|
|
foreach ($translation_table as $from => $to) {
|
|
if (isset($attribute[$from])) {
|
|
$result[$to] = $attribute[$from];
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
public function checkTemplateConformity($template, $attributes)
|
|
{
|
|
if (!empty($template['ObjectTemplate']['requirements'])) {
|
|
// check for all required attributes
|
|
if (!empty($template['ObjectTemplate']['requirements']['required'])) {
|
|
foreach ($template['ObjectTemplate']['requirements']['required'] as $requiredField) {
|
|
$found = false;
|
|
foreach ($attributes['Attribute'] as $attribute) {
|
|
if ($attribute['object_relation'] == $requiredField) {
|
|
$found = true;
|
|
}
|
|
}
|
|
if (!$found) {
|
|
return 'Could not save the object as a required attribute is not set (' . $requiredField . ')';
|
|
}
|
|
}
|
|
}
|
|
// check for all required one of attributes
|
|
if (!empty($template['ObjectTemplate']['requirements']['requiredOneOf'])) {
|
|
$found = false;
|
|
foreach ($template['ObjectTemplate']['requirements']['requiredOneOf'] as $requiredField) {
|
|
foreach ($attributes['Attribute'] as $attribute) {
|
|
if ($attribute['object_relation'] == $requiredField) {
|
|
$found = true;
|
|
}
|
|
}
|
|
}
|
|
if (!$found) {
|
|
return 'Could not save the object as it requires at least one of the following attributes to be set: ' . implode(', ', $template['ObjectTemplate']['requirements']['requiredOneOf']);
|
|
}
|
|
}
|
|
}
|
|
// check the multiple flag is adhered to
|
|
foreach ($template['ObjectTemplateElement'] as $template_attribute) {
|
|
if ($template_attribute['multiple'] !== true) {
|
|
$found_relations = array();
|
|
foreach ($attributes['Attribute'] as $attribute) {
|
|
if ($attribute['object_relation'] == $template_attribute['object_relation']) {
|
|
if (!isset($found_relations[$attribute['object_relation']])) {
|
|
$found_relations[$attribute['object_relation']] = true;
|
|
} else {
|
|
return 'Could not save the object as a unique relationship within the object was assigned to more than one attribute. This is only allowed if the multiple flag is set in the object template.';
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function checkTemplateConformityBasedOnTypes($template, $attributes)
|
|
{
|
|
$to_return = array('valid' => true, 'missingTypes' => array());
|
|
if (!empty($template['ObjectTemplate']['requirements'])) {
|
|
// check for all required attributes
|
|
if (!empty($template['ObjectTemplate']['requirements']['required'])) {
|
|
foreach ($template['ObjectTemplate']['requirements']['required'] as $requiredField) {
|
|
$requiredType = Hash::extract($template['ObjectTemplateElement'], sprintf('{n}[object_relation=%s].type', $requiredField))[0];
|
|
$found = false;
|
|
foreach ($attributes as $attribute) {
|
|
if ($attribute['Attribute']['type'] == $requiredType) {
|
|
$found = true;
|
|
}
|
|
}
|
|
if (!$found) {
|
|
$to_return = array('valid' => false, 'missingTypes' => array($requiredType));
|
|
}
|
|
}
|
|
}
|
|
// check for all required one of attributes
|
|
if (!empty($template['ObjectTemplate']['requirements']['requiredOneOf'])) {
|
|
$found = false;
|
|
$all_required_type = array();
|
|
foreach ($template['ObjectTemplate']['requirements']['requiredOneOf'] as $requiredField) {
|
|
$requiredType = Hash::extract($template['ObjectTemplateElement'], sprintf('{n}[object_relation=%s].type', $requiredField));
|
|
$requiredType = empty($requiredType) ? NULL : $requiredType[0];
|
|
$all_required_type[] = $requiredType;
|
|
foreach ($attributes as $attribute) {
|
|
if ($attribute['Attribute']['type'] == $requiredType) {
|
|
$found = true;
|
|
}
|
|
}
|
|
}
|
|
if (!$found) {
|
|
$to_return = array('valid' => false, 'missingTypes' => $all_required_type);
|
|
}
|
|
}
|
|
}
|
|
|
|
// at this point, an object could created; checking if all attribute are valids
|
|
$valid_types = array();
|
|
$to_return['invalidTypes'] = array();
|
|
$to_return['invalidTypesMultiple'] = array();
|
|
foreach ($template['ObjectTemplateElement'] as $templateElement) {
|
|
$valid_types[$templateElement['type']] = $templateElement['multiple'];
|
|
}
|
|
$check_for_multiple_type = array();
|
|
foreach ($attributes as $attribute) {
|
|
if (isset($valid_types[$attribute['Attribute']['type']])) {
|
|
if (!$valid_types[$attribute['Attribute']['type']]) { // is not multiple
|
|
if (isset($check_for_multiple_type[$attribute['Attribute']['type']])) {
|
|
$to_return['invalidTypesMultiple'][] = $attribute['Attribute']['type'];
|
|
} else {
|
|
$check_for_multiple_type[$attribute['Attribute']['type']] = 1;
|
|
}
|
|
}
|
|
} else {
|
|
$to_return['invalidTypes'][] = $attribute['Attribute']['type'];
|
|
}
|
|
}
|
|
$to_return['invalidTypes'] = array_unique($to_return['invalidTypes']);
|
|
$to_return['invalidTypesMultiple'] = array_unique($to_return['invalidTypesMultiple']);
|
|
if (!empty($to_return['invalidTypesMultiple'])) {
|
|
$to_return['valid'] = false;
|
|
}
|
|
return $to_return;
|
|
}
|
|
|
|
// simple test to see if there are any object templates - if not trigger update
|
|
public function populateIfEmpty($user)
|
|
{
|
|
$result = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'fields' => array('ObjectTemplate.id')
|
|
));
|
|
if (empty($result)) {
|
|
$this->update($user);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function setActive($id)
|
|
{
|
|
$template = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('ObjectTemplate.id' => $id)
|
|
));
|
|
if (empty($template)) {
|
|
return false;
|
|
}
|
|
if ($template['ObjectTemplate']['active']) {
|
|
$template['ObjectTemplate']['active'] = 0;
|
|
$this->save($template);
|
|
return 0;
|
|
}
|
|
$similar_templates = $this->find('all', array(
|
|
'recursive' => -1,
|
|
'conditions' => array(
|
|
'ObjectTemplate.uuid' => $template['ObjectTemplate']['uuid'],
|
|
'NOT' => array(
|
|
'ObjectTemplate.id' => $template['ObjectTemplate']['id']
|
|
)
|
|
)
|
|
));
|
|
$template['ObjectTemplate']['active'] = 1;
|
|
$this->save($template);
|
|
foreach ($similar_templates as $st) {
|
|
$st['ObjectTemplate']['active'] = 0;
|
|
$this->save($st);
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
public function getRawFromDisk($uuidOrName)
|
|
{
|
|
$template = [];
|
|
if (Validation::uuid($uuidOrName)) {
|
|
foreach ($this->readTemplatesFromDisk() as $templateFromDisk) {
|
|
if ($templateFromDisk['uuid'] == $uuidOrName) {
|
|
$template = $templateFromDisk;
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
$allTemplateNames = $this->getTemplateDirectoryPaths(false);
|
|
if (in_array($uuidOrName, $allTemplateNames)) { // ensure the path is not out of scope
|
|
$template = $this->readTemplateFromDisk($this->getFullPathFromTemplateName($uuidOrName));
|
|
}
|
|
}
|
|
return $template;
|
|
}
|
|
|
|
private function readTemplateFromDisk($path)
|
|
{
|
|
$file = new File($path, false);
|
|
if (!$file->exists()) {
|
|
return false;
|
|
}
|
|
$template = json_decode($file->read(), true);
|
|
$file->close();
|
|
return $template;
|
|
}
|
|
|
|
private function readTemplatesFromDisk()
|
|
{
|
|
foreach ($this->getTemplateDirectoryPaths() as $dirpath) {
|
|
$filepath = $dirpath . DS . 'definition.json';
|
|
$template = $this->readTemplateFromDisk($filepath);
|
|
if (isset($template['uuid'])) {
|
|
yield $template;
|
|
}
|
|
}
|
|
}
|
|
|
|
private function getTemplateDirectoryPaths($fullPath=true)
|
|
{
|
|
$dir = new Folder($this->objectsDir, false);
|
|
return $dir->read(true, false, $fullPath)[0];
|
|
}
|
|
|
|
private function getFullPathFromTemplateName($templateName)
|
|
{
|
|
return $this->objectsDir . DS . $templateName . DS . 'definition.json';
|
|
}
|
|
}
|