0.0.8

Author: wraith-wireless

LICENSE

@@ -37,4 +37,4 @@ software in furtherance of or with intent to commit any fraudulent or other ille
 activities, or otherwise in violation of any applicable law, regulation or legal
 agreement.
 
-See <http://www.gnu.org/licenses/> for a copy of the GNU General Public License.
+See <http://www.gnu.org/licenses/> for a copy of the GNU General Public License.

MANIFEST.in

@@ -1,6 +1,6 @@
-# Include license, README
+# Include license, README, channels, device, pyw and user guide
 include LICENSE README.md __init__.py channels.py device.py pyw.py PyRIC.pdf
 
 # Include subdirectories
 recursive-include lib net examples docs
-recursive-include docs *.help *.pdf
+recursive-include docs *.help

PyRIC.pdf

@@ -2,9 +2,17 @@
 ## Pythonic iw
 
 ## 1 DESCRIPTION:
-BLUF: Stop using subprocess.Popen, regular expressions and str.find. PyRIC
-is a python port of a subset of iw and python port of netlink (w.r.t nl80211
-functions).
+BLUF: Why use subprocess.Popen, regular expressions and str.find to interact
+with your Wireless Network Interface Card. PyRIC provides the ability to
+manipuate, identify and enumerate your system's cards. It is a pure python port
+of a subset the functionality provided by iw, ifconfig and iwconfig. PyRIC is:
+* Pythonic: No ctypes, SWIG etc. PyRIC redefines C header files as Python and
+uses sockets to communicate with kernel.
+* Self-sufficient: No third-party files used, PyRIC is completely self-contained
+* Fast: (relatively speaking) PyRIC is faster than using iw through subprocess.Popen
+* Parse(less): Get the output you without parsing output from iw. Never worry about
+iw updates and rewriting your parsers.
+* Easy: If you can use iw, you can use PyRIC
 
 ### a. Background
 PyRIC arose out of a need in Wraith (https://github.com/wraith-wireless/wraith)
@@ -76,7 +84,7 @@ the following:
 * get supported commands
 * get supported modes
 * get dev info
-* get phy info (does not currently process the bands)
+* get phy info
 * get/set regulatory domain
 * get/set mode
 * add/delete interfaces

README.md

@@ -1,14 +1,13 @@
   1) overall
    o look at iw dev wlan0 link
-   o look at iw dev
+   o make a cli as well
   2) libnl.py
    o see (1) in RFI
-   o define attr_ops and attr_mcast_groups in nla_policy_attr
   4) pyw
    o add txget from iw i.e. netlink perspective
    o find a better way to find the supported standards of a card
    o for now, using ioctl to set ip addresses
     - move everything to netlink
    o Can we find the current channel of a radio in monitor mode that is actively
      scanning?
-   o parse NL80211_ATTR_WIPHY_BANDS
+   o parse NL80211_ATTR_WIPHY_BANDS (have workaround currently in place)

pyric/RFI RFIpyric/RFI renamed to RFI

@@ -1 +1 @@
-# root Distribution directory
+# root Distribution directory

pyric/TODO TODOpyric/TODO renamed to TODO

@@ -0,0 +1,74 @@
+#!/usr/bin/env python
+""" device.py
+
+Example for displaying device details
+"""
+
+import argparse as ap
+import pyric                     # pyric error (and ecode EUNDEF)
+from pyric import pyw            # for iw functionality
+from pyric import device         # for chipset/driver
+from pyric.channels import rf2ch # rf to channel conversion
+
+def execute(dev):
+    # ensure dev is a wireless interfaces
+    wifaces = pyw.winterfaces()
+    if dev not in wifaces:
+        print "Device {0} is not wireless, use one of {1}".format(dev,wifaces)
+
+    dinfo = pyw.devinfo(dev)
+    card = dinfo['card']
+    pinfo = pyw.phyinfo(card)
+    driver = device.ifdriver(card.dev)
+    chipset = device.ifchipset(driver)
+
+    msg = "Device {0}\n".format(dev)
+    msg += "\tDriver: {0} Chipset: {1}\n".format(driver,chipset)
+    msg += "\tifindex: {0}\n".format(card.idx)
+    msg += "\twdev: {0}\n".format(dinfo['wdev'])
+    msg += "\taddr: {0}\n".format(dinfo['mac'])
+    msg += "\tmode: {0}\n".format(dinfo['mode'])
+    msg += "\twiphy: {0}\n".format(card.phy)
+    if dinfo['mode'] == 'managed':
+        msg += "\tchannel: {0} (1 MHz), width: {2}, CF: {3}\n".format(rf2ch(dinfo['RF']),
+                                                                      dinfo['RF'],
+                                                                      dinfo['CHW'],
+                                                                      dinfo['CF'])
+    else:
+        msg += "\tDevice not associated\n"
+    print msg
+
+    msg = "Wiphy phy{0}\n".format(card.phy)
+    msg += "\tGeneration: {0}m Coverage Class: {1}\n".format(pinfo['generation'],
+                                                             pinfo['cov_class'])
+    msg += "\tMax # scan SSIDs: {0}\n".format(pinfo['scan_ssids'])
+    msg += "\tRetry Short: {0}, Long: {1}\n".format(pinfo['retry_short'],
+                                                    pinfo['retry_long'])
+    msg += "\tThreshold Frag: {0}, RTS: {1}\n".format(pinfo['frag_thresh'],
+                                                      pinfo['rts_thresh'])
+    msg += "\tSupported Modes:\n"
+    for mode in pinfo['modes']:
+        msg += "\t  * {0}\n".format(mode)
+    msg += "\tSupported Commands:\n"
+    for cmd in pinfo['commands']:
+        msg += "\t  * {0}\n".format(cmd)
+    msg += "\tSupported Frequencies:\n"
+    for freq in pinfo['freqs']:
+        msg += "\t  * {0}\n".format(freq)
+
+    print msg
+
+if __name__ == '__main__':
+    # create arg parser and parse command line args
+    print "Wireless Device Info Display using PyRIC v{0}".format(pyric.__version__)
+    argp = ap.ArgumentParser(description="Wireless Device Data")
+    argp.add_argument('-d','--dev',help="Wireless Device")
+    args = argp.parse_args()
+    try:
+        dev = args.dev
+        if dev is None:
+            print "usage: python device.py -d <dev>"
+        else:
+            execute(dev)
+    except pyric.error as e:
+        print e

__init__.py

@@ -90,8 +90,8 @@ def execute(dev):
     try:
         dev = args.dev
         if dev is None:
-            print "usage: python pentest -d <dev> -v <vdev>"
+            print "usage: python pentest.py -d <dev>"
         else:
             execute(dev)
     except pyric.error as e:
-        print e
+        print e

examples/device.py

@@ -103,11 +103,13 @@
     - added devcmds in pyw
     - annotated (in comments) if fcts needed root privileges
     - added functions to get/set ip address, netmask and broadcast
+    - fixed PEP8 errors
+    - made worked around for pulling supported freqs out NL80211_ATTR_WIPHY_BANDS
 """
 
 __name__ = 'pyric'
 __license__ = 'GPLv3'
-__version__ = '0.0.7'
+__version__ = '0.0.8'
 __date__ = 'April 2016'
 __author__ = 'Dale Patterson'
 __maintainer__ = 'Dale Patterson'