initial commit
[soho-sigint.git] / README
1 i###############################################################################
2 # The MIT License (MIT)
3 # Copyright (c) Russell Handorf
4 # Other copyrights noted where code modification is located
5 #
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 # THE SOFTWARE.
23 #
24 ###############################################################################
25
26 SoHO SIGINT
27
28 WARNING: THIS IS VERY ALPHA/BETA CODE! Gradware at best.
29
30 FORWARD:
31 This is from a talk that I gave at BSidesDE 2015 from a small project that I started working on.
32 The powerpoint it contained within.
33
34 CONCEPT:
35 1. Continued monitoring and analysis of WiFi, Bluetooth and SDR to look and log nearby devices.
36 2. Do not store events passed 30 days unless tracked for specific monitoring and alerting.
37
38 Beta:
39 1. WiFi - Dependencies of Kismet, memory leak on BBB
40 2. Bluetooth - Dependencies of Kismet, memory leak on BBB [not released yet]
41 3. SDR - TPMS code, memory leak on BBB [not released yet]
42
43 Hardware:
44 1. One server to log and present analysis
45 2. Collection from Raspberry Pi (RPi) or Beaglebone Black (BBB)
46
47 Dependencies:
48 1. LAMP Stack
49 2. RTL-SDR, Ubertooth One, TP-Link TL-WN722N
50
51 Current Operation:
52 Client code runs on a RPi or BBB. Each client pushes data realtime to a MySQL DB. Server PHP code handles presentation. A cron job purges old messages.
53
54 TODO:
55 1. Write 802.11 sniffer / currently depends on Kismet
56 2. Write BT sniffer / currently depends on Kismet
57 3. Write a better TPMS monitor / memory leak in current code.
58 4. Better webpage admin functions