Merge pull request #917 from dfir-iris/api_v2_get_object_comment

Api v2 get object comment

Author: whikernel

source/app/blueprints/rest/alerts_routes.py

@@ -966,6 +966,7 @@ def alert_comment_delete(alert_id, com_id):
 
 
 @alerts_rest_blueprint.route('/alerts/<int:alert_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/alerts/{alert_identifier}/comments/{identifier}')
 @ac_api_requires(Permissions.alerts_read)
 def alert_comment_get(alert_id, com_id):
     """

source/app/blueprints/rest/case/case_assets_routes.py

@@ -386,6 +386,7 @@ def case_comment_asset_add(cur_id, caseid):
 
 
 @case_assets_rest_blueprint.route('/case/assets/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/assets/{asset_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_asset_get(cur_id, com_id, caseid):

source/app/blueprints/rest/case/case_evidences_routes.py

@@ -189,6 +189,7 @@ def case_comment_evidence_add(cur_id, caseid):
 
 
 @case_evidences_rest_blueprint.route('/case/evidences/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/evidences/{evidence_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_evidence_get(cur_id, com_id, caseid):

source/app/blueprints/rest/case/case_ioc_routes.py

@@ -296,6 +296,7 @@ def case_comment_ioc_add(cur_id, caseid):
 
 
 @case_ioc_rest_blueprint.route('/case/ioc/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/iocs/{ioc_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_ioc_get(cur_id, com_id, caseid):

source/app/blueprints/rest/case/case_notes_routes.py

@@ -441,6 +441,7 @@ def case_comment_note_add(cur_id, caseid):
 
 
 @case_notes_rest_blueprint.route('/case/notes/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/notes/{note_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_note_get(cur_id, com_id, caseid):

source/app/blueprints/rest/case/case_tasks_routes.py

@@ -215,6 +215,7 @@ def case_comment_task_add(cur_id: int, caseid: int):
 
 
 @case_tasks_rest_blueprint.route('/case/tasks/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/tasks/{task_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_task_get(cur_id: int, com_id: int, caseid: int):

source/app/blueprints/rest/case/case_timeline_routes.py

@@ -107,6 +107,7 @@ def case_comment_delete(cur_id, com_id, caseid):
 
 
 @case_timeline_rest_blueprint.route('/case/timeline/events/<int:cur_id>/comments/<int:com_id>', methods=['GET'])
+@endpoint_deprecated('GET', '/api/v2/events/{event_identifier}/comments/{identifier}')
 @ac_requires_case_identifier(CaseAccessLevel.read_only, CaseAccessLevel.full_access)
 @ac_api_requires()
 def case_comment_get(cur_id, com_id, caseid):

source/app/blueprints/rest/v2/alerts_routes/comments.py

@@ -23,13 +23,16 @@
 from app.blueprints.access_controls import ac_api_requires
 from app.models.authorization import Permissions
 from app.blueprints.rest.endpoints import response_api_paginated
+from app.blueprints.rest.endpoints import response_api_success
 from app.blueprints.rest.endpoints import response_api_not_found
 from app.blueprints.rest.endpoints import response_api_created
 from app.blueprints.rest.endpoints import response_api_error
 from app.blueprints.rest.parsing import parse_pagination_parameters
 from app.schema.marshables import CommentSchema
 from app.business.comments import comments_get_filtered_by_alert
 from app.business.comments import comments_create_for_alert
+from app.business.comments import comments_get_for_alert
+from app.business.alerts import alerts_get
 from app.iris_engine.access_control.iris_user import iris_current_user
 from app.business.errors import ObjectNotFoundError
 
@@ -58,6 +61,17 @@ def create(self, alert_identifier):
         except ObjectNotFoundError:
             return response_api_not_found()
 
+    def read(self, alert_identifier, identifier):
+        try:
+            alert = alerts_get(iris_current_user, alert_identifier)
+            comment = comments_get_for_alert(alert, identifier)
+            result = self._schema.dump(comment)
+            return response_api_success(result)
+        except ValidationError as e:
+            return response_api_error('Data error', data=e.normalized_messages())
+        except ObjectNotFoundError:
+            return response_api_not_found()
+
 
 alerts_comments_blueprint = Blueprint('alerts_comments', __name__, url_prefix='/<int:alert_identifier>/comments')
 comments_operations = CommentsOperations()
@@ -73,3 +87,9 @@ def get_alerts_comments(alert_identifier):
 @ac_api_requires(Permissions.alerts_write)
 def create_alerts_comment(alert_identifier):
     return comments_operations.create(alert_identifier)
+
+
+@alerts_comments_blueprint.get('/<int:identifier>')
+@ac_api_requires(Permissions.alerts_read)
+def get_alerts_comment(alert_identifier, identifier):
+    return comments_operations.read(alert_identifier, identifier)

source/app/blueprints/rest/v2/assets_routes/comments.py

@@ -25,9 +25,11 @@
 from app.blueprints.rest.endpoints import response_api_not_found
 from app.blueprints.rest.endpoints import response_api_created
 from app.blueprints.rest.endpoints import response_api_error
+from app.blueprints.rest.endpoints import response_api_success
 from app.blueprints.rest.parsing import parse_pagination_parameters
 from app.business.comments import comments_get_filtered_by_asset
 from app.business.comments import comments_create_for_asset
+from app.business.comments import comments_get_for_asset
 from app.business.assets import assets_get
 from app.business.errors import ObjectNotFoundError
 from app.schema.marshables import CommentSchema
@@ -48,7 +50,7 @@ def _get_asset(asset_identifier, possible_case_access_levels):
             raise ObjectNotFoundError()
         return asset
 
-    def get(self, asset_identifier):
+    def search(self, asset_identifier):
         try:
             asset = self._get_asset(asset_identifier, [CaseAccessLevel.read_only, CaseAccessLevel.full_access])
 
@@ -72,6 +74,17 @@ def create(self, asset_identifier):
         except ObjectNotFoundError:
             return response_api_not_found()
 
+    def read(self, asset_identifier, identifier):
+        try:
+            asset = self._get_asset(asset_identifier, [CaseAccessLevel.read_only, CaseAccessLevel.full_access])
+            comment = comments_get_for_asset(asset, identifier)
+            result = self._schema.dump(comment)
+            return response_api_success(result)
+        except ValidationError as e:
+            return response_api_error('Data error', data=e.normalized_messages())
+        except ObjectNotFoundError:
+            return response_api_not_found()
+
 
 assets_comments_blueprint = Blueprint('assets_comments', __name__, url_prefix='/<int:asset_identifier>/comments')
 comments_operations = CommentsOperations()
@@ -80,10 +93,16 @@ def create(self, asset_identifier):
 @assets_comments_blueprint.get('')
 @ac_api_requires()
 def get_assets_comments(asset_identifier):
-    return comments_operations.get(asset_identifier)
+    return comments_operations.search(asset_identifier)
 
 
 @assets_comments_blueprint.post('')
 @ac_api_requires()
 def create_assets_comment(asset_identifier):
     return comments_operations.create(asset_identifier)
+
+
+@assets_comments_blueprint.get('/<int:identifier>')
+@ac_api_requires()
+def get_assets_comment(asset_identifier, identifier):
+    return comments_operations.read(asset_identifier, identifier)

source/app/blueprints/rest/v2/events_routes/comments.py

@@ -25,10 +25,12 @@
 from app.blueprints.rest.endpoints import response_api_not_found
 from app.blueprints.rest.endpoints import response_api_created
 from app.blueprints.rest.endpoints import response_api_error
+from app.blueprints.rest.endpoints import response_api_success
 from app.blueprints.rest.parsing import parse_pagination_parameters
 from app.iris_engine.access_control.iris_user import iris_current_user
 from app.business.comments import comments_get_filtered_by_event
 from app.business.comments import comments_create_for_event
+from app.business.comments import comments_get_for_event
 from app.business.events import events_get
 from app.business.errors import ObjectNotFoundError
 from app.models.cases import CasesEvent
@@ -49,7 +51,7 @@ def _get_event(event_identifier, possible_case_access_levels) -> CasesEvent:
             raise ObjectNotFoundError()
         return event
 
-    def get(self, event_identifier):
+    def search(self, event_identifier):
         try:
             event = self._get_event(event_identifier, [CaseAccessLevel.read_only, CaseAccessLevel.full_access])
 
@@ -73,6 +75,17 @@ def create(self, event_identifier):
         except ObjectNotFoundError:
             return response_api_not_found()
 
+    def read(self, event_identifier, identifier):
+        try:
+            event = self._get_event(event_identifier, [CaseAccessLevel.read_only, CaseAccessLevel.full_access])
+            comment = comments_get_for_event(event, identifier)
+            result = self._schema.dump(comment)
+            return response_api_success(result)
+        except ValidationError as e:
+            return response_api_error('Data error', data=e.normalized_messages())
+        except ObjectNotFoundError:
+            return response_api_not_found()
+
 
 events_comments_blueprint = Blueprint('events_comments', __name__, url_prefix='/<int:event_identifier>/comments')
 comments_operations = CommentsOperations()
@@ -81,10 +94,16 @@ def create(self, event_identifier):
 @events_comments_blueprint.get('')
 @ac_api_requires()
 def get_event_comments(event_identifier):
-    return comments_operations.get(event_identifier)
+    return comments_operations.search(event_identifier)
 
 
 @events_comments_blueprint.post('')
 @ac_api_requires()
 def create_event_comment(event_identifier):
     return comments_operations.create(event_identifier)
+
+
+@events_comments_blueprint.get('/<int:identifier>')
+@ac_api_requires()
+def get_event_comment(event_identifier, identifier):
+    return comments_operations.read(event_identifier, identifier)