-
Notifications
You must be signed in to change notification settings - Fork 55
/
07-backup.pl
525 lines (382 loc) · 14.6 KB
/
07-backup.pl
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use Future::Utils qw( repeat );
my $fixture = local_user_fixture();
test "Can create backup version",
requires => [ $fixture ],
proves => [qw( can_create_backup_version )],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
log_if_fail "Create backup: ", $content;
assert_json_keys( $content, "version" );
$version = $content->{version};
matrix_get_key_backup_info( $user );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get backup info: ", $content;
assert_json_keys( $content, "algorithm" );
assert_json_keys( $content, "auth_data" );
$content->{algorithm} eq "m.megolm_backup.v1" or
die "Expected algorithm to match submitted data";
$content->{auth_data} eq "anopaquestring" or
die "Expected auth_data to match submitted data";
assert_eq( $content->{version}, $version );
Future->done(1);
});
};
test "Can update backup version",
requires => [ $fixture ],
proves => [qw( can_create_backup_version )],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
log_if_fail "Create backup: ", $content;
assert_json_keys( $content, "version" );
$version = $content->{version};
do_request_json_for(
$user,
method => "PUT",
uri => "/unstable/room_keys/version/$version",
content => {
algorithm => "m.megolm_backup.v1",
auth_data => "adifferentopaquestring",
version => $version
}
);
})->then( sub {
matrix_get_key_backup_info( $user, $version );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get backup info: ", $content;
assert_json_keys( $content, "algorithm" );
assert_json_keys( $content, "auth_data" );
$content->{algorithm} eq "m.megolm_backup.v1" or
die "Expected algorithm to match submitted data";
$content->{auth_data} eq "adifferentopaquestring" or
die "Expected auth_data to match submitted data";
assert_eq( $content->{version}, $version );
Future->done(1);
});
};
test "Responds correctly when backup is empty",
requires => [ $fixture, qw( can_create_backup_version ) ],
do => sub {
my ( $user ) = @_;
my $version;
matrix_get_key_backup_info( $user )->then( sub {
my ( $content ) = @_;
log_if_fail "Get backup info: ", $content;
$version = $content->{version};
# check that asking for a specific session that does not exist returns
# an M_NOT_FOUND
matrix_get_backup_key( $user, $version, '!notaroom', 'notassession' );
})->main::expect_m_not_found
->then( sub {
# check that asking for all the keys in a room returns an empty
# response rather than an error when nothing has been backed up yet
matrix_get_backup_key( $user, $version, '!notaroom' );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get keys from room: ", $content;
assert_deeply_eq( $content, { "sessions" => {} } );
# check that asking for all the keys returns an empty response rather
# than an error when nothing has been backed up yet
matrix_get_backup_key( $user, $version );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get all keys: ", $content;
assert_deeply_eq( $content, { "rooms" => {} } );
# check that asking for a nonexistent backup version returns an
# M_NOT_FOUND
matrix_get_backup_key( $user, 'bogusversion' );
})->main::expect_m_not_found;
};
test "Can backup keys",
requires => [ $fixture, qw( can_create_backup_version ) ],
proves => [qw( can_backup_e2e_keys )],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
$version = $content->{version};
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 3,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anopaquestring",
},
);
})->then( sub {
my ( $content ) = @_;
log_if_fail "Back up session: ", $content;
matrix_get_backup_key( $user, $version, '!abcd', '1234' );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get session backup: ", $content;
assert_json_keys( $content, qw( first_message_index forwarded_count is_verified session_data ) );
assert_eq( $content->{first_message_index}, 3, "Expected first message index to match submitted data" );
assert_eq( $content->{forwarded_count}, 0, "Expected forwarded count to match submitted data" );
assert_eq( $content->{is_verified}, JSON::false, "Expected is_verified to match submitted data" );
assert_eq( $content->{session_data}, "anopaquestring", "Expected session data to match submitted data" );
Future->done(1);
});
};
test "Can update keys with better versions",
requires => [ $fixture, qw( can_backup_e2e_keys ) ],
proves => [qw( can_update_e2e_keys )],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
$version = $content->{version};
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 2,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anotheropaquestring",
},
);
})->then( sub {
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 1,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anotheropaquestring",
},
);
})->then( sub {
my ( $content ) = @_;
log_if_fail "Back up session: ", $content;
matrix_get_backup_key( $user, $version, '!abcd', '1234' );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get session backup: ", $content;
assert_json_keys( $content, qw( first_message_index forwarded_count is_verified session_data ) );
assert_eq( $content->{first_message_index}, 1, "Expected first message index to match submitted data" );
assert_eq( $content->{forwarded_count}, 0, "Expected forwarded count to match submitted data" );
assert_eq( $content->{is_verified}, JSON::false, "Expected is_verified to match submitted data" );
assert_eq( $content->{session_data}, "anotheropaquestring", "Expected session data to match submitted data" );
Future->done(1);
});
};
test "Will not update keys with worse versions",
requires => [ $fixture, qw( can_update_e2e_keys ) ],
proves => [qw( wont_update_e2e_keys )],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
$version = $content->{version};
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 2,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anotheropaquestring",
},
);
})->then( sub {
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 3,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anotheropaquestring",
},
);
})->then( sub {
my ( $content ) = @_;
log_if_fail "Back up session: ", $content;
matrix_get_backup_key( $user, $version, '!abcd', '1234' );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get session backup: ", $content;
assert_json_keys( $content, qw( first_message_index forwarded_count is_verified session_data ) );
# The data should not be overwritten, so should be the same as what
# was set by the previous test.
assert_eq( $content->{first_message_index}, 2, "Expected first message index to match submitted data" );
assert_eq( $content->{forwarded_count}, 0, "Expected forwarded count to match submitted data" );
assert_eq( $content->{is_verified}, JSON::false, "Expected is_verified to match submitted data" );
assert_eq( $content->{session_data}, "anotheropaquestring", "Expected session data to match submitted data" );
Future->done(1);
});
};
test "Will not back up to an old backup version",
requires => [ $fixture, qw( can_create_backup_version ) ],
proves => [qw( wont_backup_to_old_version )],
do => sub {
my ( $user ) = @_;
my $old_version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
$old_version = $content->{version};
matrix_create_key_backup( $user );
})->then( sub {
matrix_backup_keys( $user, '!abcd', '1234', $old_version, {
first_message_index => 3,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "anotheropaquestring",
},
);
})->main::expect_http_4xx
->then_done(1);
};
test "Can delete backup",
requires => [ $fixture, qw( can_create_backup_version ) ],
do => sub {
my ( $user ) = @_;
my $first_version;
my $second_version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
$first_version = $content->{version};
matrix_create_key_backup( $user );
})->then( sub {
my ( $content ) = @_;
$second_version = $content->{version};
matrix_delete_key_backup( $user, $second_version );
})->then( sub {
matrix_get_key_backup_info( $user );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Get backup: ", $content;
my $new_version = $content->{version};
assert_eq( $new_version, $first_version );
matrix_get_key_backup_info ( $user, $second_version );
})->main::expect_http_404;
};
test "Deleted & recreated backups are empty",
requires => [ $fixture, qw( can_create_backup_version ) ],
do => sub {
my ( $user ) = @_;
my $version;
matrix_create_key_backup( $user )->then( sub {
my ( $content ) = @_;
log_if_fail "Create backup: ", $content;
assert_json_keys( $content, "version" );
$version = $content->{version};
log_if_fail "Created version $version";
matrix_backup_keys( $user, '!abcd', '1234', $version, {
first_message_index => 3,
forwarded_count => 0,
is_verified => JSON::false,
session_data => "areallyopaquestring",
},
);
})->then( sub {
log_if_fail "Deleting version $version";
matrix_delete_key_backup( $user, $version );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Delete backup: ", $content;
matrix_create_key_backup( $user );
})->then( sub {
my ( $content ) = @_;
log_if_fail "Created version $content->{version}";
# get all keys
do_request_json_for( $user,
method => "GET",
uri => "/unstable/room_keys/keys",
params => {
version => $content->{version},
}
);
})->then( sub {
my ( $content ) = @_;
assert_deeply_eq($content, {"rooms" => {}}, "Expected new backup to be empty");
Future->done(1);
});
};
# regression test for https://github.com/matrix-org/synapse/issues/4169
test "Can create more than 10 backup versions",
requires => [ $fixture ],
do => sub {
my ( $user ) = @_;
repeat( sub {
matrix_create_key_backup( $user );
}, foreach => [ 0 .. 10 ], while => sub { $_[0] -> is_done });
};
=head2 matrix_create_key_backup
matrix_create_key_backup( $user )
Create a new key backup version
=cut
sub matrix_create_key_backup {
my ( $user ) = @_;
do_request_json_for( $user,
method => "POST",
uri => "/unstable/room_keys/version",
content => {
algorithm => "m.megolm_backup.v1",
auth_data => "anopaquestring",
}
)
}
=head2 matrix_delete_key_backup
matrix_delete_key_backup( $user, $version )
Delete a key backup version
=cut
sub matrix_delete_key_backup {
my ( $user, $version ) = @_;
do_request_json_for( $user,
method => "DELETE",
uri => "/unstable/room_keys/version/$version",
);
}
=head2 matrix_get_key_backup_info
matrix_get_key_backup_info( $user, $version )
Fetch the metadata about a key backup version, or the latest
version if version is omitted
=cut
sub matrix_get_key_backup_info {
my ( $user, $version ) = @_;
my $url = "/unstable/room_keys/version";
if (defined($version)) {
$url .= "/$version";
}
do_request_json_for( $user,
method => "GET",
uri => $url,
)
}
=head2 matrix_backup_keys
matrix_backup_keys( $user, $room_id, $session_id, $version, $content )
Send keys to a given key backup version
=cut
sub matrix_backup_keys {
my ( $user, $room_id, $session_id, $version, $content ) = @_;
do_request_json_for( $user,
method => "PUT",
uri => "/unstable/room_keys/keys/$room_id/$session_id",
params => {
version => $version,
},
content => $content,
)
}
=head2 matrix_get_backup_key
matrix_get_backup_key( $user, $version, $room_id, $session_id )
Get keys from a given key backup version
=cut
sub matrix_get_backup_key {
my ( $user, $version, $room_id, $session_id ) = @_;
my $uri;
if ( defined $session_id ) {
$uri = "/unstable/room_keys/keys/$room_id/$session_id";
} elsif ( defined $room_id ) {
$uri = "/unstable/room_keys/keys/$room_id";
} else {
$uri = "/unstable/room_keys/keys";
}
do_request_json_for( $user,
method => "GET",
uri => $uri,
params => {
version => $version,
},
);
}