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 256 257 258 259 260 261 262
|
import unittest
from binascii import unhexlify
from collections import OrderedDict
from aioice import stun
from .utils import asynctest, read_message
class AttributeTest(unittest.TestCase):
def test_unpack_error_code(self) -> None:
data = unhexlify("00000457526f6c6520436f6e666c696374")
code, reason = stun.unpack_error_code(data)
self.assertEqual(code, 487)
self.assertEqual(reason, "Role Conflict")
def test_unpack_error_code_too_short(self) -> None:
data = unhexlify("000004")
with self.assertRaises(ValueError) as cm:
stun.unpack_error_code(data)
self.assertEqual(str(cm.exception), "STUN error code is less than 4 bytes")
def test_unpack_xor_address_ipv4(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
address, port = stun.unpack_xor_address(
unhexlify("0001a147e112a643"), transaction_id
)
self.assertEqual(address, "192.0.2.1")
self.assertEqual(port, 32853)
def test_unpack_xor_address_ipv4_too_long(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(
# Use 21 bytes for port + address, to check we don't try
# XOR'ing this data against the 20 bytes key.
unhexlify("0001a147e112a643000000000000000000000000000000"),
transaction_id,
)
self.assertEqual(str(cm.exception), "STUN address has invalid length for IPv4")
def test_unpack_xor_address_ipv4_too_short(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(unhexlify("0001a147e112a6"), transaction_id)
self.assertEqual(str(cm.exception), "STUN address has invalid length for IPv4")
def test_unpack_xor_address_ipv6(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
address, port = stun.unpack_xor_address(
unhexlify("0002a1470113a9faa5d3f179bc25f4b5bed2b9d9"), transaction_id
)
self.assertEqual(address, "2001:db8:1234:5678:11:2233:4455:6677")
self.assertEqual(port, 32853)
def test_unpack_xor_address_ipv6_too_long(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(
# Use 21 bytes for port + address, to check we don't try
# XOR'ing this data against the 20 bytes key.
unhexlify("0002a1470113a9faa5d3f179bc25f4b5bed2b900000000"),
transaction_id,
)
self.assertEqual(str(cm.exception), "STUN address has invalid length for IPv6")
def test_unpack_xor_address_ipv6_too_short(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(
unhexlify("0002a1470113a9faa5d3f179bc25f4b5bed2b9"), transaction_id
)
self.assertEqual(str(cm.exception), "STUN address has invalid length for IPv6")
def test_unpack_xor_address_too_short(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(unhexlify("0001"), transaction_id)
self.assertEqual(str(cm.exception), "STUN address length is less than 4 bytes")
def test_unpack_xor_address_unknown_protocol(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.unpack_xor_address(unhexlify("0003a147e112a643"), transaction_id)
self.assertEqual(str(cm.exception), "STUN address has unknown protocol")
def test_pack_error_code(self) -> None:
data = stun.pack_error_code((487, "Role Conflict"))
self.assertEqual(data, unhexlify("00000457526f6c6520436f6e666c696374"))
def test_pack_xor_address_ipv4(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
data = stun.pack_xor_address(("192.0.2.1", 32853), transaction_id)
self.assertEqual(data, unhexlify("0001a147e112a643"))
def test_pack_xor_address_ipv6(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
data = stun.pack_xor_address(
("2001:db8:1234:5678:11:2233:4455:6677", 32853), transaction_id
)
self.assertEqual(data, unhexlify("0002a1470113a9faa5d3f179bc25f4b5bed2b9d9"))
def test_pack_xor_address_unknown_protocol(self) -> None:
transaction_id = unhexlify("b7e7a701bc34d686fa87dfae")
with self.assertRaises(ValueError) as cm:
stun.pack_xor_address(("foo", 32853), transaction_id)
self.assertEqual(
str(cm.exception), "'foo' does not appear to be an IPv4 or IPv6 address"
)
class MessageTest(unittest.TestCase):
def test_binding_request(self) -> None:
data = read_message("binding_request.bin")
message = stun.parse_message(data)
self.assertEqual(message.message_method, stun.Method.BINDING)
self.assertEqual(message.message_class, stun.Class.REQUEST)
self.assertEqual(message.transaction_id, b"Nvfx3lU7FUBF")
self.assertEqual(message.attributes, OrderedDict())
self.assertEqual(bytes(message), data)
self.assertEqual(
repr(message),
"Message(message_method=Method.BINDING, message_class=Class.REQUEST, "
"transaction_id=b'Nvfx3lU7FUBF')",
)
def test_binding_request_ice_controlled(self) -> None:
data = read_message("binding_request_ice_controlled.bin")
message = stun.parse_message(data)
self.assertEqual(message.message_method, stun.Method.BINDING)
self.assertEqual(message.message_class, stun.Class.REQUEST)
self.assertEqual(message.transaction_id, b"wxaNbAdXjwG3")
self.assertEqual(
message.attributes,
OrderedDict(
[
("USERNAME", "AYeZ:sw7YvCSbcVex3bhi"),
("PRIORITY", 1685987071),
("SOFTWARE", "FreeSWITCH (-37-987c9b9 64bit)"),
("ICE-CONTROLLED", 5491930053772927353),
(
"MESSAGE-INTEGRITY",
unhexlify("1963108a4f764015a66b3fea0b1883dfde1436c8"),
),
("FINGERPRINT", 3230414530),
]
),
)
self.assertEqual(bytes(message), data)
def test_binding_request_ice_controlled_bad_fingerprint(self) -> None:
data = read_message("binding_request_ice_controlled.bin")[0:-1] + b"z"
with self.assertRaises(ValueError) as cm:
stun.parse_message(data)
self.assertEqual(str(cm.exception), "STUN message fingerprint does not match")
def test_binding_request_ice_controlled_bad_integrity(self) -> None:
data = read_message("binding_request_ice_controlled.bin")
with self.assertRaises(ValueError) as cm:
stun.parse_message(data, integrity_key=b"bogus-key")
self.assertEqual(str(cm.exception), "STUN message integrity does not match")
def test_binding_request_ice_controlling(self) -> None:
data = read_message("binding_request_ice_controlling.bin")
message = stun.parse_message(data)
self.assertEqual(message.message_method, stun.Method.BINDING)
self.assertEqual(message.message_class, stun.Class.REQUEST)
self.assertEqual(message.transaction_id, b"JEwwUxjLWaa2")
self.assertEqual(
message.attributes,
OrderedDict(
[
("USERNAME", "sw7YvCSbcVex3bhi:AYeZ"),
("ICE-CONTROLLING", 5943294521425135761),
("USE-CANDIDATE", None),
("PRIORITY", 1853759231),
(
"MESSAGE-INTEGRITY",
unhexlify("c87b58eccbacdbc075d497ad0c965a82937ab587"),
),
("FINGERPRINT", 1347006354),
]
),
)
def test_binding_response(self) -> None:
data = read_message("binding_response.bin")
message = stun.parse_message(data)
self.assertEqual(message.message_method, stun.Method.BINDING)
self.assertEqual(message.message_class, stun.Class.RESPONSE)
self.assertEqual(message.transaction_id, b"Nvfx3lU7FUBF")
self.assertEqual(
message.attributes,
OrderedDict(
[
("XOR-MAPPED-ADDRESS", ("80.200.136.90", 53054)),
("MAPPED-ADDRESS", ("80.200.136.90", 53054)),
("RESPONSE-ORIGIN", ("52.17.36.97", 3478)),
("OTHER-ADDRESS", ("52.17.36.97", 3479)),
("SOFTWARE", "Citrix-3.2.4.5 'Marshal West'"),
]
),
)
self.assertEqual(bytes(message), data)
def test_message_body_length_mismatch(self) -> None:
data = read_message("binding_response.bin") + b"123"
with self.assertRaises(ValueError) as cm:
stun.parse_message(data)
self.assertEqual(str(cm.exception), "STUN message length does not match")
def test_message_shorter_than_header(self) -> None:
with self.assertRaises(ValueError) as cm:
stun.parse_message(b"123")
self.assertEqual(str(cm.exception), "STUN message length is less than 20 bytes")
def test_message_with_unknown_method(self) -> None:
with self.assertRaises(ValueError) as cm:
stun.parse_message(bytes(20))
self.assertEqual(str(cm.exception), "0 is not a valid Method")
class TransactionTest(unittest.TestCase):
def setUp(self) -> None:
stun.RETRY_MAX = 0
stun.RETRY_RTO = 0
def tearDown(self) -> None:
stun.RETRY_MAX = 6
stun.RETRY_RTO = 0.5
@asynctest
async def test_timeout(self) -> None:
class DummyProtocol:
def send_stun(
self, message: stun.Message, address: tuple[str, int]
) -> None:
pass
request = stun.Message(
message_method=stun.Method.BINDING, message_class=stun.Class.REQUEST
)
transaction = stun.Transaction(request, ("127.0.0.1", 1234), DummyProtocol())
# timeout
with self.assertRaises(stun.TransactionTimeout):
await transaction.run()
# receive response after timeout
response = stun.Message(
message_method=stun.Method.BINDING, message_class=stun.Class.RESPONSE
)
transaction.response_received(response, ("127.0.0.1", 1234))
|