Skip to content

Commit 1837265

Browse files
committed
Updated docs and ran notebooks
1 parent 3fead0e commit 1837265

File tree

212 files changed

+24122
-36253
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

212 files changed

+24122
-36253
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
docs/_build/
2+
docs/source/
13
# Byte-compiled / optimized / DLL files
24
__pycache__/
35
*.py[cod]

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ RUN adduser --disabled-password \
2020
${NB_USER} \
2121
&& python3 -m pip install --upgrade six==1.15.0 attackcti==0.3.4.3 pandas==1.1.4 altair vega
2222

23-
COPY notebooks ${HOME}/notebooks
23+
COPY docs/playground/* ${HOME}/notebooks
2424

2525
RUN chown -R ${NB_USER}:${NB_USER} ${HOME} ${JUPYTER_DIR}
2626

docs/Makefile

-19
This file was deleted.

docs/_config.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Book settings
2+
# Learn more at https://jupyterbook.org/customize/config.html
3+
4+
title: ATTACK Python Client
5+
author: Roberto Rodriguez @Cyb3rWard0g
6+
logo: logo.png
7+
8+
# Force re-execution of notebooks on each build.
9+
# See https://jupyterbook.org/content/execute.html
10+
execute:
11+
execute_notebooks: force
12+
13+
# Define the name of the latex output file for PDF builds
14+
latex:
15+
latex_documents:
16+
targetname: book.tex
17+
18+
# Add a bibtex file so that we can create citations
19+
#bibtex_bibfiles:
20+
# - references.bib
21+
22+
# Information about where the book exists on the web
23+
repository:
24+
url: https://github.com/OTRF/ATTACK-Python-Client # Online location of your book
25+
path_to_book: docs # Optional path to your book, relative to the repository root
26+
branch: master # Which branch of the repository should be used when creating links (optional)
27+
28+
# Add GitHub buttons to your book
29+
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
30+
html:
31+
use_repository_button: true
32+
use_issues_button: true
33+
baseurl: https://attackcti.com/
34+
35+
launch_buttons:
36+
notebook_interface: "classic" # The interface interactive links will activate ["classic", "jupyterlab"]
37+
binderhub_url: "https://mybinder.org"

docs/_toc.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Table of content
2+
# Learn more at https://jupyterbook.org/customize/toc.html
3+
#
4+
- file: intro
5+
- part: Playground
6+
chapters:
7+
- file: playground/ATT&CK_DataSources
8+
- file: playground/Export_All_Techniques
9+
- file: playground/export_groups_navigator_layers
10+
- file: playground/ICS_ATTACK_Exploration
11+
- file: playground/techniques_by_datasources
12+
- file: playground/Usage_Basics
13+
- file: playground/Usage_Filters

docs/intro.ipynb

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Introduction\n",
8+
"\n",
9+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/OTRF/ATTACK-Python-Client/master)\n",
10+
"[![Open_Threat_Research Community](https://img.shields.io/badge/Open_Threat_Research-Community-brightgreen.svg)](https://twitter.com/OTR_Community)\n",
11+
"[![Open Source Love svg1](https://badges.frapsoft.com/os/v3/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)\n",
12+
"\n",
13+
"A Python module to access up to date ATT&CK content available in STIX via public TAXII server. This project leverages the python classes and functions of the [cti-python-stix2](https://github.com/oasis-open/cti-python-stix2) and [cti-taxii-client](https://github.com/oasis-open/cti-taxii-client) libraries developed by MITRE.\n",
14+
"\n",
15+
"## Goals\n",
16+
"\n",
17+
"* Provide an easy way to access and interact with up to date ATT&CK content available in STIX via public TAXII server\n",
18+
"* Allow security analysts to quickly explore ATT&CK content and apply it in their daily operations\n",
19+
"* Allow the integration of ATT&Ck content with other platforms to host up to date information from the framework\n",
20+
"* Help security analysts during the transition from the ATT&CK MediaWiki API to the STIX/TAXII 2.0 API\n",
21+
"* Learn STIX2 and TAXII Client Python libraries\n",
22+
"\n",
23+
"## Current Status: Production/Stable\n",
24+
"\n",
25+
"The project is currently in a Production/Stable stage, which means that the current main functions are more stable. I would love to get your feedback to make it a better project.\n",
26+
"\n",
27+
"## Resources\n",
28+
"\n",
29+
"* [MITRE CTI](https://github.com/mitre/cti)\n",
30+
"* [OASIS CTI TAXII Client](https://github.com/oasis-open/cti-taxii-client)\n",
31+
"* [OASIS CTI Python STIX2](https://github.com/oasis-open/cti-python-stix2)\n",
32+
"* [MITRE ATT&CK Framework](https://attack.mitre.org/wiki/Main_Page)\n",
33+
"* [ATT&CK MediaWiki API](https://attack.mitre.org/wiki/Using_the_API)\n",
34+
"* [Invoke-ATTACKAPI](https://github.com/Cyb3rWard0g/Invoke-ATTACKAPI)\n",
35+
"* [Mitre-Attack-API](https://github.com/annamcabee/Mitre-Attack-API)\n",
36+
"\n",
37+
"### Requirements\n",
38+
"\n",
39+
"Python 3+\n",
40+
"\n",
41+
"### Installation\n",
42+
"\n",
43+
"You can install it via PIP:\n",
44+
"\n",
45+
"```\n",
46+
"pip install attackcti\n",
47+
"```\n",
48+
"\n",
49+
"Or you can also do the following:\n",
50+
"\n",
51+
"```\n",
52+
"git clone https://github.com/OTRF/ATTACK-Python-Client\n",
53+
"cd ATTACK-Python-Client\n",
54+
"pip install .\n",
55+
"```\n",
56+
"\n",
57+
"## Author\n",
58+
"\n",
59+
"* Roberto Rodriguez [@Cyb3rWard0g](https://twitter.com/Cyb3rWard0g)\n",
60+
"\n",
61+
"## Official Committers\n",
62+
"\n",
63+
"* Jose Luis Rodriguez [@Cyb3rPandaH](https://twitter.com/Cyb3rPandaH)"
64+
]
65+
},
66+
{
67+
"cell_type": "code",
68+
"execution_count": null,
69+
"metadata": {},
70+
"outputs": [],
71+
"source": []
72+
}
73+
],
74+
"metadata": {
75+
"kernelspec": {
76+
"display_name": "PySpark_Python3",
77+
"language": "python",
78+
"name": "pyspark3"
79+
},
80+
"language_info": {
81+
"codemirror_mode": {
82+
"name": "ipython",
83+
"version": 3
84+
},
85+
"file_extension": ".py",
86+
"mimetype": "text/x-python",
87+
"name": "python",
88+
"nbconvert_exporter": "python",
89+
"pygments_lexer": "ipython3",
90+
"version": "3.7.3"
91+
}
92+
},
93+
"nbformat": 4,
94+
"nbformat_minor": 2
95+
}

docs/logo.png

9.62 KB
Loading

docs/make.bat

-35
This file was deleted.

0 commit comments

Comments
 (0)