File: backend.testc

package info (click to toggle)
cyrus-imapd 3.12.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 60,544 kB
  • sloc: ansic: 280,382; perl: 146,834; javascript: 9,624; sh: 5,730; yacc: 2,660; cpp: 2,263; makefile: 2,103; lex: 675; xml: 621; awk: 303; python: 273; asm: 262
file content (1932 lines) | stat: -rw-r--r-- 56,222 bytes parent folder | download | duplicates (2)
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
#if HAVE_CONFIG_H
#include <config.h>
#endif
#include <signal.h>
#include <sys/wait.h>
#include <sys/mman.h>
#include <assert.h>
#include "cunit/cyrunit.h"
#include "imap/saslclient.h"
#include <sasl/saslutil.h>
#include <sasl/saslplug.h>
#include "xmalloc.h"
#include "imap/mutex.h"
#include "prot.h"
#include "imap/backend.h"

#include "lib/libconfig.h"
#include "lib/libcyr_cfg.h"
#include "lib/util.h"
#include "lib/xstrlcpy.h"

#define DBDIR   "test-dbdir"
#define MAX_ALPN_MAP (4)

struct server_config {
    int sasl_plain;
    int sasl_login;
    int starttls;
    int deflate;
    int caps_one_per_line;
    struct tls_alpn_t alpn_map[MAX_ALPN_MAP + 1];
};

/*
 * This is a useful hack.  All the test server's state is
 * stored using this structure in an anonymous page which
 * is shared between the client and server.  This lets the
 * test code in the client reach into the server state and
 * either tweak the behaviour via the config or do asserts
 * on the per-connection state (which makes integrating
 * with CUnit a whole lot easier, as CU asserts in a child
 * process are really not helpful).
 */
struct server_state {
    /* dynamic configuration */
    struct server_config config;

    /* global state */
    int rend_sock;
    char banner[64];

    /* per-connection state */
    int is_connected;
    int is_authenticated;
    int is_tls;
    sasl_conn_t *saslconn;          /* the sasl connection context */
#ifdef HAVE_SSL
    SSL *tls_conn;
    char tls_alpn_proto[64];
#endif
    struct protstream *in;
    struct protstream *out;
};

#define HOST            "localhost"
#define SASLSERVICE     "vorpal"
#define USERID          "fbloggs"
#define PASSWORD        "shibboleth"
extern int verbose;

static sasl_callback_t *callbacks;
static struct server_state *server_state;
static const struct server_config default_server_config = {
    .sasl_plain = 1,
    .sasl_login = 0,
    .starttls = 0,
    .deflate = 0,
    .caps_one_per_line = 1,
    .alpn_map = {{{0}, NULL, NULL }},
};
static const struct capa_t default_capa[] = {
    { "CCSASL", CAPA_AUTH },
    { "CCSTARTTLS", CAPA_STARTTLS },
    { "CCCOMPRESS=DEFLATE", CAPA_COMPRESS },
    { NULL, 0 }
};
static const char default_banner[] = "Toy Test server v0.0.1";
static char default_service[32];

static int init_sasl(int isclient);

static struct protocol_t test_prot =
{
    /* .service is setup in default_conditions() */
    .sasl_service = SASLSERVICE,
    .alpn_map = NULL,
    .type = TYPE_STD,
    .u.std = {
        .banner = {
            .auto_capa = 1,
            .resp = "OK"
        },
        .capa_cmd = {
            .cmd = "XXCAPABILITY",
            .arg = NULL,
            .resp = "OK",
            .postcapability = NULL,
            .formatflags = CAPAF_ONE_PER_LINE|CAPAF_SKIP_FIRST_WORD,
            /* .capa is setup in default_conditions() */
        },
        .tls_cmd = {
            .cmd = "XXSTARTTLS",
            .ok = "OK",
            .fail = "NO",
            .auto_capa = 0
        },
        .sasl_cmd = {
            .cmd = "XXAUTHENTICATE",
            .maxlen = USHRT_MAX,
            .quote = 0,
            .ok = "OK",
            .fail = "NO",
            .cont = "+ ",
            .cancel = "*",
            .parse_success = NULL,
            .auto_capa = 0
        },
        .compress_cmd = {
            .cmd = NULL,
            .unsol = NULL,
            .ok = NULL
        },
        .ping_cmd = {
            .cmd = "XXNOOP",
            .unsol = NULL,
            .ok = "OK"
        },
        .logout_cmd = {
            .cmd = "XXLOGOUT",
            .unsol = NULL,
            .ok = "OK"
        }
    }
};

static void server_set_banner(struct server_state *state, const char *str)
{
    strlcpy(state->banner, str ? str : default_banner, sizeof(state->banner));
}

/*
 * Setup default test conditions, on both the client and server.
 */
static void default_conditions(void)
{
    server_state->config = default_server_config;
    server_set_banner(server_state, NULL);

    test_prot.service = default_service;
    memcpy(&test_prot.u.std.capa_cmd.capa, default_capa, sizeof(default_capa));
    test_prot.u.std.capa_cmd.formatflags = CAPAF_ONE_PER_LINE|CAPAF_SKIP_FIRST_WORD;
}

/* ====================================================================== */

/*
 * Test connecting to a host which doesn't exist.
 */
static void test_badhost(void)
{
    struct backend *be;
    const char *auth_status = NULL;

    default_conditions();

    be = backend_connect(NULL, "nonexistenthost", &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NULL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 0);
}

/*
 * Test connecting to the wrong port on the right host.
 */
static void test_badservice(void)
{
    struct backend *be;
    const char *auth_status = NULL;

    default_conditions();
    test_prot.service = "nonexistentservice";

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NULL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 0);
}

/*
 * Test that backend_version detects the remote version correctly.
 */
struct backend_version_data {
    char banner[64];
    int version;
};

static void backend_version_common(void)
{
    size_t i, n_tests;
    const struct backend_version_data data[] = {
        /* 2.3 changed index versions a few times */
        { "Cyrus IMAP v2.3.0", 7 },
        { "Cyrus IMAP v2.3.1", 7 },
        { "Cyrus IMAP v2.3.2", 7 },
        { "Cyrus IMAP v2.3.3", 7 },
        { "Cyrus IMAP v2.3.4", 8 },
        { "Cyrus IMAP v2.3.5", 8 },
        { "Cyrus IMAP v2.3.6", 8 },
        { "Cyrus IMAP v2.3.7", 9 },
        { "Cyrus IMAP v2.3.8", 9 },
        { "Cyrus IMAP v2.3.9", 9 },
        { "Cyrus IMAP v2.3.10", 10 },
        { "Cyrus IMAP v2.3.11", 10 },
        { "Cyrus IMAP v2.3.12", 10 },
        { "Cyrus IMAP v2.3.13", 10 },
        { "Cyrus IMAP v2.3.14", 10 },
        { "Cyrus IMAP v2.3.15", 10 },
        { "Cyrus IMAP v2.3.16", 10 },
        { "Cyrus IMAP v2.3.17", 10 },
        { "Cyrus IMAP v2.3.18", 10 },
        { "Cyrus IMAP v2.3.19", 10 },
        { "Cyrus IMAP v2.3.20", 10 },

        /* 2.4 only had a single index version */
        { "Cyrus IMAP v2.4.0", 12 },
        { "Cyrus IMAP v2.4.1", 12 },
        { "Cyrus IMAP v2.4.2", 12 },
        { "Cyrus IMAP v2.4.3", 12 },
        { "Cyrus IMAP v2.4.4", 12 },
        { "Cyrus IMAP v2.4.5", 12 },
        { "Cyrus IMAP v2.4.6", 12 },
        { "Cyrus IMAP v2.4.7", 12 },
        { "Cyrus IMAP v2.4.8", 12 },
        { "Cyrus IMAP v2.4.9", 12 },
        { "Cyrus IMAP v2.4.10", 12 },
        { "Cyrus IMAP v2.4.11", 12 },
        { "Cyrus IMAP v2.4.12", 12 },
        { "Cyrus IMAP v2.4.13", 12 },
        { "Cyrus IMAP v2.4.14", 12 },
        { "Cyrus IMAP v2.4.15", 12 },
        { "Cyrus IMAP v2.4.16", 12 },
        { "Cyrus IMAP v2.4.17", 12 },
        { "Cyrus IMAP v2.4.18", 12 },
        { "Cyrus IMAP v2.4.19", 12 },
        { "Cyrus IMAP v2.4.20", 12 },

        /* and a weirdly-named one, apparently? */
        { "Cyrus IMAP git2.4.0", 12 },

        /* 2.5 just had one */
        { "Cyrus IMAP 2.5.0", 13 },
        { "Cyrus IMAP 2.5.1", 13 },
        { "Cyrus IMAP 2.5.2", 13 },
        { "Cyrus IMAP 2.5.3", 13 },
        { "Cyrus IMAP 2.5.4", 13 },
        { "Cyrus IMAP 2.5.5", 13 },
        { "Cyrus IMAP 2.5.6", 13 },
        { "Cyrus IMAP 2.5.7", 13 },
        { "Cyrus IMAP 2.5.8", 13 },
        { "Cyrus IMAP 2.5.8", 13 },
        { "Cyrus IMAP 2.5.10", 13 },
        { "Cyrus IMAP 2.5.11", 13 },
        { "Cyrus IMAP 2.5.12", 13 },
        { "Cyrus IMAP 2.5.13", 13 },
        { "Cyrus IMAP 2.5.14", 13 },
        { "Cyrus IMAP 2.5.15", 13 },

        /* and some weirdly named ones? */
        { "Cyrus IMAP Murder 2.5.0", 13 },
        { "Cyrus IMAP git2.5.0", 13 },

        /* 3.0 had just one */
        { "Cyrus IMAP 3.0.0", 13 },
        { "Cyrus IMAP 3.0.1", 13 },
        { "Cyrus IMAP 3.0.2", 13 },
        { "Cyrus IMAP 3.0.3", 13 },
        { "Cyrus IMAP 3.0.4", 13 },
        { "Cyrus IMAP 3.0.5", 13 },
        { "Cyrus IMAP 3.0.6", 13 },
        { "Cyrus IMAP 3.0.7", 13 },
        { "Cyrus IMAP 3.0.8", 13 },
        { "Cyrus IMAP 3.0.8", 13 },
        { "Cyrus IMAP 3.0.10", 13 },
        { "Cyrus IMAP 3.0.11", 13 },
        { "Cyrus IMAP 3.0.12", 13 },
        { "Cyrus IMAP 3.0.13", 13 },

        /* 3.1 supported 13..16 but we don't bother detecting that microscopically */
        /* n.b. there was no 3.1.0 */
        { "Cyrus IMAP 3.1.1", 13 },
        { "Cyrus IMAP 3.1.2", 13 },
        { "Cyrus IMAP 3.1.3", 13 },
        { "Cyrus IMAP 3.1.4", 13 },
        { "Cyrus IMAP 3.1.5", 13 },
        { "Cyrus IMAP 3.1.6", 13 },
        { "Cyrus IMAP 3.1.7", 13 },
        { "Cyrus IMAP 3.1.8", 13 },
        { "Cyrus IMAP 3.1.9", 13 },

        /* 3.2 had just one */
        { "Cyrus IMAP 3.2.0", 16 },
        { "Cyrus IMAP 3.2.1", 16 },
        { "Cyrus IMAP 3.2.2", 16 },
        { "Cyrus IMAP 3.2.3", 16 },
        { "Cyrus IMAP 3.2.4", 16 },
        { "Cyrus IMAP 3.2.5", 16 },
        { "Cyrus IMAP 3.2.6", 16 },
        { "Cyrus IMAP 3.2.7", 16 },
        { "Cyrus IMAP 3.2.8", 16 },
        { "Cyrus IMAP 3.2.9", 16 },

        /* 3.3 had just one */
        { "Cyrus IMAP 3.3.0", 17 },
        { "Cyrus IMAP 3.3.1", 17 },
        { "Cyrus IMAP 3.3.2", 17 },
        { "Cyrus IMAP 3.3.3", 17 },
        { "Cyrus IMAP 3.3.4", 17 },
        { "Cyrus IMAP 3.3.5", 17 },
        { "Cyrus IMAP 3.3.6", 17 },
        { "Cyrus IMAP 3.3.7", 17 },
        { "Cyrus IMAP 3.3.8", 17 },
        { "Cyrus IMAP 3.3.9", 17 },

        /* 3.4 had just one */
        { "Cyrus IMAP 3.4.0", 17 },
        { "Cyrus IMAP 3.4.1", 17 },
        { "Cyrus IMAP 3.4.2", 17 },
        { "Cyrus IMAP 3.4.3", 17 },
        { "Cyrus IMAP 3.4.4", 17 },
        { "Cyrus IMAP 3.4.5", 17 },
        { "Cyrus IMAP 3.4.6", 17 },
        { "Cyrus IMAP 3.4.7", 17 },
        { "Cyrus IMAP 3.4.8", 17 },
        { "Cyrus IMAP 3.4.9", 17 },

        /* 3.5 had just one */
        { "Cyrus IMAP 3.5.0", 17 },
        { "Cyrus IMAP 3.5.1", 17 },
        { "Cyrus IMAP 3.5.2", 17 },
        { "Cyrus IMAP 3.5.3", 17 },
        { "Cyrus IMAP 3.5.4", 17 },
        { "Cyrus IMAP 3.5.5", 17 },
        { "Cyrus IMAP 3.5.6", 17 },
        { "Cyrus IMAP 3.5.7", 17 },
        { "Cyrus IMAP 3.5.8", 17 },
        { "Cyrus IMAP 3.5.9", 17 },

        /* 3.6 had just one */
        { "Cyrus IMAP 3.6.0", 17 },
        { "Cyrus IMAP 3.6.1", 17 },
        { "Cyrus IMAP 3.6.2", 17 },
        { "Cyrus IMAP 3.6.3", 17 },
        { "Cyrus IMAP 3.6.4", 17 },
        { "Cyrus IMAP 3.6.5", 17 },
        { "Cyrus IMAP 3.6.6", 17 },
        { "Cyrus IMAP 3.6.7", 17 },
        { "Cyrus IMAP 3.6.8", 17 },
        { "Cyrus IMAP 3.6.9", 17 },

        /* 3.7 had just one */
        { "Cyrus IMAP 3.7.0", 17 },
        { "Cyrus IMAP 3.7.1", 17 },
        { "Cyrus IMAP 3.7.2", 17 },
        { "Cyrus IMAP 3.7.3", 17 },
        { "Cyrus IMAP 3.7.4", 17 },
        { "Cyrus IMAP 3.7.5", 17 },
        { "Cyrus IMAP 3.7.6", 17 },
        { "Cyrus IMAP 3.7.7", 17 },
        { "Cyrus IMAP 3.7.8", 17 },
        { "Cyrus IMAP 3.7.9", 17 },

        /* 3.8 had just one */
        { "Cyrus IMAP 3.8.0", 17 },
        { "Cyrus IMAP 3.8.1", 17 },
        { "Cyrus IMAP 3.8.2", 17 },
        { "Cyrus IMAP 3.8.3", 17 },
        { "Cyrus IMAP 3.8.4", 17 },
        { "Cyrus IMAP 3.8.5", 17 },
        { "Cyrus IMAP 3.8.6", 17 },
        { "Cyrus IMAP 3.8.7", 17 },
        { "Cyrus IMAP 3.8.8", 17 },
        { "Cyrus IMAP 3.8.9", 17 },

        /* 3.9 supported 17..19 but we don't detect that microscopically */
        { "Cyrus IMAP 3.9.0", 17 },
        { "Cyrus IMAP 3.9.1", 17 },
        { "Cyrus IMAP 3.9.2", 17 },
        { "Cyrus IMAP 3.9.3", 17 },
        { "Cyrus IMAP 3.9.4", 17 },
        { "Cyrus IMAP 3.9.5", 17 },
        { "Cyrus IMAP 3.9.6", 17 },
        { "Cyrus IMAP 3.9.7", 17 },
        { "Cyrus IMAP 3.9.8", 17 },
        { "Cyrus IMAP 3.9.9", 17 },

        /* 3.10 had just one */
        { "Cyrus IMAP 3.10.0", 19 },
        { "Cyrus IMAP 3.10.1", 19 },
        { "Cyrus IMAP 3.10.2", 19 },
        { "Cyrus IMAP 3.10.3", 19 },
        { "Cyrus IMAP 3.10.4", 19 },
        { "Cyrus IMAP 3.10.5", 19 },
        { "Cyrus IMAP 3.10.6", 19 },
        { "Cyrus IMAP 3.10.7", 19 },
        { "Cyrus IMAP 3.10.8", 19 },
        { "Cyrus IMAP 3.10.9", 19 },

        /* better test some pre-release version strings too, would be bad if
         * the parser chokes on them!
         */
        { "Cyrus IMAP 3.0.0-rc1", 13 },
        { "Cyrus IMAP 3.2.0-beta4", 16 },
        { "Cyrus IMAP 3.6.0-beta2", 17 },
        { "Cyrus IMAP 3.7.0-alpha0-1155-gf86d12f44a", 17 },
        { "Cyrus IMAP 3.9.0-alpha0-223-g903b25195", 17 },
        { "Cyrus IMAP 3.11.0-alpha0", 19 },
    };

    /* XXX there's something wrong with the toy test server that results in
     * XXX the banner not being set with auto_capa enabled???
     */
    test_prot.u.std.banner.auto_capa = 0;

    n_tests = sizeof(data) / sizeof(data[0]);

    CU_ASSERT_NOT_EQUAL_FATAL(n_tests, 0);

    for (i = 0; i < n_tests; i++) {
        struct backend *be;
        const char *auth_status = NULL;
        int got_version;

        server_set_banner(server_state, data[i].banner);

        be = backend_connect(NULL, HOST, &test_prot,
                             USERID, callbacks, &auth_status, /*fd*/-1);
        CU_ASSERT_PTR_NOT_NULL_FATAL(be);
        CU_ASSERT_EQUAL(server_state->is_connected, 1);
        CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
        CU_ASSERT_EQUAL(server_state->is_tls, 0);

        got_version = backend_version(be);
        CU_ASSERT_EQUAL(got_version, data[i].version);

        backend_disconnect(be);
        free(be);
    }
}

static void test_backend_version_multiline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 1;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_ONE_PER_LINE|CAPAF_SKIP_FIRST_WORD;
    backend_version_common();
}

static void test_backend_version_oneline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 0;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_MANY_PER_LINE;
    backend_version_common();
}

static void unrecognised_backend_version_common(void)
{
    size_t i, n_tests;
    struct backend_version_data data[] = {
        { "BOGUS", 6 }, /* completely unrecognised */
        { "Cyrus IMAP v2.3.B (OGUS)", 6 }, /* junk 2.3 revision */
        { "Cyrus IMAP 10.0.0", MAILBOX_MINOR_VERSION }, /* unknown future version */
        { "Cyrus IMAP 10.0.0-rc1", MAILBOX_MINOR_VERSION },
        { "Cyrus IMAP 10.0.0-alpha0-57-g1f6140ee54", MAILBOX_MINOR_VERSION },
    };

    /* XXX there's something wrong with the toy test server that results in
     * XXX the banner not being set with auto_capa enabled???
     */
    test_prot.u.std.banner.auto_capa = 0;

    n_tests = sizeof(data) / sizeof(data[0]);

    CU_ASSERT_NOT_EQUAL_FATAL(n_tests, 0);

    for (i = 0; i < n_tests; i++) {
        struct backend *be;
        const char *auth_status = NULL;
        int got_version;

        server_set_banner(server_state, data[i].banner);

        be = backend_connect(NULL, HOST, &test_prot,
                             USERID, callbacks, &auth_status, /*fd*/-1);
        CU_ASSERT_PTR_NOT_NULL_FATAL(be);
        CU_ASSERT_EQUAL(server_state->is_connected, 1);
        CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
        CU_ASSERT_EQUAL(server_state->is_tls, 0);

        CU_SYSLOG_MATCH("Assuming index version [0-9]+!");
        got_version = backend_version(be);
        CU_ASSERT_EQUAL(got_version, data[i].version);
        CU_ASSERT_SYSLOG(/*all*/0, 1);

        backend_disconnect(be);
        free(be);
    }
}

static void test_unrecognised_backend_version_multiline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 1;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_ONE_PER_LINE|CAPAF_SKIP_FIRST_WORD;
    unrecognised_backend_version_common();
}

static void test_unrecognised_backend_version_oneline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 0;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_MANY_PER_LINE;
    unrecognised_backend_version_common();
}

/*
 * Test authenticating with the PLAIN mechanism.
 */
static void test_sasl_plain(void)
{
    struct backend *be;
    const char *auth_status = NULL;
    char *mechs;
    int r;

    default_conditions();
    server_state->config.sasl_plain = 1;

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NOT_NULL_FATAL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 1);
    CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
    CU_ASSERT_EQUAL(server_state->is_tls, 0);

    mechs = backend_get_cap_params(be, CAPA_AUTH);
    CU_ASSERT_STRING_EQUAL(mechs, "PLAIN");
    free(mechs);

    r = backend_ping(be, NULL);
    CU_ASSERT_EQUAL(r, 0);

    backend_disconnect(be);
    free(be);
}

#if 0
/*
 * Test authenticating with the LOGIN mechanism.
 * This test doesn't work for me.  I have NFI why - gnb.
 */
static void not_test_sasl_login(void)
{
    struct backend *be;
    const char *auth_status = NULL;
    char *mechs;
    int r;

    default_conditions();
    server_state->config.sasl_plain = 0;
    server_state->config.sasl_login = 1;

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NOT_NULL_FATAL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 1);
    CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
    CU_ASSERT_EQUAL(server_state->is_tls, 0);

    mechs = backend_get_cap_params(be, CAPA_AUTH);
    CU_ASSERT_STRING_EQUAL(mechs, "LOGIN");
    free(mechs);

    r = backend_ping(be);
    CU_ASSERT_EQUAL(r, 0);

    backend_disconnect(be);
    free(be);
}
#endif

/* Common routine to test the semantics of capabilities */
static void caps_common(void)
{
#define CAPA_FOO        (1<<(CAPA_COMPRESS+1))
#define CAPA_BAZ        (1<<(CAPA_COMPRESS+2))
#define CAPA_QUUX       (1<<(CAPA_COMPRESS+3))
#define CAPA_FNORD      (1<<(CAPA_COMPRESS+4))
#define CAPA_CAPITALS   (1<<(CAPA_COMPRESS+5))
#define CAPA_MIA        (1<<(CAPA_COMPRESS+6))
    struct backend *be;
    const char *auth_status = NULL;
    char *params;
    int r;
    int n;
    static const struct capa_t extra_capa[] = {
        { "FOO", CAPA_FOO },
        { "BAZ", CAPA_BAZ },
        { "QUUX", CAPA_QUUX },
        { "FNORD=BOO", CAPA_FNORD },
        { "CAPITALS", CAPA_CAPITALS },
        { "MIA", CAPA_MIA },
        { NULL, 0 }
        /* No more room in the fixed size array, dammit */
    };

    /* append some extra capabilities */
    n = sizeof(default_capa)/sizeof(default_capa[0]) - 1;
    CU_ASSERT_FATAL(n * sizeof(struct capa_t) +
                    sizeof(extra_capa) <= sizeof(test_prot.u.std.capa_cmd.capa));
    memcpy(&test_prot.u.std.capa_cmd.capa[n], extra_capa, sizeof(extra_capa));

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NOT_NULL_FATAL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 1);
    CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
    CU_ASSERT_EQUAL(server_state->is_tls, 0);

    /* FOO is present, its parameter is BAR */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_FOO), 1);
    params = backend_get_cap_params(be, CAPA_FOO);
    CU_ASSERT_STRING_EQUAL(params, "BAR");
    free(params);

    /* BAZ is present, it has no parameters */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_BAZ), 1);
    params = backend_get_cap_params(be, CAPA_BAZ);
    CU_ASSERT_PTR_NULL(params);

    /* QUUX is present, its parameters are FOONLY and FMEH */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_QUUX), 1);
    params = backend_get_cap_params(be, CAPA_QUUX);
    CU_ASSERT_STRING_EQUAL(params, "FOONLY FMEH");
    free(params);

    /* FNORD is present, its parameters are BOO and GNERGH,
     * but we asked specifically for FNORD=BOO so CAPA()
     * should succeed but we should see no params. */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_FNORD), 1);
    params = backend_get_cap_params(be, CAPA_FNORD);
    CU_ASSERT_PTR_NULL(params);

    /* CAPITALS is present, its parameter is Oslo.  Note the
     * name is matched case-insensitive but the parameters
     * are returned as seen on the wire. */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_CAPITALS), 1);
    params = backend_get_cap_params(be, CAPA_CAPITALS);
    CU_ASSERT_STRING_EQUAL(params, "Oslo");
    free(params);

    /* MIA is missing in action */
    CU_ASSERT_EQUAL(!!CAPA(be, CAPA_MIA), 0);
    params = backend_get_cap_params(be, CAPA_MIA);
    CU_ASSERT_PTR_NULL(params);

    r = backend_ping(be, NULL);
    CU_ASSERT_EQUAL(r, 0);

    backend_disconnect(be);
    free(be);
#undef CAPA_FOO
#undef CAPA_BAZ
#undef CAPA_QUUX
#undef CAPA_FNORD
#undef CAPA_CAPITALS
#undef CAPA_MIA
}

/*
 * Test parsing capabilities in multi-line format
 */
static void test_multiline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 1;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_ONE_PER_LINE|CAPAF_SKIP_FIRST_WORD;
    caps_common();
}

/*
 * Test parsing capabilities in one-line format
 */
static void test_oneline_caps(void)
{
    default_conditions();
    server_state->config.caps_one_per_line = 0;
    test_prot.u.std.capa_cmd.formatflags = CAPAF_MANY_PER_LINE;
    caps_common();
}

/*
 * Test STARTTLS
 */
static void test_starttls(void)
{
#ifdef HAVE_SSL
    struct backend *be;
    const char *auth_status = NULL;
    char *mechs;
    int r;

    default_conditions();
    server_state->config.sasl_plain = 1;
    server_state->config.starttls = 1;

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    CU_ASSERT_PTR_NOT_NULL_FATAL(be);
    CU_ASSERT_EQUAL(server_state->is_connected, 1);
    CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
    CU_ASSERT_EQUAL(server_state->is_tls, 1);

    mechs = backend_get_cap_params(be, CAPA_AUTH);
    CU_ASSERT_STRING_EQUAL(mechs, "PLAIN");
    free(mechs);

    CU_ASSERT(CAPA(be, CAPA_STARTTLS))

    r = backend_ping(be, NULL);
    CU_ASSERT_EQUAL(r, 0);

    backend_disconnect(be);
    free(be);
#endif
}

/*
 * ALPN tests
 */
enum {
    ALPN_COMMON_EXPECT_FAIL = 0,
    ALPN_COMMON_EXPECT_SUCCESS = 1,
};

static void alpn_common(const struct tls_alpn_t *client_alpn_map,
                        unsigned n_client_protocols,
                        const struct tls_alpn_t *server_alpn_map,
                        unsigned n_server_protocols,
                        int expect_success,
                        const char *expect_protocol)
{
    struct backend *be;
    const char *auth_status = NULL;
    int r;

    CU_ASSERT_FATAL(n_client_protocols <= MAX_ALPN_MAP);
    CU_ASSERT_FATAL(n_server_protocols <= MAX_ALPN_MAP);

    default_conditions();
    server_state->config.sasl_plain = 1;
    server_state->config.starttls = 1;
    if (n_server_protocols) {
        memcpy(server_state->config.alpn_map,
               server_alpn_map,
               n_server_protocols * sizeof(struct tls_alpn_t));
    }

    test_prot.alpn_map = client_alpn_map;

    be = backend_connect(NULL, HOST, &test_prot,
                         USERID, callbacks, &auth_status, /*fd*/-1);
    if (expect_success) {
        CU_ASSERT_PTR_NOT_NULL_FATAL(be);
        CU_ASSERT_PTR_NOT_NULL_FATAL(be->tlsconn);

        CU_ASSERT_EQUAL(server_state->is_connected, 1);
        CU_ASSERT_EQUAL(server_state->is_authenticated, 1);
        CU_ASSERT_EQUAL(server_state->is_tls, 1);

        CU_ASSERT(CAPA(be, CAPA_STARTTLS))

        if (expect_protocol) {
            char *client_proto = NULL;

            client_proto = tls_get_alpn_protocol(be->tlsconn);
            CU_ASSERT_PTR_NOT_NULL(client_proto);
            CU_ASSERT_STRING_EQUAL(client_proto, expect_protocol);
            free(client_proto);

            CU_ASSERT_STRING_EQUAL(server_state->tls_alpn_proto,
                                   expect_protocol);
        }
        else {
            CU_ASSERT_PTR_NULL(tls_get_alpn_protocol(be->tlsconn));
            CU_ASSERT_STRING_EQUAL(server_state->tls_alpn_proto, "");
        }

        r = backend_ping(be, NULL);
        CU_ASSERT_EQUAL(r, 0);

        backend_disconnect(be);
        free(be);
    }
    else {
        CU_ASSERT_PTR_NULL(be);
    }
}

static void test_alpn_match_single(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_SUCCESS,
                "foo");
#endif
}

static void test_alpn_match_client_only(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                NULL,
                0,
                ALPN_COMMON_EXPECT_SUCCESS,
                NULL);
#endif
}

static void test_alpn_match_server_only(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(NULL,
                0,
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_SUCCESS,
                NULL);
#endif
}

static void test_alpn_match_client_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_SUCCESS,
                "foo");
#endif
}

static void test_alpn_match_server_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_SUCCESS,
                "foo");
#endif
}

static void test_alpn_match_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "bar", NULL, NULL },
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_SUCCESS,
                "bar");
#endif
}

static void test_alpn_nomatch_single(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_FAIL,
                NULL);
#endif
}

static void test_alpn_nomatch_client_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "qux", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_FAIL,
                NULL);
#endif
}

static void test_alpn_nomatch_server_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "qux", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_FAIL,
                NULL);
#endif
}

static void test_alpn_nomatch_multi(void)
{
#if defined(HAVE_SSL) && defined(HAVE_TLS_ALPN)
    struct tls_alpn_t client_map[] = {
        { "baz", NULL, NULL },
        { "qux", NULL, NULL },
        { "",    NULL, NULL },
    };
    struct tls_alpn_t server_map[] = {
        { "foo", NULL, NULL },
        { "bar", NULL, NULL },
        { "",    NULL, NULL },
    };

    alpn_common(client_map,
                sizeof(client_map) / sizeof(client_map[0]),
                server_map,
                sizeof(server_map) / sizeof(server_map[0]),
                ALPN_COMMON_EXPECT_FAIL,
                NULL);
#endif
}

/* TODO: test UNIX socket comms too */
/* TODO: test IPv6 socket comms too */
/* TODO: test connect() timeout */

/* ====================================================================== */

/*
 * Allocate, and return a mapped pointer to, an anonymous page in
 * memory (a non-heap non-text page with no backing file) which will be
 * shared across fork().  The page is assumed to be zeroed.
 */
static void *get_anonymous_page(void)
{
    void *page;
    size_t pagesize = getpagesize();

#if defined(MAP_ANON) && !defined(MAP_ANONYMOUS)
    /* FreeBSD */
#define MAP_ANONYMOUS MAP_ANON
#endif

#ifdef MAP_ANONYMOUS
    /* Linux and Solaris */
    page = mmap(NULL, pagesize, PROT_READ|PROT_WRITE,
                MAP_ANONYMOUS|MAP_SHARED, -1, 0);
    if (page == MAP_FAILED) {
        perror("mmap");
        return NULL;
    }
#else
    int fd;

    fd = open("/dev/zero", O_RDWR);
    if (fd < 0) {
        perror("/dev/zero");
        return NULL;
    }
    page = mmap(NULL, pagesize, PROT_READ|PROT_WRITE,
                MAP_SHARED, fd, 0);
    if (page == MAP_FAILED) {
        perror("mmap");
        page = NULL;
    }
    close(fd);
#endif

    return page;
}

/*
 * Free an anonymous page returned from get_anonymous_page()
 */
static void free_anonymous_page(void *page)
{
    munmap(page, getpagesize());
}

/*
 * Create a bound and listening TCP4 server socket, bound to the IPv4
 * loopback address and a port chosen by the kernel.
 *
 * Returns: socket, or -1 on error.  *@portp is filled with the port
 * number.
 */
static int create_server_socket(int *portp)
{
    int sock;
    struct sockaddr_in sin;
    int r;

    sock = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (sock < 0) {
        perror("socket(TCP)");
        return -1;
    }

    memset(&sin, 0, sizeof(sin));
    sin.sin_family = AF_INET;
    sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
    if (*portp)
        sin.sin_port = htons(*portp);

    r = bind(sock, (struct sockaddr *)&sin, sizeof(sin));
    if (r < 0) {
        perror("bind");
        goto error;
    }

    r = listen(sock, 5);
    if (r < 0) {
        perror("listen");
        goto error;
    }

    if (!*portp) {
        socklen_t len = sizeof(sin);
        r = getsockname(sock, (struct sockaddr *)&sin, &len);
        if (r < 0) {
            perror("getsockname");
            goto error;
        }
        if (len != sizeof(sin) || sin.sin_family != AF_INET) {
            fprintf(stderr, "Bad address from getsockname()\n");
            goto error;
        }
        *portp = ntohs(sin.sin_port);
    }

    return sock;

error:
    close(sock);
    return -1;
}

/*
 * Block until an incoming connection is received, then establish the
 * connection and initialise per-connection state.  On success, set
 * @state->is_connected.
 *
 * Returns 0 on success, -1 on failure (errors indicate some resource
 * limitation in the server, not any behaviour of the client, and
 * should be fatal).
 */
static int server_accept(struct server_state *state)
{
    int conn_sock;
    int r;

    if (verbose > 1)
        fprintf(stderr, "Server waiting for connection\n");

    conn_sock = accept(state->rend_sock, NULL, NULL);
    if (conn_sock < 0) {
        perror("accept");
        return -1;
    }
    if (verbose > 1)
        fprintf(stderr, "Server accepted connection\n");

    state->in = prot_new(conn_sock, /*read*/0);
    state->out = prot_new(dup(conn_sock), /*write*/1);
    if (!state->in || !state->out) {
        perror("prot_new");
        return -1;
    }

    r = sasl_server_new(SASLSERVICE, HOST,
                        /*user_realm*/NULL, /*iplocalport*/NULL,
                        /*ipremoteport*/NULL, /*callbacks*/NULL,
                        /*flags*/0, &state->saslconn);
    if (r != SASL_OK) {
        fprintf(stderr, "sasl_server_new() failed with error %d\n", r);
        return -1;
    }

    state->is_authenticated = 0;
    state->is_connected = 1;
    state->is_tls = 0;
#ifdef HAVE_SSL
    state->tls_conn = NULL;
#endif

    return 0;
}

/*
 * Handle the end of a connection, by cleaning up all the per-connection
 * state.  In particular, clears @state->is_connected.
 */
static void server_unaccept(struct server_state *state)
{
    prot_free(state->in);
    state->in = NULL;
    prot_free(state->out);
    state->out = NULL;
    sasl_dispose(&state->saslconn);
    state->is_connected = 0;
    state->is_authenticated = 0;
    state->is_tls = 0;
#ifdef HAVE_SSL
    if (state->tls_conn) {
        tls_reset_servertls(&state->tls_conn);
        state->tls_conn = NULL;
    }
    memset(state->tls_alpn_proto, 0, sizeof(state->tls_alpn_proto));
#endif
}

/*
 * Main routine for pushing text back to the client.
 */
static void
__attribute__((format(printf, 2, 3)))
server_printf(struct server_state *state, const char *fmt, ...)
{
    va_list args;
    int r;
    char buf[2048];

    if (verbose > 1) {
        va_start(args, fmt);
        fprintf(stderr, "S: ");
        vfprintf(stderr, fmt, args);
        va_end(args);
    }

    va_start(args, fmt);
    r = vsnprintf(buf, sizeof(buf), fmt, args);
    assert(r < (int)sizeof(buf));
    va_end(args);

    r = prot_write(state->out, buf, strlen(buf));
    assert(r >= 0);
}

/*
 * Flush any pending output back to the client.
 */
static void server_flush(struct server_state *state)
{
    prot_flush(state->out);
}

/*
 * Get a line of text from the client.  Blocks until
 * a while line is available.
 *
 * Returns: 0 on success, -1 on error or end of file.
 */
static int server_getline(struct server_state *state,
                          char *buf, int maxlen)
{
    if (!prot_fgets(buf, maxlen, state->in))
        return -1;
    if (verbose > 1)
        fprintf(stderr, "C: %s\n", buf);
    return 0;
}

/*
 * Emit to the client a banner including the server's capability
 * strings.  This might be in response to the client connecting, or to
 * the client issuing the XXCAPABILITY command.  Various flags in
 * @state->config control which of the magical caps known by the
 * backend.c client code are reported.  Some other test capabilities are
 * always reported.  Depending on @state->config.caps_one_per_line, the
 * caps are listed in a multi-line format, one cap per line (LMTP, POP3,
 * ManageSieve, and sync style) or a single-line, many caps per line
 * format (IMAP style).
 */
static void server_emit_caps(struct server_state *state)
{
    const char *saslmechs = NULL;
    char *p;
    char *b;
    int n = 0;
    const char *name;
    const char *words[256];     /* array of:
                                 * NAME, VALUE, VALUE, NULL,
                                 * NAME, VALUE, NULL,
                                 * NULL */
    char line[1024];

    /*
     * The ccSASL cap reports a list of SASL mechanism names.
     * Note that we suppress them all if STARTTLS is enabled.
     */
    if (!state->config.starttls || state->is_tls) {
        int got_login = 0;
        int got_plain = 0;

        /* First see what mechanisms SASL has; no point reporting
         * mechanisms which aren't actually available. */
        sasl_listmech(state->saslconn, /*user*/NULL, /*prefix*/"",
                      /*sep*/" ", /*suffix*/"", &saslmechs, /*plen*/NULL,
                      /*pcount*/NULL);
        b = xstrdup(saslmechs);
        /* Build our own list of mechanisms, which is the intersection
         * of the ones configured in SASL and the ones our server config
         * allows us. */
        words[n++] = "ccSASL";
        for (p = strtok(b, " ") ; p ; p = strtok(NULL, " ")) {
            if (!strcasecmp(p, "LOGIN") && state->config.sasl_login) {
                words[n++] = "LOGIN";
                got_login = 1;
            }
            if (!strcasecmp(p, "PLAIN") && state->config.sasl_plain) {
                words[n++] = "PLAIN";
                got_plain = 1;
            }
        }
        words[n++] = NULL;
        free(b);

        if (state->config.sasl_login && !got_login)
            fprintf(stderr, "Server failed to find requested "
                            "SASL mechanism \"LOGIN\"\n");
        if (state->config.sasl_plain && !got_plain)
            fprintf(stderr, "Server failed to find requested "
                            "SASL mechanism \"PLAIN\"\n");
    }

    /*
     * The ccSTARTTLS cap reports the ability to do STARTTLS
     */
    if (state->config.starttls) {
        words[n++] = "ccSTARTTLS";
        words[n++] = NULL;
    }

    /*
     * The ccCOMPRESS=DEFLATE cap reports the ability to do Deflate
     * compression.
     */
    if (state->config.deflate) {
        words[n++] = "ccCOMPRESS";
        words[n++] = "DEFLATE";
        words[n++] = NULL;
    }

    /*
     * Various test capabilities; the test code in the client knows what
     * to expect for these.
     */
    words[n++] = "FOO";
    words[n++] = "BAR";
    words[n++] = NULL;

    words[n++] = "BAZ";
    words[n++] = NULL;

    words[n++] = "QUUX";
    words[n++] = "FOONLY";
    words[n++] = "FMEH";
    words[n++] = NULL;

    words[n++] = "FNORD";
    words[n++] = "BOO";
    words[n++] = "GNERGH";
    words[n++] = NULL;

    words[n++] = "cApItAls";
    words[n++] = "Oslo";
    words[n++] = NULL;

    words[n++] = NULL;

    /*
     * Finally we have all the capability names and values, now
     * pull them out of words[] and emit lines to the client.
     */
    n = 0;
    if (state->config.caps_one_per_line) {
        /* Multi-line, one cap and all its values on each line (LMTP,
         * ManageSieve, POP3 and sync style) */
        while ((name = words[n++])) {
            line[0] = '\0';
            for ( ; words[n] ; n++) {
                strcat(line, " ");
                strcat(line, words[n]);
            }
            n++;
            server_printf(state, "* %s%s\r\n", name, line);
        }
        server_printf(state, "OK %s server ready\r\n", state->banner);
    } else {
        /* One-line, NAME=VALUE pairs inside IMAP-style response code */
        line[0] = '\0';
        while ((name = words[n++])) {
            if (words[n]) {
                for ( ; words[n] ; n++) {
                    strcat(line, " ");
                    strcat(line, name);
                    strcat(line, "=");
                    strcat(line, words[n]);
                }
            } else {
                strcat(line, " ");
                strcat(line, name);
            }
            n++;
        }
        server_printf(state, "OK [CAPABILITY%s] %s server ready\r\n",
                      line, state->banner);
    }
    server_flush(state);
}

/*
 * Handle the XXAUTHENTICATE command from the client.  The 1st and 2nd
 * arguments to the command on wire are passed as @mech and
 * @initial_in_b64.  Handles any SASL conversation with the client (e.g.
 * server challenges and client responses), and telling the client the
 * final status.  If successful, sets @state->is_authenticated.
 */
static void cmd_authenticate(struct server_state *state,
                             const char *mech, const char *initial_in_b64)
{
    char *word;
    const char *server_out;
    unsigned int server_out_len;
    int r;
    unsigned int buflen = 0;
    char buf[21848];
    static const char sep[] = " \t\r\n";

    if (!mech)
        goto badsyntax;

    if (initial_in_b64) {
        r = sasl_decode64(initial_in_b64, strlen(initial_in_b64),
                          buf, sizeof(buf), &buflen);
        if (r != SASL_OK)
            goto badsyntax;
    } else {
        buflen = 0;
    }

    server_out = NULL;
    server_out_len = 0;
    r = sasl_server_start(state->saslconn, mech,
                          buf, buflen,
                          &server_out, &server_out_len);

    while (r == SASL_CONTINUE) {
        if (server_out_len)
            sasl_encode64(server_out, server_out_len, buf, sizeof(buf), NULL);
        else
            strcpy(buf, "=");
        server_printf(state, "+ %s\n", buf);
        server_flush(state);

        if (server_getline(state, buf, sizeof(buf)) < 0) {
            fprintf(stderr, "No response to AUTH challenge\n");
            return;
        }
        word = strtok(buf, sep);
        if (word) {
            r = sasl_decode64(word, strlen(word), buf, sizeof(buf), &buflen);
            if (r != SASL_OK)
                goto badsyntax;
        } else {
            buflen = 0;
        }

        server_out = NULL;
        server_out_len = 0;
        r = sasl_server_step(state->saslconn, buf, buflen,
                             &server_out, &server_out_len);
    }

    if (r != SASL_OK) {
        server_printf(state, "BAD sasl error code %d\r\n", r);
        server_flush(state);
        return;
    }

    state->is_authenticated = 1;
    server_printf(state, "OK\r\n");
    server_flush(state);
    return;

badsyntax:
    server_printf(state, "BAD syntax\r\n");
    server_flush(state);
}

/*
 * Handle the XXSTARTTLS command from the client.
 * If successful, sets @state->is_tls.
 */
static void cmd_starttls(struct server_state *state)
{
#ifdef HAVE_SSL
    int r;
    SSL *tls_conn = NULL;
    char *alpn_proto = NULL;
    static struct saslprops_t saslprops = SASLPROPS_INITIALIZER;

    r = tls_init_serverengine("backend_test", /*verifydepth*/5,
                              /*askcert*/1, NULL);
    if (r < 0) {
        server_printf(state, "BAD error initializing TLS\r\n");
        server_flush(state);
        return;
    }

    server_printf(state, "OK Begin TLS negotiation now\r\n");
    /* must flush our buffers before starting tls */
    server_flush(state);

    r = tls_start_servertls(/*readfd*/state->in->fd,
                            /*writefd*/state->out->fd,
                            /*timeout_sec*/3000,
                            &saslprops,
                            state->config.alpn_map,
                            &tls_conn);
    if (r < 0) {
        server_printf(state, "BAD STARTTLS negotiation failed\r\n");
        server_flush(state);
        return;
    }

    /* tell SASL about the negotiated layer */
    r = saslprops_set_tls(&saslprops, state->saslconn);
    if (r != SASL_OK) {
        server_printf(state,
                      "BAD saslprops_set_tls() failed: cmd_starttls()\r\n");
        server_flush(state);
        return;
    }

    /* tell the prot layer about our new layers */
    prot_settls(state->in, tls_conn);
    prot_settls(state->out, tls_conn);
    state->tls_conn = tls_conn;
    state->is_tls = 1;

    if ((alpn_proto = tls_get_alpn_protocol(tls_conn))) {
        snprintf(state->tls_alpn_proto, sizeof(state->tls_alpn_proto),
                 "%s", alpn_proto);
        free(alpn_proto);
    }
    else {
        memset(state->tls_alpn_proto, 0, sizeof(state->tls_alpn_proto));
    }
#else
    server_printf(state, "BAD this server is not built with SSL\r\n");
    server_flush(state);
#endif
}

/*
 * Server main command loop for a single connection.  Blocks waiting for
 * commands from the client, and handles each command.  Returns when the
 * client sends a XXLOGOUT command or drops the connection.
 */
static void server_cmdloop(struct server_state *state)
{
    char *command;
    char buf[1024];
    static const char sep[] = " \t\r\n";

    /* Emit the connection banner */
    server_emit_caps(state);

    while (server_getline(state, buf, sizeof(buf)) == 0) {
        command = strtok(buf, sep);

        if (!command) {
            server_printf(state, "BAD command\r\n");
            server_flush(state);
            continue;
        }

        if (!strcasecmp(command, "XXLOGOUT")) {
            /* graceful disconnect */
            server_printf(state, "OK\r\n");
            server_flush(state);
            break;
        } else if (!strcasecmp(command, "XXNOOP")) {
            server_printf(state, "OK\r\n");
            server_flush(state);
        } else if (!strcasecmp(command, "XXCAPABILITY")) {
            server_emit_caps(state);
        } else if (!strcasecmp(command, "XXAUTHENTICATE")) {
            char *mech = strtok(NULL, sep);
            char *initial_in = strtok(NULL, sep);
            cmd_authenticate(state, mech, initial_in);
        } else if (!strcasecmp(command, "XXSTARTTLS")) {
            cmd_starttls(state);
        } else {
            server_printf(state, "BAD command\r\n");
            server_flush(state);
        }
    }
}

/*
 * Start the server.  Forks a child process, which does some once-off
 * server initialisation and then enters a service loop.  The service
 * loop is very dumb: it serves a single connection at a time, with no
 * forking or threading or async request handling.
 *
 * Returns: pid of the child process, or -1 on error.
 */
static pid_t server_start(struct server_state *state)
{
    pid_t pid;

    pid = fork();
    if (pid < 0) {
        perror("fork");
        return -1;
    }
    if (pid) {
        /* We are the parent process.  We don't need to wait for the
         * child to finish starting, as we have a bound socket we can
         * connect immediately (it just might take the child a little
         * while to respond to the first command). */
        close(state->rend_sock);
        return pid;
    }
    /* We are the child process. */

    if (init_sasl(/*client*/0) < 0)
        exit(1);

    /* Main connection loop.  This is a toy, single-threaded server
     * which handles one connection at a time. */
    for (;;)
    {
        /* Wait for a connection */
        if (server_accept(state) < 0)
            exit(1);

        /* Run the main command loop for this connection */
        server_cmdloop(state);

        /* Forget the per-connection state */
        server_unaccept(state);

        /* This loops forever until it's killed off by an uncaught SIGTERM.
         * It MUST NOT exit(0) nor return, otherwise it'll make a mess of the
         * cunit internal state that's still in memory since we did fork()
         * but not exec().
         */
    }
}

/*
 * Shut down the server, given it's PID.  It's pretty simple and brutal:
 * we just send it SIGTERM and wait to reap it.
 */
static void server_shutdown(pid_t pid)
{
    int status;
    pid_t r;

    kill(pid, SIGTERM);
    for (;;) {
        r = waitpid(pid, &status, 0);
        if (r < 0) {
            if (errno == EINTR)
                continue;
            if (errno != ESRCH)
                perror("waitpid");
            return;
        }
        if (r == pid)
            return; /* ok, killed it */
        fprintf(stderr, "WTF? waitpid(%d) = %d?\n", pid, r);
    }
}

/*
 * Callback which we use to fakes server-side password checking for
 * those mechanisms where a plaintext password from the client is
 * available to the SASL server code, i.e. PLAIN and LOGIN.
 */
static int server_checkpass(sasl_conn_t *conn __attribute__((unused)),
                            void *context __attribute__((unused)),
                            const char *user, const char *pass,
                            unsigned passlen,
                            struct propctx *propctx __attribute__((unused)))
{
    if (strcmp(user, USERID))
        return SASL_NOUSER;
    if (passlen != strlen(PASSWORD) ||
        strncmp(pass, PASSWORD, passlen))
        return SASL_BADAUTH;
    return SASL_OK;
}

/* The auxprop API changed in commit a321326, Oct 2008 */
#if SASL_AUXPROP_PLUG_VERSION > 4
#   define AUXPROP_RTYPE int
#   define AUXPROP_RET 0
#else
#   define AUXPROP_RTYPE void
#   define AUXPROP_RET
#endif

/*
 * Callback which we use to fake out server-side password checking for
 * those mechanisms where a plaintext password from the client is *NOT*
 * available, and so the SASL server code needs to retrieve the password
 * from an auxprop plugin.
 */
static AUXPROP_RTYPE server_auxprop_lookup(void *glob_context __attribute__((unused)),
                                 sasl_server_params_t *sparams,
                                 unsigned flags __attribute__((unused)),
                                 const char *user,
                                 unsigned ulen)
{
    const struct propval *prop;

    if (ulen != strlen(USERID) ||
        strncmp(user, USERID, ulen))
        return AUXPROP_RET;

    prop = sparams->utils->prop_get(sparams->propctx);
    if (!prop)
        return AUXPROP_RET;
    for ( ; prop->name ; prop++) {
        if (!strcmp(prop->name, "*userPassword")) {
            if (prop->values)
                sparams->utils->prop_erase(sparams->propctx, prop->name);
            sparams->utils->prop_set(sparams->propctx, prop->name,
                                     PASSWORD, strlen(PASSWORD));
        }
    }

    return AUXPROP_RET;
}

/*
 * Helps create a fake "auxiliary property plugin" for the SASL library,
 * which is how we hook into the DIGEST-MD5? mechanism when it wants to
 * get a plaintext password to check against the hash received from the
 * client.
 */
static int server_auxprop_init(const sasl_utils_t *utils __attribute__((unused)),
                               int max_version,
                               int *out_version,
                               sasl_auxprop_plug_t **plugp,
                               const char *plugname __attribute__((unused)))
{
    static sasl_auxprop_plug_t plug = {
        .features = 0,
        .auxprop_lookup = server_auxprop_lookup,
        .name = (char *) "testserver-hack"
    };

    *out_version = max_version;
    *plugp = &plug;
    return SASL_OK;
}

/*
 * Initialise the SASL library, client or server.
 *
 * Returns: 0 on success, -ve on error.
 */
static int init_sasl(int isclient)
{
    int r;

    /* set the SASL allocation functions */
    sasl_set_alloc((sasl_malloc_t *)xmalloc,
                   (sasl_calloc_t *)xcalloc,
                   (sasl_realloc_t *)xrealloc,
                   (sasl_free_t *)free);

    /* set the SASL mutex functions */
    sasl_set_mutex(cyrus_mutex_alloc, cyrus_mutex_lock,
                   cyrus_mutex_unlock, cyrus_mutex_free);

    if (isclient) {
        static const struct sasl_callback client_cb[] = {
            { SASL_CB_LIST_END, NULL, NULL }
        };

        /* load the SASL client plugins */
        if (sasl_client_init(client_cb)) {
            fprintf(stderr, "could not init sasl client\n");
            return -1;
        }

        callbacks = mysasl_callbacks(USERID, USERID, NULL, PASSWORD);
        if (!callbacks) {
            fprintf(stderr, "could not init sasl client callbacks\n");
            return -1;
        }
    } else {
        static const struct sasl_callback server_cb[] = {
            { SASL_CB_SERVER_USERDB_CHECKPASS, (void *)&server_checkpass, NULL },
            { SASL_CB_LIST_END, NULL, NULL }
        };

        /* load the SASL server plugins */
        r = sasl_server_init(server_cb, "testserver");
        if (r != SASL_OK) {
            fprintf(stderr, "sasl_server_init() failed: error %d\n", r);
            return -1;
        }

        sasl_auxprop_add_plugin("testserver", server_auxprop_init);
    }

    return 0;
}

/* ====================================================================== */

static struct server_state *server_state;
static pid_t server_pid;
static int sasl_initialised;

/*
 * Test suite setup function.  Sets up the global
 * server_state page.  Forks a server process which listens
 * on a TCP port, and writes the port number into default_service[]
 * so that the client code can connect to it.
 */
static int set_up(void)
{
    int rend_sock, port = 0;
    char *sr;
    char cwd[PATH_MAX];
    struct buf myconfig = BUF_INITIALIZER;

    if (verbose > 1)
        fprintf(stderr, "Starting server!\n");

    sr = getcwd(cwd, sizeof(cwd));
    if (!sr) {
        fprintf(stderr, "getcwd() failed: %s\n", strerror(errno));
        return -1;
    }

    /* we need config for these tests */
    libcyrus_config_setstring(CYRUSOPT_CONFIG_DIR, DBDIR);
    buf_printf(&myconfig, "configdirectory: %s/conf\n", DBDIR);

    /* certs are in current directory */
    buf_printf(&myconfig, "tls_server_ca_file: %s/cacert.pm\n", cwd);
    buf_printf(&myconfig, "tls_server_cert: %s/cert.pem\n", cwd);
    buf_printf(&myconfig, "tls_server_key: %s/key.pem\n", cwd);

    /* disable SSL session caching */
    buf_printf(&myconfig, "tls_session_timeout: 0\n");

    config_read_string(buf_cstring(&myconfig));
    buf_free(&myconfig);

    rend_sock = create_server_socket(&port);
    if (rend_sock < 0)
        return -1;

    server_state = get_anonymous_page();
    if (!server_state) {
        close(rend_sock);
        return -1;
    }
    server_state->rend_sock = rend_sock;

    if (verbose > 1)
        fprintf(stderr, "Bound to port tcp/%u\n", port);
    snprintf(default_service, sizeof(default_service), "%d", port);

    server_pid = server_start(server_state);
    if (server_pid < 0)
        return -1;

    /*
     * Initialise the SASL library in the client process.  This init
     * function can actually be called multiple times in the lifetime of
     * a test runner process, which is perhaps surprising, but we have
     * to deal with it.  We do however seem to be able to get away with
     * initialising SASL multiple times as long as we call sasl_done()
     * after we're done.
     */
    if (init_sasl(/*client*/1) < 0)
        return -1;
    sasl_initialised = 1;

    return 0;
}

/*
 * Test suite teardown function.  Shuts down the server and
 * removes the global server_state page.
 */
static int tear_down(void)
{
    int r;

    config_reset();

    if (verbose > 1)
        fprintf(stderr, "Cleaning up server! NOT.\n");
    if (server_pid > 1)
        server_shutdown(server_pid);
    if (server_state)
        free_anonymous_page(server_state);
    if (callbacks) {
        free_callbacks(callbacks);
        callbacks = NULL;
    }
    if (sasl_initialised) {
        sasl_done();
        sasl_initialised = 0;
    }

    r = system("rm -rf " DBDIR);

    return r;
}

/* ====================================================================== */
/* vim: set ft=c: */