File: README.md

package info (click to toggle)
tcpflow 1.5.2%2Brepack1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 3,428 kB
  • sloc: cpp: 18,481; python: 8,737; sh: 1,343; xml: 1,118; makefile: 392; ansic: 367
file content (17 lines) | stat: -rw-r--r-- 774 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
To execute customizable python plugins:

1. Check examples in directory `tcpflow/python/plugins`.

2. Create a python script with the following properties:

  - The script contains one or more functions for tcpflow usage.
  - Each intended function must take a single string parameter.
    This parameter will hold the contents of the application data captured by tcpflow.
  - If an intended function returns, it must return a string,
    which will then be added to the report.xml file with the "plugindata" tag.

3. Execute the `tcpflow` command line with arguments `-e python -S py_path=path -S py_module=module -S py_function=foo`.

   Example:

	    tcpflow -r my.cap -o flows -e python -S py_path=python/plugins -S py_module=samplePlugin -S py_function=sampleFunction