Metadata-Version: 1.2
Name: jspcapy
Version: 0.1.3
Summary: A command line pcap file analyser tool.
Home-page: https://github.com/JarryShaw/jspcap/jspcapy/
Author: Jarry Shaw
Author-email: jarryshaw@icloud.com
License: GNU General Public License v3 (GPLv3)
Description-Content-Type: UNKNOWN
Description: .. _header-n0:
        
        jspcapy
        =======
        
            This program is derived from ``jspcap`` and ``jsformat``.
        
         ``jspcapy`` is a **command line** pcap file analyser tool. It supports
        analysis on several networking protocol headers, such as ``IP`` (both
        version 4 and 6), ``ICMP``, ``TCP``, ``UDP``, ``SCTP``, et al and
        streaming output of ``plist``, ``json`` and *tree-view* text file.
        
             In the core of the ``JSPCAP`` project, it works with the support of
            ``jspcap`` and ``jsformat``, which can both be found in three
            projects above and are maintained in the
            ```dev`` <https://github.com/JarryShaw/jspcap/tree/master/dev/>`__
            folder.
        
         Notice that the whole project is developed in ``Python 3.6`` and its
        compatibility hasn't been tested.
        
        .. _header-n16:
        
        Installation
        ------------
        
         Simply run the following to install the latest from PyPI:
        
        .. code:: bash
        
            $ pip install jspcapy
        
         Or install from the git repository:
        
        .. code:: bash
        
            $ git clone https://github.com/JarryShaw/jspcap.git
            $ cd jspcap/jspcapy
            $ python setup.py install
        
        .. _header-n25:
        
        Usage
        -----
        
         As it shows in the help manual, it is quite easy to use:
        
        .. code:: bash
        
            $ jspcapy -h
            usage: jspcapy.py [-h] [-v] [-o file-name] [-f format] [-j] [-p] [-t] [-a]
                              [-V]
                              input-file-name
        
            PCAP file extractor and formatted exporter
        
            positional arguments:
              input-file-name       The name of input pcap file. If ".pcap" omits, it will
                                    be automatically appended.
        
            optional arguments:
              -h, --help            show this help message and exit
              -v, --version         show program's version number and exit
              -o file-name, --output file-name
                                    The name of input pcap file. If format extension
                                    omits, it will be automatically appended.
              -f format, --format format
                                    Print a extraction report in the specified output
                                    format. Available are all formats supported by
                                    jsformat, e.g.: json, plist, tree, xml, html.
              -j, --json            Display extraction report as json. This will yield
                                    "raw" output that may be used by external tools. This
                                    option overrides all other options.
              -p, --plist           Display extraction report as macOS Property List
                                    (plist). This will yield "raw" output that may be used
                                    by external tools. This option overrides all other
                                    options.
              -t, --tree            Display extraction report as tree view text. This will
                                    yield "raw" output that may be used by external tools.
                                    This option overrides all other options.
              -a, --auto-extension  If output file extension omits, append automatically.
              -V, --verbose         Show more information.
        
         Under most circumstances, you should indicate the name of input pcap
        file (extension may omit) and at least, output format (``json``,
        ``plist``, ``tree``, ``xml``, or ``html``). Once format unspecified, the
        name of output file must have proper extension (``*.json``, ``*.plist``,
        ``*.txt``, ``*.xml``, or ``*.js``), otherwise ``FormatError`` will
        raise.
        
         As for ``verbose`` mode, detailed information will print while
        extraction (as following examples). And ``auto-extension`` flag works
        for the output file, to indicate whether extensions should be appended.
        
        .. _header-n35:
        
        Samples
        -------
        
         Here are some usage samples:
        
        -  export to a macOS Property List (``Xcode`` has special support for
           this format)
        
        .. code:: bash
        
             $ jspcapy in -f plist -V
             🚨Loading file 'in.pcap'
              - Frame   1: Ethernet:IPv6:ICMPv6
              - Frame   2: Ethernet:IPv6:ICMPv6
              - Frame   3: Ethernet:IPv4:TCP
              - Frame   4: Ethernet:IPv4:TCP
              - Frame   5: Ethernet:IPv4:TCP
              - Frame   6: Ethernet:IPv4:UDP
             🍺Report file stored in 'out.plist'
        
        -  export to a json file (with no format specified)
        
        .. code:: bash
        
             $ jspcapy in -o out.json -V
             🚨Loading file 'in.pcap'
             - Frame   1: Ethernet:IPv6:ICMPv6
             - Frame   2: Ethernet:IPv6:ICMPv6
             - Frame   3: Ethernet:IPv4:TCP
             - Frame   4: Ethernet:IPv4:TCP
             - Frame   5: Ethernet:IPv4:TCP
             - Frame   6: Ethernet:IPv4:UDP
            🍺Report file stored in 'out.json'
        
        -  export to a text tree view file (without extension autocorrect)
        
        .. code:: bash
        
             $ jspcapy in -o out -f tree -V
             🚨Loading file 'in.pcap'
             - Frame   1: Ethernet:IPv6:ICMPv6
             - Frame   2: Ethernet:IPv6:ICMPv6
             - Frame   3: Ethernet:IPv4:TCP
             - Frame   4: Ethernet:IPv4:TCP
             - Frame   5: Ethernet:IPv4:TCP
             - Frame   6: Ethernet:IPv4:UDP
            🍺Report file stored in 'out'
        
Keywords: computer-networking pcap-analyzer pcap-parser
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=3.4
