You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: python/README.md
+20-18Lines changed: 20 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
# pmercury
2
2
3
3
pmercury provides a Python reference implementation for network fingerprinting and advanced analysis techniques. As an example, the code can generate a TLS fingerprint given a network interface or packet capture file, and then leverage the provided fingerprint database to perform process identification.
4
+
pmercury is designed to highlight the functionality of the protocol classes and to provide a simple interface into the fingerprint database.
4
5
5
6
There are four distinct (but related) components:
6
7
@@ -9,15 +10,19 @@ There are four distinct (but related) components:
9
10
* ../src/python-inference/* - A Cython port of protocols/tls.pyx that can be called from C++14 or higher code (and is used to perform process inference in mercury)
10
11
* ../resources/fingerprint_db.json.gz - The star of the show; a detailed database associating billions of network and endpoint observations
11
12
12
-
## Installation
13
+
## Requirements
14
+
15
+
On Linux pmercury requires Python>=3.6,<=3.11 with pip3 that can be installed with `sudo apt install python3-pip` on debian/ubuntu, or the equivalent command for your OS.
13
16
14
-
pmercury depends on libpcap-dev:
17
+
and requires libpcap-dev:
15
18
16
19
```bash
17
20
sudo apt-get install libpcap-dev
18
21
```
19
22
20
-
On Linux and Python 3.6 and 3.7, install pmercury with pip:
23
+
## Installation
24
+
25
+
Install pmercury with pip:
21
26
22
27
```bash
23
28
pip3 install pmercury
@@ -29,33 +34,30 @@ To build cython extensions:
29
34
python setup.py build_ext --inplace
30
35
```
31
36
32
-
To install pmercury:
37
+
## Build from source
33
38
34
39
```bash
35
-
python setup.py install
40
+
sudo apt-get install libpcap-dev
36
41
```
37
42
38
-
## pmercury
39
-
40
-
pmercury is designed to highlight the functionality of the protocol classes and to provide a simple interface into the fingerprint database.
43
+
pmercury needs `/pmercury` directory to exist in the root and be accessible
44
+
```bash
45
+
sudo mkdir /pmercury
46
+
sudo chmod 777 /pmercury
47
+
```
41
48
49
+
To install from sources
42
50
43
-
### Dependencies
51
+
```bash
52
+
python setup.py install
53
+
```
44
54
45
-
pmercury requires Python 3.6+ along with the following packages:
55
+
mercury has the following Python dependencies installed by `setup.py` script:
0 commit comments