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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
# -*- test-case-name: twisted.web.test.test_http_headers -*-
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
An API for storing HTTP header names and values.
"""
from typing import (
AnyStr,
ClassVar,
Dict,
Iterator,
List,
Mapping,
Optional,
Sequence,
Tuple,
TypeVar,
Union,
overload,
)
from twisted.python.compat import cmp, comparable
_T = TypeVar("_T")
def _sanitizeLinearWhitespace(headerComponent: bytes) -> bytes:
r"""
Replace linear whitespace (C{\n}, C{\r\n}, C{\r}) in a header key
or value with a single space.
@param headerComponent: The header key or value to sanitize.
@return: The sanitized header key or value.
"""
return b" ".join(headerComponent.splitlines())
@comparable
class Headers:
"""
Stores HTTP headers in a key and multiple value format.
When passed L{str}, header names (e.g. 'Content-Type')
are encoded using ISO-8859-1 and header values (e.g.
'text/html;charset=utf-8') are encoded using UTF-8. Some methods that return
values will return them in the same type as the name given.
If the header keys or values cannot be encoded or decoded using the rules
above, using just L{bytes} arguments to the methods of this class will
ensure no decoding or encoding is done, and L{Headers} will treat the keys
and values as opaque byte strings.
@cvar _caseMappings: A L{dict} that maps lowercase header names
to their canonicalized representation, for headers with unconventional
capitalization.
@cvar _canonicalHeaderCache: A L{dict} that maps header names to their
canonicalized representation.
@ivar _rawHeaders: A L{dict} mapping header names as L{bytes} to L{list}s of
header values as L{bytes}.
"""
_caseMappings: ClassVar[Dict[bytes, bytes]] = {
b"content-md5": b"Content-MD5",
b"dnt": b"DNT",
b"etag": b"ETag",
b"p3p": b"P3P",
b"te": b"TE",
b"www-authenticate": b"WWW-Authenticate",
b"x-xss-protection": b"X-XSS-Protection",
}
_canonicalHeaderCache: ClassVar[Dict[Union[bytes, str], bytes]] = {}
_MAX_CACHED_HEADERS: ClassVar[int] = 10_000
__slots__ = ["_rawHeaders"]
def __init__(
self,
rawHeaders: Optional[Mapping[AnyStr, Sequence[AnyStr]]] = None,
) -> None:
self._rawHeaders: Dict[bytes, List[bytes]] = {}
if rawHeaders is not None:
for name, values in rawHeaders.items():
self.setRawHeaders(name, values)
def __repr__(self) -> str:
"""
Return a string fully describing the headers set on this object.
"""
return "{}({!r})".format(
self.__class__.__name__,
self._rawHeaders,
)
def __cmp__(self, other):
"""
Define L{Headers} instances as being equal to each other if they have
the same raw headers.
"""
if isinstance(other, Headers):
return cmp(
sorted(self._rawHeaders.items()), sorted(other._rawHeaders.items())
)
return NotImplemented
def _encodeName(self, name: Union[str, bytes]) -> bytes:
"""
Encode the name of a header (eg 'Content-Type') to an ISO-8859-1
encoded bytestring if required. It will be canonicalized and
whitespace-sanitized.
@param name: A HTTP header name
@return: C{name}, encoded if required, lowercased
"""
if canonicalName := self._canonicalHeaderCache.get(name, None):
return canonicalName
bytes_name = name.encode("iso-8859-1") if isinstance(name, str) else name
if bytes_name.lower() in self._caseMappings:
# Some headers have special capitalization:
result = self._caseMappings[bytes_name.lower()]
else:
result = _sanitizeLinearWhitespace(
b"-".join([word.capitalize() for word in bytes_name.split(b"-")])
)
# In general, we should only see a very small number of header
# variations in the real world, so caching them is fine. However, an
# attacker could generate infinite header variations to fill up RAM, so
# we cap how many we cache. The performance degradation from lack of
# caching won't be that bad, and legit traffic won't hit it.
if len(self._canonicalHeaderCache) < self._MAX_CACHED_HEADERS:
self._canonicalHeaderCache[name] = result
return result
def copy(self):
"""
Return a copy of itself with the same headers set.
@return: A new L{Headers}
"""
return self.__class__(self._rawHeaders)
def hasHeader(self, name: AnyStr) -> bool:
"""
Check for the existence of a given header.
@param name: The name of the HTTP header to check for.
@return: C{True} if the header exists, otherwise C{False}.
"""
return self._encodeName(name) in self._rawHeaders
def removeHeader(self, name: AnyStr) -> None:
"""
Remove the named header from this header object.
@param name: The name of the HTTP header to remove.
@return: L{None}
"""
self._rawHeaders.pop(self._encodeName(name), None)
def setRawHeaders(
self, name: Union[str, bytes], values: Sequence[Union[str, bytes]]
) -> None:
"""
Sets the raw representation of the given header.
@param name: The name of the HTTP header to set the values for.
@param values: A list of strings each one being a header value of
the given name.
@raise TypeError: Raised if C{values} is not a sequence of L{bytes}
or L{str}, or if C{name} is not L{bytes} or L{str}.
@return: L{None}
"""
_name = self._encodeName(name)
encodedValues: List[bytes] = []
for v in values:
if isinstance(v, str):
_v = v.encode("utf8")
else:
_v = v
encodedValues.append(_sanitizeLinearWhitespace(_v))
self._rawHeaders[_name] = encodedValues
def addRawHeader(self, name: Union[str, bytes], value: Union[str, bytes]) -> None:
"""
Add a new raw value for the given header.
@param name: The name of the header for which to set the value.
@param value: The value to set for the named header.
"""
self._rawHeaders.setdefault(self._encodeName(name), []).append(
_sanitizeLinearWhitespace(
value.encode("utf8") if isinstance(value, str) else value
)
)
@overload
def getRawHeaders(self, name: AnyStr) -> Optional[Sequence[AnyStr]]:
...
@overload
def getRawHeaders(self, name: AnyStr, default: _T) -> Union[Sequence[AnyStr], _T]:
...
def getRawHeaders(
self, name: AnyStr, default: Optional[_T] = None
) -> Union[Sequence[AnyStr], Optional[_T]]:
"""
Returns a sequence of headers matching the given name as the raw string
given.
@param name: The name of the HTTP header to get the values of.
@param default: The value to return if no header with the given C{name}
exists.
@return: If the named header is present, a sequence of its
values. Otherwise, C{default}.
"""
encodedName = self._encodeName(name)
values = self._rawHeaders.get(encodedName, [])
if not values:
return default
if isinstance(name, str):
return [v.decode("utf8") for v in values]
return values
def getAllRawHeaders(self) -> Iterator[Tuple[bytes, Sequence[bytes]]]:
"""
Return an iterator of key, value pairs of all headers contained in this
object, as L{bytes}. The keys are capitalized in canonical
capitalization.
"""
return iter(self._rawHeaders.items())
__all__ = ["Headers"]
|
