├── 1_Pcap
    └── .gitkeep
├── 2_Session
    └── .gitkeep
├── 4_Png
    └── .gitkeep
├── 5_Mnist
    └── .gitkeep
├── 3_ProcessedSession
    └── .gitkeep
├── requirements.txt
├── 0_Tool
    ├── finddupe.exe
    └── SplitCap_2-1
    │   ├── SplitCap.exe
    │   ├── ChangeLog.txt
    │   └── LICENSE-SplitCap.txt
├── 1_Pcap2Session.ps1
├── CONTRIBUTING.md
├── 3_Session2Png.py
├── 4_Png2Mnist.py
├── 2_ProcessSession.ps1
├── .gitignore
├── README.md
└── LICENSE


/1_Pcap/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/2_Session/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/4_Png/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/5_Mnist/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/3_ProcessedSession/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | numpy>=1.16.4
2 | PIL>=1.1.6


--------------------------------------------------------------------------------
/0_Tool/finddupe.exe:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davidyslu/USTC-TK2016/HEAD/0_Tool/finddupe.exe


--------------------------------------------------------------------------------
/0_Tool/SplitCap_2-1/SplitCap.exe:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davidyslu/USTC-TK2016/HEAD/0_Tool/SplitCap_2-1/SplitCap.exe


--------------------------------------------------------------------------------
/0_Tool/SplitCap_2-1/ChangeLog.txt:
--------------------------------------------------------------------------------
 1 | 2013-11-09	SplitCap 2.1
 2 | 
 3 |  *	Support for reading PCAP data from stdin with "-r -", for example in order to run:
 4 | 	tcpdump -i eth0 -w - | mono SplitCap.exe -r -
 5 | 
 6 | 2013-06-25	SplitCap 2.0
 7 | 
 8 |  *	Changed from "\\" to System.IO.Path.DirectorySeparatorChar in order to run better
 9 | 	on Linux and other non-Windows platforms.
10 | 	Hint: use Mono framework to run SplitCap in Linux.
11 | 	Installation in Ubuntu with: apt-get install libmono2.0-cil
12 | 
13 |  *	Added "-s seconds <s>" and "-s packets <c>" to split pcap files based on
14 | 	time or packet count (much like editcap).


--------------------------------------------------------------------------------
/0_Tool/SplitCap_2-1/LICENSE-SplitCap.txt:
--------------------------------------------------------------------------------
 1 | Copyright 2008-2011, Erik Hjelmvik <erik.hjelmvik[at]gmail.com>
 2 | SplitCap is available from http://www.netresec.com/?page=SplitCap
 3 | 
 4 | SOFTWARE LICENSE
 5 | 
 6 | SplitCap is licensed under the GNU General Public License Version 3.
 7 | http://www.gnu.org/licenses/gpl.html
 8 | 
 9 | SplitCap uses the assemblies PacketParser and PcapFileHandler, which both stem
10 | from the NetworkMiner open source network forensics application available at:
11 | http://networkminer.sourceforge.net/
12 | 
13 | The SplitCap open source project space is available on SourceForge:
14 | http://sourceforge.net/projects/splitcap/
15 | 
16 | 
17 | SplitCap was initially created as part of the Statistical Protocol IDentification
18 | research project carried out by Erik Hjelmvik with fundings from .SE.
19 | More info on .SE is available at: http://www.iis.se/en/


--------------------------------------------------------------------------------
/1_Pcap2Session.ps1:
--------------------------------------------------------------------------------
 1 | # Wei Wang (ww8137@mail.ustc.edu.cn)
 2 | #
 3 | # This Source Code Form is subject to the terms of the Mozilla Public
 4 | # License, v. 2.0. If a copy of the MPL was not distributed with this file, You
 5 | # can obtain one at http://mozilla.org/MPL/2.0/.
 6 | # ==============================================================================
 7 | 
 8 | foreach($f in gci 1_Pcap *.pcap)
 9 | {
10 |     0_Tool\SplitCap_2-1\SplitCap -p 50000 -b 50000 -r $f.FullName -o 2_Session\AllLayers\$($f.BaseName)-ALL
11 |     # 0_Tool\SplitCap_2-1\SplitCap -p 50000 -b 50000 -r $f.FullName -s flow -o 2_Session\AllLayers\$($f.BaseName)-ALL
12 |     gci 2_Session\AllLayers\$($f.BaseName)-ALL | ?{$_.Length -eq 0} | del
13 | 
14 |     0_Tool\SplitCap_2-1\SplitCap -p 50000 -b 50000 -r $f.FullName -o 2_Session\L7\$($f.BaseName)-L7 -y L7
15 |     # 0_Tool\SplitCap_2-1\SplitCap -p 50000 -b 50000 -r $f.FullName -s flow -o 2_Session\L7\$($f.BaseName)-L7 -y L7
16 |     gci 2_Session\L7\$($f.BaseName)-L7 | ?{$_.Length -eq 0} | del
17 | }
18 | 
19 | 0_Tool\finddupe -del 2_Session\AllLayers
20 | 0_Tool\finddupe -del 2_Session\L7


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | I'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow. Please read the following content before contributing. Thanks for your cooperation.
 4 | 
 5 | ---
 6 | ## About Pull Requests
 7 | 
 8 | 1. Fork this repository and clone the repository you forked
 9 |     ```bash
10 |     # Clone your fork of the repo into the current directory
11 |     $ git clone https://github.com/<YOUR_USERNAME>/USTC-TK2016
12 |     # Navigate to the newly cloned directory
13 |     $ cd USTC-TK2016
14 |     ```
15 | 2. Create new branch named `develop` and switch to this branch
16 |     ```bash
17 |     # Create a new branch named develop
18 |     $ git branch develop
19 |     # Switch to branch named develop
20 |     $ git checkout develop
21 |     ```
22 | 3. Assign the original repository to a remote called `upstream` and update
23 |     ```bash
24 |     # Assign the original repo to a remote called "upstream"
25 |     $ git remote add upstream https://github.com/yungshenglu/USTC-TK2016
26 |     # Update to remote repository
27 |     $ git remote update
28 |     ```
29 | 4. Pull the latest version from our repository and merge to your branch
30 |     ```bash
31 |     # Pull the latest version from our repository
32 |     $ git fetch upstream master
33 |     # Merge our latest version to your branch
34 |     $ git rebase upstream/master
35 |     ```
36 | 
37 | ---
38 | ## License
39 | 
40 | [Mozilla Public License Version 2.0](LICENSE)
41 | 


--------------------------------------------------------------------------------
/3_Session2Png.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Wei Wang (ww8137@mail.ustc.edu.cn)
 3 | #
 4 | # This Source Code Form is subject to the terms of the Mozilla Public
 5 | # License, v. 2.0. If a copy of the MPL was not distributed with this file, You
 6 | # can obtain one at http://mozilla.org/MPL/2.0/.
 7 | # ==============================================================================
 8 | 
 9 | import numpy
10 | from PIL import Image
11 | import binascii
12 | import errno    
13 | import os
14 | 
15 | PNG_SIZE = 28
16 | 
17 | def getMatrixfrom_pcap(filename,width):
18 |     with open(filename, 'rb') as f:
19 |         content = f.read()
20 |     hexst = binascii.hexlify(content)  
21 |     fh = numpy.array([int(hexst[i:i+2],16) for i in range(0, len(hexst), 2)])  
22 |     rn = len(fh)/width
23 |     fh = numpy.reshape(fh[:rn*width],(-1,width))  
24 |     fh = numpy.uint8(fh)
25 |     return fh
26 | 
27 | def mkdir_p(path):
28 |     try:
29 |         os.makedirs(path)
30 |     except OSError as exc:  # Python >2.5
31 |         if exc.errno == errno.EEXIST and os.path.isdir(path):
32 |             pass
33 |         else:
34 |             raise
35 | 
36 | paths = [['3_ProcessedSession\TrimedSession\Train', '4_Png\Train'],['3_ProcessedSession\TrimedSession\Test', '4_Png\Test']]
37 | for p in paths:
38 |     for i, d in enumerate(os.listdir(p[0])):
39 |         dir_full = os.path.join(p[1], str(i))
40 |         mkdir_p(dir_full)
41 |         for f in os.listdir(os.path.join(p[0], d)):
42 |             bin_full = os.path.join(p[0], d, f)
43 |             im = Image.fromarray(getMatrixfrom_pcap(bin_full,PNG_SIZE))
44 |             png_full = os.path.join(dir_full, os.path.splitext(f)[0]+'.png')
45 |             im.save(png_full)
46 | 


--------------------------------------------------------------------------------
/4_Png2Mnist.py:
--------------------------------------------------------------------------------
 1 | # Wei Wang (ww8137@mail.ustc.edu.cn)
 2 | #
 3 | # This Source Code Form is subject to the terms of the Mozilla Public
 4 | # License, v. 2.0. If a copy of the MPL was not distributed with this file, You
 5 | # can obtain one at http://mozilla.org/MPL/2.0/.
 6 | # ==============================================================================
 7 | 
 8 | import os
 9 | import errno
10 | from PIL import Image
11 | from array import *
12 | from random import shuffle
13 | 
14 | def mkdir_p(path):
15 |     try:
16 |         os.makedirs(path)
17 |     except OSError as exc:  # Python >2.5
18 |         if exc.errno == errno.EEXIST and os.path.isdir(path):
19 |             pass
20 |         else:
21 |             raise
22 | 
23 | # Load from and save to
24 | mkdir_p('5_Mnist')
25 | Names = [['4_Png\Train','5_Mnist\\train']]
26 | 
27 | for name in Names:	
28 | 	data_image = array('B')
29 | 	data_label = array('B')
30 | 
31 | 	FileList = []
32 | 	for dirname in os.listdir(name[0]): 
33 | 		path = os.path.join(name[0],dirname)
34 | 		for filename in os.listdir(path):
35 | 			if filename.endswith(".png"):
36 | 				FileList.append(os.path.join(name[0],dirname,filename))
37 | 
38 | 	shuffle(FileList) # Usefull for further segmenting the validation set
39 | 
40 | 	for filename in FileList:
41 | 		print filename
42 | 		label = int(filename.split('\\')[2])
43 | 		Im = Image.open(filename)
44 | 		pixel = Im.load()
45 | 		width, height = Im.size
46 | 		for x in range(0,width):
47 | 			for y in range(0,height):
48 | 				data_image.append(pixel[y,x])
49 | 		data_label.append(label) # labels start (one unsigned byte each)
50 | 	hexval = "{0:#0{1}x}".format(len(FileList),6) # number of files in HEX
51 | 	hexval = '0x' + hexval[2:].zfill(8)
52 | 	
53 | 	# header for label array
54 | 	header = array('B')
55 | 	header.extend([0,0,8,1])
56 | 	header.append(int('0x'+hexval[2:][0:2],16))
57 | 	header.append(int('0x'+hexval[2:][2:4],16))
58 | 	header.append(int('0x'+hexval[2:][4:6],16))
59 | 	header.append(int('0x'+hexval[2:][6:8],16))	
60 | 	data_label = header + data_label
61 | 
62 | 	# additional header for images array	
63 | 	if max([width,height]) <= 256:
64 | 		header.extend([0,0,0,width,0,0,0,height])
65 | 	else:
66 | 		raise ValueError('Image exceeds maximum size: 256x256 pixels');
67 | 
68 | 	header[3] = 3 # Changing MSB for image data (0x00000803)	
69 | 	data_image = header + data_image
70 | 	output_file = open(name[1]+'-images-idx3-ubyte', 'wb')
71 | 	data_image.tofile(output_file)
72 | 	output_file.close()
73 | 	output_file = open(name[1]+'-labels-idx1-ubyte', 'wb')
74 | 	data_label.tofile(output_file)
75 | 	output_file.close()
76 | 
77 | # gzip resulting files
78 | for name in Names:
79 | 	os.system('gzip '+name[1]+'-images-idx3-ubyte')
80 | 	os.system('gzip '+name[1]+'-labels-idx1-ubyte')


--------------------------------------------------------------------------------
/2_ProcessSession.ps1:
--------------------------------------------------------------------------------
 1 | # Wei Wang (ww8137@mail.ustc.edu.cn)
 2 | #
 3 | # This Source Code Form is subject to the terms of the Mozilla Public
 4 | # License, v. 2.0. If a copy of the MPL was not distributed with this file, You
 5 | # can obtain one at http://mozilla.org/MPL/2.0/.
 6 | # ==============================================================================
 7 | 
 8 | $SESSIONS_COUNT_LIMIT_MIN = 0
 9 | $SESSIONS_COUNT_LIMIT_MAX = 60000
10 | $TRIMED_FILE_LEN = 784
11 | $SOURCE_SESSION_DIR = "Flow\L7"
12 | 
13 | echo "If Sessions more than $SESSIONS_COUNT_LIMIT_MAX we only select the largest $SESSIONS_COUNT_LIMIT_MAX."
14 | echo "Finally Selected Sessions:"
15 | 
16 | $dirs = gci $SOURCE_SESSION_DIR -Directory
17 | foreach($d in $dirs)
18 | {
19 |     $files = gci $d.FullName
20 |     $count = $files.count
21 |     if($count -gt $SESSIONS_COUNT_LIMIT_MIN)
22 |     {             
23 |         echo "$($d.Name) $count"        
24 |         if($count -gt $SESSIONS_COUNT_LIMIT_MAX)
25 |         {
26 |             $files = $files | sort Length -Descending | select -First $SESSIONS_COUNT_LIMIT_MAX
27 |             $count = $SESSIONS_COUNT_LIMIT_MAX
28 |         }
29 | 
30 |         $files = $files | resolve-path
31 |         $test  = $files | get-random -count ([int]($count/10))
32 |         $train = $files | ?{$_ -notin $test}     
33 | 
34 |         $path_test  = "3_ProcessedSession\FilteredSession\Test\$($d.Name)"
35 |         $path_train = "3_ProcessedSession\FilteredSession\Train\$($d.Name)"
36 |         ni -Path $path_test -ItemType Directory -Force
37 |         ni -Path $path_train -ItemType Directory -Force    
38 | 
39 |         cp $test -destination $path_test        
40 |         cp $train -destination $path_train
41 |     }
42 | }
43 | 
44 | echo "All files will be trimed to $TRIMED_FILE_LEN length and if it's even shorter we'll fill the end with 0x00..."
45 | 
46 | $paths = @(('3_ProcessedSession\FilteredSession\Train', '3_ProcessedSession\TrimedSession\Train'), ('3_ProcessedSession\FilteredSession\Test', '3_ProcessedSession\TrimedSession\Test'))
47 | foreach($p in $paths)
48 | {
49 |     foreach ($d in gci $p[0] -Directory) 
50 |     {
51 |         ni -Path "$($p[1])\$($d.Name)" -ItemType Directory -Force
52 |         foreach($f in gci $d.fullname)
53 |         {
54 |             $content = [System.IO.File]::ReadAllBytes($f.FullName)
55 |             $len = $f.length - $TRIMED_FILE_LEN
56 |             if($len -gt 0)
57 |             {        
58 |                 $content = $content[0..($TRIMED_FILE_LEN-1)]        
59 |             }
60 |             elseif($len -lt 0)
61 |             {        
62 |                 $padding = [Byte[]] (,0x00 * ([math]::abs($len)))
63 |                 $content = $content += $padding
64 |             }
65 |             Set-Content -value $content -encoding byte -path "$($p[1])\$($d.Name)\$($f.Name)"
66 |         }        
67 |     }
68 | }


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | 
  2 | # Created by https://www.gitignore.io/api/python,powershell,visualstudiocode
  3 | # Edit at https://www.gitignore.io/?templates=python,powershell,visualstudiocode
  4 | 
  5 | ### PowerShell ###
  6 | # Exclude packaged modules
  7 | *.zip
  8 | 
  9 | # Exclude .NET assemblies from source
 10 | *.dll
 11 | 
 12 | ### Python ###
 13 | # Byte-compiled / optimized / DLL files
 14 | __pycache__/
 15 | *.py[cod]
 16 | *$py.class
 17 | 
 18 | # C extensions
 19 | *.so
 20 | 
 21 | # Distribution / packaging
 22 | .Python
 23 | build/
 24 | develop-eggs/
 25 | dist/
 26 | downloads/
 27 | eggs/
 28 | .eggs/
 29 | lib/
 30 | lib64/
 31 | parts/
 32 | sdist/
 33 | var/
 34 | wheels/
 35 | pip-wheel-metadata/
 36 | share/python-wheels/
 37 | *.egg-info/
 38 | .installed.cfg
 39 | *.egg
 40 | MANIFEST
 41 | 
 42 | # PyInstaller
 43 | #  Usually these files are written by a python script from a template
 44 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 45 | *.manifest
 46 | *.spec
 47 | 
 48 | # Installer logs
 49 | pip-log.txt
 50 | pip-delete-this-directory.txt
 51 | 
 52 | # Unit test / coverage reports
 53 | htmlcov/
 54 | .tox/
 55 | .nox/
 56 | .coverage
 57 | .coverage.*
 58 | .cache
 59 | nosetests.xml
 60 | coverage.xml
 61 | *.cover
 62 | .hypothesis/
 63 | .pytest_cache/
 64 | 
 65 | # Translations
 66 | *.mo
 67 | *.pot
 68 | 
 69 | # Django stuff:
 70 | *.log
 71 | local_settings.py
 72 | db.sqlite3
 73 | 
 74 | # Flask stuff:
 75 | instance/
 76 | .webassets-cache
 77 | 
 78 | # Scrapy stuff:
 79 | .scrapy
 80 | 
 81 | # Sphinx documentation
 82 | docs/_build/
 83 | 
 84 | # PyBuilder
 85 | target/
 86 | 
 87 | # Jupyter Notebook
 88 | .ipynb_checkpoints
 89 | 
 90 | # IPython
 91 | profile_default/
 92 | ipython_config.py
 93 | 
 94 | # pyenv
 95 | .python-version
 96 | 
 97 | # pipenv
 98 | #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 99 | #   However, in case of collaboration, if having platform-specific dependencies or dependencies
100 | #   having no cross-platform support, pipenv may install dependencies that don’t work, or not
101 | #   install all needed dependencies.
102 | #Pipfile.lock
103 | 
104 | # celery beat schedule file
105 | celerybeat-schedule
106 | 
107 | # SageMath parsed files
108 | *.sage.py
109 | 
110 | # Environments
111 | .env
112 | .venv
113 | env/
114 | venv/
115 | ENV/
116 | env.bak/
117 | venv.bak/
118 | 
119 | # Spyder project settings
120 | .spyderproject
121 | .spyproject
122 | 
123 | # Rope project settings
124 | .ropeproject
125 | 
126 | # mkdocs documentation
127 | /site
128 | 
129 | # mypy
130 | .mypy_cache/
131 | .dmypy.json
132 | dmypy.json
133 | 
134 | # Pyre type checker
135 | .pyre/
136 | 
137 | ### VisualStudioCode ###
138 | .vscode
139 | .vscode/*
140 | !.vscode/settings.json
141 | !.vscode/tasks.json
142 | !.vscode/launch.json
143 | !.vscode/extensions.json
144 | 
145 | ### VisualStudioCode Patch ###
146 | # Ignore all local history of files
147 | .history
148 | 
149 | # End of https://www.gitignore.io/api/python,powershell,visualstudiocode
150 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # USTC-TK2016
 2 | 
 3 | This repository is a toolkit called "USTC-TK2016", which is used to parse network traffic (`.pcap` file). Besides, the dataset is "USTC-TFC2016".
 4 | 
 5 | * The [`master`](https://github.com/yungshenglu/USTC-TK2016/tree/master) branch can only run on Windows environment.
 6 | * The [`ubuntu`](https://github.com/yungshenglu/USTC-TK2016/tree/ubuntu) branch can run on Ubuntu Linux 16.04 LTS environment.
 7 | 
 8 | > **NOTICE:** This repository credits to [echowei/DeepTraffic](https://github.com/echowei/DeepTraffic)
 9 | 
10 | ---
11 | ## Installation
12 | 
13 | 1. Clone this repository on your machine
14 |     ```bash
15 |     # Clone the repository on "master" branch
16 |     $ git clone -b master https://github.com/yungshenglu/USTC-TK2016
17 |     ```
18 | 2. Install the required packages via the following command
19 |     ```bash
20 |     # Run the command at the root of the repository
21 |     $ pip3 install -r requirements.txt
22 |     ```
23 |     * The requried packages are listed as follow:
24 |         * [`numpy 1.16.4`](https://pypi.org/project/numpy/)
25 |         * [`PIL 1.1.6`](https://pypi.org/project/PIL/)
26 | 
27 | ---
28 | ## Execution
29 | 
30 | > **NOTICE:** You are on the `master` branch now!
31 | 
32 | 1. Download the traffic dataset **USTC-TFC2016** and put it into the directory [`1_Pcap\`](1_Pcap/)
33 |     * You can download the traffic dataset **USTC-TFC2016** from my another [repository](https://github.com/yungshenglu/USTC-TFC2016).
34 | 2. Open the PowerShell and run `1_Pcap2Session.ps1` (take a few minutes)
35 |     * To split the PCAP file by each **session**, please make sure the line 10 and 14 in `1_Pcap2Session.ps1` is uncommented and make line 11 and 15 is in comment.
36 |     * To split the PCAp file by each **flow**, please make sure the line 11 and 15 in `1_Pcap2Session.ps1` is uncommented and make line 10 and 14 is in comment.
37 |     * Run [`1_Pcap2Session.ps1`](1_Pcap2Session.ps1)
38 |         ```bash
39 |         # Make sure your current directory is correct
40 |         PS> .\1_Pcap2Session.ps1
41 |         ```
42 |     * If succeed, you will see the following files (folders) in folder [`2_Session\`](2_Session/)
43 |         * `AllLayers\`
44 |         * `L7\`
45 | 3. Run [`2_ProcessSession.ps1`](2_ProcessSession.ps1) (take a few minutes)
46 |     ```bash
47 |     # Make sure your current directory is correct
48 |     PS> .\2_ProcessSession.ps1
49 |     ```
50 |     * If succeed, you will see the following files (folders) in folder [`3_ProcessedSession\`](3_ProcessedSession/)
51 |         * `FilteredSession\` - Get the top 60000 large PCAP files
52 |         * `TrimedSession\` - Trim the filtered PCAP files into size 784 bytes (28 x 28) and append `0x00` if the PCAP file is shorter than 784 bytes
53 |         * The files in subdirectory `Test\` and `Train\` is random picked from dataset.
54 | 4. Run [`3_Session2Png.py`](3_Session2Png.py) (take a few minutes)
55 |     ```bash
56 |     # Make sure your current directory is correct
57 |     PS> python3 3_Session2png.py
58 |     ```
59 |     * If succeed, you will see the following files (folders) in folder [`4_Png\`](4_Png/)
60 |         * `Test\` - For testing
61 |         * `Train\` - For training
62 | 5. Run [`4_Png2Mnist.py`](4_Png2Mnist.py) (take a few minutes)
63 |     ```bash
64 |     # Make sure your current directory is correct
65 |     PS> python3 4_Png2Mnist.py
66 |     ```
67 |     * If succeed, you will see the the training datasets in folder [`5_Mnist\`](5_Mnist/)
68 |         * `train-images-idx1-ubyte`
69 |         * `train-images-idx3-ubyte`
70 |         * `train-images-idx1-ubyte.gz`
71 |         * `train-images-idx3-ubyte.gz`
72 | 
73 | ---
74 | ## Contributor
75 | 
76 | > **NOTICE:** You can follow the contributing process [CONTRIBUTING.md](CONTRIBUTING.md) to join me. I am very welcome any issue!
77 | 
78 | * Author
79 |     * [Wei Wang](https://github.com/echowei) - ww8137@mail.ustc.edu.cn
80 | * Contributor
81 |     * [David Lu](https://github.com/yungshenglu)
82 | 
83 | ---
84 | ## License
85 | 
86 | [Mozilla Public License Version 2.0](LICENSE)


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | Mozilla Public License Version 2.0
  2 | ==================================
  3 | 
  4 | 1. Definitions
  5 | --------------
  6 | 
  7 | 1.1. "Contributor"
  8 |     means each individual or legal entity that creates, contributes to
  9 |     the creation of, or owns Covered Software.
 10 | 
 11 | 1.2. "Contributor Version"
 12 |     means the combination of the Contributions of others (if any) used
 13 |     by a Contributor and that particular Contributor's Contribution.
 14 | 
 15 | 1.3. "Contribution"
 16 |     means Covered Software of a particular Contributor.
 17 | 
 18 | 1.4. "Covered Software"
 19 |     means Source Code Form to which the initial Contributor has attached
 20 |     the notice in Exhibit A, the Executable Form of such Source Code
 21 |     Form, and Modifications of such Source Code Form, in each case
 22 |     including portions thereof.
 23 | 
 24 | 1.5. "Incompatible With Secondary Licenses"
 25 |     means
 26 | 
 27 |     (a) that the initial Contributor has attached the notice described
 28 |         in Exhibit B to the Covered Software; or
 29 | 
 30 |     (b) that the Covered Software was made available under the terms of
 31 |         version 1.1 or earlier of the License, but not also under the
 32 |         terms of a Secondary License.
 33 | 
 34 | 1.6. "Executable Form"
 35 |     means any form of the work other than Source Code Form.
 36 | 
 37 | 1.7. "Larger Work"
 38 |     means a work that combines Covered Software with other material, in
 39 |     a separate file or files, that is not Covered Software.
 40 | 
 41 | 1.8. "License"
 42 |     means this document.
 43 | 
 44 | 1.9. "Licensable"
 45 |     means having the right to grant, to the maximum extent possible,
 46 |     whether at the time of the initial grant or subsequently, any and
 47 |     all of the rights conveyed by this License.
 48 | 
 49 | 1.10. "Modifications"
 50 |     means any of the following:
 51 | 
 52 |     (a) any file in Source Code Form that results from an addition to,
 53 |         deletion from, or modification of the contents of Covered
 54 |         Software; or
 55 | 
 56 |     (b) any new file in Source Code Form that contains any Covered
 57 |         Software.
 58 | 
 59 | 1.11. "Patent Claims" of a Contributor
 60 |     means any patent claim(s), including without limitation, method,
 61 |     process, and apparatus claims, in any patent Licensable by such
 62 |     Contributor that would be infringed, but for the grant of the
 63 |     License, by the making, using, selling, offering for sale, having
 64 |     made, import, or transfer of either its Contributions or its
 65 |     Contributor Version.
 66 | 
 67 | 1.12. "Secondary License"
 68 |     means either the GNU General Public License, Version 2.0, the GNU
 69 |     Lesser General Public License, Version 2.1, the GNU Affero General
 70 |     Public License, Version 3.0, or any later versions of those
 71 |     licenses.
 72 | 
 73 | 1.13. "Source Code Form"
 74 |     means the form of the work preferred for making modifications.
 75 | 
 76 | 1.14. "You" (or "Your")
 77 |     means an individual or a legal entity exercising rights under this
 78 |     License. For legal entities, "You" includes any entity that
 79 |     controls, is controlled by, or is under common control with You. For
 80 |     purposes of this definition, "control" means (a) the power, direct
 81 |     or indirect, to cause the direction or management of such entity,
 82 |     whether by contract or otherwise, or (b) ownership of more than
 83 |     fifty percent (50%) of the outstanding shares or beneficial
 84 |     ownership of such entity.
 85 | 
 86 | 2. License Grants and Conditions
 87 | --------------------------------
 88 | 
 89 | 2.1. Grants
 90 | 
 91 | Each Contributor hereby grants You a world-wide, royalty-free,
 92 | non-exclusive license:
 93 | 
 94 | (a) under intellectual property rights (other than patent or trademark)
 95 |     Licensable by such Contributor to use, reproduce, make available,
 96 |     modify, display, perform, distribute, and otherwise exploit its
 97 |     Contributions, either on an unmodified basis, with Modifications, or
 98 |     as part of a Larger Work; and
 99 | 
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 |     for sale, have made, import, and otherwise transfer either its
102 |     Contributions or its Contributor Version.
103 | 
104 | 2.2. Effective Date
105 | 
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 | 
110 | 2.3. Limitations on Grant Scope
111 | 
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 | 
118 | (a) for any code that a Contributor has removed from Covered Software;
119 |     or
120 | 
121 | (b) for infringements caused by: (i) Your and any other third party's
122 |     modifications of Covered Software, or (ii) the combination of its
123 |     Contributions with other software (except as part of its Contributor
124 |     Version); or
125 | 
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 |     its Contributions.
128 | 
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 | 
133 | 2.4. Subsequent Licenses
134 | 
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 | 
140 | 2.5. Representation
141 | 
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 | 
146 | 2.6. Fair Use
147 | 
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 | 
152 | 2.7. Conditions
153 | 
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 | 
157 | 3. Responsibilities
158 | -------------------
159 | 
160 | 3.1. Distribution of Source Form
161 | 
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 | 
170 | 3.2. Distribution of Executable Form
171 | 
172 | If You distribute Covered Software in Executable Form then:
173 | 
174 | (a) such Covered Software must also be made available in Source Code
175 |     Form, as described in Section 3.1, and You must inform recipients of
176 |     the Executable Form how they can obtain a copy of such Source Code
177 |     Form by reasonable means in a timely manner, at a charge no more
178 |     than the cost of distribution to the recipient; and
179 | 
180 | (b) You may distribute such Executable Form under the terms of this
181 |     License, or sublicense it under different terms, provided that the
182 |     license for the Executable Form does not attempt to limit or alter
183 |     the recipients' rights in the Source Code Form under this License.
184 | 
185 | 3.3. Distribution of a Larger Work
186 | 
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 | 
198 | 3.4. Notices
199 | 
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 | 
206 | 3.5. Application of Additional Terms
207 | 
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 | 
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 | 
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 | 
232 | 5. Termination
233 | --------------
234 | 
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 | 
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 | 
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 | 
261 | ************************************************************************
262 | *                                                                      *
263 | *  6. Disclaimer of Warranty                                           *
264 | *  -------------------------                                           *
265 | *                                                                      *
266 | *  Covered Software is provided under this License on an "as is"       *
267 | *  basis, without warranty of any kind, either expressed, implied, or  *
268 | *  statutory, including, without limitation, warranties that the       *
269 | *  Covered Software is free of defects, merchantable, fit for a        *
270 | *  particular purpose or non-infringing. The entire risk as to the     *
271 | *  quality and performance of the Covered Software is with You.        *
272 | *  Should any Covered Software prove defective in any respect, You     *
273 | *  (not any Contributor) assume the cost of any necessary servicing,   *
274 | *  repair, or correction. This disclaimer of warranty constitutes an   *
275 | *  essential part of this License. No use of any Covered Software is   *
276 | *  authorized under this License except under this disclaimer.         *
277 | *                                                                      *
278 | ************************************************************************
279 | 
280 | ************************************************************************
281 | *                                                                      *
282 | *  7. Limitation of Liability                                          *
283 | *  --------------------------                                          *
284 | *                                                                      *
285 | *  Under no circumstances and under no legal theory, whether tort      *
286 | *  (including negligence), contract, or otherwise, shall any           *
287 | *  Contributor, or anyone who distributes Covered Software as          *
288 | *  permitted above, be liable to You for any direct, indirect,         *
289 | *  special, incidental, or consequential damages of any character      *
290 | *  including, without limitation, damages for lost profits, loss of    *
291 | *  goodwill, work stoppage, computer failure or malfunction, or any    *
292 | *  and all other commercial damages or losses, even if such party      *
293 | *  shall have been informed of the possibility of such damages. This   *
294 | *  limitation of liability shall not apply to liability for death or   *
295 | *  personal injury resulting from such party's negligence to the       *
296 | *  extent applicable law prohibits such limitation. Some               *
297 | *  jurisdictions do not allow the exclusion or limitation of           *
298 | *  incidental or consequential damages, so this exclusion and          *
299 | *  limitation may not apply to You.                                    *
300 | *                                                                      *
301 | ************************************************************************
302 | 
303 | 8. Litigation
304 | -------------
305 | 
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 | 
313 | 9. Miscellaneous
314 | ----------------
315 | 
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 | 
323 | 10. Versions of the License
324 | ---------------------------
325 | 
326 | 10.1. New Versions
327 | 
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 | 
333 | 10.2. Effect of New Versions
334 | 
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 | 
340 | 10.3. Modified Versions
341 | 
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 | 
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 | 
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 | 
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 | 
358 |   This Source Code Form is subject to the terms of the Mozilla Public
359 |   License, v. 2.0. If a copy of the MPL was not distributed with this
360 |   file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 | 
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 | 
367 | You may add additional accurate notices of copyright ownership.
368 | 
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 | 
372 |   This Source Code Form is "Incompatible With Secondary Licenses", as
373 |   defined by the Mozilla Public License, v. 2.0.
374 | 


--------------------------------------------------------------------------------