File: keytotpmodeltest.cpp

package info (click to toggle)
nitrokey-authenticator 1.2.4-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 728 kB
  • sloc: cpp: 2,883; xml: 43; makefile: 7
file content (276 lines) | stat: -rw-r--r-- 10,734 bytes parent folder | download
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
/*
 * BSD 2-Clause License
 *
 * Copyright (c) 2020, Agnieszka Cicha-Cisek
 * Copyright (c) 2020, Patryk Cisek
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include <chrono>
#include <memory>
#include <thread>

#include <QAbstractItemModelTester>
#include <QSignalSpy>
#include <QtTest/QtTest>

#include "authentication.h"
#include "common_mocks/authenticatedialogmock.h"
#include "common_mocks/nitrokeymock.h"
#include "common_mocks/newtotpslotdialogmock.h"
#include "keytotpmodel.h"
#include "nitrokeyprovider.h"
#include "totpuriparser.h"

class KeyTOTPModelTest : public QObject
{
    Q_OBJECT

    std::shared_ptr<NitrokeyMock> mockKey;
    std::shared_ptr<NitrokeyProvider> keyProvider;
    std::shared_ptr<NewTOTPSlotDialogMock> newTOTPSlotDialogMock;
    std::shared_ptr<AuthenticateDialogMock> adminAuthenticateDialog;
    std::shared_ptr<Authentication> adminAuthentication;
    std::shared_ptr<AuthenticateDialogMock> userAuthenticateDialog;
    std::shared_ptr<Authentication> userAuthentication;
    std::unique_ptr<KeyTOTPModel> model;
    std::unique_ptr<QAbstractItemModelTester> modelTester;

    std::vector<TOTPSlot> generateTestSlots()
    {
        return {
            { "slot1", 0 },
            { "slot2", 1 },
            { "slot3", 2 },
            { "slot4", 7 }
        };
    }

    const QString TEST_URI;
    const std::string TEST_SLOT_NAME;
    const std::string TEST_URI_SECRET;
    const QString ADMIN_PIN;

    void initAuthAndProvider()
    {
        constexpr int TIMEOUT_MSEC = 1000;
        keyProvider.reset(new NitrokeyProvider(mockKey));
        adminAuthenticateDialog.reset(new AuthenticateDialogMock(AuthenticateDialog::Type::ADMIN));
        adminAuthentication.reset(new Authentication(adminAuthenticateDialog, keyProvider, TIMEOUT_MSEC));
        userAuthenticateDialog.reset(new AuthenticateDialogMock(AuthenticateDialog::Type::USER));
        userAuthentication.reset(new Authentication(userAuthenticateDialog, keyProvider, TIMEOUT_MSEC));
        newTOTPSlotDialogMock.reset(new NewTOTPSlotDialogMock());
    }

public:
    KeyTOTPModelTest()
        : TEST_URI("otpauth://totp/LinkedIn:fsdu39d@protonmail.com?secret=ZQN4SYDIGT3B2WF4GHKJZINYAVLMF3IV&issuer=LinkedIn"),
          TEST_SLOT_NAME("randomName"),
          TEST_URI_SECRET("ZQN4SYDIGT3B2WF4GHKJZINYAVLMF3IV"),
          ADMIN_PIN("12345678") {}

private slots:
    void initTestCase()
    {
        ::testing::GTEST_FLAG(throw_on_failure) = true;
    }

    void init()
    {
        mockKey.reset(new NitrokeyMock());
        EXPECT_CALL(*mockKey, connect()).WillRepeatedly(::testing::Return(true));
    }

    void modelReadsSlotsOnCreation()
    {
        // Given
        EXPECT_CALL(*mockKey, getSlots())
                .WillRepeatedly(::testing::Return(generateTestSlots()));
        initAuthAndProvider();
        QSignalSpy spy(keyProvider.get(), SIGNAL(gotSlots(QList<TOTPSlot>)));

        // When
        model.reset(new KeyTOTPModel(keyProvider,
                                     adminAuthenticateDialog,
                                     adminAuthentication,
                                     userAuthenticateDialog,
                                     userAuthentication,
                                     newTOTPSlotDialogMock));
        modelTester.reset(new QAbstractItemModelTester(model.get()));

        // Then
        spy.wait(100);
        QTRY_VERIFY2(spy.count() > 0, "Key provider never emitted TOTP slots");
    }

    void modelReturnsProperNumberOrRows()
    {
        // Given
        const auto SLOTS = generateTestSlots();
        auto readSlotsAsync = [&SLOTS]()
        {
            std::this_thread::sleep_for(std::chrono::milliseconds(100));
            return SLOTS;
        };
        EXPECT_CALL(*mockKey, getSlots())
                .WillRepeatedly(::testing::Invoke(readSlotsAsync));
        initAuthAndProvider();

        // When
        model.reset(new KeyTOTPModel(keyProvider,
                                     adminAuthenticateDialog,
                                     adminAuthentication,
                                     userAuthenticateDialog,
                                     userAuthentication,
                                     newTOTPSlotDialogMock));
        modelTester.reset(new QAbstractItemModelTester(model.get()));

        // Then
        QTRY_COMPARE_WITH_TIMEOUT(static_cast<std::size_t>(model->rowCount()),
                                  SLOTS.size(),
                                  200);
    }

    void modelReturnsIconsAsData()
    {
        // Given
        const auto SLOTS = generateTestSlots();
        auto readSlotsAsync = [&SLOTS]()
        {
            std::this_thread::sleep_for(std::chrono::milliseconds(100));
            return SLOTS;
        };
        EXPECT_CALL(*mockKey, getSlots())
                .WillRepeatedly(::testing::Invoke(readSlotsAsync));
        initAuthAndProvider();

        // When
        model.reset(new KeyTOTPModel(keyProvider,
                                     adminAuthenticateDialog,
                                     adminAuthentication,
                                     userAuthenticateDialog,
                                     userAuthentication,
                                     newTOTPSlotDialogMock));
        modelTester.reset(new QAbstractItemModelTester(model.get()));

        // Then
        for (std::size_t idx = 0; idx < SLOTS.size(); ++idx)
        {
            QTRY_VERIFY2(model->data(model->index(idx), Qt::UserRole).canConvert<QIcon>(), "Returned data should be a QIcon instance");
            QTRY_VERIFY2(model->data(model->index(idx), Qt::DecorationRole).canConvert<QIcon>(), "Returned data should be a QIcon instance");
        }
    }

    void modelWritesNewEntryIntoCorrectSlot()
    {
        // Given
        const auto SLOTS = generateTestSlots();
        auto readSlotsAsync = [&SLOTS]()
        {
            std::this_thread::sleep_for(std::chrono::milliseconds(100));
            return SLOTS;
        };

        EXPECT_CALL(*mockKey, getSlots())
                .WillOnce(::testing::Invoke(readSlotsAsync))
                .WillOnce(::testing::Invoke(readSlotsAsync));
        initAuthAndProvider();
        EXPECT_CALL(*adminAuthenticateDialog, exec()).WillOnce(::testing::Return(QDialog::Accepted));
        EXPECT_CALL(*adminAuthenticateDialog, pin()).WillOnce(::testing::Return(QString(ADMIN_PIN)));
        EXPECT_CALL(*mockKey, firstAuth(
                        ::testing::Eq(ADMIN_PIN.toStdString()),
                        ::testing::_)).Times(1);
        EXPECT_CALL(*newTOTPSlotDialogMock, exec()).WillOnce(::testing::Return(QDialog::Accepted));
        EXPECT_CALL(*newTOTPSlotDialogMock, slotName()). WillOnce(::testing::Return(QString(TEST_SLOT_NAME.c_str())));

        model.reset(new KeyTOTPModel(keyProvider,
                                     adminAuthenticateDialog,
                                     adminAuthentication,
                                     userAuthenticateDialog,
                                     userAuthentication,
                                     newTOTPSlotDialogMock));
        modelTester.reset(new QAbstractItemModelTester(model.get()));

        auto parser = std::unique_ptr<TotpUriParser>(new TotpUriParser(TEST_URI));
        QSignalSpy spy(keyProvider.get(), &NitrokeyProvider::totpSlotWritten);

        // When
        model->addNewSlot(std::move(parser));

        // Then
        EXPECT_CALL(*mockKey, writeTotpSlot(
                        ::testing::Eq(3),
                        ::testing::Eq(TEST_SLOT_NAME),
                        ::testing::_,
                        ::testing::Eq(30),
                        ::testing::_))
                .Times(1);
        spy.wait();
    }

    void modelDoesNotWriteSlotIfCanceledInSlotNameDialog()
    {
        // Given
        const auto SLOTS = generateTestSlots();
        auto readSlotsAsync = [&SLOTS]()
        {
            std::this_thread::sleep_for(std::chrono::milliseconds(100));
            return SLOTS;
        };

        EXPECT_CALL(*mockKey, getSlots())
                .WillOnce(::testing::Invoke(readSlotsAsync));
        initAuthAndProvider();
        EXPECT_CALL(*newTOTPSlotDialogMock, exec()).WillOnce(::testing::Return(QDialog::Rejected));

        model.reset(new KeyTOTPModel(keyProvider,
                                     adminAuthenticateDialog,
                                     adminAuthentication,
                                     userAuthenticateDialog,
                                     userAuthentication,
                                     newTOTPSlotDialogMock));
        modelTester.reset(new QAbstractItemModelTester(model.get()));

        auto parser = std::unique_ptr<TotpUriParser>(new TotpUriParser(TEST_URI));
        QSignalSpy spy(keyProvider.get(), &NitrokeyProvider::totpSlotWritten);

        // When
        model->addNewSlot(std::move(parser));

        // Then
        EXPECT_CALL(*mockKey, writeTotpSlot(
                        ::testing::_,
                        ::testing::_,
                        ::testing::_,
                        ::testing::_,
                        ::testing::_))
                .Times(0);
        spy.wait(300);
        QTRY_VERIFY2(0 == spy.count(),
                     "When canceled in New TOTP Slot dialog, the slot should not have been saved.");
    }
};

QTEST_MAIN(KeyTOTPModelTest)
#include "keytotpmodeltest.moc"