Feature taxonomy

.drone.yml

@@ -8,7 +8,7 @@ steps:
   - name: submodules
     image: alpine/git
     commands:
-      - git submodule update --recursive --init --remote
+      - git submodule update --recursive --init
 
   # Restore cache of downloaded dependencies
   - name: restore-cache

dto/src/main/scala/org/thp/thehive/dto/v0/Tag.scala

@@ -2,13 +2,13 @@ package org.thp.thehive.dto.v0
 
 import play.api.libs.json.{Json, OFormat, OWrites}
 
-case class InputTag(namespace: String, predicate: String, value: Option[String], description: Option[String], colour: Option[Int])
+case class InputTag(namespace: String, predicate: String, value: Option[String], description: Option[String], colour: Option[String])
 
 object InputTag {
   implicit val writes: OWrites[InputTag] = Json.writes[InputTag]
 }
 
-case class OutputTag(namespace: String, predicate: String, value: Option[String], description: Option[String], colour: Int)
+case class OutputTag(namespace: String, predicate: String, value: Option[String], description: Option[String], colour: String)
 
 object OutputTag {
   implicit val format: OFormat[OutputTag] = Json.format[OutputTag]

dto/src/main/scala/org/thp/thehive/dto/v1/CustomFieldValue.scala

@@ -70,6 +70,7 @@ object InputCustomFieldValue {
       }
     case _ => Good(Nil)
   }
+
   implicit val writes: Writes[Seq[InputCustomFieldValue]] = Writes[Seq[InputCustomFieldValue]] { icfv =>
     val fields = icfv.map {
       case InputCustomFieldValue(name, Some(s: String), _)  => name -> JsString(s)

dto/src/main/scala/org/thp/thehive/dto/v1/Tag.scala

@@ -0,0 +1,15 @@
+package org.thp.thehive.dto.v1
+
+import play.api.libs.json.{Json, OFormat}
+
+case class OutputTag(
+  namespace: String,
+  predicate: String,
+  value: Option[String],
+  description: Option[String],
+  colour: String
+)
+
+object OutputTag {
+  implicit val format: OFormat[OutputTag] = Json.format[OutputTag]
+}

dto/src/main/scala/org/thp/thehive/dto/v1/Taxonomy.scala

@@ -0,0 +1,73 @@
+package org.thp.thehive.dto.v1
+
+import java.util.Date
+import play.api.libs.json.{JsObject, Json, OFormat}
+
+/*
+Format based on :
+https://tools.ietf.org/id/draft-dulaunoy-misp-taxonomy-format-04.html
+*/
+
+case class InputTaxonomy(
+  namespace: String,
+  description: String,
+  version: Int,
+  `type`: Option[Seq[String]],
+  exclusive: Option[Boolean],
+  predicates: Seq[InputPredicate],
+  values: Option[Seq[InputValue]]
+)
+
+case class InputPredicate(
+  value: String,
+  expanded: Option[String],
+  exclusive: Option[Boolean],
+  description: Option[String]
+)
+
+case class InputValue(
+  predicate: String,
+  entry: Seq[InputEntry]
+)
+
+case class InputEntry(
+  value: String,
+  expanded: Option[String],
+  colour: Option[String],
+  description: Option[String],
+  numerical_value: Option[Int]
+)
+
+object InputTaxonomy {
+  implicit val format: OFormat[InputTaxonomy] = Json.format[InputTaxonomy]
+}
+
+object InputPredicate {
+  implicit val format: OFormat[InputPredicate] = Json.format[InputPredicate]
+}
+
+object InputValue {
+  implicit val format: OFormat[InputValue] = Json.format[InputValue]
+}
+
+object InputEntry {
+  implicit val format: OFormat[InputEntry] = Json.format[InputEntry]
+}
+
+case class OutputTaxonomy(
+  _id: String,
+  _type: String,
+  _createdBy: String,
+  _updatedBy: Option[String] = None,
+  _createdAt: Date,
+  _updatedAt: Option[Date] = None,
+  namespace: String,
+  description: String,
+  version: Int,
+  tags: Seq[OutputTag],
+  extraData: JsObject
+)
+
+object OutputTaxonomy {
+  implicit val format: OFormat[OutputTaxonomy] = Json.format[OutputTaxonomy]
+}

frontend/app/index.html

@@ -139,6 +139,7 @@
     <script src="scripts/components/common/custom-field-input.component.js"></script>
     <script src="scripts/components/common/custom-field-labels.component.js"></script>
     <script src="scripts/components/common/observable-flags.component.js"></script>
+    <script src="scripts/components/common/tag.component.js"></script>
     <script src="scripts/components/control-sidebar.component.js"></script>
     <script src="scripts/components/header.component.js"></script>
     <script src="scripts/components/list/stats-item.component.js"></script>
@@ -167,6 +168,7 @@
     <script src="scripts/controllers/admin/organisation/OrgUsersCtrl.js"></script>
     <script src="scripts/controllers/admin/profile/ProfileListCtrl.js"></script>
     <script src="scripts/controllers/admin/profile/ProfileModalCtrl.js"></script>
+    <script src="scripts/controllers/admin/taxonomy/TaxonomyListCtrl.js"></script>
     <script src="scripts/controllers/alert/AlertEventCtrl.js"></script>
     <script src="scripts/controllers/alert/AlertListCtrl.js"></script>
     <script src="scripts/controllers/alert/AlertStatsCtrl.js"></script>
@@ -294,6 +296,7 @@
     <script src="scripts/services/api/ProfileSrv.js"></script>
     <script src="scripts/services/api/TagSrv.js"></script>
     <script src="scripts/services/api/TaskLogSrv.js"></script>
+    <script src="scripts/services/api/TaxonomySrv.js"></script>
     <script src="scripts/services/api/UiSettingsSrv.js"></script>
     <script src="scripts/services/api/UserSrv.js"></script>
     <script src="scripts/services/api/VersionSrv.js"></script>

frontend/app/scripts/app.js

@@ -217,6 +217,21 @@ angular.module('thehive', [
                     permissions: ['manageProfile']
                 }
             })
+            .state('app.administration.taxonomies', {
+                url: '/taxonomies',
+                templateUrl: 'views/partials/admin/taxonomy/list.html',
+                controller: 'TaxonomyListCtrl',
+                controllerAs: '$vm',
+                title: 'Taxonomies administration',
+                resolve: {
+                    appConfig: function(VersionSrv) {
+                        return VersionSrv.get();
+                    }
+                },
+                guard: {
+                    permissions: ['manageTaxonomy']
+                }
+            })
             .state('app.administration.organisations', {
                 url: '/organisations',
                 templateUrl: 'views/partials/admin/organisation/list.html',

frontend/app/scripts/components/common/tag.component.js

@@ -0,0 +1,22 @@
+(function() {
+    'use strict';
+
+    angular.module('theHiveComponents')
+        .component('tag', {
+            controller: function() {
+                this.$onInit = function() {
+                    this.tag = _.without([
+                        this.value.namespace,
+                        ':',
+                        this.value.predicate,
+                        this.value.value ? ("=\"" + this.value.value + "\"") : null
+                    ], null).join('');
+                };
+            },
+            controllerAs: '$ctrl',
+            templateUrl: 'views/components/common/tag.component.html',
+            bindings: {
+                value: '<'
+            }
+        });
+})();

frontend/app/scripts/controllers/admin/taxonomy/TaxonomyListCtrl.js

@@ -0,0 +1,207 @@
+(function() {
+    'use strict';
+
+    angular.module('theHiveControllers')
+        .controller('TaxonomyListCtrl', TaxonomyListCtrl)
+        .controller('TaxonomyDialogCtrl', TaxonomyDialogCtrl)
+        .controller('TaxonomyImportCtrl', TaxonomyImportCtrl);
+
+    function TaxonomyListCtrl($scope, $uibModal, PaginatedQuerySrv, FilteringSrv, TaxonomySrv, NotificationSrv, ModalSrv, appConfig) {
+        var self = this;
+
+        this.appConfig = appConfig;
+
+        self.load = function() {
+            this.loading = true;
+
+            this.list = new PaginatedQuerySrv({
+                name: 'taxonomies',
+                root: undefined,
+                objectType: 'taxonomy',
+                version: 'v1',
+                scope: $scope,
+                sort: self.filtering.context.sort,
+                loadAll: false,
+                pageSize: self.filtering.context.pageSize,
+                filter: this.filtering.buildQuery(),
+                operations: [
+                    {'_name': 'listTaxonomy'}
+                ],
+                extraData: ['enabled'],
+                onUpdate: function() {
+                    self.loading = false;
+                }
+            });
+        };
+
+        self.show = function(taxonomy) {
+            // var modalInstance = $uibModal.open({
+
+            $uibModal.open({
+                animation: true,
+                templateUrl: 'views/partials/admin/taxonomy/view.html',
+                controller: 'TaxonomyDialogCtrl',
+                controllerAs: '$modal',
+                size: 'max',
+                resolve: {
+                    taxonomy: angular.copy(taxonomy)
+                }
+            });
+
+            // modalInstance.result
+            //     .then(function() {
+            //         self.load();
+            //     })
+            //     .catch(function(err){
+            //         if(err && !_.isString(err)) {
+            //             NotificationSrv.error('Taxonomies import', err.data, err.status);
+            //         }
+            //     });
+        };
+
+
+        self.import = function () {
+            var modalInstance = $uibModal.open({
+                animation: true,
+                templateUrl: 'views/partials/admin/taxonomy/import.html',
+                controller: 'TaxonomyImportCtrl',
+                controllerAs: '$vm',
+                size: 'lg',
+                resolve: {
+                    appConfig: self.appConfig
+                }
+            });
+
+            modalInstance.result
+                .then(function() {
+                    self.load();
+                })
+                .catch(function(err){
+                    if(err && !_.isString(err)) {
+                        NotificationSrv.error('Taxonomies import', err.data, err.status);
+                    }
+                });
+        };
+
+        this.toggleActive = function(taxonomy) {
+            var active = !taxonomy.extraData.enabled;
+
+            TaxonomySrv.toggleActive(taxonomy._id, active)
+                .then(function() {
+                    NotificationSrv.log(['Taxonomy [', taxonomy.namespace, '] has been successfully', (active ? 'activated' : 'deactivated')].join(' '), 'success');
+
+                    self.load();
+                })
+                .catch(function(err){
+                    if(err && !_.isString(err)) {
+                        NotificationSrv.error('Taxonomies ' + active ? 'activation' : 'deactivation', err.data, err.status);
+                    }
+                });
+        };
+
+        self.remove = function(taxonomy) {
+            var modalInstance = ModalSrv.confirm(
+                'Remove taxonomy',
+                'Are you sure you want to remove the selected taxonomy?', {
+                    flavor: 'danger',
+                    okText: 'Yes, remove it'
+                }
+            );
+
+            modalInstance.result
+                .then(function() {
+                    return TaxonomySrv.remove(taxonomy._id);
+                })
+                .then(function( /*response*/ ) {
+                    self.load();
+                    NotificationSrv.success(
+                        'Taxonomy ' + taxonomy.namespace + ' has been successfully removed.'
+                    );
+                })
+                .catch(function(err) {
+                    if (err && !_.isString(err)) {
+                        NotificationSrv.error('TaxonomyListCtrl', err.data, err.status);
+                    }
+                });
+        };
+
+        this.toggleFilters = function () {
+            this.filtering.toggleFilters();
+        };
+
+        this.filter = function () {
+            self.filtering.filter().then(this.applyFilters);
+        };
+
+        this.clearFilters = function () {
+            this.filtering.clearFilters()
+                .then(self.search);
+        };
+
+        this.removeFilter = function (index) {
+            self.filtering.removeFilter(index)
+                .then(self.search);
+        };
+
+        this.search = function () {
+            self.load();
+            self.filtering.storeContext();
+        };
+        this.addFilterValue = function (field, value) {
+            this.filtering.addFilterValue(field, value);
+            this.search();
+        };
+
+        self.$onInit = function() {
+            self.filtering = new FilteringSrv('taxonomy', 'taxonomy.list', {
+                version: 'v1',
+                defaults: {
+                    showFilters: true,
+                    showStats: false,
+                    pageSize: 15,
+                    sort: ['+namespace']
+                },
+                defaultFilter: []
+            });
+
+            self.filtering.initContext('list')
+                .then(function() {
+                    self.load();
+
+                    $scope.$watch('$vm.list.pageSize', function (newValue) {
+                        self.filtering.setPageSize(newValue);
+                    });
+                });
+        };
+    }
+
+    function TaxonomyDialogCtrl($uibModalInstance, TaxonomySrv, NotificationSrv, taxonomy) {
+        this.taxonomy = taxonomy;
+
+        this.ok = function () {
+            $uibModalInstance.close();
+        };
+
+        this.cancel = function () {
+            $uibModalInstance.dismiss('cancel');
+        };
+    }
+
+    function TaxonomyImportCtrl($uibModalInstance, TaxonomySrv, NotificationSrv, appConfig) {
+        this.appConfig = appConfig;
+        this.formData = {};
+
+        this.ok = function () {
+            TaxonomySrv.import(this.formData)
+                .then(function() {
+                    $uibModalInstance.close();
+                }, function(response) {
+                    NotificationSrv.error('TaxonomyImportCtrl', response.data, response.status);
+                });
+        };
+
+        this.cancel = function () {
+            $uibModalInstance.dismiss('cancel');
+        };
+    }
+})();