Merge pull request #9 from icgood/tlv

Support TLV data in V2 headers

Author: icgood

.coveragerc

@@ -1,7 +1,7 @@
 language: python
 python:
-  - "3.7"
   - "3.8"
+  - "3.7"
 dist: bionic     # https://docs.travis-ci.com/user/languages/python/#python-37-and-higher
 install:
   - travis_retry pip install -U -r doc/requirements.txt
@@ -19,10 +19,14 @@ branches:
   only:
     - master
 deploy:
-  provider: pages
-  skip_cleanup: true
-  github_token: $GH_TOKEN
-  keep_history: true
-  on:
-    branch: master
-  local_dir: doc/build/html
+  - provider: pages:git
+    on:
+      tags: true
+    local_dir: doc/build/html
+    edge: true
+  - provider: pypi
+    distributions: sdist bdist_wheel
+    skip_existing: true
+    on:
+      tags: true
+    edge: true

.travis.yml

@@ -3,8 +3,10 @@
 import pkg_resources
 from abc import abstractmethod, ABCMeta
 from socket import AddressFamily, SocketKind
-from typing import Any, Optional, Sequence
+from ssl import SSLSocket, SSLObject
+from typing import Any, Union, Optional, Sequence
 
+from .tlv import ProxyProtocolTLV
 from .typing import Address, StreamReaderProtocol
 
 __all__ = ['__version__', 'ProxyProtocolError', 'ProxyProtocolResult',
@@ -63,6 +65,12 @@ def protocol(self) -> Optional[SocketKind]:
         """The original socket protocol."""
         return None
 
+    @property
+    @abstractmethod
+    def tlv(self) -> ProxyProtocolTLV:
+        """Additional information about the connection."""
+        ...
+
     @property
     def _sockname(self) -> Address:
         return None
@@ -113,6 +121,8 @@ async def read(self, reader: StreamReaderProtocol, *,
     @abstractmethod
     def build(self, source: Address, dest: Address, *, family: AddressFamily,
               protocol: Optional[SocketKind] = None,
+              ssl: Union[None, SSLObject, SSLSocket] = None,
+              unique_id: Optional[bytes] = None,
               proxied: bool = True) -> bytes:
         """Builds a PROXY protocol v1 header that may be sent at the beginning
         of an outbound, client-side connection to indicate the original
@@ -123,6 +133,8 @@ def build(self, source: Address, dest: Address, *, family: AddressFamily,
             dest: The original destination address of the connection.
             family: The original socket family.
             protocol: The original socket protocol.
+            ssl: The original socket SSL information.
+            unique_id: The original connection unique identifier.
             proxied: True if the connection should not be considered proxied.
 
         Raises:

proxyprotocol/__init__.py

@@ -1,6 +1,7 @@
 
 from socket import AddressFamily, SocketKind
-from typing import Optional
+from ssl import SSLSocket, SSLObject
+from typing import Union, Optional
 
 from . import ProxyProtocolError, ProxyProtocolResult, ProxyProtocol
 from .result import ProxyProtocolResultUnknown
@@ -25,7 +26,7 @@ class ProxyProtocolDetect(ProxyProtocol):
 
     def __init__(self, *versions: ProxyProtocol) -> None:
         super().__init__()
-        self.versions = versions or [ProxyProtocolV1(), ProxyProtocolV2()]
+        self.versions = versions or [ProxyProtocolV2(), ProxyProtocolV1()]
 
     def is_valid(self, signature: bytes) -> bool:
         return any(v.is_valid(signature) for v in self.versions)
@@ -55,11 +56,14 @@ def choose_version(self, signature: bytes) -> ProxyProtocol:
 
     def build(self, source: Address, dest: Address, *, family: AddressFamily,
               protocol: Optional[SocketKind] = None,
+              ssl: Union[None, SSLSocket, SSLObject] = None,
+              unique_id: Optional[bytes] = None,
               proxied: bool = True) -> bytes:
         for version in self.versions:
             try:
                 return version.build(source, dest, family=family,
-                                     protocol=protocol, proxied=proxied)
+                                     protocol=protocol, ssl=ssl,
+                                     unique_id=unique_id, proxied=proxied)
             except (KeyError, ValueError):
                 pass
         else:

proxyprotocol/detect.py

@@ -1,6 +1,7 @@
 
 from socket import AddressFamily, SocketKind
-from typing import Optional, Sequence, NoReturn
+from ssl import SSLSocket, SSLObject
+from typing import Union, Optional, Sequence, NoReturn
 
 from . import ProxyProtocol
 from .result import ProxyProtocolResultLocal
@@ -30,5 +31,7 @@ async def read(self, reader: StreamReaderProtocol, *,
 
     def build(self, source: Address, dest: Address, *, family: AddressFamily,
               protocol: Optional[SocketKind] = None,
+              ssl: Union[None, SSLSocket, SSLObject] = None,
+              unique_id: Optional[bytes] = None,
               proxied: bool = True) -> bytes:
         return b''

proxyprotocol/noop.py

@@ -6,6 +6,7 @@
 from typing_extensions import Literal
 
 from . import ProxyProtocolResult
+from .tlv import ProxyProtocolTLV
 
 __all__ = ['ProxyProtocolResult', 'ProxyProtocolResultLocal',
            'ProxyProtocolResultUnknown', 'ProxyProtocolResultIPv4',
@@ -34,6 +35,10 @@ def source(self) -> None:
     def dest(self) -> None:
         return None
 
+    @property
+    def tlv(self) -> ProxyProtocolTLV:
+        return ProxyProtocolTLV()
+
 
 class ProxyProtocolResultUnknown(ProxyProtocolResult):
     """Indicates that the source of the connection is unknown."""
@@ -64,6 +69,10 @@ def source(self) -> None:
     def dest(self) -> None:
         return None
 
+    @property
+    def tlv(self) -> ProxyProtocolTLV:
+        return ProxyProtocolTLV()
+
 
 class ProxyProtocolResultIPv4(ProxyProtocolResult):
     """The original connection was made with an IPv4 socket. The
@@ -72,15 +81,17 @@ class ProxyProtocolResultIPv4(ProxyProtocolResult):
 
     """
 
-    __slots__ = ['_source', '_dest', '_protocol']
+    __slots__ = ['_source', '_dest', '_protocol', '_tlv']
 
     def __init__(self, source: Tuple[IPv4Address, int],
                  dest: Tuple[IPv4Address, int], *,
-                 protocol: Optional[SocketKind] = None) -> None:
+                 protocol: Optional[SocketKind] = None,
+                 tlv: ProxyProtocolTLV = ProxyProtocolTLV()) -> None:
         super().__init__()
         self._source = source
         self._dest = dest
         self._protocol = protocol
+        self._tlv = tlv
 
     @property
     def proxied(self) -> Literal[True]:
@@ -102,6 +113,10 @@ def family(self) -> AddressFamily:
     def protocol(self) -> Optional[SocketKind]:
         return self._protocol
 
+    @property
+    def tlv(self) -> ProxyProtocolTLV:
+        return self._tlv
+
     @property
     def _peername(self) -> Tuple[str, int]:
         return str(self.source[0]), self.source[1]
@@ -125,15 +140,17 @@ class ProxyProtocolResultIPv6(ProxyProtocolResult):
 
     """
 
-    __slots__ = ['_source', '_dest', '_protocol']
+    __slots__ = ['_source', '_dest', '_protocol', '_tlv']
 
     def __init__(self, source: Tuple[IPv6Address, int],
                  dest: Tuple[IPv6Address, int], *,
-                 protocol: Optional[SocketKind] = None) -> None:
+                 protocol: Optional[SocketKind] = None,
+                 tlv: ProxyProtocolTLV = ProxyProtocolTLV()) -> None:
         super().__init__()
         self._source = source
         self._dest = dest
         self._protocol = protocol
+        self._tlv = tlv
 
     @property
     def proxied(self) -> Literal[True]:
@@ -155,6 +172,10 @@ def family(self) -> AddressFamily:
     def protocol(self) -> Optional[SocketKind]:
         return self._protocol
 
+    @property
+    def tlv(self) -> ProxyProtocolTLV:
+        return self._tlv
+
     @property
     def _peername(self) -> Tuple[str, int, int, int]:
         return str(self.source[0]), self.source[1], 0, 0
@@ -178,14 +199,16 @@ class ProxyProtocolResultUnix(ProxyProtocolResult):
 
     """
 
-    __slots__ = ['_source', '_dest', '_protocol']
+    __slots__ = ['_source', '_dest', '_protocol', '_tlv']
 
     def __init__(self, source: str, dest: str, *,
-                 protocol: Optional[SocketKind] = None) -> None:
+                 protocol: Optional[SocketKind] = None,
+                 tlv: ProxyProtocolTLV = ProxyProtocolTLV()) -> None:
         super().__init__()
         self._source = source
         self._dest = dest
         self._protocol = protocol
+        self._tlv = tlv
 
     @property
     def proxied(self) -> Literal[True]:
@@ -207,6 +230,10 @@ def family(self) -> AddressFamily:
     def protocol(self) -> Optional[SocketKind]:
         return self._protocol
 
+    @property
+    def tlv(self) -> ProxyProtocolTLV:
+        return self._tlv
+
     @property
     def _peername(self) -> str:
         return self.source