readme.md 1.79 KB
Newer Older
1
# Inspector
2

Aral Balkan's avatar
Aral Balkan committed
3
Inspector is a series of tools that helps bootstrap investigations into web malware (trackers, etc.)
4 5 6

## How it works

Aral Balkan's avatar
Aral Balkan committed
7
Inspector loads in a web page from a URL (or a local HAR file) and generates an [HTTP Archive (HAR file)](http://www.softwareishard.com/blog/har-12-spec/) from it and saves it in *~/better.fyi/archive/*.
8 9 10

It then analyses the HAR file and:

11 12 13
* Generates a draft entry for the site itself under *~/better.fyi/drafts/sites/*
* Generates a draft list of third-party content that is accessed by the site and adds them to *~/better.fyi/drafts/trackers/*
* Non-destructively updates the list of trackers in published site entries under *~/better.fyi/content/sites/*
14

Aral Balkan's avatar
Aral Balkan committed
15
Drafts are just that, drafts. They are meant as a convenient starting point to an investigation with space to note what we find, not as final documents.
16

Aral Balkan's avatar
Aral Balkan committed
17 18 19 20 21 22
**Drafts should never be checked into published content without manual review and editing.**

This point cannot be stressed enough: **the manual investigation and editing process is the heart and soul of Better.**

## Inquiry

23
Inquiry is a tool that runs inspections on [the domains currently being tracked by Better](https://source.ind.ie/better/domains).
24 25 26

## Installation

27 28
Update: Headless Chrome version. Until we automate this, make sure you have Chrome installed first.

29 30 31 32 33 34
```bash
./install
```

## Usage

35 36 37 38
Update: Headless Chrome version. Until we automate this, make sure Headless Chrome is running first:

`chrome --headless --disable-gpu --remote-debugging-port=9222`

39
```bash
Aral Balkan's avatar
Aral Balkan committed
40 41 42 43 44 45
./inspect <URL>			: non-interactive
./inspect <URL> -i		: interactive
./inspect -f <path>		: analyse HTTP Archive file (.har/.har.gz) at path

./inquiry				: start an inquiry
./inquiry --local		: re-examine the existing HTTP Archives in the archive
46 47 48 49
```

## License

Aral Balkan's avatar
Aral Balkan committed
50
Inspector is released under GNU AGPLv3.