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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
"""Pytest fixtures for SniTun."""
import asyncio
from collections.abc import AsyncGenerator, Generator
from dataclasses import dataclass, field
from datetime import UTC, datetime, timedelta
import logging
import os
import select
import socket
from threading import Thread
from unittest.mock import patch
import pytest
import snitun
from snitun.multiplexer.channel import MultiplexerChannel
from snitun.multiplexer.core import Multiplexer
from snitun.multiplexer.crypto import CryptoTransport
from snitun.server.listener_peer import PeerListener
from snitun.server.listener_sni import SNIProxy
from snitun.server.peer import Peer
from snitun.server.peer_manager import PeerManager
from snitun.utils.asyncio import asyncio_timeout
from .server.const_fernet import FERNET_TOKENS
logging.basicConfig(level=logging.DEBUG)
@pytest.fixture
def event_loop() -> Generator[asyncio.AbstractEventLoop, None, None]:
"""Create an instance of the default event loop for the test session.
Note: pytest-asyncio 1.x removed the event_loop fixture but we still need it
for testing sync functions. Otherwise we need to rewrite tons of tests.
It's restored here so we can do a gradual migration but keep the CI working.
All the async functions have been updated to use asyncio.get_running_loop().
"""
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
yield loop
loop.close()
@dataclass
class Client:
"""Represent a TCP client object."""
reader: asyncio.StreamReader
writer: asyncio.StreamWriter
close: asyncio.Event = field(default_factory=asyncio.Event)
@pytest.fixture
def raise_timeout() -> Generator[None, None, None]:
"""Raise timeout on async-timeout."""
with patch.object(asyncio_timeout, "timeout", side_effect=TimeoutError()):
yield
@pytest.fixture
async def test_server() -> AsyncGenerator[list[Client], None]:
"""Create a TCP test server."""
connections = []
async def process_data(
reader: asyncio.StreamReader,
writer: asyncio.StreamWriter,
) -> None:
"""Read data from client."""
client = Client(reader, writer)
connections.append(client)
await client.close.wait()
server = await asyncio.start_server(process_data, host="127.0.0.1", port="8866")
yield connections
server.close()
@pytest.fixture
async def test_endpoint() -> AsyncGenerator[list[Client], None]:
"""Create a TCP test endpoint."""
connections = []
async def process_data(
reader: asyncio.StreamReader,
writer: asyncio.StreamWriter,
) -> None:
"""Read data from client."""
client = Client(reader, writer)
connections.append(client)
await client.close.wait()
server = await asyncio.start_server(process_data, host="127.0.0.1", port="8822")
yield connections
server.close()
@pytest.fixture
async def test_client(test_server: list[Client]) -> AsyncGenerator[Client, None]:
"""Create a TCP test client."""
reader, writer = await asyncio.open_connection(host="127.0.0.1", port="8866")
yield Client(reader, writer)
writer.close()
@pytest.fixture
def test_server_sync(
event_loop: asyncio.AbstractEventLoop,
) -> Generator[list[socket.socket], None, None]:
"""Create a TCP test server."""
connections: list[socket.socket] = []
shutdown = False
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
sock.bind(("127.0.0.1", 8366))
sock.listen(2)
sock.setblocking(False)
def _incoming() -> None:
nonlocal shutdown
poller = select.epoll()
poller.register(sock, select.EPOLLIN)
while not shutdown:
events = poller.poll(0.1)
for _, _ in events:
connection, _ = sock.accept()
connections.append(connection)
poller.close()
runner = Thread(target=_incoming)
runner.start()
yield connections
shutdown = True
runner.join()
sock.close()
@pytest.fixture
def test_client_sync(
test_server_sync: list[socket.socket],
) -> Generator[socket.socket, None, None]:
"""Create a TCP test client."""
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 8366))
yield sock
sock.close()
@pytest.fixture
def test_client_ssl_sync(
test_server_sync: list[socket.socket],
) -> Generator[socket.socket, None, None]:
"""Create a TCP test client for SSL."""
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 8366))
yield sock
sock.close()
@pytest.fixture
async def multiplexer_server(
test_server: list[Client],
test_client: Client,
crypto_key_iv: tuple[bytes, bytes],
) -> AsyncGenerator[Multiplexer, None]:
"""Create a multiplexer client from server."""
client = test_server[0]
async def mock_new_channel(
multiplexer: Multiplexer,
channel: MultiplexerChannel,
) -> None:
"""Mock new channel."""
multiplexer = Multiplexer(
CryptoTransport(*crypto_key_iv),
client.reader,
client.writer,
snitun.PROTOCOL_VERSION,
mock_new_channel,
)
yield multiplexer
multiplexer.shutdown()
client.close.set()
@pytest.fixture
async def multiplexer_server_peer_protocol_0(
test_server: list[Client],
test_client: Client,
crypto_key_iv: tuple[bytes, bytes],
) -> AsyncGenerator[Multiplexer, None]:
"""Create a multiplexer client from server with the peer using protocol 0."""
client = test_server[0]
async def mock_new_channel(
multiplexer: Multiplexer,
channel: MultiplexerChannel,
) -> None:
"""Mock new channel."""
multiplexer = Multiplexer(
CryptoTransport(*crypto_key_iv),
client.reader,
client.writer,
0,
mock_new_channel,
)
yield multiplexer
multiplexer.shutdown()
client.close.set()
@pytest.fixture
async def multiplexer_client(
test_client: Client,
crypto_key_iv: tuple[bytes, bytes],
) -> AsyncGenerator[Multiplexer, None]:
"""Create a multiplexer client from server."""
async def mock_new_channel(
multiplexer: Multiplexer,
channel: MultiplexerChannel,
) -> None:
"""Mock new channel."""
multiplexer = Multiplexer(
CryptoTransport(*crypto_key_iv),
test_client.reader,
test_client.writer,
snitun.PROTOCOL_VERSION,
mock_new_channel,
)
yield multiplexer
multiplexer.shutdown()
@pytest.fixture
async def peer_manager(multiplexer_server: Multiplexer, peer: Peer) -> PeerManager:
"""Create a localhost peer for tests."""
manager = PeerManager(FERNET_TOKENS)
manager._peers[peer.hostname] = peer
return manager
@pytest.fixture
async def sni_proxy(peer_manager: PeerManager) -> AsyncGenerator[SNIProxy, None]:
"""Create a SNI Proxy."""
proxy = SNIProxy(peer_manager, "127.0.0.1", "8863")
await proxy.start()
yield proxy
await proxy.stop()
@pytest.fixture
async def test_client_ssl(sni_proxy: SNIProxy) -> AsyncGenerator[Client, None]:
"""Create a TCP test client."""
reader, writer = await asyncio.open_connection(host="127.0.0.1", port="8863")
yield Client(reader, writer)
writer.close()
@pytest.fixture
def crypto_key_iv() -> tuple[bytes, bytes]:
"""Create a key and iv."""
key = os.urandom(32)
iv = os.urandom(16)
return key, iv
@pytest.fixture
async def peer(
crypto_key_iv: tuple[bytes, bytes],
multiplexer_server: Multiplexer,
) -> Peer:
"""Init a peer with transport."""
valid = datetime.now(tz=UTC) + timedelta(days=1)
peer = Peer(
"localhost",
valid,
os.urandom(32),
os.urandom(16),
snitun.PROTOCOL_VERSION,
)
peer._crypto = CryptoTransport(*crypto_key_iv)
peer._multiplexer = multiplexer_server
return peer
@pytest.fixture
async def peer_listener(
peer_manager: PeerManager,
peer: Peer,
) -> AsyncGenerator[PeerListener, None]:
"""Create a Peer listener."""
listener = PeerListener(peer_manager, "127.0.0.1", "8893")
await listener.start()
# Cleanup mock peer
peer_manager.remove_peer(peer)
yield listener
await listener.stop()
@pytest.fixture
async def test_client_peer(peer_listener: PeerListener) -> AsyncGenerator[Client, None]:
"""Create a TCP test client."""
reader, writer = await asyncio.open_connection(host="127.0.0.1", port="8893")
yield Client(reader, writer)
writer.close()
|
