summaryrefslogtreecommitdiffstats
blob: 9690c093f3324f5e9f8a0dc796c53d31a571442a (plain)
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
/*
 * Copyright (c) 2011 Tobias Markmann
 * Licensed under the simplified BSD license.
 * See Documentation/Licenses/BSD-simplified.txt for more information.
 */

/*
 * Copyright (c) 2015-2016 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#include <boost/bind.hpp>
#include <boost/random/mersenne_twister.hpp>
#include <boost/random/uniform_int.hpp>
#include <boost/random/variate_generator.hpp>
#include <boost/smart_ptr/make_shared.hpp>

#include <QA/Checker/IO.h>

#include <cppunit/extensions/HelperMacros.h>
#include <cppunit/extensions/TestFactoryRegistry.h>

#include <Swiften/Base/Algorithm.h>
#include <Swiften/Base/ByteArray.h>
#include <Swiften/Base/Concat.h>
#include <Swiften/Base/Log.h>
#include <Swiften/Base/StartStopper.h>
#include <Swiften/Crypto/CryptoProvider.h>
#include <Swiften/Crypto/PlatformCryptoProvider.h>
#include <Swiften/EventLoop/DummyEventLoop.h>
#include <Swiften/FileTransfer/ByteArrayReadBytestream.h>
#include <Swiften/FileTransfer/ByteArrayWriteBytestream.h>
#include <Swiften/FileTransfer/SOCKS5BytestreamClientSession.h>
#include <Swiften/FileTransfer/SOCKS5BytestreamRegistry.h>
#include <Swiften/JID/JID.h>
#include <Swiften/Network/DummyConnection.h>
#include <Swiften/Network/DummyTimerFactory.h>
#include <Swiften/StringCodecs/Hexify.h>

using namespace Swift;

static boost::mt19937 randomGen;

class SOCKS5BytestreamClientSessionTest : public CppUnit::TestFixture {
    CPPUNIT_TEST_SUITE(SOCKS5BytestreamClientSessionTest);
    CPPUNIT_TEST(testForSessionReady);
    CPPUNIT_TEST(testErrorHandlingHello);
    CPPUNIT_TEST(testErrorHandlingRequest);
    CPPUNIT_TEST(testWriteBytestream);
    CPPUNIT_TEST(testReadBytestream);
    CPPUNIT_TEST_SUITE_END();

public:
    SOCKS5BytestreamClientSessionTest() : destinationAddressPort(HostAddressPort(HostAddress("127.0.0.1"), 8888)) {}

    void setUp() {
        crypto = boost::shared_ptr<CryptoProvider>(PlatformCryptoProvider::create());
        destination = "092a44d859d19c9eed676b551ee80025903351c2";
        randomGen.seed(static_cast<unsigned int>(time(nullptr)));
        eventLoop = new DummyEventLoop();
        timerFactory = new DummyTimerFactory();
        connection = boost::make_shared<MockeryConnection>(failingPorts, true, eventLoop);
        //connection->onDataSent.connect(boost::bind(&SOCKS5BytestreamServerSessionTest::handleDataWritten, this, _1));
        //stream1 = boost::make_shared<ByteArrayReadBytestream>(createByteArray("abcdefg")));
//        connection->onDataRead.connect(boost::bind(&SOCKS5BytestreamClientSessionTest::handleDataRead, this, _1));
    }

    void tearDown() {
        //connection.reset();
        delete timerFactory;
        delete eventLoop;
    }

    void testForSessionReady() {
        TestHelper helper;
        connection->onDataSent.connect(boost::bind(&TestHelper::handleConnectionDataWritten, &helper, _1));

        SOCKS5BytestreamClientSession::ref clientSession = boost::make_shared<SOCKS5BytestreamClientSession>(connection, destinationAddressPort, destination, timerFactory);
        clientSession->onSessionReady.connect(boost::bind(&TestHelper::handleSessionReady, &helper, _1));

        clientSession->start();
        eventLoop->processEvents();
        CPPUNIT_ASSERT(createByteArray("\x05\x01\x00", 3) == helper.unprocessedInput);

        helper.unprocessedInput.clear();
        serverRespondHelloOK();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x05\x01\x00\x03", 4), createByteArray(&helper.unprocessedInput[0], 4));
        CPPUNIT_ASSERT_EQUAL(createByteArray(static_cast<char>(destination.size())), createByteArray(static_cast<char>(helper.unprocessedInput[4])));
        CPPUNIT_ASSERT_EQUAL(createByteArray(destination), createByteArray(&helper.unprocessedInput[5], destination.size()));
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x00", 1), createByteArray(&helper.unprocessedInput[5 + destination.size()], 1));

        helper.unprocessedInput.clear();
        serverRespondRequestOK();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyCalled);
        CPPUNIT_ASSERT_EQUAL(false, helper.sessionReadyError);
    }

    void testErrorHandlingHello() {
        TestHelper helper;
        connection->onDataSent.connect(boost::bind(&TestHelper::handleConnectionDataWritten, &helper, _1));

        SOCKS5BytestreamClientSession::ref clientSession = boost::make_shared<SOCKS5BytestreamClientSession>(connection, destinationAddressPort, destination, timerFactory);
        clientSession->onSessionReady.connect(boost::bind(&TestHelper::handleSessionReady, &helper, _1));

        clientSession->start();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x05\x01\x00", 3), helper.unprocessedInput);

        helper.unprocessedInput.clear();
        serverRespondHelloAuthFail();
        eventLoop->processEvents();

        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyCalled);
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyError);
        CPPUNIT_ASSERT_EQUAL(true, connection->disconnectCalled);
    }

    void testErrorHandlingRequest() {
        TestHelper helper;
        connection->onDataSent.connect(boost::bind(&TestHelper::handleConnectionDataWritten, &helper, _1));

        SOCKS5BytestreamClientSession::ref clientSession = boost::make_shared<SOCKS5BytestreamClientSession>(connection, destinationAddressPort, destination, timerFactory);
        clientSession->onSessionReady.connect(boost::bind(&TestHelper::handleSessionReady, &helper, _1));

        clientSession->start();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x05\x01\x00", 3), helper.unprocessedInput);

        helper.unprocessedInput.clear();
        serverRespondHelloOK();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x05\x01\x00\x03", 4), createByteArray(&helper.unprocessedInput[0], 4));
        CPPUNIT_ASSERT_EQUAL(createByteArray(static_cast<char>(destination.size())), createByteArray(static_cast<char>(helper.unprocessedInput[4])));
        CPPUNIT_ASSERT_EQUAL(createByteArray(destination), createByteArray(&helper.unprocessedInput[5], destination.size()));
        CPPUNIT_ASSERT_EQUAL(createByteArray("\x00", 1), createByteArray(&helper.unprocessedInput[5 + destination.size()], 1));

        helper.unprocessedInput.clear();
        serverRespondRequestFail();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyCalled);
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyError);
        CPPUNIT_ASSERT_EQUAL(true, connection->disconnectCalled);
    }

    void testWriteBytestream() {
        TestHelper helper;
        connection->onDataSent.connect(boost::bind(&TestHelper::handleConnectionDataWritten, &helper, _1));

        SOCKS5BytestreamClientSession::ref clientSession = boost::make_shared<SOCKS5BytestreamClientSession>(connection, destinationAddressPort, destination, timerFactory);
        clientSession->onSessionReady.connect(boost::bind(&TestHelper::handleSessionReady, &helper, _1));

        clientSession->start();
        eventLoop->processEvents();

        helper.unprocessedInput.clear();
        serverRespondHelloOK();
        eventLoop->processEvents();

        helper.unprocessedInput.clear();
        serverRespondRequestOK();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyCalled);
        CPPUNIT_ASSERT_EQUAL(false, helper.sessionReadyError);

        boost::shared_ptr<ByteArrayWriteBytestream> output = boost::make_shared<ByteArrayWriteBytestream>();
        clientSession->startReceiving(output);

        ByteArray transferData = generateRandomByteArray(1024);
        connection->onDataRead(createSafeByteArrayRef(vecptr(transferData), transferData.size()));
        CPPUNIT_ASSERT_EQUAL(transferData, output->getData());
    }

    void testReadBytestream() {
        TestHelper helper;
        connection->onDataSent.connect(boost::bind(&TestHelper::handleConnectionDataWritten, &helper, _1));

        SOCKS5BytestreamClientSession::ref clientSession = boost::make_shared<SOCKS5BytestreamClientSession>(connection, destinationAddressPort, destination, timerFactory);
        clientSession->onSessionReady.connect(boost::bind(&TestHelper::handleSessionReady, &helper, _1));

        clientSession->start();
        eventLoop->processEvents();

        helper.unprocessedInput.clear();
        serverRespondHelloOK();
        eventLoop->processEvents();

        helper.unprocessedInput.clear();
        serverRespondRequestOK();
        eventLoop->processEvents();
        CPPUNIT_ASSERT_EQUAL(true, helper.sessionReadyCalled);
        CPPUNIT_ASSERT_EQUAL(false, helper.sessionReadyError);

        helper.unprocessedInput.clear();
        ByteArray transferData = generateRandomByteArray(1024);
        boost::shared_ptr<ByteArrayReadBytestream> input = boost::make_shared<ByteArrayReadBytestream>(transferData);
        clientSession->startSending(input);
        eventLoop->processEvents();

        CPPUNIT_ASSERT_EQUAL(createByteArray(vecptr(transferData), transferData.size()), helper.unprocessedInput);
    }



private:
    static ByteArray generateRandomByteArray(size_t len) {
        boost::uniform_int<> dist(0, 255);
        boost::variate_generator<boost::mt19937&, boost::uniform_int<> > randomByte(randomGen, dist);
        ByteArray result(len);
        for (size_t i=0; i < len; ++i ) {
            result[i] = static_cast<unsigned char>(randomByte());
        }
        return result;
    }

    // Server responses
    void serverRespondHelloOK() {
        connection->onDataRead(createSafeByteArrayRef("\x05\00", 2));
    }

    void serverRespondHelloAuthFail() {
        connection->onDataRead(createSafeByteArrayRef("\x05\xFF", 2));
    }

    void serverRespondRequestOK() {
        boost::shared_ptr<SafeByteArray> dataToSend = createSafeByteArrayRef("\x05\x00\x00\x03", 4);
        append(*dataToSend, createSafeByteArray(static_cast<char>(destination.size())));
        append(*dataToSend, createSafeByteArray(destination));
        append(*dataToSend, createSafeByteArray("\x00", 1));
        connection->onDataRead(dataToSend);
    }

    void serverRespondRequestFail() {
        boost::shared_ptr<SafeByteArray> correctData = createSafeByteArrayRef("\x05\x00\x00\x03", 4);
        append(*correctData, createSafeByteArray(static_cast<char>(destination.size())));
        append(*correctData, createSafeByteArray(destination));
        append(*correctData, createSafeByteArray("\x00", 1));

        boost::shared_ptr<SafeByteArray> dataToSend;
        //ByteArray failingData = Hexify::unhexify("8417947d1d305c72c11520ea7d2c6e787396705e72c312c6ccc3f66613d7cae1b91b7ab48e8b59a17d559c15fb51");
        //append(dataToSend, failingData);
        //SWIFT_LOG(debug) << "hexed: " << Hexify::hexify(failingData) << std::endl;
        do {
            ByteArray rndArray = generateRandomByteArray(correctData->size());
            dataToSend = createSafeByteArrayRef(vecptr(rndArray), rndArray.size());
        } while (*dataToSend == *correctData);
        connection->onDataRead(dataToSend);
    }

private:
    struct TestHelper {
        TestHelper() : sessionReadyCalled(false), sessionReadyError(false) {}
        ByteArray unprocessedInput;
        bool sessionReadyCalled;
        bool sessionReadyError;

        void handleConnectionDataWritten(const SafeByteArray& data) {
            append(unprocessedInput, data);
            //SWIFT_LOG(debug) << "unprocessedInput (" << unprocessedInput.size() <<  "): " << Hexify::hexify(unprocessedInput) << std::endl;
        }

        void handleSessionReady(bool error) {
            sessionReadyCalled = true;
            sessionReadyError = error;
        }
    };


private:
    struct MockeryConnection : public Connection, public EventOwner, public boost::enable_shared_from_this<MockeryConnection> {
        public:
        MockeryConnection(const std::vector<HostAddressPort>& failingPorts, bool isResponsive, EventLoop* eventLoop) : eventLoop(eventLoop), failingPorts(failingPorts), isResponsive(isResponsive), disconnectCalled(false) {}

            void listen() { assert(false); }
            void connect(const HostAddressPort& address) {
                hostAddressPort = address;
                if (isResponsive) {
                    bool fail = std::find(failingPorts.begin(), failingPorts.end(), address) != failingPorts.end();
                    eventLoop->postEvent(boost::bind(boost::ref(onConnectFinished), fail));
                }
            }

            HostAddressPort getLocalAddress() const { return HostAddressPort(); }

            HostAddressPort getRemoteAddress() const { return HostAddressPort(); }

            void disconnect() {
                disconnectCalled = true;
            }

            void write(const SafeByteArray& data) {
                eventLoop->postEvent(boost::ref(onDataWritten), shared_from_this());
                onDataSent(data);
            }

            boost::signal<void (const SafeByteArray&)> onDataSent;

            EventLoop* eventLoop;
            boost::optional<HostAddressPort> hostAddressPort;
            std::vector<HostAddressPort> failingPorts;
            bool isResponsive;
            bool disconnectCalled;
    };

private:
    HostAddressPort destinationAddressPort;
    std::string destination;
    DummyEventLoop* eventLoop;
    DummyTimerFactory* timerFactory;
    boost::shared_ptr<MockeryConnection> connection;
    const std::vector<HostAddressPort> failingPorts;
    boost::shared_ptr<CryptoProvider> crypto;
};

CPPUNIT_TEST_SUITE_REGISTRATION(SOCKS5BytestreamClientSessionTest);