-
Notifications
You must be signed in to change notification settings - Fork 592
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add intelligence command to the CLI client (#2864)
* adding a intelligence sub command to the Timesketch CLI + documentation * W0622: Redefining built-in 'type' (redefined-builtin * Apply suggestions from code review Co-authored-by: Johan Berggren <[email protected]> * code review feedback * Update cli_client/python/timesketch_cli_client/commands/intelligence.py * Update cli_client/python/timesketch_cli_client/commands/intelligence.py * Update cli_client/python/timesketch_cli_client/commands/intelligence.py * s/type/ioc-type --------- Co-authored-by: Johan Berggren <[email protected]>
- Loading branch information
Showing
4 changed files
with
241 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
145 changes: 145 additions & 0 deletions
145
cli_client/python/timesketch_cli_client/commands/intelligence.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| # Copyright 2023 Google Inc. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| """Commands for interacting with intelligence within a Sketch.""" | ||
|
|
||
| import sys | ||
| import json | ||
| import click | ||
|
|
||
|
|
||
| @click.group("intelligence") | ||
| def intelligence_group(): | ||
| """Manage intelligence within a sketch.""" | ||
|
|
||
|
|
||
| @intelligence_group.command("list") | ||
| @click.option( | ||
| "--header/--no-header", | ||
| default=True, | ||
| help="Include header in output. (default is to show header))", | ||
| ) | ||
| @click.option( | ||
| "--columns", | ||
| default="ioc,type", | ||
| help="Comma separated list of columns to show. (default: ioc,type)", | ||
| ) | ||
| @click.pass_context | ||
| def list_intelligence(ctx, header, columns): | ||
| """List all intelligence. | ||
| Args: | ||
| ctx: Click context object. | ||
| header: Include header in output. (default is to show header) | ||
| columns: Comma separated list of columns to show. (default: ioc,type) | ||
| Other options: externalURI, tags | ||
| """ | ||
|
|
||
| if not columns: | ||
| columns = "ioc,type" | ||
|
|
||
| columns = columns.split(",") | ||
|
|
||
| output = ctx.obj.output_format | ||
| sketch = ctx.obj.sketch | ||
| try: | ||
| intelligence = sketch.get_intelligence_attribute() | ||
| except ValueError as e: | ||
| click.echo(e) | ||
| sys.exit(1) | ||
|
|
||
| if not intelligence: | ||
| click.echo("No intelligence found.") | ||
| ctx.exit(1) | ||
| if output == "json": | ||
| click.echo(json.dumps(intelligence, indent=4, sort_keys=True)) | ||
| elif output == "text": | ||
| if header: | ||
| click.echo("\t".join(columns)) | ||
| for entry in intelligence: | ||
| row = [] | ||
| for column in columns: | ||
| if column == "tags": | ||
| row.append(",".join(entry.get(column, []))) | ||
| else: | ||
| row.append(entry.get(column, "")) | ||
| click.echo("\t".join(row)) | ||
| elif output == "csv": | ||
| if header: | ||
| click.echo(",".join(columns)) | ||
| for entry in intelligence: | ||
| row = [] | ||
| for column in columns: | ||
| if column == "tags": | ||
| # Tags can be multiple values but they should only be | ||
| # one value on the csv so we join them with a comma | ||
| # surrounded the array by quotes | ||
| row.append(f'"{",".join(entry.get(column, []))}"') | ||
| else: | ||
| row.append(entry.get(column, "")) | ||
| click.echo(",".join(row)) | ||
| else: | ||
| click.echo(f"Output format {output} not implemented.") | ||
|
|
||
|
|
||
| @intelligence_group.command("add") | ||
| @click.option( | ||
| "--ioc", | ||
| required=True, | ||
| help="Indicator Of Compromise (IOC) value.", | ||
| ) | ||
| @click.option( | ||
| "--ioc-type", | ||
| required=False, | ||
| help="Type of the intelligence (ipv4, hash_sha256, hash_sha1, hash_md5, other).", | ||
| ) | ||
| @click.option( | ||
| "--tags", | ||
| required=False, | ||
| help="Comma separated list of tags.", | ||
| ) | ||
| @click.pass_context | ||
| def add_intelligence(ctx, ioc, tags, ioc_type="other"): | ||
| """Add intelligence to a sketch. | ||
| A sketch can have multiple intelligence entries. Each entry consists of | ||
| an indicator, a type and a list of tags. | ||
| Reference: https://timesketch.org/guides/user/intelligence/ | ||
| Args: | ||
| ctx: Click context object. | ||
| ioc: IOC value. | ||
| ioc_type: Type of the intelligence. This is defined in the ontology file. | ||
| If a string doesn't match any of the aforementioned IOC types, | ||
| the type will fall back to other. | ||
| tags: Comma separated list of tags. | ||
| """ | ||
| sketch = ctx.obj.sketch | ||
|
|
||
| # Create a tags dict from the comma separated list | ||
| if tags: | ||
| tags = tags.split(",") | ||
| tags = {tag: [] for tag in tags} | ||
| else: | ||
| tags = [] | ||
|
|
||
| ioc_dict = {"ioc": ioc, "type": ioc_type, "tags": tags} | ||
| # Put the ioc in a nested object to match the format of the API | ||
| data = {"data": [ioc_dict]} | ||
| try: | ||
| sketch.add_attribute(name="intelligence", ontology="intelligence", value=data) | ||
| except ValueError as e: | ||
| click.echo(e) | ||
| sys.exit(1) | ||
| click.echo(f"Intelligence added: {ioc}") |
46 changes: 46 additions & 0 deletions
46
cli_client/python/timesketch_cli_client/commands/intelligence_test.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Copyright 2023 Google Inc. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| """Tests for intelligence command.""" | ||
|
|
||
| import unittest | ||
| import mock | ||
|
|
||
| from click.testing import CliRunner | ||
|
|
||
| # pylint: disable=import-error | ||
| from timesketch_api_client import test_lib as api_test_lib | ||
|
|
||
| # pylint: enable=import-error | ||
|
|
||
| from .. import test_lib | ||
| from .intelligence import intelligence_group | ||
|
|
||
|
|
||
| class IntelligenceTest(unittest.TestCase): | ||
| """Test Sigma CLI command.""" | ||
|
|
||
| @mock.patch("requests.Session", api_test_lib.mock_session) | ||
| def setUp(self): | ||
| """Setup test case.""" | ||
| self.ctx = test_lib.get_cli_context() | ||
|
|
||
| def test_list_intelligence(self): | ||
| """Test to list Sigma rules.""" | ||
| runner = CliRunner() | ||
| result = runner.invoke( | ||
| intelligence_group, | ||
| ["list"], | ||
| obj=self.ctx, | ||
| ) | ||
| assert 1 is result.exit_code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters