packaged it up

This commit is contained in:
Neale Pickett 2021-07-02 16:00:22 -06:00
parent c3ced6f1c4
commit 8cd7cb0bdc
10 changed files with 216 additions and 8 deletions

4
.gitignore vendored
View File

@ -1 +1,5 @@
__pycache__
build
dist
netarch.egg-info
*.pyc

View File

@ -1,7 +1,6 @@
#! /usr/bin/python3
import binascii
import sys
import struct
from . import ip
@ -181,9 +180,9 @@ def _registry(encoding):
codecs.register(_registry)
def main(session):
def main(session, pcaps):
s = None
reseq = ip.Dispatch(*sys.argv[1:])
reseq = ip.Dispatch(*pcaps)
for _, d in reseq:
srv, first, chunk = d
if not s:

View File

@ -1,6 +1,7 @@
#! /usr/bin/python3
import netarch
import sys
class DumbPacket(netarch.Packet):
def parse(self, data):
@ -9,4 +10,4 @@ class DumbPacket(netarch.Packet):
class DumbSession(netarch.Session):
Packet = DumbPacket
netarch.main(DumbSession)
netarch.main(DumbSession, sys.argv[1:])

View File

@ -12,7 +12,6 @@ import io
try:
import pcap
except ImportError:
warnings.warn("Using slow pure-python pcap library")
from . import py_pcap as pcap
import os
import cgi
@ -307,7 +306,6 @@ class TCP_Resequence:
self.handle = self.handle_handshake
def bundle_pending(self, xdi, pkt, seq):
"""Bundle up any pending packets.
@ -366,6 +364,8 @@ class TCP_Resequence:
return (xdi, first, gs)
def handle(self, pkt):
"""This method will be re-assigned to one of the handle_* methods below"""
def handle_handshake(self, pkt):
if not self.first:
@ -405,6 +405,7 @@ class TCP_Resequence:
self.closed = [True, True]
self.handle = self.handle_drop
print(self.lastack)
return self.bundle_pending(xdi, pkt, self.lastack[idx])
else:
# Stick it into pending

View File

@ -1,16 +1,17 @@
#! /usr/bin/python3
import struct
import builtins
_MAGIC = 0xA1B2C3D4
builtin_open = open
class PcapFile:
def __init__(self, stream, mode='r', snaplen=65535, linktype=1):
if 'b' not in mode:
mode += 'b'
try:
self.stream = builtins.open(stream, mode)
self.stream = builtin_open(stream, mode)
except TypeError:
self.stream = stream
try:

202
setup.py Normal file
View File

@ -0,0 +1,202 @@
#! /usr/bin/python3
"""A setuptools based setup module.
See:
https://packaging.python.org/guides/distributing-packages-using-setuptools/
https://github.com/pypa/sampleproject
"""
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
import pathlib
here = pathlib.Path(__file__).parent.resolve()
# Get the long description from the README file
long_description = (here / 'README.md').read_text(encoding='utf-8')
# Arguments marked as "Required" below must be included for upload to PyPI.
# Fields marked as "Optional" may be commented out.
setup(
# This is the name of your project. The first time you publish this
# package, this name will be registered for you. It will determine how
# users can install this project, e.g.:
#
# $ pip install sampleproject
#
# And where it will live on PyPI: https://pypi.org/project/sampleproject/
#
# There are some restrictions on what makes a valid project name
# specification here:
# https://packaging.python.org/specifications/core-metadata/#name
name='netarch', # Required
# Versions should comply with PEP 440:
# https://www.python.org/dev/peps/pep-0440/
#
# For a discussion on single-sourcing the version across setup.py and the
# project code, see
# https://packaging.python.org/en/latest/single_source_version.html
version='1.0.1', # Required
# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
description='Network Archaeology toolkit', # Optional
# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
#
# Often, this is the same as your README, so you can just read it in from
# that file directly (as we have already done above)
#
# This field corresponds to the "Description" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
long_description=long_description, # Optional
# Denotes that our long_description is in Markdown; valid values are
# text/plain, text/x-rst, and text/markdown
#
# Optional if long_description is written in reStructuredText (rst) but
# required for plain-text or Markdown; if unspecified, "applications should
# attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
# fall back to text/plain if it is not valid rst" (see link below)
#
# This field corresponds to the "Description-Content-Type" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
long_description_content_type='text/markdown', # Optional (see note above)
# This should be a valid link to your project's main homepage.
#
# This field corresponds to the "Home-Page" metadata field:
# https://packaging.python.org/specifications/core-metadata/#home-page-optional
url='https://github.com/dirtbags/netarch', # Optional
# This should be your name or the name of the organization which owns the
# project.
author='Neale Pickett', # Optional
# This should be a valid email address corresponding to the author listed
# above.
author_email='neale@woozle.org', # Optional
# Classifiers help users find your project by categorizing it.
#
# For a list of valid classifiers, see https://pypi.org/classifiers/
classifiers=[ # Optional
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 5 - Production/Stable',
# Indicate who your project is intended for
'Intended Audience :: Developers',
#'Topic :: Software Development :: Build Tools',
# Pick your license as you wish
'License :: Public Domain',
# Specify the Python versions you support here. In particular, ensure
# that you indicate you support Python 3. These classifiers are *not*
# checked by 'pip install'. See instead 'python_requires' below.
#'Programming Language :: Python :: 3',
#'Programming Language :: Python :: 3.6',
#'Programming Language :: Python :: 3.7',
#'Programming Language :: Python :: 3.8',
#'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3 :: Only',
],
# This field adds keywords for your project which will appear on the
# project page. What does your project relate to?
#
# Note that this is a list of additional keywords, separated
# by commas, to be used to assist searching for the distribution in a
# larger catalog.
keywords='network, packet, tcp, protocol, development', # Optional
# When your source code is in a subdirectory under the project root, e.g.
# `src/`, it is necessary to specify the `package_dir` argument.
#package_dir={'': 'src'}, # Optional
# You can just specify package directories manually here if your project is
# simple. Or you can use find_packages().
#
# Alternatively, if you just want to distribute a single Python file, use
# the `py_modules` argument instead as follows, which will expect a file
# called `my_module.py` to exist:
#
# py_modules=["my_module"],
#
#packages=find_packages(where='src'), # Required
packages=["netarch"],
# Specify which Python versions you support. In contrast to the
# 'Programming Language' classifiers above, 'pip install' will check this
# and refuse to install the project if the version does not match. See
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
python_requires='>=3.6, <4',
# This field lists other packages that your project depends on to run.
# Any package you put here will be installed by pip when your project is
# installed, so they must be valid existing projects.
#
# For an analysis of "install_requires" vs pip's requirements files see:
# https://packaging.python.org/en/latest/requirements.html
#install_requires=['peppercorn'], # Optional
# List additional groups of dependencies here (e.g. development
# dependencies). Users will be able to install these using the "extras"
# syntax, for example:
#
# $ pip install sampleproject[dev]
#
# Similar to `install_requires` above, these must be valid existing
# projects.
extras_require={ # Optional
#'dev': ['check-manifest'],
#'test': ['coverage'],
},
# If there are data files included in your packages that need to be
# installed, specify them here.
package_data={ # Optional
#'sample': ['package_data.dat'],
},
# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages. See:
# http://docs.python.org/distutils/setupscript.html#installing-additional-files
#
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
#data_files=[('my_data', ['data/data_file'])], # Optional
# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# `pip` to create the appropriate form of executable for the target
# platform.
#
# For example, the following would provide a command called `sample` which
# executes the function `main` from this package when invoked:
#entry_points={ # Optional
#'console_scripts': [
#'sample=sample:main',
#],
#},
# List additional URLs that are relevant to your project as a dict.
#
# This field corresponds to the "Project-URL" metadata fields:
# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
#
# Examples listed include a pattern for specifying where the package tracks
# issues, where the source is hosted, where to say thanks to the package
# maintainers, and where to support the project financially. The key is
# what's used to render the link text on PyPI.
project_urls={ # Optional
'Bug Reports': 'https://github.com/dirtbags/netarch/issues',
'Source': 'https://github.com/dirtbags/netarch/',
},
)