├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.md ├── portstat ├── __init__.py └── portstat.py ├── setup.py └── tests ├── portstat.conf └── tests.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "2.6" 4 | - "2.7" 5 | - "3.3" 6 | - "3.4" 7 | install: 8 | - pip install . 9 | script: 10 | - python tests/tests.py 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # portstat 2 | 3 | ![](https://badge.fury.io/py/portstat.svg) ![](https://travis-ci.org/imlonghao/portstat.svg) ![](https://landscape.io/github/imlonghao/portstat/master/landscape.svg?style=flat) 4 | 5 | A simple port traffic monitor 6 | 7 | ## Install 8 | 9 | ### Install pip 10 | 11 | For Debian / Ubunut user 12 | 13 | ``` 14 | apt-get update 15 | apt-get install python-pip 16 | ``` 17 | 18 | ### Install portstat 19 | 20 | ``` 21 | pip install portstat 22 | ``` 23 | 24 | ### System setting 25 | 26 | Add the following line to `/etc/rc.local` to run portstat on the startup. 27 | 28 | Notice that add it before `exit 0` . 29 | 30 | ``` 31 | /sbin/iptables -N PORTSTAT 32 | /sbin/iptables -A INPUT -j PORTSTAT 33 | /sbin/iptables -A OUTPUT -j PORTSTAT 34 | /bin/bash /etc/portstat.rules 35 | ``` 36 | 37 | To upload the traffic information every minute, we should add the following line in `crontab -e` 38 | 39 | ``` 40 | * * * * * /usr/local/bin/portstat -u 41 | ``` 42 | 43 | Run it every 5 minutes like the following 44 | 45 | ``` 46 | */5 * * * * /usr/local/bin/portstat -u 47 | ``` 48 | 49 | To activate the new iptables rules, please run the `/sbin/iptables` command manually or issue a `reboot` command. 50 | 51 | After that, you have installed portstat successfully. 52 | 53 | ## Upgrade 54 | 55 | Every new version I will upload it to pypi so that you can upgrade to the latest version with the following code. 56 | 57 | ``` 58 | pip install -U portstat 59 | ``` 60 | 61 | For some unexpectable reason, I can NOT promise that you can upgrade to the latest version without change your settings. 62 | 63 | So, please come back to see what's new at every upgrade. 64 | 65 | ## Usage 66 | 67 | ``` 68 | usage: portstat [-h] [-c CONFIG] [-v | -s | -u] 69 | 70 | A simple port traffic monitor 71 | 72 | optional arguments: 73 | -h, --help show this help message and exit 74 | -c CONFIG, --config CONFIG 75 | Path of the config file. 76 | -v, --version Show portstat version. 77 | -s, --sync Sync the portstat settings and iptables. 78 | -u, --upload Upload the port stat with webhook. 79 | ``` 80 | 81 | ## Tutorial 82 | 83 | First of all, you should install portstat as I mentioned above. 84 | 85 | Create a conf in where you like, by default the path is `/etc/portstat.conf`, just remenber use `-c path` to declare the config file if you don't use the default path. 86 | The conf file should looks like that: 87 | 88 | ``` 89 | [imlonghao] 90 | Port=80 91 | Webhook=https://imlonghao.com/?imlonghao 92 | 93 | [shadowsocks] 94 | Port=10000-10010 95 | Webhook=https://imlonghao.com/?shadowsocks 96 | 97 | [test] 98 | Port=22,111,8080 99 | Webhook=https://imlonghao.com/?test 100 | ``` 101 | 102 | `[name]` used to distinguish every port you want to monitor. 103 | 104 | `Port=111` used to declare the port you want to monitor, it should be a int like `111` , or a range like `10000-10010`, or `80,81,8080,8888` . 105 | 106 | `Webhook=https://imlonghao.com/` used to received the traffic information, portstat will post the information to the webhook like that 107 | 108 | ![](https://cloud.githubusercontent.com/assets/4951333/8232820/24432094-1605-11e5-9534-5fc9362d1626.png) 109 | 110 | Then, save the config file. 111 | 112 | Run `portstat -s` to create new iptables rules to monitor the port you just add. 113 | 114 | Run `portstat -u` to upload to port traffic information to webhook manually. 115 | 116 | ## Contribution 117 | 118 | - [Issue](https://github.com/imlonghao/portstat/issues) 119 | - [Pull Request](https://github.com/imlonghao/portstat/pulls) 120 | 121 | ## License 122 | 123 | Licensed under the Apache License, Version 2.0 -------------------------------------------------------------------------------- /portstat/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imlonghao/portstat/f7e286aba75886f30f4ace463066d334bea2f3ad/portstat/__init__.py -------------------------------------------------------------------------------- /portstat/portstat.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | import os 5 | import time 6 | import argparse 7 | 8 | try: 9 | from urllib.parse import urlencode 10 | except ImportError: 11 | from urllib import urlencode 12 | 13 | try: 14 | import urllib.request as urllib2 15 | except ImportError: 16 | import urllib2 17 | 18 | try: 19 | import configparser 20 | except ImportError: 21 | import ConfigParser as configparser 22 | 23 | __author__ = 'imlonghao' 24 | __version__ = '0.0.6' 25 | 26 | 27 | def version(): 28 | return __version__.split(',') 29 | 30 | 31 | def getConfig(path): 32 | settings = configparser.ConfigParser() 33 | settings.read(path) 34 | portGroups = [] 35 | for each in settings.sections(): 36 | portGroups.append( 37 | [each, settings.get(each, 'Port'), settings.get(each, 'Webhook')]) 38 | return portGroups 39 | 40 | 41 | def sync(portGroups): 42 | with open('/etc/portstat.rules', 'w') as portstat_rules: 43 | portstat_rules.write('#!/bin/bash\n') 44 | portstat_rules.write('/sbin/iptables -F PORTSTAT\n') 45 | for each in portGroups: 46 | if '-' in each[1]: 47 | begin = int(each[1].split('-')[0]) 48 | end = int(each[1].split('-')[1]) + 1 49 | for i in range(begin, end): 50 | portstat_rules.write( 51 | '/sbin/iptables -A PORTSTAT -p tcp --dport %s\n' 52 | % str(i)) 53 | portstat_rules.write( 54 | '/sbin/iptables -A PORTSTAT -p tcp --sport %s\n' 55 | % str(i)) 56 | elif ',' in each[1]: 57 | portLists = each[1].split(',') 58 | while '' in portLists: 59 | portLists.remove('') 60 | for i in portLists: 61 | portstat_rules.write( 62 | '/sbin/iptables -A PORTSTAT -p tcp --dport %s\n' % i) 63 | portstat_rules.write( 64 | '/sbin/iptables -A PORTSTAT -p tcp --sport %s\n' % i) 65 | else: 66 | portstat_rules.write( 67 | '/sbin/iptables -A PORTSTAT -p tcp --dport %s\n' % each[1]) 68 | portstat_rules.write( 69 | '/sbin/iptables -A PORTSTAT -p tcp --sport %s\n' % each[1]) 70 | os.system('/bin/bash /etc/portstat.rules') 71 | 72 | 73 | def upload(portGroups): 74 | # stats = {9999: 11111}, {10000: 11112} 75 | stats = {} 76 | for each in os.popen('/sbin/iptables -vxn -L PORTSTAT').readlines()[2:]: 77 | port = int(each.strip().split()[9][4:]) 78 | value = int(each.strip().split()[1]) 79 | if port in stats: 80 | stats[port] += value 81 | else: 82 | stats[port] = value 83 | # datas = [{'1.php': {22: 100}}, {'2.php': {21: 101, 22: 99}}] 84 | datas = [] 85 | for each in portGroups: 86 | line = {} 87 | if '-' in each[1]: 88 | begin = int(each[1].split('-')[0]) 89 | end = int(each[1].split('-')[1]) + 1 90 | for i in range(begin, end): 91 | line[i] = stats[i] 92 | elif ',' in each[1]: 93 | portLists = each[1].split(',') 94 | while '' in portLists: 95 | portLists.remove('') 96 | for i in portLists: 97 | line[int(i)] = stats[int(i)] 98 | else: 99 | line[int(each[1])] = stats[int(each[1])] 100 | datas.append({each[2]: line}) 101 | for each in datas: 102 | req = urllib2.Request( 103 | '%s?%s' % (each.keys()[0], str(int(time.time()))), 104 | urlencode(each.values()[0]).encode('utf-8')) 105 | urllib2.urlopen(req) 106 | os.system('/sbin/iptables -Z PORTSTAT') 107 | 108 | 109 | def main(): 110 | parser = argparse.ArgumentParser( 111 | description='A simple port traffic monitor') 112 | parser.add_argument('-c', '--config', type=str, 113 | default='/etc/portstat.conf', 114 | help='Path of the config file.') 115 | group = parser.add_mutually_exclusive_group() 116 | group.add_argument( 117 | '-v', '--version', help='Show portstat version.', action='store_true') 118 | group.add_argument( 119 | '-s', '--sync', 120 | help='Sync the portstat settings and iptables.', action='store_true') 121 | group.add_argument( 122 | '-u', '--upload', 123 | help='Upload the port stat with webhook.', action='store_true') 124 | args = parser.parse_args() 125 | portGroups = getConfig(args.config) 126 | if args.version: 127 | print('portstat in version %s' % version()) 128 | if args.sync: 129 | sync(portGroups) 130 | if args.upload: 131 | upload(portGroups) 132 | 133 | 134 | if __name__ == '__main__': 135 | main() 136 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from os import path 3 | from codecs import open 4 | 5 | here = path.abspath(path.dirname(__file__)) 6 | 7 | with open(path.join(here, 'README.md'), encoding='utf-8') as f: 8 | long_description = f.read() 9 | 10 | setup( 11 | name='portstat', 12 | version='0.0.6', 13 | keywords=('port', 'monitor', 'traffic'), 14 | url='https://github.com/imlonghao/portstat', 15 | license='Apache License 2.0', 16 | author='imlonghao', 17 | author_email='shield@fastmail.com', 18 | description='A simple port traffic monitor', 19 | long_description=long_description, 20 | packages=find_packages(), 21 | platforms='any', 22 | entry_points={ 23 | 'console_scripts': [ 24 | 'portstat=portstat.portstat:main' 25 | ] 26 | } 27 | ) 28 | -------------------------------------------------------------------------------- /tests/portstat.conf: -------------------------------------------------------------------------------- 1 | [webserver] 2 | Port=80 3 | Webhook=https://imlonghao.com/?webserver 4 | 5 | [shadowsocks] 6 | Port=10000-10005 7 | Webhook=https://imlonghao.com/?shadowsocks -------------------------------------------------------------------------------- /tests/tests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from portstat import portstat 4 | --------------------------------------------------------------------------------