Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

snoopsnitch / README @ master

History | View | Annotate | Download (2.74 KB)

1
SnoopSnitch
2
===========
3

    
4
This is the SnoopSnitch source repository. SnoopSnitch collects and analyzes
5
mobile radio data to make you aware of your mobile network security and to warn
6
you about threats like fake base stations (IMSI catchers), user tracking and
7
over-the-air updates.
8

    
9
License
10
-------
11

    
12
Copyright (C) 2014 - 2017  Security Research Labs
13

    
14
This program is free software: you can redistribute it and/or modify it under
15
the terms of the GNU General Public License as published by the Free Software
16
Foundation, either version 3 of the License, or (at your option) any later
17
version.
18

    
19
See COPYING for details.
20

    
21
Resources
22
---------
23

    
24
Project website:       https://opensource.srlabs.de/projects/snoopsnitch
25
Public Git repository: https://opensource.srlabs.de/git/snoopsnitch.git
26
Mailing list:          https://lists.srlabs.de/cgi-bin/mailman/listinfo/gsmmap
27
Email:			       snoopsnitch@srlabs.de 
28
                       (PGP: 9728 A7F9 D457 1FBB 746F  5381 D52C AC10 634A 9561)
29

    
30
Building from source
31
--------------------
32

    
33
SnoopSnitch - including helper binaries - is known to build sucessfully on
34
Linux and OS X. When using the prebuilt helper binaries contained in the
35
repository, the app may also build on Windows.
36

    
37
To build SnoopSnitch you need the Android SDK [1] for building the actual app
38
and the Android NDK [2] (version 14.1) to build the native components like the Qualcomm DIAG
39
wrapper or the GSM parser. Download SDK and NDK and install it somewhere in
40
your file system. Set the environment variable NDK and SDK to the respective
41
paths:
42

    
43
	$ export ANDROID_HOME=<your_sdk_dir>
44
	$ export NDK_DIR=<your_ndk_dir>
45

    
46
IMPORTANT NOTE: contrib/prebuilt/ contains binaries to allow e.g. windows users
47
to build and deploy the SnoopSnitch app easily. However, you can rebuild
48
everything contained in contrib/prebuilt - including the libasn1c and
49
libosmocore projects we depend on - from source using the contrib/compile.sh
50
script. The source of those projects is pulled in by the build scripts through
51
sub-modules.
52

    
53
As SnoopSnitch ships with the prebuilt binaries, the following step is optional.
54
To build the parser binary from source, first install:
55

    
56
	$ sudo apt-get install default-jdk
57

    
58
In the SnoopSnitch source directory do the following (make sure you are using the version 14.1 of the NDK, as newer version of the NDK build tools are not supported yet):
59

    
60
	$ cd contrib/
61
	$ ./compile.sh -t android -g -u
62

    
63
To build the app, in the SnoopSnitch source directory, run the gradle wrapper like this:
64

    
65
	$ cd SnoopSnitch
66
	$ ./gradlew build
67

    
68
The compiled apk file can be found under: SnoopSnitch/app/build/outputs/apk
69

    
70

    
71
Please consult the Android documentation on how to set up the tools and
72
perform a release build.
73

    
74

    
75
[1] https://developer.android.com/sdk/
76
[2] https://developer.android.com/tools/sdk/ndk/