blob: 8fe90ea37ab24c3f3d9b217739ad3df0aee56ac6 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# -*- test-case-name: twisted.protocols.haproxy.test -*-
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Interfaces used by the PROXY protocol modules.
"""
from typing import Tuple, Union
import zope.interface
class IProxyInfo(zope.interface.Interface):
"""
Data container for PROXY protocol header data.
"""
header = zope.interface.Attribute(
"The raw byestring that represents the PROXY protocol header.",
)
source = zope.interface.Attribute(
"An L{twisted.internet.interfaces.IAddress} representing the "
"connection source."
)
destination = zope.interface.Attribute(
"An L{twisted.internet.interfaces.IAddress} representing the "
"connection destination."
)
class IProxyParser(zope.interface.Interface):
"""
Streaming parser that handles PROXY protocol headers.
"""
def feed(data: bytes) -> Union[Tuple[IProxyInfo, bytes], Tuple[None, None]]:
"""
Consume a chunk of data and attempt to parse it.
@param data: A bytestring.
@type data: bytes
@return: A two-tuple containing, in order, an L{IProxyInfo} and any
bytes fed to the parser that followed the end of the header. Both
of these values are None until a complete header is parsed.
@raises InvalidProxyHeader: If the bytes fed to the parser create an
invalid PROXY header.
"""
def parse(line: bytes) -> IProxyInfo:
"""
Parse a bytestring as a full PROXY protocol header line.
@param line: A bytestring that represents a valid HAProxy PROXY
protocol header line.
@type line: bytes
@return: An L{IProxyInfo} containing the parsed data.
@raises InvalidProxyHeader: If the bytestring does not represent a
valid PROXY header.
"""
|
