aboutsummaryrefslogtreecommitdiff
path: root/test/storage/VaultTest.mc
blob: b0895962829d9ff50d26527bf0967a81248c9366 (plain) (blame)
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
// Author:  cirakg & claude ai
// Summary: Tests for the vault: add/open/update/move/remove, persistence, locked and pending entries, quotas, store full.

import Toybox.Lang;
import Toybox.Test;

(:test)
function vaultRoundTripsAndPersists(logger as Test.Logger) as Boolean {
    var store = new MemoryBackend();
    var time = new FakeTime();
    var vault = new Vault(store, time);
    var originals = [StorageFixtures.totp("A"), StorageFixtures.hotp("B", 3l), StorageFixtures.steam("C"), StorageFixtures.code("D")];
    for (var i = 0; i < originals.size(); i++) {
        vault.add(originals[i] as Entry);
    }
    // A new Vault on the same store is what the next app start sees.
    var reopened = new Vault(store, time);
    var ids = reopened.ids();
    if (ids.size() != 4) {
        logger.error("expected 4 ids, got " + ids.size());
        return false;
    }
    for (var i = 0; i < ids.size(); i++) {
        var expected = originals[i] as Entry;
        if (!ids[i].equals(expected.id) || !Entry.isValidId(ids[i])) {
            logger.error("order or id wrong at " + i);
            return false;
        }
        var opened = reopened.open(ids[i]);
        var same = StorageFixtures.same(logger, opened, expected);
        opened.wipeSecrets();
        var header = reopened.header(ids[i]);
        if (!same || header == null || !header.name.equals(expected.name) || header.secret != null) {
            return false;
        }
    }
    return true;
}

(:test)
function vaultUpdatesMovesAndRemoves(logger as Test.Logger) as Boolean {
    var vault = new Vault(new MemoryBackend(), new FakeTime());
    var a = vault.add(StorageFixtures.totp("A"));
    var b = vault.add(StorageFixtures.totp("B"));
    var c = vault.add(StorageFixtures.hotp("C", 0l));
    vault.move(c, 0);
    vault.move(a, 99);
    var order = vault.ids();
    if (!order[0].equals(c) || !order[1].equals(b) || !order[2].equals(a)) {
        logger.error("move gave " + order.toString());
        return false;
    }
    var e = vault.open(b);
    e.name = "B renamed";
    vault.update(e);
    e.wipeSecrets();
    vault.setCounter(c, 42l);
    vault.remove(a);
    var header = vault.header(b);
    var hotp = vault.open(c);
    var counter = hotp.counter;
    hotp.wipeSecrets();
    var notFound = 0;
    try {
        vault.open(a);
    } catch (err instanceof VaultError) {
        notFound = err.code;
    }
    return header != null && header.name.equals("B renamed") && counter == 42l
        && vault.ids().size() == 2 && notFound == VaultError.NOT_FOUND;
}

(:test)
function vaultRejectsInvalidEntries(logger as Test.Logger) as Boolean {
    var vault = new Vault(new MemoryBackend(), new FakeTime());
    var e = StorageFixtures.totp("bad");
    e.digits = 4;
    var code = 0;
    try {
        vault.add(e);
    } catch (err instanceof VaultError) {
        code = err.code;
    }
    return code == VaultError.INVALID && vault.ids().size() == 0;
}

// A damaged record shows as null from header(), DAMAGED from open(), and
// can still be deleted.
(:test)
function vaultReportsDamagedRecords(logger as Test.Logger) as Boolean {
    var store = new MemoryBackend();
    var vault = new Vault(store, new FakeTime());
    var id = vault.add(StorageFixtures.totp("A"));
    var record = store.raw("e." + id) as ByteArray;
    record[record.size() - 1] = record[record.size() - 1] ^ 0x80;
    var code = 0;
    try {
        vault.open(id);
    } catch (err instanceof VaultError) {
        code = err.code;
    }
    // The header itself is intact, so the list can still show the name.
    var headerStillReadable = vault.header(id) != null;
    store.setValue("e." + id, "not a record");
    var headerGone = vault.header(id) == null;
    vault.remove(id);
    return code == VaultError.DAMAGED && headerStillReadable && headerGone && vault.ids().size() == 0;
}

// Swapping two records' storage keys must not make either open.
(:test)
function vaultDetectsSwappedRecords(logger as Test.Logger) as Boolean {
    var store = new MemoryBackend();
    var vault = new Vault(store, new FakeTime());
    var a = vault.add(StorageFixtures.totp("A"));
    var b = vault.add(StorageFixtures.totp("B"));
    var recordA = store.getValue("e." + a);
    store.setValue("e." + a, store.getValue("e." + b));
    store.setValue("e." + b, recordA);
    var damaged = 0;
    var ids = [a, b];
    for (var i = 0; i < ids.size(); i++) {
        try {
            vault.open(ids[i]);
        } catch (err instanceof VaultError) {
            if (err.code == VaultError.DAMAGED) {
                damaged++;
            }
        }
    }
    return damaged == 2;
}

(:test)
function vaultLockedEntriesNeedTheSession(logger as Test.Logger) as Boolean {
    var store = new MemoryBackend();
    var vault = new Vault(store, new FakeTime());
    StorageFixtures.setPin(vault, StorageFixtures.PIN);
    var e = StorageFixtures.totp("Locked");
    e.locked = true;
    var id = vault.add(e);
    var record = store.raw("e." + id) as ByteArray;
    if (Record.keyRef(record) != Record.KEY_MASTER) {
        logger.error("locked entry not sealed with the master key");
        return false;
    }
    vault.lock();
    var codes = [] as Array<Number>;
    try { vault.open(id); } catch (err instanceof VaultError) { codes.add(err.code); }
    try { vault.remove(id); } catch (err instanceof VaultError) { codes.add(err.code); }
    try { vault.setCounter(id, 1l); } catch (err instanceof VaultError) { codes.add(err.code); }
    var header = vault.header(id);
    if (codes.size() != 3 || codes[0] != VaultError.LOCKED || codes[1] != VaultError.LOCKED || header == null || !header.locked) {
        logger.error("locked entry accessible while locked: " + codes.toString());
        return false;
    }
    if (!StorageFixtures.unlock(vault, StorageFixtures.PIN)) {
        logger.error("unlock failed");
        return false;
    }
    var opened = vault.open(id);
    var ok = StorageFixtures.same(logger, opened, e);
    opened.wipeSecrets();
    return ok;
}

(:test)
function vaultQueuesLockedEntriesWhileLocked(logger as Test.Logger) as Boolean {
    var store = new MemoryBackend();
    var vault = new Vault(store, new FakeTime());
    // Before any PIN exists.
    var first = StorageFixtures.totp("Pending 1");
    first.locked = true;
    var id1 = vault.add(first);
    StorageFixtures.setPin(vault, StorageFixtures.PIN);
    vault.lock();
    // While locked.
    var second = StorageFixtures.code("Pending 2");
    second.locked = true;
    var id2 = vault.add(second);
    if (vault.ids().size() != 0 || vault.pendingIds().size() != 2 || store.getValue("p." + id1) == null) {
        logger.error("pending entries not queued");
        return false;
    }
    if (!StorageFixtures.unlock(vault, StorageFixtures.PIN) || vault.promotePending() != 2) {
        logger.error("promotion failed");
        return false;
    }
    var ids = vault.ids();
    var record = store.raw("e." + id2) as ByteArray;
    var opened = vault.open(id1);
    var ok = StorageFixtures.same(logger, opened, first);
    opened.wipeSecrets();
    return ok && ids.size() == 2 && vault.pendingIds().size() == 0 && store.getValue("p." + id1) == null
        && store.getValue("p." + id2) == null && Record.keyRef(record) == Record.KEY_MASTER;
}

(:test)
function vaultEnforcesTheEntryCap(logger as Test.Logger) as Boolean {
    var vault = new Vault(new MemoryBackend(), new FakeTime());
    for (var i = 0; i < Vault.MAX_ENTRIES; i++) {
        vault.add(StorageFixtures.totp("E" + i));
    }
    var code = 0;
    try {
        vault.add(StorageFixtures.totp("one too many"));
    } catch (err instanceof VaultError) {
        code = err.code;
    }
    return code == VaultError.LIMIT && vault.ids().size() == Vault.MAX_ENTRIES;
}

// A full store gives VaultError FULL and leaves no half-added entry behind,
// whether the record write or the metadata write is the one that fails.
(:test)
function vaultHandlesAFullStore(logger as Test.Logger) as Boolean {
    var sawFull = false;
    var sawSuccess = false;
    for (var extra = 0; extra < 600; extra += 9) {
        var store = new MemoryBackend();
        var vault = new Vault(store, new FakeTime());
        vault.add(StorageFixtures.totp("fits"));
        store.capacity = store.usedBytes() + extra;
        var expected = 2;
        try {
            vault.add(StorageFixtures.totp("more"));
            sawSuccess = true;
        } catch (err instanceof VaultError) {
            if (err.code != VaultError.FULL) {
                logger.error("unexpected error " + err.code);
                return false;
            }
            sawFull = true;
            expected = 1;
        }
        var reopened = new Vault(store, new FakeTime());
        var keys = store.keys();
        var records = 0;
        for (var i = 0; i < keys.size(); i++) {
            if (keys[i].find("e.") == 0) {
                records++;
            }
        }
        if (reopened.ids().size() != expected || records != expected) {
            logger.error("inconsistent store at extra=" + extra + ": ids " + reopened.ids().size() + ", records " + records);
            return false;
        }
    }
    return sawFull && sawSuccess;
}