Skip to content

Commit bf6bdf6

Browse files
dek443dek443
committed
Major version update/rewrite to Dshell, now using Python 3. See README for more details.
Highlights: - This is a major framework update to Dshell. Plugins written for the previous version are not compatible with this version, and vice versa. - Uses Python 3 - Rewritten in Python 3 from the ground up. Python 2 language deprecated on 1 JAN 2020 - By extension, dpkt and pypcap have been replaced with Python 3-friendly pypacker and pcapy (respectively). - Is a Python package - All plugins are chainable - Plugins can use all output modules - Improved error handling - Enables development of external plugin packs, allowing the sharing and installation of new, externally-developed plugins without overlapping the core Dshell libraries.
1 parent 87524b8 commit bf6bdf6

File tree

159 files changed

+8121
-10541
lines changed

Some content is hidden

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

159 files changed

+8121
-10541
lines changed

‎.gitignore‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
*.pyc
2-
__init__.py
32
__pycache__
4-
5-
# Ignore built files
6-
/.dshellrc
7-
/bin/decode
8-
/dshell
9-
/dshell-decode
3+
Dshell.egg-info

‎Dshell-Training-Pack-0.1.tar.gz‎

1.88 KB
Binary file not shown.

‎LICENSE‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
© (2020) United States Government, as represented by the Secretary of the Army. All rights reserved.
2+
3+
ICF Incorporated, L.L.C. contributed to the development of Dshell (Python 3).
4+
5+
Because the project utilizes code licensed from contributors and other third parties, it therefore is licensed under the MIT License. http://opensource.org/licenses/mit-license.php. Under that license, permission is granted free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the conditions that any appropriate copyright notices and this permission notice are included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8+

‎LICENSE.txt‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎Makefile‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎README‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# Dshell
2+
An extensible network forensic analysis framework. Enables rapid development of plugins to support the dissection of network packet captures.
3+
4+
Key features:
5+
* Deep packet analysis using specialized plugins
6+
* Robust stream reassembly
7+
* IPv4 and IPv6 support
8+
* Custom output handlers
9+
* Chainable plugins
10+
11+
## Requirements
12+
* Linux (developed on Red Hat Enterprise Linux 6.7)
13+
* Python 3 (developed with Python 3.5.1)
14+
* [pypacker](https://github.com/mike01/pypacker)
15+
* [pcapy](http://www.coresecurity.com/corelabs-research/open-source-tools/pcapy)
16+
* [geoip2](https://github.com/maxmind/GeoIP2-python)
17+
* [MaxMind GeoIP2 datasets](https://dev.maxmind.com/geoip/geoip2/geolite2/)
18+
19+
## Optional
20+
* [oui.txt](http://standards-oui.ieee.org/oui.txt)
21+
* used by some plugins that handle MAC addresses
22+
* place in <dshell>/data/
23+
* [elasticsearch](https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html)
24+
* used in the elasticout output module
25+
* only necessary if planning to use elasticsearch to store output
26+
27+
## Major Changes Since Previous Release
28+
* This is a major framework update to Dshell. Plugins written for the previous version are not compatible with this version, and vice versa.
29+
* Uses Python 3
30+
* Rewritten in Python 3 from the ground up. Python 2 language deprecated on [1 JAN 2020](https://www.python.org/doc/sunset-python-2/)
31+
* By extension, dpkt and pypcap have been replaced with Python3-friendly pypacker and pcapy (respectively).
32+
* Is a Python package
33+
* Converted into a single package, removing the need for the shell to set several environment variables.
34+
* Allows easier use of Dshell plugins in other Python scripts
35+
* Changed "decoders" to "plugins"
36+
* Primarily a word-swap, to clarify that "decoders" can do more than simply decode traffic, and to put Dshell more in line with the terminology of other frameworks.
37+
* Significant reduction in camelCase functions, replaced with more Pythonic snake\_case functions.
38+
* Notable examples include blobHandler->blob\_handler, rawHandler->raw\_handler, connectionInitHandler->connection\_init\_handler, etc.
39+
* All plugins are now chainable
40+
* To accommodate this, handler functions in plugins must now use return statements indicating whether a packet, connection, or similar will continue to the next plugin. The type of object(s) to return depends on the type of handler, but will generally match the types of the handler's input. Dshell will display a warning if it's not the right type.
41+
* Plugins can now use all output modules<sup>\*</sup> available to the command line switch, -O
42+
* That does not mean every output module will be _useful_ to every plugin (e.g. using netflow output for a plugin that looks at individual packets), but they are available.
43+
* alert(), write(), and dump() are now the same function: write()
44+
* Output modules can be listed with a new flag in decode.py, --list-output or --lo
45+
* Arguments for output modules are now passed with the --oargs command-line argument
46+
* \* pcapout is (currently) the exception to this rule. A method has yet to arise that allows it to work with connection-based plugins
47+
* No more dObj declaration
48+
* decode.py just looks for the class named DshellPlugin and creates an instance of that
49+
* Improved error handling
50+
* Dshell handles more of the most common exceptions during everyday use
51+
* Enables development of external plugin packs, allowing the sharing and installation of new, externally-developed plugins without overlapping the core Dshell libraries.
52+
53+
## Installation
54+
55+
1. Install Dshell with pip
56+
* `sudo python3 -m pip install Dshell/` OR `sudo python3 -m pip install <Dshell-tarball>`
57+
2. Configure geoip2 by moving the MaxMind data files (GeoLite2-ASN.mmdb, GeoLite2-City.mmdb, GeoLite2-Country.mmdb) to &lt;install-location&gt;/data/GeoIP/
58+
3. Run `dshell`. This should drop you into a `Dshell> ` prompt.
59+
60+
## Basic Usage
61+
62+
* `decode -l`
63+
* This will list all available plugins, alongside basic information about them
64+
* `decode -h`
65+
* Show generic command-line flags available to most plugins
66+
* `decode -p <plugin>`
67+
* Display information about a plugin, including available command line flags
68+
* `decode -p <plugin> <pcap>`
69+
* Run the selected plugin on a pcap file
70+
* `decode -p <plugin1>+<plugin2> <pcap>`
71+
* Chain two (or more) plugins together and run them on a pcap file
72+
* `decode -p <plugin> -i <interface>`
73+
* Run the selected plugin live on an interface (may require superuser privileges)
74+
75+
## Usage Examples
76+
Showing DNS lookups in [sample traffic](http://wiki.wireshark.org/SampleCaptures#General_.2F_Unsorted)
77+
78+
```
79+
Dshell> decode -p dns ~/pcap/dns.cap |sort
80+
[DNS] 2005-03-30 03:47:46 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 4146, TXT? google.com., TXT: b'\x0fv=spf1 ptr ?all' **
81+
[DNS] 2005-03-30 03:47:50 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 63343, MX? google.com., MX: b'\x00(\x05smtp4\xc0\x0c', MX: b'\x00\n\x05smtp5\xc0\x0c', MX: b'\x00\n\x05smtp6\xc0\x0c', MX: b'\x00\n\x05smtp1\xc0\x0c', MX: b'\x00\n\x05smtp2\xc0\x0c', MX: b'\x00(\x05smtp3\xc0\x0c' **
82+
[DNS] 2005-03-30 03:47:59 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 18849, LOC? google.com. **
83+
[DNS] 2005-03-30 03:48:07 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 39867, PTR? 104.9.192.66.in-addr.arpa., PTR: 66-192-9-104.gen.twtelecom.net. **
84+
[DNS] 2005-03-30 03:49:18 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 30144, A? www.netbsd.org., A: 204.152.190.12 (ttl 82159s) **
85+
[DNS] 2005-03-30 03:49:35 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 61652, AAAA? www.netbsd.org., AAAA: 2001:4f8:4:7:2e0:81ff:fe52:9a6b (ttl 86400s) **
86+
[DNS] 2005-03-30 03:50:35 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 32569, AAAA? www.netbsd.org., AAAA: 2001:4f8:4:7:2e0:81ff:fe52:9a6b (ttl 86340s) **
87+
[DNS] 2005-03-30 03:50:44 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 36275, AAAA? www.google.com., CNAME: 'www.l.google.com.' **
88+
[DNS] 2005-03-30 03:50:54 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 56482, AAAA? www.l.google.com. **
89+
[DNS] 2005-03-30 03:51:35 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 48159, AAAA? www.example.com. **
90+
[DNS] 2005-03-30 03:51:46 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 9837, AAAA? www.example.notginh., NXDOMAIN **
91+
[DNS] 2005-03-30 03:52:17 192.168.170.8:32795 -- 192.168.170.20:53 ** ID: 65251, AAAA: 2001:4f8:0:2::d (ttl 600s), A: 204.152.184.88 (ttl 600s) **
92+
[DNS] 2005-03-30 03:52:17 192.168.170.8:32796 -- 192.168.170.20:53 ** ID: 23123, PTR? 1.0.0.127.in-addr.arpa., PTR: localhost. **
93+
[DNS] 2005-03-30 03:52:17 192.168.170.8:32797 -- 192.168.170.20:53 ** ID: 8330, NS: b'\x06ns-ext\x04nrt1\xc0\x0c', NS: b'\x06ns-ext\x04sth1\xc0\x0c', NS: b'\x06ns-ext\xc0\x0c', NS: b'\x06ns-ext\x04lga1\xc0\x0c' **
94+
[DNS] 2005-03-30 03:52:17 192.168.170.56:1707 -- 217.13.4.24:53 ** ID: 12910, SRV? _ldap._tcp.Default-First-Site-Name._sites.dc._msdcs.utelsystems.local., NXDOMAIN **
95+
[DNS] 2005-03-30 03:52:17 192.168.170.56:1708 -- 217.13.4.24:53 ** ID: 61793, SRV? _ldap._tcp.dc._msdcs.utelsystems.local., NXDOMAIN **
96+
[DNS] 2005-03-30 03:52:17 192.168.170.56:1709 -- 217.13.4.24:53 ** ID: 33633, SRV? _ldap._tcp.05b5292b-34b8-4fb7-85a3-8beef5fd2069.domains._msdcs.utelsystems.local., NXDOMAIN **
97+
[DNS] 2005-03-30 03:52:17 192.168.170.56:1710 -- 217.13.4.24:53 ** ID: 53344, A? GRIMM.utelsystems.local., NXDOMAIN **
98+
[DNS] 2005-03-30 03:52:25 192.168.170.56:1711 -- 217.13.4.24:53 ** ID: 30307, A? GRIMM.utelsystems.local., NXDOMAIN **
99+
```
100+
101+
Following and reassembling a stream in [sample traffic](http://wiki.wireshark.org/SampleCaptures#General_.2F_Unsorted)
102+
103+
```
104+
Dshell> decode -p followstream ~/pcap/v6-http.cap
105+
Connection 1 (TCP)
106+
Start: 2007-08-05 15:16:44.189851
107+
End: 2007-08-05 15:16:44.219460
108+
2001:6f8:102d:0:2d0:9ff:fee3:e8de: 59201 -> 2001:6f8:900:7c0::2: 80 (300 bytes)
109+
2001:6f8:900:7c0::2: 80 -> 2001:6f8:102d:0:2d0:9ff:fee3:e8de: 59201 (2379 bytes)
110+
111+
GET / HTTP/1.0
112+
Host: cl-1985.ham-01.de.sixxs.net
113+
Accept: text/html, text/plain, text/css, text/sgml, */*;q=0.01
114+
Accept-Encoding: gzip, bzip2
115+
Accept-Language: en
116+
User-Agent: Lynx/2.8.6rel.2 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.8b
117+
118+
119+
120+
HTTP/1.1 200 OK
121+
Date: Sun, 05 Aug 2007 19:16:44 GMT
122+
Server: Apache
123+
Content-Length: 2121
124+
Connection: close
125+
Content-Type: text/html
126+
127+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
128+
<html>
129+
<head>
130+
<title>Index of /</title>
131+
</head>
132+
<body>
133+
<h1>Index of /</h1>
134+
<pre><img src="/icons/blank.gif" alt="Icon "> <a href="?C=N;O=D">Name</a> <a href="?C=M;O=A">Last modified</a> <a href="?C=S;O=A">Size</a> <a href="?C=D;O=A">Description</a><hr><img src="/icons/folder.gif" alt="[DIR]"> <a href="202-vorbereitung/">202-vorbereitung/</a> 06-Jul-2007 14:31 -
135+
<img src="/icons/layout.gif" alt="[ ]"> <a href="Efficient_Video_on_demand_over_Multicast.pdf">Efficient_Video_on_d..&gt;</a> 19-Dec-2006 03:17 291K
136+
<img src="/icons/unknown.gif" alt="[ ]"> <a href="Welcome%20Stranger!!!">Welcome Stranger!!!</a> 28-Dec-2006 03:46 0
137+
<img src="/icons/text.gif" alt="[TXT]"> <a href="barschel.htm">barschel.htm</a> 31-Jul-2007 02:21 44K
138+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="bnd/">bnd/</a> 30-Dec-2006 08:59 -
139+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="cia/">cia/</a> 28-Jun-2007 00:04 -
140+
<img src="/icons/layout.gif" alt="[ ]"> <a href="cisco_ccna_640-801_command_reference_guide.pdf">cisco_ccna_640-801_c..&gt;</a> 28-Dec-2006 03:48 236K
141+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="doc/">doc/</a> 19-Sep-2006 01:43 -
142+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="freenetproto/">freenetproto/</a> 06-Dec-2006 09:00 -
143+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="korrupt/">korrupt/</a> 03-Jul-2007 11:57 -
144+
<img src="/icons/folder.gif" alt="[DIR]"> <a href="mp3_technosets/">mp3_technosets/</a> 04-Jul-2007 08:56 -
145+
<img src="/icons/text.gif" alt="[TXT]"> <a href="neues_von_rainald_goetz.htm">neues_von_rainald_go..&gt;</a> 21-Mar-2007 23:27 31K
146+
<img src="/icons/text.gif" alt="[TXT]"> <a href="neues_von_rainald_goetz0.htm">neues_von_rainald_go..&gt;</a> 21-Mar-2007 23:29 36K
147+
<img src="/icons/layout.gif" alt="[ ]"> <a href="pruef.pdf">pruef.pdf</a> 28-Dec-2006 07:48 88K
148+
<hr></pre>
149+
</body></html>
150+
```
151+
152+
Chaining plugins to view flow data for a specific country code in [sample traffic](http://wiki.wireshark.org/SampleCaptures#General_.2F_Unsorted) (note: TCP handshakes are not included in the packet count)
153+
154+
```
155+
Dshell> decode -p country+netflow --country_code=JP ~/pcap/SkypeIRC.cap
156+
2006-08-25 15:32:20.766761 192.168.1.2 -> 202.232.205.123 (-- -> JP) UDP 60583 33438 1 0 64 0 0.0000s
157+
2006-08-25 15:32:20.634046 192.168.1.2 -> 202.232.205.123 (-- -> JP) UDP 60583 33435 1 0 64 0 0.0000s
158+
2006-08-25 15:32:20.747503 192.168.1.2 -> 202.232.205.123 (-- -> JP) UDP 60583 33437 1 0 64 0 0.0000s
159+
2006-08-25 15:32:20.651501 192.168.1.2 -> 202.232.205.123 (-- -> JP) UDP 60583 33436 1 0 64 0 0.0000s
160+
```
161+
162+
Collecting DNS traffic from several files and storing it in a new pcap file.
163+
164+
```
165+
Dshell> decode -p dns+pcapwriter --pcapwriter_outfile=test.pcap ~/pcap/*.cap >/dev/null
166+
Dshell> tcpdump -nnr test.pcap |head
167+
reading from file test.pcap, link-type EN10MB (Ethernet)
168+
15:36:08.670569 IP 192.168.1.2.2131 > 192.168.1.1.53: 40209+ A? ui.skype.com. (30)
169+
15:36:08.670687 IP 192.168.1.2.2131 > 192.168.1.1.53: 40210+ AAAA? ui.skype.com. (30)
170+
15:36:08.674022 IP 192.168.1.1.53 > 192.168.1.2.2131: 40209- 1/0/0 A 212.72.49.131 (46)
171+
15:36:09.011208 IP 192.168.1.1.53 > 192.168.1.2.2131: 40210 0/1/0 (94)
172+
15:36:10.171350 IP 192.168.1.2.2131 > 192.168.1.1.53: 40210+ AAAA? ui.skype.com. (30)
173+
15:36:10.961350 IP 192.168.1.1.53 > 192.168.1.2.2131: 40210* 0/1/0 (85)
174+
15:36:10.961608 IP 192.168.1.2.2131 > 192.168.1.1.53: 40211+ AAAA? ui.skype.com. (30)
175+
15:36:11.294333 IP 192.168.1.1.53 > 192.168.1.2.2131: 40211 0/1/0 (94)
176+
15:32:21.664798 IP 192.168.1.2.2130 > 192.168.1.1.53: 39862+ A? ui.skype.com. (30)
177+
15:32:21.664913 IP 192.168.1.2.2130 > 192.168.1.1.53: 39863+ AAAA? ui.skype.com. (30)
178+
```
179+
180+
Collecting TFTP data and converting alerts to JSON format using [sample traffic](https://wiki.wireshark.org/SampleCaptures#TFTP)
181+
182+
```
183+
Dshell> decode -p tftp -O jsonout ~/pcap/tftp_*.pcap
184+
{"dport": 3445, "dip": "192.168.0.10", "data": "read rfc1350.txt (24599 bytes) ", "sport": 50618, "readwrite": "read", "sip": "192.168.0.253", "plugin": "tftp", "ts": 1367411051.972852, "filename": "rfc1350.txt"}
185+
{"dport": 2087, "dip": "192.168.0.13", "data": "write rfc1350.txt (24599 bytes) ", "sport": 57509, "readwrite": "write", "sip": "192.168.0.1", "plugin": "tftp", "ts": 1367053679.45274, "filename": "rfc1350.txt"}
186+
```
187+
188+
Running a plugin within a separate Python script using [sample traffic](https://wiki.wireshark.org/SampleCaptures#TFTP)
189+
190+
```
191+
# Import required Dshell libraries
192+
import dshell.decode as decode
193+
import dshell.plugins.tftp.tftp as tftp
194+
195+
# Instantiate plugin
196+
plugin = tftp.DshellPlugin()
197+
# Define plugin-specific arguments, if needed
198+
dargs = {plugin: {"outdir": "/tmp/"}}
199+
# Add plugin(s) to plugin chain
200+
decode.plugin_chain = [plugin]
201+
# Run decode main function with all other arguments
202+
decode.main(
203+
debug=True,
204+
files=["/home/user/pcap/tftp_rrq.pcap", "/home/user/pcap/tftp_wrq.pcap"],
205+
plugin_args=dargs
206+
)
207+
```

0 commit comments

Comments
 (0)