U W[0@sdZddlZddlZddlZddlZddlZddlmZddlm Z m Z ddl m Z m Z mZddlmZmZddlmZddlmZdd lmZdd lmZdd lmZmZmZmZmZdd l m!Z!m"Z"d ddgZ#dZ$dZ%dZ&dZ'Gdd d e Z(eej)Gdddeee*Z+GdddeddZ,Gddde Z-Gddde*Z.eej/Gdddej0Z1eedddde1j2e1j3e1_3dS) zc Support for Linux ethernet and IP tunnel devices. @see: U{https://en.wikipedia.org/wiki/TUN/TAP} N) namedtuple)Flags FlagConstant) Attribute Interface implementer) FancyEqMixin FancyStrMixin)Version)fullyQualifiedName) deprecated)log)abstracterrortask interfacesdefer)ethernetraw TunnelFlags TunnelAddress TuntapPortiT@lTs /dev/net/tunc@speZdZdZedZedZedZedZedZ edZ edZ ed Z ed Z ed Zed Zed ZdS)ra~ L{TunnelFlags} defines more flags which are used to configure the behavior of a tunnel device. @cvar IFF_TUN: This indicates a I{tun}-type device. This type of tunnel carries IP datagrams. This flag is mutually exclusive with C{IFF_TAP}. @cvar IFF_TAP: This indicates a I{tap}-type device. This type of tunnel carries ethernet frames. This flag is mutually exclusive with C{IFF_TUN}. @cvar IFF_NO_PI: This indicates the I{protocol information} header will B{not} be included in data read from the tunnel. @see: U{https://www.kernel.org/doc/Documentation/networking/tuntap.txt} r @ii i@iN)__name__ __module__ __qualname____doc__rIFF_TUNIFF_TAPZ TUN_FASYNCZTUN_NOCHECKSUMZ TUN_NO_PIZ TUN_ONE_QUEUEZ TUN_PERSISTZ TUN_VNET_HDR IFF_NO_PIZ IFF_ONE_QUEUEZ IFF_VNET_HDRZ IFF_TUN_EXCLr'r'5/usr/lib/python3/dist-packages/twisted/pair/tuntap.pyr(sc@s@eZdZdZdZdddfdfZeddZd d Zd d Z d S)rzU A L{TunnelAddress} represents the tunnel to which a L{TuntapPort} is bound. ) _typeValuenametypecCs|jSN)r*)flagr'r'r(OzTunnelAddress.r*cCs|jjS)z Return the integer value of the C{type} attribute. Used to produce correct results in the equality implementation. )r+valueselfr'r'r(r)QszTunnelAddress._typeValuecCs||_||_dS)z @param type: Either L{TunnelFlags.IFF_TUN} or L{TunnelFlags.IFF_TAP}, representing the type of this tunnel. @param name: The system name of the tunnel. @type name: L{bytes} N)r+r*)r2r+r*r'r'r(__init__[szTunnelAddress.__init__cCstjdtddd|jf|S)zS Deprecated accessor for the tunnel name. Use attributes instead. zUTunnelAddress.__getitem__ is deprecated since Twisted 14.0.0 Use attributes instead.r)category stacklevelZTUNTAP)warningswarnDeprecationWarningr*)r2indexr'r'r( __getitem__gs zTunnelAddress.__getitem__N) r r!r"r#ZcompareAttributesZshowAttributespropertyr)r3r:r'r'r'r(rIs  c@seZdZdZdS)_TunnelDescriptionz Describe an existing tunnel. @ivar fileno: the file descriptor associated with the tunnel @type fileno: L{int} @ivar name: the name of the tunnel @type name: L{bytes} N)r r!r"r#r'r'r'r(r<ssr<z fileno namec@sdeZdZdZedZedZedZdddZdd d Z d d Z d dZ ddZ ddZ ddZdS)_IInputOutputSystemz An interface for performing some basic kinds of I/O (particularly that I/O which might be useful for L{twisted.pair.tuntap}-using code). z@see: L{os.O_RDWR}z@see: L{os.O_NONBLOCK}z@see: L{os.O_CLOEXEC}cCsdS)z" @see: L{os.open} Nr')filenamer-moder'r'r(opensz_IInputOutputSystem.openNcCsdS)z& @see: L{fcntl.ioctl} Nr')fdZoptargZ mutate_flagr'r'r(ioctlsz_IInputOutputSystem.ioctlcCsdS)z" @see: L{os.read} Nr')rBlimitr'r'r(readsz_IInputOutputSystem.readcCsdS)z# @see: L{os.write} Nr')rBdatar'r'r(writesz_IInputOutputSystem.writecCsdS)z# @see: L{os.close} Nr')rBr'r'r(closesz_IInputOutputSystem.closecCsdS)a Send a datagram to a certain address. @param datagram: The payload of a UDP datagram to send. @type datagram: L{bytes} @param address: The destination to which to send the datagram. @type address: L{tuple} of (L{bytes}, L{int}) @return: The local address from which the datagram was sent. @rtype: L{tuple} of (L{bytes}, L{int}) Nr')datagramZaddressr'r'r(sendUDPsz_IInputOutputSystem.sendUDPcCsdS)af Return a socket which can be used to receive datagrams sent to the given address. @param fileno: A file descriptor representing a tunnel device which the datagram was either sent via or will be received via. @type fileno: L{int} @param host: The IPv4 address at which the datagram will be received. @type host: L{bytes} @param port: The UDP port number at which the datagram will be received. @type port: L{int} @return: A L{socket.socket} which can be used to receive the specified datagram. Nr')filenoZhostZportr'r'r( receiveUDPsz_IInputOutputSystem.receiveUDP)r>)NN)r r!r"r#rO_RDWR O_NONBLOCK O_CLOEXECrArDrFrHrIrKrMr'r'r'r(r=s  r=c@sZeZdZdZeejZeejZeejZeej Z ee j Z ej Z ej Z eeddZdS) _RealSystemz An interface to the parts of the operating system which L{TuntapPort} relies on. This is most of an implementation of L{_IInputOutputSystem}. rPiN)r r!r"r# staticmethodosrArFrHrIfcntlrDrNrOgetattrrPr'r'r'r(rQs     rQc@seZdZdZdZd!ddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZd"ddZddZdd ZdS)#rzH A Port that reads and writes packets from/to a TUN/TAP-device. irNcCstj|rd|_tj|_nd|_tj|_tj|s:t |dkrHt }||_ t j ||||_||_||_||j}d||jjf|_dS)Nrrz%s (%s))rZIEthernetProtocolZ providedByrr%_moder$rZIRawPacketProtocolAssertionErrorrQ_systemrFileDescriptorr3 interfaceprotocol maxPacketSizeZ _getLogPrefixr*logstr)r2rZprotor\reactorsystem logPrefixr'r'r(r3s   zTuntapPort.__init__cCs@t|jjf}|jr|d}n|d}||jj|jf}d|S)N))znot z<%s %slistening on %s/%s>)r r[ __class__ connectedrVr*rZ)r2argsr'r'r(__repr__s  zTuntapPort.__repr__cCs ||j||dS)z Create and bind my socket, and begin listening on it. This must be called after creating a server to begin listening on the specified tunnel. N) _bindSocketr[ZmakeConnectionZ startReadingr1r'r'r(startListenings zTuntapPort.startListeningcCsd|jj|jjB|jjB}tdtf||j}|jt |}|j |t |}t ||dt dS)af Open the named tunnel using the given mode. @param name: The name of the tunnel to open. @type name: L{bytes} @param mode: Flags from L{TunnelFlags} with exactly one of L{TunnelFlags.IFF_TUN} or L{TunnelFlags.IFF_TAP} set. @return: A L{_TunnelDescription} representing the newly opened tunnel. z%dsHN)rXrNrPrOstructZpack _IFNAMSIZr0rA _TUN_KO_PATHrD _TUNSETIFFr<strip)r2r*r@flagsZconfigrLresultr'r'r( _openTunnels zTuntapPort._openTunnelc Cstjd|jj|jdz||j|jtjB\}}Wn6t t fk rj}zt d|j|W5d}~XYnX||_||_ d|_dS)z" Open the tunnel. z&%(protocol)s starting on %(interface)s)formatr[rZNr)r msgr[rcrZrqrVrr&IOErrorOSErrorrZCannotListenError_filenord)r2rLrZer'r'r(rg(s "zTuntapPort._bindSocketcCs|jSr,)rvr1r'r'r(rL<szTuntapPort.filenoc Csd}||jkrz|j|j|j}WnPtk rh}z&|jtjtjtj fkrVWY dSW5d}~XYnYnX|t |7}z|j j |ddWqt |j j}tdd|fYqXqdS)z= Called when my socket is ready for reading. rN)partialz,Unhandled exception from %s.datagramReceived) maxThroughputrXrFrvr\EnvironmentErrorerrnoZ EWOULDBLOCKZEAGAINEINTRlenr[ZdatagramReceivedr rcr err)r2rFrGrwclsr'r'r(doRead@s&    zTuntapPort.doReadc CsZz|j|j|WStk rT}z$|jtjkrB||WYSW5d}~XYnXdS)z Write the given data as a single datagram. @param datagram: The data that will make up the complete datagram to be written. @type datagram: L{bytes} N)rXrHrvrtr{r|)r2rJrwr'r'r(rHZs  zTuntapPort.writecCs|d|dS)z Write a datagram constructed from a L{list} of L{bytes}. @param datagram: The data that will make up the complete datagram to be written. @type seq: L{list} of L{bytes} r/N)rHjoin)r2seqr'r'r( writeSequencejszTuntapPort.writeSequencecCsH||jr|jS|jr:t|jd|j|_d|_|jSt dSdS)z Stop accepting connections on this port. This will shut down my socket and call self.connectionLost(). @return: A L{Deferred} that fires when this port has stopped. rTN) Z stopReadingZ disconnectingZ_stoppedDeferredrdrZ deferLaterr_connectionLostrZsucceedr1r'r'r( stopListeninguszTuntapPort.stopListeningcCs|tjdS)zN Close this tunnel. Use L{TuntapPort.stopListening} instead. N)rZ addErrbackr r~r1r'r'r(loseConnectionszTuntapPort.loseConnectioncCsFtd|jtj|||jd|_|j |j d|_ dS)zY Cleans up my socket. @param reason: Ignored. Do not use this. z(Tuntap %s Closed)rN) r rsrZrrYrr[ZdoStoprdrXrIrv)r2reasonr'r'r(rs  zTuntapPort.connectionLostcCs|jS)zK Returns the name of my class, to prefix log entries with. )r]r1r'r'r(raszTuntapPort.logPrefixcCst|j|jS)z Get the local address of this L{TuntapPort}. @return: A L{TunnelAddress} which describes the tunnel device to which this object is bound. @rtype: L{TunnelAddress} )rrVrZr1r'r'r(getHostszTuntapPort.getHost)rNN)N)r r!r"r#ryr3rfrhrqrgrLrrHrrrrrarr'r'r'r(rs$     ZTwisted)4r#rSrTr{rjr6 collectionsrZ constantlyrrZzope.interfacerrrZtwisted.python.utilrr Z incrementalr Ztwisted.python.reflectr Ztwisted.python.deprecater Ztwisted.pythonr Ztwisted.internetrrrrrZ twisted.pairrr__all__rkrmZ _TUNGETIFFrlrZIAddressobjectrr<r=rQZIListeningPortrYrrrr'r'r'r(sL     !) LP