Ticket #3014: Twisted-11.0.0-ipv6.chjurk.diff

twisted/internet/abstract.py

@@ -9 +9 @@
 Maintainer: Itamar Shtull-Trauring
 """
 
+import socket
+
 from zope.interface import implements
 
 # Twisted Imports
@@ -412 +414 @@
         return -1
 
 
-def isIPAddress(addr):
+def isIPv6Address(addr):
+    """
+    Determine whether the given string represents an IPv6 address.
+
+        @param addr: A string which may or may not be the hexadecimal
+        representation of an IPv6 address.
+
+        @rtype: C{bool}
+        @return: C{True} if C{addr} represents an IPv6 address, C{False}
+    otherwise.
+    """
+    if addr.find(":") != 1:
+        try:
+            socket.getaddrinfo(addr, 0, socket.AF_INET6, 0, 0, socket.AI_NUMERICHOST)
+        except socket.gaierror:
+            pass
+        else:
+            return True
+    return False
+
+def isIPv4Address(addr):
     """
     Determine whether the given string represents an IPv4 address.
 
@@ -437 +459 @@
         return True
     return False
 
+def isIPAddress(addr):
+    """
+    Determine whether the given string represents an IPv4 or IPv6 address.
+    
+    @type addr: C{str}
+    @param addr: A string which may or may not be the decimal dotted
+    representation of an IPv4 address.
+
+    @rtype: C{bool}
+    @return: C{True} if C{addr} represents an IPv4 address, C{False}
+    """
+    return isIPv4Address(addr) or isIPv6Address(addr)
 
 __all__ = ["FileDescriptor"]

twisted/internet/address.py

@@ -5 +5 @@
 Address objects for network connections.
 """
 
-import warnings, os
+import warnings, os, socket
 
 from zope.interface import implements
 
@@ -13 +13 @@
 from twisted.python import util
 
 
-class IPv4Address(object, util.FancyEqMixin):
+class IPAddress(object, util.FancyEqMixin):
     """
-    Object representing an IPv4 socket endpoint.
+    Object representing an IP socket endpoint.
 
     @ivar type: A string describing the type of transport, either 'TCP' or
         'UDP'.
@@ -25 +25 @@
 
     implements(IAddress)
 
-    compareAttributes = ('type', 'host', 'port')
+    compareAttributes = ('type', 'family', 'host', 'port')
 
-    def __init__(self, type, host, port, _bwHack = None):
+    def __init__(self, type, family, host, port, _bwHack = None):
         assert type in ('TCP', 'UDP')
         self.type = type
+        self.family = family
         self.host = host
         self.port = port
         if _bwHack is not None:
@@ -37 +38 @@
                     DeprecationWarning, stacklevel=2)
 
     def __repr__(self):
-        return 'IPv4Address(%s, %r, %d)' % (self.type, self.host, self.port)
+        family_str = "IPv4" if self.family == socket.AF_INET else "IPv6"
+        return 'IPAddress(%s, %s, %r, %d)' % (self.type, family_str, self.host, self.port)
 
 
     def __hash__(self):
-        return hash((self.type, self.host, self.port))
-
+        return hash((self.type, self.family, self.host, self.port))
 
+class IPv4Address(IPAddress):
+    """
+    Generic version of IPv4Address.
+    """
+    def __init(self, type, host, port):
+        IPAddress.__init__(type, socket.AF_INET, host, port, None)        
 
 class UNIXAddress(object, util.FancyEqMixin):
     """
@@ -92 +99 @@
 
 
 
+class _ServerFactoryIPAddress(IPAddress):
+    def __eq__(self, other):
+        if isinstance(other, IPAddress):
+            a = (self.type, self.family, self.host, self.port)
+            b = (other.type, other.family, other.host, other.port)
+            return a == b
+        return False
+
 # These are for buildFactory backwards compatability due to
 # stupidity-induced inconsistency.
 

twisted/internet/base.py

@@ -249 +249 @@
             else:
                 userDeferred.callback(result)
 
+    def _lookup(self, name):
+        """
+        Replacement for gethostbyname.
+        """
+        ai = socket.getaddrinfo(name, 0)
+        assert len(ai) > 0 and len(ai[0]) >= 5
+        
+        # Sort the result. IPv4 addresses should be preferred over
+        # IPv6 addresses to keep legacy applications working.
+        ai = sorted(ai, key=lambda fields: fields[0])
+        
+        return ai[0][4][0]
 
     def getHostByName(self, name, timeout = (1, 3, 11, 45)):
         """
@@ -265 +277 @@
         userDeferred = defer.Deferred()
         lookupDeferred = threads.deferToThreadPool(
             self.reactor, self.reactor.getThreadPool(),
-            socket.gethostbyname, name)
+            self._lookup, name)
         cancelCall = self.reactor.callLater(
             timeoutDelay, self._cleanup, name, lookupDeferred)
         self._runningQueries[lookupDeferred] = (userDeferred, cancelCall)

twisted/internet/endpoints.py

@@ -145 +145 @@
 
 
 
-class TCP4ServerEndpoint(object):
+class TCPServerEndpoint(object):
     """
-    TCP server endpoint with an IPv4 configuration
+    TCP server endpoint with an IP configuration
 
     @ivar _reactor: An L{IReactorTCP} provider.
 
@@ -186 +186 @@
                              backlog=self._backlog,
                              interface=self._interface)
 
+""" Legacy: TCP4ServerEndpoint """
+class TCP4ServerEndpoint(TCPServerEndpoint):
+    pass
 
-
-class TCP4ClientEndpoint(object):
+class TCPClientEndpoint(object):
     """
-    TCP client endpoint with an IPv4 configuration.
+    TCP client endpoint with an IP configuration.
 
     @ivar _reactor: An L{IReactorTCP} provider.
 
@@ -245 +247 @@
         except:
             return defer.fail()
 
+""" Legacy: TCP4ClientEndpoint """
+class TCP4ClientEndpoint(TCPClientEndpoint):
+    pass
 
-
-class SSL4ServerEndpoint(object):
+class SSLServerEndpoint(object):
     """
-    SSL secured TCP server endpoint with an IPv4 configuration.
+    SSL secured TCP server endpoint with an IP configuration.
 
     @ivar _reactor: An L{IReactorSSL} provider.
 
@@ -301 +305 @@
                              backlog=self._backlog,
                              interface=self._interface)
 
+""" Legacy: SSL4ServerEndpoint """
+class SSL4ServerEndpoint(SSLServerEndpoint):
+    pass
 
-
-class SSL4ClientEndpoint(object):
+class SSLClientEndpoint(object):
     """
-    SSL secured TCP client endpoint with an IPv4 configuration
+    SSL secured TCP client endpoint with an IP configuration
 
     @ivar _reactor: An L{IReactorSSL} provider.
 
@@ -369 +375 @@
         except:
             return defer.fail()
 
-
+""" Legacy: SSL4ClientEndpoint """
+class SSL4ClientEndpoint(SSLClientEndpoint):
+    pass
 
 class UNIXServerEndpoint(object):
     """
@@ -652 +660 @@
 
 # Mappings from description "names" to endpoint constructors.
 _endpointServerFactories = {
-    'TCP': TCP4ServerEndpoint,
-    'SSL': SSL4ServerEndpoint,
+    'TCP': TCPServerEndpoint,
+    'SSL': SSLServerEndpoint,
     'UNIX': UNIXServerEndpoint,
     }
 
 _endpointClientFactories = {
-    'TCP': TCP4ClientEndpoint,
-    'SSL': SSL4ClientEndpoint,
+    'TCP': TCPClientEndpoint,
+    'SSL': SSLClientEndpoint,
     'UNIX': UNIXClientEndpoint,
     }
 

twisted/internet/iocpreactor/tcp.py

@@ -261 +261 @@
     def __init__(self, host, port, bindAddress, connector, reactor):
         self.connector = connector
         self.addr = (host, port)
+        self.addressFamily = connector.family
         self.reactor = reactor
         # ConnectEx documentation says socket _has_ to be bound
         if bindAddress is None:
@@ -352 +353 @@
 
     def getHost(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the address from which I am connecting.
         """
-        return address.IPv4Address('TCP', *self.socket.getsockname())
+        return address.IPAddress('TCP', self.socket.family, *self.socket.getsockname())
 
 
     def getPeer(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the address that I am connected to.
         """
-        return address.IPv4Address('TCP', *self.realAddress)
+        return address.IPv4Address('TCP', self.addressFamily, *self.realAddress)
 
 
     def __repr__(self):
@@ -423 +424 @@
 
     def getHost(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the server's address.
         """
@@ -432 +433 @@
 
     def getPeer(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the client's address.
         """
@@ -482 +483 @@
 
 
     def startListening(self):
+        # Get the correct address family by using getaddrinfo() on the interface address
+        ai = socket.getaddrinfo(self.interface, self.port)
+        self.addressFamily = ai[0][0]
+        
         try:
             skt = self.reactor.createSocket(self.addressFamily,
                                             self.socketType)
@@ -574 +579 @@
 
     def getHost(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the server's address.
         """
-        return address.IPv4Address('TCP', *self.socket.getsockname())
+        return address.IPAddress('TCP', self.socket.family, *self.socket.getsockname())
 
 
     def cbAccept(self, rc, bytes, evt):
@@ -605 +610 @@
             assert family == self.addressFamily
 
             protocol = self.factory.buildProtocol(
-                address._ServerFactoryIPv4Address('TCP', rAddr[0], rAddr[1]))
+                address._ServerFactoryIPAddress('TCP', family, rAddr[0], rAddr[1]))
             if protocol is None:
                 evt.newskt.close()
             else:
                 s = self.sessionno
                 self.sessionno = s+1
                 transport = Server(evt.newskt, protocol,
-                        address.IPv4Address('TCP', rAddr[0], rAddr[1]),
-                        address.IPv4Address('TCP', lAddr[0], lAddr[1]),
+                        address.IPAddress('TCP', family, rAddr[0], rAddr[1]),
+                        address.IPAddress('TCP', family, lAddr[0], lAddr[1]),
                         s, self.reactor)
                 protocol.makeConnection(transport)
             return True

twisted/internet/iocpreactor/udp.py

@@ -51 +51 @@
 
         abstract.FileHandle.__init__(self, reactor)
 
+        # Get the correct address family by using getaddrinfo() on the interface address
+        ai = socket.getaddrinfo(self.interface, self.port)
+        self.addressFamily = ai[0][0]
+        
         skt = socket.socket(self.addressFamily, self.socketType)
         addrLen = _iocp.maxAddrLen(skt.fileno())
         self.addressBuffer = _iocp.AllocateReadBuffer(addrLen)
@@ -269 +273 @@
 
     def getHost(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the address from which I am connecting.
         """
-        return address.IPv4Address('UDP', *self.socket.getsockname())
+        return address.IPAddress('UDP', self.socket.family, *self.socket.getsockname())
 
 
 

twisted/internet/tcp.py

@@ -695 +695 @@
         # BaseClient.__init__ is invoked later
         self.connector = connector
         self.addr = (host, port)
-
+        self.addressFamily = connector.family
+        
         whenDone = self.resolveAddress
         err = None
         skt = None
@@ -714 +715 @@
         self._finishInit(whenDone, skt, err, reactor)
 
     def getHost(self):
-        """Returns an IPv4Address.
+        """Returns an IPAddress.
 
         This indicates the address from which I am connecting.
         """
-        return address.IPv4Address('TCP', *self.socket.getsockname())
+        return address.IPAddress('TCP', self.socket.family, *self.socket.getsockname())
 
     def getPeer(self):
-        """Returns an IPv4Address.
+        """Returns an IPAddress.
 
         This indicates the address that I am connected to.
         """
-        return address.IPv4Address('TCP', *self.realAddress)
+        return address.IPAddress('TCP', self.addressFamily, *self.realAddress)
 
     def __repr__(self):
         s = '<%s to %s at %x>' % (self.__class__, self.addr, unsignedID(self))
@@ -776 +777 @@
 
 
     def getHost(self):
-        """Returns an IPv4Address.
+        """Returns an IPAddress.
 
         This indicates the server's address.
         """
-        return address.IPv4Address('TCP', *self.socket.getsockname())
+        return address.IPAddress('TCP', self.socket.family, *self.socket.getsockname())
 
     def getPeer(self):
-        """Returns an IPv4Address.
+        """Returns an IPAddress.
 
         This indicates the client's address.
         """
-        return address.IPv4Address('TCP', *self.client)
+        return address.IPAddress('TCP', self.socket.family, *self.client)
 
 
 
@@ -848 +849 @@
             return "<%s of %s (not listening)>" % (self.__class__, self.factory.__class__)
 
     def createInternetSocket(self):
+        # Get the correct address family by using getaddrinfo() on the interface address
+        ai = socket.getaddrinfo(self.interface, self.port)
+        self.addressFamily = ai[0][0]
         s = base.BasePort.createInternetSocket(self)
         if platformType == "posix" and sys.platform != "cygwin":
             s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
@@ -863 +867 @@
         try:
             skt = self.createInternetSocket()
             skt.bind((self.interface, self.port))
+            pass
         except socket.error, le:
             raise CannotListenError, (self.interface, self.port, le)
 
@@ -885 +890 @@
 
 
     def _buildAddr(self, (host, port)):
-        return address._ServerFactoryIPv4Address('TCP', host, port)
+        return address._ServerFactoryIPAddress('TCP', self.addressFamily, host, port)
 
 
     def doRead(self):
@@ -939 +944 @@
                     raise
 
                 fdesc._setCloseOnExec(skt.fileno())
+                
+                # IPv6 addresses have usually more than two fields, reduce them.
+                if len(addr) > 2:
+                    addr = addr[0:2]
+                
                 protocol = self.factory.buildProtocol(self._buildAddr(addr))
                 if protocol is None:
                     skt.close()
@@ -1009 +1019 @@
         return reflect.qual(self.factory.__class__)
 
     def getHost(self):
-        """Returns an IPv4Address.
+        """Returns an IPAddress.
 
         This indicates the server's address.
         """
-        return address.IPv4Address('TCP', *self.socket.getsockname())
+        return address.IPAddress('TCP', self.socket.family, *self.socket.getsockname())
 
 class Connector(base.BaseConnector):
     def __init__(self, host, port, factory, timeout, bindAddress, reactor=None):
+        ai = socket.getaddrinfo(host, port)
+        self.family = ai[0][0]
         self.host = host
         if isinstance(port, types.StringTypes):
             try:
@@ -1031 +1043 @@
         return Client(self.host, self.port, self.bindAddress, self, self.reactor)
 
     def getDestination(self):
-        return address.IPv4Address('TCP', self.host, self.port)
+        return address.IPAddress('TCP', self.family, self.host, self.port)

twisted/internet/udp.py

@@ -86 +86 @@
         self._connectToProtocol()
 
     def _bindSocket(self):
+        # Get the correct address family by using getaddrinfo() on the interface address
+        ai = socket.getaddrinfo(self.interface, self.port)
+        self.addressFamily = ai[0][0]
+        
         try:
             skt = self.createInternetSocket()
             skt.bind((self.interface, self.port))
@@ -238 +242 @@
 
     def getHost(self):
         """
-        Returns an IPv4Address.
+        Returns an IPAddress.
 
         This indicates the address from which I am connecting.
         """
-        return address.IPv4Address('UDP', *self.socket.getsockname())
+        return address.IPAddress('UDP', self.socket.family, *self.socket.getsockname())