Skip to content

Commit faf659c

Browse files
author
remiallain
committed
first commit
0 parents  commit faf659c

File tree

9 files changed

+470
-0
lines changed

9 files changed

+470
-0
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
![](https://www.cyberprotect.fr/wp-content/uploads/2015/12/Logo-340-156-web-noir.png)
2+
3+
> Rémi ALLAIN <rallain@cyberprotect.fr>
4+
5+
# CortexRunner
6+
7+
Cortex jobs automation for TheHive
8+
9+
## Requirements
10+
11+
- thehive4py
12+
- requests
13+
14+
## Installation
15+
16+
```bash
17+
git clone 'https://github.com/Cyberprotect/CortexRunner.git'
18+
cd CortexRunner-master
19+
python setup.py install
20+
```
21+
22+
## Usage
23+
24+
```python
25+
from cortexrunner.api import CortexRunner
26+
27+
observable = '1234abcd1234abcd1234abcd1234abcd'
28+
config = {
29+
'thehive': {
30+
'url': 'http://127.0.0.1:8080',
31+
'proxies': None,
32+
'cert': True,
33+
'key': '--API-KEY--'
34+
}
35+
}
36+
rules = {
37+
'file': [{
38+
'analyzer': 'Cuckoo_Sandbox_File_Analysis_1_0',
39+
'scope': 'internal'
40+
},{
41+
'analyzer': 'VirusTotal_Report_2_0',
42+
'scope': 'external'
43+
}],
44+
'filename': [{
45+
'analyzer': 'MISP_2_0',
46+
'scope': 'internal'
47+
},{
48+
'analyzer': 'HybridAnalysis_GetReport_1_0',
49+
'scope': 'external'
50+
}],
51+
'url': [{
52+
'analyzer': 'Threatcrowd_1_0',
53+
'scope': 'external'
54+
}]
55+
}
56+
57+
runner = CortexRunner(observable, rules, config)
58+
59+
result = runner.launch()
60+
61+
print(result)
62+
```
63+
64+
For a more complete and real example, get a look at `example/` directory

‎cortexrunner/__init__.py

Whitespace-only changes.

‎cortexrunner/api.py

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
4+
__author__ = "Rémi ALLAIN"
5+
__copyright__ = "Copyright 2018, Cyberprotect - SDN International"
6+
__credits__ = ["Rémi ALLAIN"]
7+
__license__ = "Apache 2.0"
8+
__version__ = "1.0.0"
9+
__maintainer__ = "Rémi ALLAIN"
10+
__email__ = "rallain@cyberprotect.fr"
11+
__status__ = "Production"
12+
13+
import json, requests
14+
from thehive4py.api import TheHiveApi, BearerAuth
15+
16+
"""Cortex jobs automation for TheHive."""
17+
class CortexRunner:
18+
19+
"""String: Observable Id"""
20+
observable_id = None
21+
22+
"""Dict: Observable information"""
23+
observable = None
24+
25+
"""Dict: Rules"""
26+
rules = None
27+
28+
"""Dict: Configuration"""
29+
config = None
30+
31+
"""Object: TheHiveApi"""
32+
thehive4py = None
33+
34+
"""List of dict: jobs created"""
35+
jobs = None
36+
37+
def __init__(self, observable_id, rules, config):
38+
"""Cortex jobs automation for TheHive."""
39+
# Register the configuration
40+
self.set_config(config)
41+
# Check the observable id and retrieve information
42+
self.set_observable_id(observable_id)
43+
# Register the rules
44+
self.set_rules(rules)
45+
# Instanciate thehive4py
46+
self.thehive4py = TheHiveApi(self.config['thehive']['url'], self.config['thehive']['key'], proxies=self.proxies, cert=self.cert)
47+
48+
def set_observable_id(self, observable_id):
49+
"""Store the observable Id only if length is correct (32) and retrieve the information about the observable."""
50+
# Check length
51+
if(len(observable_id) != 32):
52+
raise CortexRunnerException('Observable Id seems to be invalid. Not a 32 character Id.')
53+
# Store Id
54+
self.observable_id = observable_id
55+
# Retrieve information
56+
self.get_observable_data()
57+
58+
def set_rules(self, rules):
59+
"""Store the rules."""
60+
self.rules = rules
61+
# Check structure
62+
if not isinstance(rules, dict):
63+
raise CortexRunnerException('"rules" parameter is not a dictionnary.')
64+
for key in rules:
65+
if not isinstance(key, basestring):
66+
raise CortexRunnerException('dataType in rules must be a string. Invalid value = {}'.format(key))
67+
for rule in rules[key]:
68+
if not rule.get('analyzer'):
69+
raise CortexRunnerException('rule for {} must contain an "analyzer" key-value.'.format(key))
70+
71+
def set_config(self, config):
72+
"""Store the configuration"""
73+
# Check the structure
74+
if config.get('thehive') and config['thehive'].get('url') and config['thehive'].get('key'):
75+
# Store configuration items
76+
self.config = config
77+
self.proxies = config['thehive'].get('proxies')
78+
self.auth = BearerAuth(self.config['thehive'].get('key'))
79+
self.cert = config['thehive'].get('cert')
80+
else:
81+
raise CortexRunnerException('Configuration not valid. The configuration dictionnary must have at least the keys : "thehive.url" and "thehive.key"')
82+
83+
def launch(self):
84+
"""Create jobs based on dataType rules for the selected observable"""
85+
# Reset the created job list
86+
self.jobs = []
87+
# Get the rules for the dataType of the current observable
88+
if self.rules.get(self.observable.get('dataType')):
89+
for rule in self.rules.get(self.observable.get('dataType')):
90+
# Create job for each analyzer
91+
job = self.launch_job(rule.get('analyzer'))
92+
# Report the response and the matching rule into the list
93+
self.jobs += [{
94+
"rule": rule,
95+
"job": job
96+
}]
97+
return self.jobs
98+
99+
def launch_job(self, analyzer_id):
100+
"""Create job for the observable id and the given analyzer id"""
101+
# Send request
102+
response = self.thehive4py.run_analyzer(None, self.observable_id, analyzer_id)
103+
# If job was created report information about it
104+
if(response.status_code == 200):
105+
return response.json()
106+
return {}
107+
108+
def get_observable_data(self):
109+
"""Get the observable information"""
110+
# Build url
111+
req = "{}/api/case/artifact/{}".format(self.config['thehive']['url'], self.observable_id)
112+
try:
113+
# Send request
114+
response = requests.get(req, proxies=self.proxies, auth=self.auth, verify=self.cert)
115+
if response.status_code == 200:
116+
# Store the data
117+
self.observable = response.json()
118+
else:
119+
raise CortexRunnerException('Unable to get the observable : {}'.format(response.text))
120+
except requests.exceptions.RequestException as e:
121+
raise CortexRunnerException('Unable to get the observable : {}'.format(e))
122+
123+
class CortexRunnerException(Exception):
124+
pass

0 commit comments

Comments
 (0)