Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Linux/Windows TUN/TAP wrapper for Python

Project description

TUN/TAP package for Linux and Windows
================================

``pytuntap`` is a Python module for you create TUN/TAP device very easily.
It canbe work both on Linux and Windows

License: MIT (see LICENSE)

Installation and Dependencies
-----------------------------

Install ``pytuntap`` with ``pip install python-pytuntap``

As ``pytuntap`` is python wrapper for tuntap driver on Linux , and openvpn driver on
Windows. If you use it on windows, you should install openvpn's tap driver first.
please refer to openvpn ,how to install it .

Documentation
-------------

NOTE: On most distributions you will need to be root to create TUN/TAP devices.

To create a TUN device::

from tuntap import TunTap

tun = TunTap(nic_type="Tun",nic_name="tun0")

To create a TAP device::

聽 from tuntap import TunTap

tap = TunTap(nic_type="Tap",nic_name="tap0")

To config device:

tap.config(ip="192.168.1.10",mask="255.255.255.0",gateway="192.168.1.254")

You can get some parameters of the device directly::

print(tun.name,tun.ip,tun.mask)

If the device is a TAP you can also get/set its MAC address::

print(tap.mac)

To read/write to the device, use the methods ``read(size)`` and
``write(buf)``::

buf = tun.read(size)
tun.write(buf)

To close the device::

tun.close()

you can also use ``TunTapDevice`` objects with all functions that expect a
``tun.handle`` method (e.g ``select()``)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-pytuntap, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size python-pytuntap-1.0.5.tar.gz (6.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page