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
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
|
/*
This file is part of libmicrohttpd
Copyright (C) 2007-2018 Daniel Pittman and Christian Grothoff
Copyright (C) 2014-2021 Evgeny Grin (Karlson2k)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file microhttpd/internal.h
* @brief MHD internal shared structures
* @author Daniel Pittman
* @author Christian Grothoff
* @author Karlson2k (Evgeny Grin)
*/
#ifndef INTERNAL_H
#define INTERNAL_H
#include "mhd_options.h"
#include "platform.h"
#include "microhttpd.h"
#include "mhd_assert.h"
#ifdef HTTPS_SUPPORT
#include <gnutls/gnutls.h>
#if GNUTLS_VERSION_MAJOR >= 3
#include <gnutls/abstract.h>
#endif
#endif /* HTTPS_SUPPORT */
#ifdef HAVE_STDBOOL_H
#include <stdbool.h>
#endif
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif /* HAVE_INTTYPES_H */
#ifndef PRIu64
#define PRIu64 "llu"
#endif /* ! PRIu64 */
/* Must be included before other internal headers! */
#include "mhd_panic.h"
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
#include "mhd_threads.h"
#endif
#include "mhd_locks.h"
#include "mhd_sockets.h"
#include "mhd_itc_types.h"
#include "mhd_str_types.h"
#if defined(BAUTH_SUPPORT) || defined(DAUTH_SUPPORT)
#include "gen_auth.h"
#endif /* BAUTH_SUPPORT || DAUTH_SUPPORT*/
/**
* Macro to drop 'const' qualifier from pointer without compiler warning.
* To be used *only* to deal with broken external APIs, which require non-const
* pointer to unmodifiable data.
* Must not be used to transform pointers for MHD needs.
*/
#define _MHD_DROP_CONST(ptr) ((void *) ((uintptr_t) ((const void *) (ptr))))
/**
* @def _MHD_MACRO_NO
* "Negative answer"/"false" for use in macros, meaningful for precompiler
*/
#define _MHD_MACRO_NO 0
/**
* @def _MHD_MACRO_YES
* "Positive answer"/"true" for use in macros, meaningful for precompiler
*/
#define _MHD_MACRO_YES 1
/**
* Close FD and abort execution if error is detected.
* @param fd the FD to close
*/
#define MHD_fd_close_chk_(fd) do { \
if ( (0 != close ((fd)) && (EBADF == errno)) ) { \
MHD_PANIC (_ ("Failed to close FD.\n")); \
} \
} while (0)
/*
#define EXTRA_CHECKS _MHD_MACRO_NO
* Not used. Behaviour is controlled by _DEBUG/NDEBUG macros.
*/
#ifndef _MHD_DEBUG_CONNECT
/**
* Print extra messages when establishing
* connections? (only adds non-error messages).
*/
#define _MHD_DEBUG_CONNECT _MHD_MACRO_NO
#endif /* ! _MHD_DEBUG_CONNECT */
#ifndef _MHD_DEBUG_SEND_DATA
/**
* Should all data send be printed to stderr?
*/
#define _MHD_DEBUG_SEND_DATA _MHD_MACRO_NO
#endif /* ! _MHD_DEBUG_SEND_DATA */
#ifndef _MHD_DEBUG_CLOSE
/**
* Add extra debug messages with reasons for closing connections
* (non-error reasons).
*/
#define _MHD_DEBUG_CLOSE _MHD_MACRO_NO
#endif /* ! _MHD_DEBUG_CLOSE */
#define MHD_MAX(a,b) (((a)<(b)) ? (b) : (a))
#define MHD_MIN(a,b) (((a)<(b)) ? (a) : (b))
/**
* Minimum reasonable size by which MHD tries to increment read/write buffers.
* We usually begin with half the available pool space for the
* IO-buffer, but if absolutely needed we additively grow by the
* number of bytes given here (up to -- theoretically -- the full pool
* space).
*/
#define MHD_BUF_INC_SIZE 1024
#ifndef MHD_STATICSTR_LEN_
/**
* Determine length of static string / macro strings at compile time.
*/
#define MHD_STATICSTR_LEN_(macro) (sizeof(macro) / sizeof(char) - 1)
#endif /* ! MHD_STATICSTR_LEN_ */
/**
* Tri-state on/off/unknown
*/
enum MHD_tristate
{
_MHD_UNKNOWN = -1, /**< State is not yet checked nor set */
_MHD_OFF = false, /**< State is "off" / "disabled" */
_MHD_NO = false, /**< State is "off" / "disabled" */
_MHD_ON = true, /**< State is "on" / "enabled" */
_MHD_YES = true /**< State is "on" / "enabled" */
} _MHD_FIXED_ENUM;
/**
* State of the socket with respect to epoll (bitmask).
*/
enum MHD_EpollState
{
/**
* The socket is not involved with a defined state in epoll() right
* now.
*/
MHD_EPOLL_STATE_UNREADY = 0,
/**
* epoll() told us that data was ready for reading, and we did
* not consume all of it yet.
*/
MHD_EPOLL_STATE_READ_READY = 1,
/**
* epoll() told us that space was available for writing, and we did
* not consume all of it yet.
*/
MHD_EPOLL_STATE_WRITE_READY = 2,
/**
* Is this connection currently in the 'eready' EDLL?
*/
MHD_EPOLL_STATE_IN_EREADY_EDLL = 4,
/**
* Is this connection currently in the epoll() set?
*/
MHD_EPOLL_STATE_IN_EPOLL_SET = 8,
/**
* Is this connection currently suspended?
*/
MHD_EPOLL_STATE_SUSPENDED = 16,
/**
* Is this connection in some error state?
*/
MHD_EPOLL_STATE_ERROR = 128
} _MHD_FIXED_FLAGS_ENUM;
/**
* What is this connection waiting for?
*/
enum MHD_ConnectionEventLoopInfo
{
/**
* We are waiting to be able to read.
*/
MHD_EVENT_LOOP_INFO_READ = 0,
/**
* We are waiting to be able to write.
*/
MHD_EVENT_LOOP_INFO_WRITE = 1,
/**
* We are waiting for the application to provide data.
*/
MHD_EVENT_LOOP_INFO_BLOCK = 2,
/**
* We are finished and are awaiting cleanup.
*/
MHD_EVENT_LOOP_INFO_CLEANUP = 3
} _MHD_FIXED_ENUM;
/**
* Additional test value for enum MHD_FLAG to check only for MHD_ALLOW_SUSPEND_RESUME and
* NOT for MHD_USE_ITC.
*/
#define MHD_TEST_ALLOW_SUSPEND_RESUME 8192
/**
* Maximum length of a nonce in digest authentication. 64(SHA-256 Hex) +
* 12(Timestamp Hex) + 1(NULL); hence 77 should suffice, but Opera
* (already) takes more (see Mantis #1633), so we've increased the
* value to support something longer...
*/
#define MAX_CLIENT_NONCE_LENGTH 129
/**
* The maximum size of MHD-generated nonce when printed with hexadecimal chars.
*
* This is equal to "(32 bytes for SHA-256 nonce plus 6 bytes for timestamp)
* multiplied by two hex chars per byte".
* Please keep it in sync with digestauth.c
*/
#define MAX_DIGEST_NONCE_LENGTH ((32 + 6) * 2)
/**
* A structure representing the internal holder of the
* nonce-nc map.
*/
struct MHD_NonceNc
{
/**
* Nonce counter, a value that increases for each subsequent
* request for the same nonce. Matches the largest last received
* 'nc' value.
* This 'nc' value was already used by the client.
*/
uint32_t nc;
/**
* Bitmask over the previous 64 nonce counter values (down to to nc-64).
* Used to allow out-of-order 'nc'.
* If bit in the bitmask is set to one, then this 'nc' value was already used
* by the client.
*/
uint64_t nmask;
/**
* Nonce value:
*/
char nonce[MAX_DIGEST_NONCE_LENGTH + 1];
};
#ifdef HAVE_MESSAGES
/**
* fprintf()-like helper function for logging debug
* messages.
*/
void
MHD_DLOG (const struct MHD_Daemon *daemon,
const char *format,
...);
#endif
/**
* Header or footer for HTTP response.
*/
struct MHD_HTTP_Res_Header
{
/**
* Headers are kept in a double-linked list.
*/
struct MHD_HTTP_Res_Header *next;
/**
* Headers are kept in a double-linked list.
*/
struct MHD_HTTP_Res_Header *prev;
/**
* The name of the header (key), without the colon.
*/
char *header;
/**
* The length of the @a header, not including the final zero termination.
*/
size_t header_size;
/**
* The value of the header.
*/
char *value;
/**
* The length of the @a value, not including the final zero termination.
*/
size_t value_size;
/**
* Type of the value.
*/
enum MHD_ValueKind kind;
};
/**
* Header, footer, or cookie for HTTP request.
*/
struct MHD_HTTP_Req_Header
{
/**
* Headers are kept in a double-linked list.
*/
struct MHD_HTTP_Req_Header *next;
/**
* Headers are kept in a double-linked list.
*/
struct MHD_HTTP_Req_Header *prev;
/**
* The name of the header (key), without the colon.
*/
const char *header;
/**
* The length of the @a header, not including the final zero termination.
*/
size_t header_size;
/**
* The value of the header.
*/
const char *value;
/**
* The length of the @a value, not including the final zero termination.
*/
size_t value_size;
/**
* Type of the value.
*/
enum MHD_ValueKind kind;
};
/**
* Automatically assigned flags
*/
enum MHD_ResponseAutoFlags
{
MHD_RAF_NO_FLAGS = 0, /**< No auto flags */
MHD_RAF_HAS_CONNECTION_HDR = 1 << 0, /**< Has "Connection" header */
MHD_RAF_HAS_CONNECTION_CLOSE = 1 << 1, /**< Has "Connection: close" */
MHD_RAF_HAS_TRANS_ENC_CHUNKED = 1 << 2, /**< Has "Transfer-Encoding: chunked" */
MHD_RAF_HAS_CONTENT_LENGTH = 1 << 3, /**< Has "Content-Length" header */
MHD_RAF_HAS_DATE_HDR = 1 << 4 /**< Has "Date" header */
} _MHD_FIXED_FLAGS_ENUM;
#if defined(MHD_WINSOCK_SOCKETS)
/**
* Internally used I/O vector type for use with winsock.
* Binary matches system "WSABUF".
*/
typedef struct _MHD_W32_iovec
{
unsigned long iov_len;
char *iov_base;
} MHD_iovec_;
#define MHD_IOV_ELMN_MAX_SIZE ULONG_MAX
typedef unsigned long MHD_iov_size_;
#elif defined(HAVE_SENDMSG) || defined(HAVE_WRITEV)
/**
* Internally used I/O vector type for use when writev or sendmsg
* is available. Matches system "struct iovec".
*/
typedef struct iovec MHD_iovec_;
#define MHD_IOV_ELMN_MAX_SIZE SIZE_MAX
typedef size_t MHD_iov_size_;
#else
/**
* Internally used I/O vector type for use when writev or sendmsg
* is not available.
*/
typedef struct MHD_IoVec MHD_iovec_;
#define MHD_IOV_ELMN_MAX_SIZE SIZE_MAX
typedef size_t MHD_iov_size_;
#endif
struct MHD_iovec_track_
{
/**
* The copy of array of iovec elements.
* The copy of elements are updated during sending.
* The number of elements is not changed during lifetime.
*/
MHD_iovec_ *iov;
/**
* The number of elements in @a iov.
* This value is not changed during lifetime.
*/
size_t cnt;
/**
* The number of sent elements.
* At the same time, it is the index of the next (or current) element
* to send.
*/
size_t sent;
};
/**
* Representation of a response.
*/
struct MHD_Response
{
/**
* Head of double-linked list of headers to send for the response.
*/
struct MHD_HTTP_Res_Header *first_header;
/**
* Tail of double-linked list of headers to send for the response.
*/
struct MHD_HTTP_Res_Header *last_header;
/**
* Buffer pointing to data that we are supposed
* to send as a response.
*/
const char *data;
/**
* Closure to give to the content reader @e crc
* and content reader free callback @e crfc.
*/
void *crc_cls;
/**
* How do we get more data? NULL if we are
* given all of the data up front.
*/
MHD_ContentReaderCallback crc;
/**
* NULL if data must not be freed, otherwise
* either user-specified callback or "&free".
*/
MHD_ContentReaderFreeCallback crfc;
#ifdef UPGRADE_SUPPORT
/**
* Application function to call once we are done sending the headers
* of the response; NULL unless this is a response created with
* #MHD_create_response_for_upgrade().
*/
MHD_UpgradeHandler upgrade_handler;
/**
* Closure for @e uh.
*/
void *upgrade_handler_cls;
#endif /* UPGRADE_SUPPORT */
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* Mutex to synchronize access to @e data, @e size and
* @e reference_count.
*/
MHD_mutex_ mutex;
#endif
/**
* The size of the response body.
* Set to #MHD_SIZE_UNKNOWN if size is not known.
*/
uint64_t total_size;
/**
* At what offset in the stream is the
* beginning of @e data located?
*/
uint64_t data_start;
/**
* Offset to start reading from when using @e fd.
*/
uint64_t fd_off;
/**
* Number of bytes ready in @e data (buffer may be larger
* than what is filled with payload).
*/
size_t data_size;
/**
* Size of the writable data buffer @e data.
*/
size_t data_buffer_size;
/**
* Reference count for this response. Free once the counter hits
* zero.
*/
unsigned int reference_count;
/**
* File-descriptor if this response is FD-backed.
*/
int fd;
/**
* Flags set for the MHD response.
*/
enum MHD_ResponseFlags flags;
/**
* Automatic flags set for the MHD response.
*/
enum MHD_ResponseAutoFlags flags_auto;
/**
* If the @e fd is a pipe (no sendfile()).
*/
bool is_pipe;
/**
* I/O vector used with MHD_create_response_from_iovec.
*/
MHD_iovec_ *data_iov;
/**
* Number of elements in data_iov.
*/
unsigned int data_iovcnt;
};
/**
* States in a state machine for a connection.
*
* The main transitions are any-state to #MHD_CONNECTION_CLOSED, any
* state to state+1, #MHD_CONNECTION_FOOTERS_SENT to
* #MHD_CONNECTION_INIT. #MHD_CONNECTION_CLOSED is the terminal state
* and #MHD_CONNECTION_INIT the initial state.
*
* Note that transitions for *reading* happen only after the input has
* been processed; transitions for *writing* happen after the
* respective data has been put into the write buffer (the write does
* not have to be completed yet). A transition to
* #MHD_CONNECTION_CLOSED or #MHD_CONNECTION_INIT requires the write
* to be complete.
*/
enum MHD_CONNECTION_STATE
{
/**
* Connection just started (no headers received).
* Waiting for the line with the request type, URL and version.
*/
MHD_CONNECTION_INIT = 0,
/**
* Part of the request line was received.
* Wait for complete line.
*/
MHD_CONNECTION_REQ_LINE_RECEIVING = MHD_CONNECTION_INIT + 1,
/**
* We got the URL (and request type and version). Wait for a header line.
*/
MHD_CONNECTION_URL_RECEIVED = MHD_CONNECTION_REQ_LINE_RECEIVING + 1,
/**
* We got part of a multi-line request header. Wait for the rest.
*/
MHD_CONNECTION_HEADER_PART_RECEIVED = MHD_CONNECTION_URL_RECEIVED + 1,
/**
* We got the request headers. Process them.
*/
MHD_CONNECTION_HEADERS_RECEIVED = MHD_CONNECTION_HEADER_PART_RECEIVED + 1,
/**
* We have processed the request headers. Send 100 continue.
*/
MHD_CONNECTION_HEADERS_PROCESSED = MHD_CONNECTION_HEADERS_RECEIVED + 1,
/**
* We have processed the headers and need to send 100 CONTINUE.
*/
MHD_CONNECTION_CONTINUE_SENDING = MHD_CONNECTION_HEADERS_PROCESSED + 1,
/**
* We have sent 100 CONTINUE (or do not need to). Read the message body.
*/
MHD_CONNECTION_CONTINUE_SENT = MHD_CONNECTION_CONTINUE_SENDING + 1,
/**
* We got the request body. Wait for a line of the footer.
*/
MHD_CONNECTION_BODY_RECEIVED = MHD_CONNECTION_CONTINUE_SENT + 1,
/**
* We got part of a line of the footer. Wait for the
* rest.
*/
MHD_CONNECTION_FOOTER_PART_RECEIVED = MHD_CONNECTION_BODY_RECEIVED + 1,
/**
* We received the entire footer.
*/
MHD_CONNECTION_FOOTERS_RECEIVED = MHD_CONNECTION_FOOTER_PART_RECEIVED + 1,
/**
* We received the entire request.
* Wait for a response to be queued.
*/
MHD_CONNECTION_FULL_REQ_RECEIVED = MHD_CONNECTION_FOOTERS_RECEIVED + 1,
/**
* Finished reading of the request and the response is ready.
* Switch internal logic from receiving to sending, prepare connection
* sending the reply and build the reply header.
*/
MHD_CONNECTION_START_REPLY = MHD_CONNECTION_FULL_REQ_RECEIVED + 1,
/**
* We have prepared the response headers in the write buffer.
* Send the response headers.
*/
MHD_CONNECTION_HEADERS_SENDING = MHD_CONNECTION_START_REPLY + 1,
/**
* We have sent the response headers. Get ready to send the body.
*/
MHD_CONNECTION_HEADERS_SENT = MHD_CONNECTION_HEADERS_SENDING + 1,
/**
* We are waiting for the client to provide more
* data of a non-chunked body.
*/
MHD_CONNECTION_NORMAL_BODY_UNREADY = MHD_CONNECTION_HEADERS_SENT + 1,
/**
* We are ready to send a part of a non-chunked body. Send it.
*/
MHD_CONNECTION_NORMAL_BODY_READY = MHD_CONNECTION_NORMAL_BODY_UNREADY + 1,
/**
* We are waiting for the client to provide a chunk of the body.
*/
MHD_CONNECTION_CHUNKED_BODY_UNREADY = MHD_CONNECTION_NORMAL_BODY_READY + 1,
/**
* We are ready to send a chunk.
*/
MHD_CONNECTION_CHUNKED_BODY_READY = MHD_CONNECTION_CHUNKED_BODY_UNREADY + 1,
/**
* We have sent the response body. Prepare the footers.
*/
MHD_CONNECTION_BODY_SENT = MHD_CONNECTION_CHUNKED_BODY_READY + 1,
/**
* We have prepared the response footer. Send it.
*/
MHD_CONNECTION_FOOTERS_SENDING = MHD_CONNECTION_BODY_SENT + 1,
/**
* We have sent the response footer. Shutdown or restart.
*/
MHD_CONNECTION_FOOTERS_SENT = MHD_CONNECTION_FOOTERS_SENDING + 1,
/**
* This connection is to be closed.
*/
MHD_CONNECTION_CLOSED = MHD_CONNECTION_FOOTERS_SENT + 1,
#ifdef UPGRADE_SUPPORT
/**
* Connection was "upgraded" and socket is now under the
* control of the application.
*/
MHD_CONNECTION_UPGRADE
#endif /* UPGRADE_SUPPORT */
} _MHD_FIXED_ENUM;
/**
* States of TLS transport layer.
*/
enum MHD_TLS_CONN_STATE
{
MHD_TLS_CONN_NO_TLS = 0, /**< Not a TLS connection (plain socket). */
MHD_TLS_CONN_INIT, /**< TLS connection is not established yet. */
MHD_TLS_CONN_HANDSHAKING, /**< TLS is in handshake process. */
MHD_TLS_CONN_CONNECTED, /**< TLS is established. */
MHD_TLS_CONN_WR_CLOSING, /**< Closing WR side of TLS layer. */
MHD_TLS_CONN_WR_CLOSED, /**< WR side of TLS layer is closed. */
MHD_TLS_CONN_TLS_CLOSING, /**< TLS session is terminating. */
MHD_TLS_CONN_TLS_CLOSED, /**< TLS session is terminated. */
MHD_TLS_CONN_TLS_FAILED, /**< TLS session failed. */
MHD_TLS_CONN_INVALID_STATE/**< Sentinel. Not a valid value. */
} _MHD_FIXED_ENUM;
/**
* Should all state transitions be printed to stderr?
*/
#define DEBUG_STATES _MHD_MACRO_NO
#ifdef HAVE_MESSAGES
#if DEBUG_STATES
const char *
MHD_state_to_string (enum MHD_CONNECTION_STATE state);
#endif
#endif
/**
* Function to receive plaintext data.
*
* @param conn the connection struct
* @param write_to where to write received data
* @param max_bytes maximum number of bytes to receive
* @return number of bytes written to @a write_to
*/
typedef ssize_t
(*ReceiveCallback) (struct MHD_Connection *conn,
void *write_to,
size_t max_bytes);
/**
* Function to transmit plaintext data.
*
* @param conn the connection struct
* @param read_from where to read data to transmit
* @param max_bytes maximum number of bytes to transmit
* @return number of bytes transmitted
*/
typedef ssize_t
(*TransmitCallback) (struct MHD_Connection *conn,
const void *read_from,
size_t max_bytes);
/**
* Ability to use same connection for next request
*/
enum MHD_ConnKeepAlive
{
/**
* Connection must be closed after sending response.
*/
MHD_CONN_MUST_CLOSE = -1,
/**
* KeelAlive state is not yet determined
*/
MHD_CONN_KEEPALIVE_UNKOWN = 0,
/**
* Connection can be used for serving next request
*/
MHD_CONN_USE_KEEPALIVE = 1,
/**
* Connection will be upgraded
*/
MHD_CONN_MUST_UPGRADE = 2
} _MHD_FIXED_ENUM;
enum MHD_HTTP_Version
{
/**
* Not a HTTP protocol or HTTP version is invalid.
*/
MHD_HTTP_VER_INVALID = -1,
/**
* HTTP version is not yet received from the client.
*/
MHD_HTTP_VER_UNKNOWN = 0,
/**
* HTTP version before 1.0, unsupported.
*/
MHD_HTTP_VER_TOO_OLD = 1,
/**
* HTTP version 1.0
*/
MHD_HTTP_VER_1_0 = 2,
/**
* HTTP version 1.1
*/
MHD_HTTP_VER_1_1 = 3,
/**
* HTTP version 1.2-1.9, must be used as 1.1
*/
MHD_HTTP_VER_1_2__1_9 = 4,
/**
* HTTP future version. Unsupported.
*/
MHD_HTTP_VER_FUTURE = 100
} _MHD_FIXED_ENUM;
/**
* Returns boolean 'true' if HTTP version is supported by MHD
*/
#define MHD_IS_HTTP_VER_SUPPORTED(ver) (MHD_HTTP_VER_1_0 <= (ver) && \
MHD_HTTP_VER_1_2__1_9 >= (ver))
/**
* Protocol should be used as HTTP/1.1 protocol.
*
* See the last paragraph of
* https://datatracker.ietf.org/doc/html/rfc7230#section-2.6
*/
#define MHD_IS_HTTP_VER_1_1_COMPAT(ver) (MHD_HTTP_VER_1_1 == (ver) || \
MHD_HTTP_VER_1_2__1_9 == (ver))
/**
* The HTTP method.
*
* Only primary methods (specified in RFC7231) are defined here.
*/
enum MHD_HTTP_Method
{
/**
* No request string has been received yet
*/
MHD_HTTP_MTHD_NO_METHOD = 0,
/**
* HTTP method GET
*/
MHD_HTTP_MTHD_GET = 1,
/**
* HTTP method HEAD
*/
MHD_HTTP_MTHD_HEAD = 2,
/**
* HTTP method POST
*/
MHD_HTTP_MTHD_POST = 3,
/**
* HTTP method PUT
*/
MHD_HTTP_MTHD_PUT = 4,
/**
* HTTP method DELETE
*/
MHD_HTTP_MTHD_DELETE = 5,
/**
* HTTP method CONNECT
*/
MHD_HTTP_MTHD_CONNECT = 6,
/**
* HTTP method OPTIONS
*/
MHD_HTTP_MTHD_OPTIONS = 7,
/**
* HTTP method TRACE
*/
MHD_HTTP_MTHD_TRACE = 8,
/**
* Other HTTP method. Check the string value.
*/
MHD_HTTP_MTHD_OTHER = 1000
} _MHD_FIXED_ENUM;
/**
* Request-specific values.
*
* Meaningful for the current request only.
*/
struct MHD_Request
{
/**
* HTTP version string (i.e. http/1.1). Allocated
* in pool.
*/
const char *version;
/**
* HTTP protocol version as enum.
*/
enum MHD_HTTP_Version http_ver;
/**
* Request method. Should be GET/POST/etc. Allocated in pool.
*/
const char *method;
/**
* The request method as enum.
*/
enum MHD_HTTP_Method http_mthd;
/**
* Requested URL (everything after "GET" only). Allocated
* in pool.
*/
const char *url;
/**
* The length of the @a url in characters, not including the terminating zero.
*/
size_t url_len;
/**
* Linked list of parsed headers.
*/
struct MHD_HTTP_Req_Header *headers_received;
/**
* Tail of linked list of parsed headers.
*/
struct MHD_HTTP_Req_Header *headers_received_tail;
/**
* Number of bytes we had in the HTTP header, set once we
* pass #MHD_CONNECTION_HEADERS_RECEIVED.
*/
size_t header_size;
/**
* How many more bytes of the body do we expect
* to read? #MHD_SIZE_UNKNOWN for unknown.
*/
uint64_t remaining_upload_size;
/**
* Are we receiving with chunked encoding?
* This will be set to #MHD_YES after we parse the headers and
* are processing the body with chunks.
* After we are done with the body and we are processing the footers;
* once the footers are also done, this will be set to #MHD_NO again
* (before the final call to the handler).
* It is used only for requests, chunked encoding for response is
* indicated by @a rp_props.
*/
bool have_chunked_upload;
/**
* If we are receiving with chunked encoding, where are we right
* now?
* Set to 0 if we are waiting to receive the chunk size;
* otherwise, this is the size of the current chunk.
* A value of zero is also used when we're at the end of the chunks.
*/
uint64_t current_chunk_size;
/**
* If we are receiving with chunked encoding, where are we currently
* with respect to the current chunk (at what offset / position)?
*/
uint64_t current_chunk_offset;
/**
* We allow the main application to associate some pointer with the
* HTTP request, which is passed to each #MHD_AccessHandlerCallback
* and some other API calls. Here is where we store it. (MHD does
* not know or care what it is).
*/
void *client_context;
/**
* Did we ever call the "default_handler" on this request?
* This flag determines if we have called the #MHD_OPTION_NOTIFY_COMPLETED
* handler when the request finishes.
*/
bool client_aware;
#ifdef BAUTH_SUPPORT
/**
* Basic Authorization parameters.
* The result of Basic Authorization header parsing.
* Allocated in the connection's pool.
*/
const struct MHD_RqBAuth *bauth;
/**
* Set to true if current request headers are checked for Basic Authorization
*/
bool bauth_tried;
#endif /* BAUTH_SUPPORT */
#ifdef DAUTH_SUPPORT
/**
* Digest Authorization parameters.
* The result of Digest Authorization header parsing.
* Allocated in the connection's pool.
*/
const struct MHD_RqDAuth *dauth;
/**
* Set to true if current request headers are checked for Digest Authorization
*/
bool dauth_tried;
#endif /* DAUTH_SUPPORT */
/**
* Last incomplete header line during parsing of headers.
* Allocated in pool. Only valid if state is
* either #MHD_CONNECTION_HEADER_PART_RECEIVED or
* #MHD_CONNECTION_FOOTER_PART_RECEIVED.
*/
char *last;
/**
* Position after the colon on the last incomplete header
* line during parsing of headers.
* Allocated in pool. Only valid if state is
* either #MHD_CONNECTION_HEADER_PART_RECEIVED or
* #MHD_CONNECTION_FOOTER_PART_RECEIVED.
*/
char *colon;
};
/**
* Reply-specific properties.
*/
struct MHD_Reply_Properties
{
bool set; /**< Indicates that other members are set and valid */
bool use_reply_body_headers; /**< Use reply body-specific headers */
bool send_reply_body; /**< Send reply body (can be zero-sized) */
bool chunked; /**< Use chunked encoding for reply */
};
#if defined(_MHD_HAVE_SENDFILE)
enum MHD_resp_sender_
{
MHD_resp_sender_std = 0,
MHD_resp_sender_sendfile
};
#endif /* _MHD_HAVE_SENDFILE */
/**
* Reply-specific values.
*
* Meaningful for the current reply only.
*/
struct MHD_Reply
{
/**
* Response to transmit (initially NULL).
*/
struct MHD_Response *response;
/**
* HTTP response code. Only valid if response object
* is already set.
*/
unsigned int responseCode;
/**
* The "ICY" response.
* Reply begins with the SHOUTcast "ICY" line instead of "HTTP".
*/
bool responseIcy;
/**
* Current write position in the actual response
* (excluding headers, content only; should be 0
* while sending headers).
*/
uint64_t rsp_write_position;
/**
* The copy of iov response.
* Valid if iovec response is used.
* Updated during send.
* Members are allocated in the pool.
*/
struct MHD_iovec_track_ resp_iov;
#if defined(_MHD_HAVE_SENDFILE)
enum MHD_resp_sender_ resp_sender;
#endif /* _MHD_HAVE_SENDFILE */
/**
* Reply-specific properties
*/
struct MHD_Reply_Properties props;
};
/**
* State kept for each HTTP request.
*/
struct MHD_Connection
{
#ifdef EPOLL_SUPPORT
/**
* Next pointer for the EDLL listing connections that are epoll-ready.
*/
struct MHD_Connection *nextE;
/**
* Previous pointer for the EDLL listing connections that are epoll-ready.
*/
struct MHD_Connection *prevE;
#endif
/**
* Next pointer for the DLL describing our IO state.
*/
struct MHD_Connection *next;
/**
* Previous pointer for the DLL describing our IO state.
*/
struct MHD_Connection *prev;
/**
* Next pointer for the XDLL organizing connections by timeout.
* This DLL can be either the
* 'manual_timeout_head/manual_timeout_tail' or the
* 'normal_timeout_head/normal_timeout_tail', depending on whether a
* custom timeout is set for the connection.
*/
struct MHD_Connection *nextX;
/**
* Previous pointer for the XDLL organizing connections by timeout.
*/
struct MHD_Connection *prevX;
/**
* Reference to the MHD_Daemon struct.
*/
struct MHD_Daemon *daemon;
/**
* Request-specific data
*/
struct MHD_Request rq;
/**
* Reply-specific data
*/
struct MHD_Reply rp;
/**
* The memory pool is created whenever we first read from the TCP
* stream and destroyed at the end of each request (and re-created
* for the next request). In the meantime, this pointer is NULL.
* The pool is used for all connection-related data except for the
* response (which maybe shared between connections) and the IP
* address (which persists across individual requests).
*/
struct MemoryPool *pool;
/**
* We allow the main application to associate some pointer with the
* TCP connection (which may span multiple HTTP requests). Here is
* where we store it. (MHD does not know or care what it is).
* The location is given to the #MHD_NotifyConnectionCallback and
* also accessible via #MHD_CONNECTION_INFO_SOCKET_CONTEXT.
*/
void *socket_context;
/**
* Close connection after sending response?
* Functions may change value from "Unknown" or "KeepAlive" to "Must close",
* but no functions reset value "Must Close" to any other value.
*/
enum MHD_ConnKeepAlive keepalive;
/**
* Buffer for reading requests. Allocated in pool. Actually one
* byte larger than @e read_buffer_size (if non-NULL) to allow for
* 0-termination.
*/
char *read_buffer;
/**
* Buffer for writing response (headers only). Allocated
* in pool.
*/
char *write_buffer;
/**
* Foreign address (of length @e addr_len). MALLOCED (not
* in pool!).
*/
struct sockaddr_storage *addr;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* Thread handle for this connection (if we are using
* one thread per connection).
*/
MHD_thread_handle_ID_ pid;
#endif
/**
* Size of @e read_buffer (in bytes).
* This value indicates how many bytes we're willing to read
* into the buffer.
*/
size_t read_buffer_size;
/**
* Position where we currently append data in @e read_buffer (the
* next char after the last valid position).
*/
size_t read_buffer_offset;
/**
* Size of @e write_buffer (in bytes).
*/
size_t write_buffer_size;
/**
* Offset where we are with sending from @e write_buffer.
*/
size_t write_buffer_send_offset;
/**
* Last valid location in write_buffer (where do we
* append and up to where is it safe to send?)
*/
size_t write_buffer_append_offset;
/**
* Position in the 100 CONTINUE message that
* we need to send when receiving http 1.1 requests.
*/
size_t continue_message_write_offset;
/**
* Length of the foreign address.
*/
socklen_t addr_len;
/**
* Last time this connection had any activity
* (reading or writing).
*/
uint64_t last_activity;
/**
* After how many milliseconds of inactivity should
* this connection time out?
* Zero for no timeout.
*/
uint64_t connection_timeout_ms;
/**
* Socket for this connection. Set to #MHD_INVALID_SOCKET if
* this connection has died (daemon should clean
* up in that case).
*/
MHD_socket socket_fd;
/**
* true if @e socket_fd is not TCP/IP (a UNIX domain socket, a pipe),
* false (TCP/IP) otherwise.
*/
enum MHD_tristate is_nonip;
/**
* true if #socket_fd is non-blocking, false otherwise.
*/
bool sk_nonblck;
/**
* true if connection socket has set SIGPIPE suppression
*/
bool sk_spipe_suppress;
/**
* Tracks TCP_CORK / TCP_NOPUSH of the connection socket.
*/
enum MHD_tristate sk_corked;
/**
* Tracks TCP_NODELAY state of the connection socket.
*/
enum MHD_tristate sk_nodelay;
/**
* Has this socket been closed for reading (i.e. other side closed
* the connection)? If so, we must completely close the connection
* once we are done sending our response (and stop trying to read
* from this socket).
*/
bool read_closed;
/**
* Some error happens during processing the connection therefore this
* connection must be closed.
* The error may come from the client side (like wrong request format),
* from the application side (like data callback returned error), or from
* the OS side (like out-of-memory).
*/
bool stop_with_error;
/**
* Response queued early, before the request is fully processed,
* the client upload is rejected.
* The connection cannot be reused for additional requests as the current
* request is incompletely read and it is unclear where is the initial
* byte of the next request.
*/
bool discard_request;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* Set to `true` if the thread has been joined.
*/
bool thread_joined;
#endif
/**
* Are we currently inside the "idle" handler (to avoid recursively
* invoking it).
*/
bool in_idle;
/**
* Connection is in the cleanup DL-linked list.
*/
bool in_cleanup;
#ifdef EPOLL_SUPPORT
/**
* What is the state of this socket in relation to epoll?
*/
enum MHD_EpollState epoll_state;
#endif
/**
* State in the FSM for this connection.
*/
enum MHD_CONNECTION_STATE state;
/**
* What is this connection waiting for?
*/
enum MHD_ConnectionEventLoopInfo event_loop_info;
/**
* Function used for reading HTTP request stream.
*/
ReceiveCallback recv_cls;
#ifdef UPGRADE_SUPPORT
/**
* If this connection was upgraded, this points to
* the upgrade response details such that the
* #thread_main_connection_upgrade()-logic can perform the
* bi-directional forwarding.
*/
struct MHD_UpgradeResponseHandle *urh;
#endif /* UPGRADE_SUPPORT */
#ifdef HTTPS_SUPPORT
/**
* State required for HTTPS/SSL/TLS support.
*/
gnutls_session_t tls_session;
/**
* State of connection's TLS layer
*/
enum MHD_TLS_CONN_STATE tls_state;
/**
* Could it be that we are ready to read due to TLS buffers
* even though the socket is not?
*/
bool tls_read_ready;
#endif /* HTTPS_SUPPORT */
/**
* Is the connection suspended?
*/
bool suspended;
/**
* Is the connection wanting to resume?
*/
volatile bool resuming;
/**
* Special member to be returned by #MHD_get_connection_info()
*/
union MHD_ConnectionInfo connection_info_dummy;
};
#ifdef UPGRADE_SUPPORT
/**
* Buffer we use for upgrade response handling in the unlikely
* case where the memory pool was so small it had no buffer
* capacity left. Note that we don't expect to _ever_ use this
* buffer, so it's mostly wasted memory (except that it allows
* us to handle a tricky error condition nicely). So no need to
* make this one big. Applications that want to perform well
* should just pick an adequate size for the memory pools.
*/
#define RESERVE_EBUF_SIZE 8
/**
* Context we pass to epoll() for each of the two sockets
* of a `struct MHD_UpgradeResponseHandle`. We need to do
* this so we can distinguish the two sockets when epoll()
* gives us event notifications.
*/
struct UpgradeEpollHandle
{
/**
* Reference to the overall response handle this struct is
* included within.
*/
struct MHD_UpgradeResponseHandle *urh;
/**
* The socket this event is kind-of about. Note that this is NOT
* necessarily the socket we are polling on, as for when we read
* from TLS, we epoll() on the connection's socket
* (`urh->connection->socket_fd`), while this then the application's
* socket (where the application will read from). Nevertheless, for
* the application to read, we need to first read from TLS, hence
* the two are related.
*
* Similarly, for writing to TLS, this epoll() will be on the
* connection's `socket_fd`, and this will merely be the FD which
* the application would write to. Hence this struct must always be
* interpreted based on which field in `struct
* MHD_UpgradeResponseHandle` it is (`app` or `mhd`).
*/
MHD_socket socket;
/**
* IO-state of the @e socket (or the connection's `socket_fd`).
*/
enum MHD_EpollState celi;
};
/**
* Handle given to the application to manage special
* actions relating to MHD responses that "upgrade"
* the HTTP protocol (i.e. to WebSockets).
*/
struct MHD_UpgradeResponseHandle
{
/**
* The connection for which this is an upgrade handle. Note that
* because a response may be shared over many connections, this may
* not be the only upgrade handle for the response of this connection.
*/
struct MHD_Connection *connection;
#ifdef HTTPS_SUPPORT
/**
* Kept in a DLL per daemon.
*/
struct MHD_UpgradeResponseHandle *next;
/**
* Kept in a DLL per daemon.
*/
struct MHD_UpgradeResponseHandle *prev;
#ifdef EPOLL_SUPPORT
/**
* Next pointer for the EDLL listing urhs that are epoll-ready.
*/
struct MHD_UpgradeResponseHandle *nextE;
/**
* Previous pointer for the EDLL listing urhs that are epoll-ready.
*/
struct MHD_UpgradeResponseHandle *prevE;
/**
* Specifies whether urh already in EDLL list of ready connections.
*/
bool in_eready_list;
#endif
/**
* The buffer for receiving data from TLS to
* be passed to the application. Contains @e in_buffer_size
* bytes (unless @e in_buffer_size is zero). Do not free!
*/
char *in_buffer;
/**
* The buffer for receiving data from the application to
* be passed to TLS. Contains @e out_buffer_size
* bytes (unless @e out_buffer_size is zero). Do not free!
*/
char *out_buffer;
/**
* Size of the @e in_buffer.
* Set to 0 if the TLS connection went down for reading or socketpair
* went down for writing.
*/
size_t in_buffer_size;
/**
* Size of the @e out_buffer.
* Set to 0 if the TLS connection went down for writing or socketpair
* went down for reading.
*/
size_t out_buffer_size;
/**
* Number of bytes actually in use in the @e in_buffer. Can be larger
* than @e in_buffer_size if and only if @a in_buffer_size is zero and
* we still have bytes that can be forwarded.
* Reset to zero if all data was forwarded to socketpair or
* if socketpair went down for writing.
*/
size_t in_buffer_used;
/**
* Number of bytes actually in use in the @e out_buffer. Can be larger
* than @e out_buffer_size if and only if @a out_buffer_size is zero and
* we still have bytes that can be forwarded.
* Reset to zero if all data was forwarded to TLS connection or
* if TLS connection went down for writing.
*/
size_t out_buffer_used;
/**
* The socket we gave to the application (r/w).
*/
struct UpgradeEpollHandle app;
/**
* If @a app_sock was a socketpair, our end of it, otherwise
* #MHD_INVALID_SOCKET; (r/w).
*/
struct UpgradeEpollHandle mhd;
/**
* Emergency IO buffer we use in case the memory pool has literally
* nothing left.
*/
char e_buf[RESERVE_EBUF_SIZE];
#endif /* HTTPS_SUPPORT */
/**
* Set to true after the application finished with the socket
* by #MHD_UPGRADE_ACTION_CLOSE.
*
* When BOTH @e was_closed (changed by command from application)
* AND @e clean_ready (changed internally by MHD) are set to
* #MHD_YES, function #MHD_resume_connection() will move this
* connection to cleanup list.
* @remark This flag could be changed from any thread.
*/
volatile bool was_closed;
/**
* Set to true if connection is ready for cleanup.
*
* In TLS mode functions #MHD_connection_finish_forward_() must
* be called before setting this flag to true.
*
* In thread-per-connection mode, true in this flag means
* that connection's thread exited or about to exit and will
* not use MHD_Connection::urh data anymore.
*
* In any mode true in this flag also means that
* MHD_Connection::urh data will not be used for socketpair
* forwarding and forwarding itself is finished.
*
* When BOTH @e was_closed (changed by command from application)
* AND @e clean_ready (changed internally by MHD) are set to
* true, function #MHD_resume_connection() will move this
* connection to cleanup list.
* @remark This flag could be changed from thread that process
* connection's recv(), send() and response.
*/
volatile bool clean_ready;
};
#endif /* UPGRADE_SUPPORT */
/**
* Signature of function called to log URI accesses.
*
* @param cls closure
* @param uri uri being accessed
* @param con connection handle
* @return new closure
*/
typedef void *
(*LogCallback)(void *cls,
const char *uri,
struct MHD_Connection *con);
/**
* Signature of function called to unescape URIs. See also
* #MHD_http_unescape().
*
* @param cls closure
* @param conn connection handle
* @param uri 0-terminated string to unescape (should be updated)
* @return length of the resulting string
*/
typedef size_t
(*UnescapeCallback)(void *cls,
struct MHD_Connection *conn,
char *uri);
/**
* State kept for each MHD daemon. All connections are kept in two
* doubly-linked lists. The first one reflects the state of the
* connection in terms of what operations we are waiting for (read,
* write, locally blocked, cleanup) whereas the second is about its
* timeout state (default or custom).
*/
struct MHD_Daemon
{
/**
* Callback function for all requests.
*/
MHD_AccessHandlerCallback default_handler;
/**
* Closure argument to default_handler.
*/
void *default_handler_cls;
/**
* Daemon's flags (bitfield).
*
* @remark Keep this member after pointer value to keep it
* properly aligned as it will be used as member of union MHD_DaemonInfo.
*/
enum MHD_FLAG options;
/**
* Head of doubly-linked list of new, externally added connections.
*/
struct MHD_Connection *new_connections_head;
/**
* Tail of doubly-linked list of new, externally added connections.
*/
struct MHD_Connection *new_connections_tail;
/**
* Head of doubly-linked list of our current, active connections.
*/
struct MHD_Connection *connections_head;
/**
* Tail of doubly-linked list of our current, active connections.
*/
struct MHD_Connection *connections_tail;
/**
* Head of doubly-linked list of our current but suspended connections.
*/
struct MHD_Connection *suspended_connections_head;
/**
* Tail of doubly-linked list of our current but suspended connections.
*/
struct MHD_Connection *suspended_connections_tail;
/**
* Head of doubly-linked list of connections to clean up.
*/
struct MHD_Connection *cleanup_head;
/**
* Tail of doubly-linked list of connections to clean up.
*/
struct MHD_Connection *cleanup_tail;
/**
* _MHD_YES if the @e listen_fd socket is a UNIX domain socket.
*/
enum MHD_tristate listen_is_unix;
#ifdef EPOLL_SUPPORT
/**
* Head of EDLL of connections ready for processing (in epoll mode).
*/
struct MHD_Connection *eready_head;
/**
* Tail of EDLL of connections ready for processing (in epoll mode)
*/
struct MHD_Connection *eready_tail;
/**
* File descriptor associated with our epoll loop.
*
* @remark Keep this member after pointer value to keep it
* properly aligned as it will be used as member of union MHD_DaemonInfo.
*/
int epoll_fd;
/**
* true if the @e listen_fd socket is in the 'epoll' set,
* false if not.
*/
bool listen_socket_in_epoll;
#ifdef UPGRADE_SUPPORT
#ifdef HTTPS_SUPPORT
/**
* File descriptor associated with the #run_epoll_for_upgrade() loop.
* Only available if #MHD_USE_HTTPS_EPOLL_UPGRADE is set.
*/
int epoll_upgrade_fd;
/**
* true if @e epoll_upgrade_fd is in the 'epoll' set,
* false if not.
*/
bool upgrade_fd_in_epoll;
#endif /* HTTPS_SUPPORT */
/**
* Head of EDLL of upgraded connections ready for processing (in epoll mode).
*/
struct MHD_UpgradeResponseHandle *eready_urh_head;
/**
* Tail of EDLL of upgraded connections ready for processing (in epoll mode)
*/
struct MHD_UpgradeResponseHandle *eready_urh_tail;
#endif /* UPGRADE_SUPPORT */
#endif /* EPOLL_SUPPORT */
/**
* Head of the XDLL of ALL connections with a default ('normal')
* timeout, sorted by timeout (earliest at the tail, most recently
* used connection at the head). MHD can just look at the tail of
* this list to determine the timeout for all of its elements;
* whenever there is an event of a connection, the connection is
* moved back to the tail of the list.
*
* All connections by default start in this list; if a custom
* timeout that does not match @e connection_timeout_ms is set, they
* are moved to the @e manual_timeout_head-XDLL.
* Not used in MHD_USE_THREAD_PER_CONNECTION mode as each thread
* needs only one connection-specific timeout.
*/
struct MHD_Connection *normal_timeout_head;
/**
* Tail of the XDLL of ALL connections with a default timeout,
* sorted by timeout (earliest timeout at the tail).
* Not used in MHD_USE_THREAD_PER_CONNECTION mode.
*/
struct MHD_Connection *normal_timeout_tail;
/**
* Head of the XDLL of ALL connections with a non-default/custom
* timeout, unsorted. MHD will do a O(n) scan over this list to
* determine the current timeout.
* Not used in MHD_USE_THREAD_PER_CONNECTION mode.
*/
struct MHD_Connection *manual_timeout_head;
/**
* Tail of the XDLL of ALL connections with a non-default/custom
* timeout, unsorted.
* Not used in MHD_USE_THREAD_PER_CONNECTION mode.
*/
struct MHD_Connection *manual_timeout_tail;
/**
* Function to call to check if we should accept or reject an
* incoming request. May be NULL.
*/
MHD_AcceptPolicyCallback apc;
/**
* Closure argument to apc.
*/
void *apc_cls;
/**
* Function to call when we are done processing
* a particular request. May be NULL.
*/
MHD_RequestCompletedCallback notify_completed;
/**
* Closure argument to @e notify_completed.
*/
void *notify_completed_cls;
/**
* Function to call when we are starting/stopping
* a connection. May be NULL.
*/
MHD_NotifyConnectionCallback notify_connection;
/**
* Closure argument to @e notify_connection.
*/
void *notify_connection_cls;
/**
* Function to call with the full URI at the
* beginning of request processing. May be NULL.
* <p>
* Returns the initial pointer to internal state
* kept by the client for the request.
*/
LogCallback uri_log_callback;
/**
* Closure argument to @e uri_log_callback.
*/
void *uri_log_callback_cls;
/**
* Function to call when we unescape escape sequences.
*/
UnescapeCallback unescape_callback;
/**
* Closure for @e unescape_callback.
*/
void *unescape_callback_cls;
/**
* Listen port.
*
* @remark Keep this member after pointer value to keep it
* properly aligned as it will be used as member of union MHD_DaemonInfo.
*/
uint16_t port;
#ifdef HAVE_MESSAGES
/**
* Function for logging error messages (if we
* support error reporting).
*/
MHD_LogCallback custom_error_log;
/**
* Closure argument to @e custom_error_log.
*/
void *custom_error_log_cls;
#endif
/**
* Pointer to master daemon (NULL if this is the master)
*/
struct MHD_Daemon *master;
/**
* Listen socket.
*
* @remark Keep this member after pointer value to keep it
* properly aligned as it will be used as member of union MHD_DaemonInfo.
*/
MHD_socket listen_fd;
/**
* Listen socket is non-blocking.
*/
bool listen_nonblk;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* Worker daemons (one per thread)
*/
struct MHD_Daemon *worker_pool;
#endif
/**
* Table storing number of connections per IP
*/
void *per_ip_connection_count;
/**
* Number of active parallel connections.
*
* @remark Keep this member after pointer value to keep it
* properly aligned as it will be used as member of union MHD_DaemonInfo.
*/
unsigned int connections;
/**
* Size of the per-connection memory pools.
*/
size_t pool_size;
/**
* Increment for growth of the per-connection memory pools.
*/
size_t pool_increment;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* Size of threads created by MHD.
*/
size_t thread_stack_size;
/**
* Number of worker daemons
*/
unsigned int worker_pool_size;
/**
* The select thread handle (if we have internal select)
*/
MHD_thread_handle_ID_ pid;
/**
* Mutex for per-IP connection counts.
*/
MHD_mutex_ per_ip_connection_mutex;
/**
* Mutex for (modifying) access to the "cleanup", "normal_timeout" and
* "manual_timeout" DLLs.
*/
MHD_mutex_ cleanup_connection_mutex;
/**
* Mutex for any access to the "new connections" DL-list.
*/
MHD_mutex_ new_connections_mutex;
#endif
/**
* Our #MHD_OPTION_SERVER_INSANITY level, bits indicating
* which sanity checks are off.
*/
enum MHD_DisableSanityCheck insanity_level;
/**
* Whether to allow/disallow/ignore reuse of listening address.
* The semantics is the following:
* 0: ignore (user did not ask for neither allow/disallow, use SO_REUSEADDR
* except W32)
* >0: allow (use SO_REUSEPORT on most platforms, SO_REUSEADDR on Windows)
* <0: disallow (mostly no action, SO_EXCLUSIVEADDRUSE on Windows or SO_EXCLBIND
* on Solaris)
*/
int listening_address_reuse;
/**
* Inter-thread communication channel (also used to unblock
* select() in non-threaded code).
*/
struct MHD_itc_ itc;
/**
* Are we shutting down?
*/
volatile bool shutdown;
/**
* Has this daemon been quiesced via #MHD_quiesce_daemon()?
* If so, we should no longer use the @e listen_fd (including
* removing it from the @e epoll_fd when possible).
*/
volatile bool was_quiesced;
/**
* Did we hit some system or process-wide resource limit while
* trying to accept() the last time? If so, we don't accept new
* connections until we close an existing one. This effectively
* temporarily lowers the "connection_limit" to the current
* number of connections.
*/
bool at_limit;
/*
* Do we need to process resuming connections?
*/
volatile bool resuming;
/**
* Indicate that new connections in @e new_connections_head list
* need to be processed.
*/
volatile bool have_new;
/**
* 'True' if some data is already waiting to be processed.
* If set to 'true' - zero timeout for select()/poll*()
* is used.
* Should be reset each time before processing connections
* and raised by any connection which require additional
* immediately processing (application does not provide
* data for response, data waiting in TLS buffers etc.)
*/
bool data_already_pending;
/**
* Limit on the number of parallel connections.
*/
unsigned int connection_limit;
/**
* After how many milliseconds of inactivity should
* this connection time out?
* Zero for no timeout.
*/
uint64_t connection_timeout_ms;
/**
* Maximum number of connections per IP, or 0 for
* unlimited.
*/
unsigned int per_ip_connection_limit;
/**
* Be neutral (zero), strict (1) or permissive (-1) to client.
*/
int strict_for_client;
/**
* True if SIGPIPE is blocked
*/
bool sigpipe_blocked;
#ifdef HTTPS_SUPPORT
#ifdef UPGRADE_SUPPORT
/**
* Head of DLL of upgrade response handles we are processing.
* Used for upgraded TLS connections when thread-per-connection
* is not used.
*/
struct MHD_UpgradeResponseHandle *urh_head;
/**
* Tail of DLL of upgrade response handles we are processing.
* Used for upgraded TLS connections when thread-per-connection
* is not used.
*/
struct MHD_UpgradeResponseHandle *urh_tail;
#endif /* UPGRADE_SUPPORT */
/**
* Desired cipher algorithms.
*/
gnutls_priority_t priority_cache;
/**
* What kind of credentials are we offering
* for SSL/TLS?
*/
gnutls_credentials_type_t cred_type;
/**
* Server x509 credentials
*/
gnutls_certificate_credentials_t x509_cred;
/**
* Diffie-Hellman parameters
*/
gnutls_dh_params_t dh_params;
/**
* Server PSK credentials
*/
gnutls_psk_server_credentials_t psk_cred;
#if GNUTLS_VERSION_MAJOR >= 3
/**
* Function that can be used to obtain the certificate. Needed
* for SNI support. See #MHD_OPTION_HTTPS_CERT_CALLBACK.
*/
gnutls_certificate_retrieve_function2 *cert_callback;
/**
* Function that can be used to obtain the shared key.
*/
MHD_PskServerCredentialsCallback cred_callback;
/**
* Closure for @e cred_callback.
*/
void *cred_callback_cls;
#endif
#if GNUTLS_VERSION_NUMBER >= 0x030603
/**
* Function that can be used to obtain the certificate. Needed
* for OCSP stapling support. See #MHD_OPTION_HTTPS_CERT_CALLBACK2.
*/
gnutls_certificate_retrieve_function3 *cert_callback2;
#endif
/**
* Pointer to our SSL/TLS key (in ASCII) in memory.
*/
const char *https_mem_key;
/**
* Pointer to our SSL/TLS certificate (in ASCII) in memory.
*/
const char *https_mem_cert;
/**
* Pointer to 0-terminated HTTPS passphrase in memory.
*/
const char *https_key_password;
/**
* Pointer to our SSL/TLS certificate authority (in ASCII) in memory.
*/
const char *https_mem_trust;
/**
* Our Diffie-Hellman parameters in memory.
*/
gnutls_dh_params_t https_mem_dhparams;
/**
* true if we have initialized @e https_mem_dhparams.
*/
bool have_dhparams;
/**
* true if ALPN is disabled.
*/
bool disable_alpn;
#endif /* HTTPS_SUPPORT */
#ifdef DAUTH_SUPPORT
/**
* Character array of random values.
*/
const char *digest_auth_random;
/**
* The malloc'ed copy of the @a digest_auth_random.
*/
void *digest_auth_random_copy;
/**
* An array that contains the map nonce-nc.
*/
struct MHD_NonceNc *nnc;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
/**
* A rw-lock for synchronizing access to @e nnc.
*/
MHD_mutex_ nnc_lock;
#endif
/**
* Size of `digest_auth_random.
*/
size_t digest_auth_rand_size;
/**
* Size of the nonce-nc array.
*/
unsigned int nonce_nc_size;
/**
* Nonce bind type.
*/
unsigned int dauth_bind_type;
#endif
#ifdef TCP_FASTOPEN
/**
* The queue size for incoming SYN + DATA packets.
*/
unsigned int fastopen_queue_size;
#endif
/**
* The size of queue for listen socket.
*/
unsigned int listen_backlog_size;
/**
* The number of user options used.
*
* Contains number of only meaningful options, i.e. #MHD_OPTION_END
* and #MHD_OPTION_ARRAY are not counted, while options inside
* #MHD_OPTION_ARRAY are counted.
*/
size_t num_opts;
/* TODO: replace with a single member */
/**
* The value to be returned by #MHD_get_daemon_info()
*/
union MHD_DaemonInfo daemon_info_dummy_listen_fd;
#ifdef EPOLL_SUPPORT
/**
* The value to be returned by #MHD_get_daemon_info()
*/
union MHD_DaemonInfo daemon_info_dummy_epoll_fd;
#endif /* EPOLL_SUPPORT */
/**
* The value to be returned by #MHD_get_daemon_info()
*/
union MHD_DaemonInfo daemon_info_dummy_num_connections;
/**
* The value to be returned by #MHD_get_daemon_info()
*/
union MHD_DaemonInfo daemon_info_dummy_flags;
/**
* The value to be returned by #MHD_get_daemon_info()
*/
union MHD_DaemonInfo daemon_info_dummy_port;
};
#ifdef DAUTH_SUPPORT
/**
* Parameter of request's Digest Authorization header
*/
struct MHD_RqDAuthParam
{
/**
* The string with length, NOT zero-terminated
*/
struct _MHD_str_w_len value;
/**
* True if string must be "unquoted" before processing.
* This member is false if the string is used in DQUOTE marks, but no
* backslash-escape is used in the string.
*/
bool quoted;
};
/**
* Request client's Digest Authorization header parameters
*/
struct MHD_RqDAuth
{
struct MHD_RqDAuthParam nonce;
struct MHD_RqDAuthParam opaque;
struct MHD_RqDAuthParam response;
struct MHD_RqDAuthParam username;
struct MHD_RqDAuthParam username_ext;
struct MHD_RqDAuthParam realm;
struct MHD_RqDAuthParam uri;
/* The raw QOP value, used in the 'response' calculation */
struct MHD_RqDAuthParam qop_raw;
struct MHD_RqDAuthParam cnonce;
struct MHD_RqDAuthParam nc;
/* Decoded values are below */
bool userhash; /* True if 'userhash' parameter has value 'true'. */
enum MHD_DigestAuthAlgo3 algo3;
enum MHD_DigestAuthQOP qop;
};
#endif /* DAUTH_SUPPORT */
/**
* Insert an element at the head of a DLL. Assumes that head, tail and
* element are structs with prev and next fields.
*
* @param head pointer to the head of the DLL
* @param tail pointer to the tail of the DLL
* @param element element to insert
*/
#define DLL_insert(head,tail,element) do { \
mhd_assert (NULL == (element)->next); \
mhd_assert (NULL == (element)->prev); \
(element)->next = (head); \
(element)->prev = NULL; \
if ((tail) == NULL) { \
(tail) = element; \
} else { \
(head)->prev = element; \
} \
(head) = (element); } while (0)
/**
* Remove an element from a DLL. Assumes
* that head, tail and element are structs
* with prev and next fields.
*
* @param head pointer to the head of the DLL
* @param tail pointer to the tail of the DLL
* @param element element to remove
*/
#define DLL_remove(head,tail,element) do { \
mhd_assert ( (NULL != (element)->next) || ((element) == (tail))); \
mhd_assert ( (NULL != (element)->prev) || ((element) == (head))); \
if ((element)->prev == NULL) { \
(head) = (element)->next; \
} else { \
(element)->prev->next = (element)->next; \
} \
if ((element)->next == NULL) { \
(tail) = (element)->prev; \
} else { \
(element)->next->prev = (element)->prev; \
} \
(element)->next = NULL; \
(element)->prev = NULL; } while (0)
/**
* Insert an element at the head of a XDLL. Assumes that head, tail and
* element are structs with prevX and nextX fields.
*
* @param head pointer to the head of the XDLL
* @param tail pointer to the tail of the XDLL
* @param element element to insert
*/
#define XDLL_insert(head,tail,element) do { \
mhd_assert (NULL == (element)->nextX); \
mhd_assert (NULL == (element)->prevX); \
(element)->nextX = (head); \
(element)->prevX = NULL; \
if (NULL == (tail)) { \
(tail) = element; \
} else { \
(head)->prevX = element; \
} \
(head) = (element); } while (0)
/**
* Remove an element from a XDLL. Assumes
* that head, tail and element are structs
* with prevX and nextX fields.
*
* @param head pointer to the head of the XDLL
* @param tail pointer to the tail of the XDLL
* @param element element to remove
*/
#define XDLL_remove(head,tail,element) do { \
mhd_assert ( (NULL != (element)->nextX) || ((element) == (tail))); \
mhd_assert ( (NULL != (element)->prevX) || ((element) == (head))); \
if (NULL == (element)->prevX) { \
(head) = (element)->nextX; \
} else { \
(element)->prevX->nextX = (element)->nextX; \
} \
if (NULL == (element)->nextX) { \
(tail) = (element)->prevX; \
} else { \
(element)->nextX->prevX = (element)->prevX; \
} \
(element)->nextX = NULL; \
(element)->prevX = NULL; } while (0)
/**
* Insert an element at the head of a EDLL. Assumes that head, tail and
* element are structs with prevE and nextE fields.
*
* @param head pointer to the head of the EDLL
* @param tail pointer to the tail of the EDLL
* @param element element to insert
*/
#define EDLL_insert(head,tail,element) do { \
(element)->nextE = (head); \
(element)->prevE = NULL; \
if ((tail) == NULL) { \
(tail) = element; \
} else { \
(head)->prevE = element; \
} \
(head) = (element); } while (0)
/**
* Remove an element from a EDLL. Assumes
* that head, tail and element are structs
* with prevE and nextE fields.
*
* @param head pointer to the head of the EDLL
* @param tail pointer to the tail of the EDLL
* @param element element to remove
*/
#define EDLL_remove(head,tail,element) do { \
if ((element)->prevE == NULL) { \
(head) = (element)->nextE; \
} else { \
(element)->prevE->nextE = (element)->nextE; \
} \
if ((element)->nextE == NULL) { \
(tail) = (element)->prevE; \
} else { \
(element)->nextE->prevE = (element)->prevE; \
} \
(element)->nextE = NULL; \
(element)->prevE = NULL; } while (0)
/**
* Convert all occurrences of '+' to ' '.
*
* @param arg string that is modified (in place), must be 0-terminated
*/
void
MHD_unescape_plus (char *arg);
/**
* Callback invoked when iterating over @a key / @a value
* argument pairs during parsing.
*
* @param cls context of the iteration
* @param key 0-terminated key string, never NULL
* @param key_size number of bytes in key
* @param value 0-terminated binary data, may include binary zeros, may be NULL
* @param value_size number of bytes in value
* @param kind origin of the key-value pair
* @return #MHD_YES on success (continue to iterate)
* #MHD_NO to signal failure (and abort iteration)
*/
typedef enum MHD_Result
(*MHD_ArgumentIterator_)(void *cls,
const char *key,
size_t key_size,
const char *value,
size_t value_size,
enum MHD_ValueKind kind);
/**
* Parse and unescape the arguments given by the client
* as part of the HTTP request URI.
*
* @param kind header kind to pass to @a cb
* @param connection connection to add headers to
* @param[in,out] args argument URI string (after "?" in URI),
* clobbered in the process!
* @param cb function to call on each key-value pair found
* @param cls the iterator context
* @return #MHD_NO on failure (@a cb returned #MHD_NO),
* #MHD_YES for success (parsing succeeded, @a cb always
* returned #MHD_YES)
*/
enum MHD_Result
MHD_parse_arguments_ (struct MHD_Connection *connection,
enum MHD_ValueKind kind,
char *args,
MHD_ArgumentIterator_ cb,
void *cls);
/**
* Check whether response header contains particular token.
*
* Token could be surrounded by spaces and tabs and delimited by comma.
* Case-insensitive match used for header names and tokens.
*
* @param response the response to query
* @param key header name
* @param key_len the length of @a key, not including optional
* terminating null-character.
* @param token the token to find
* @param token_len the length of @a token, not including optional
* terminating null-character.
* @return true if token is found in specified header,
* false otherwise
*/
bool
MHD_check_response_header_token_ci (const struct MHD_Response *response,
const char *key,
size_t key_len,
const char *token,
size_t token_len);
/**
* Check whether response header contains particular static @a tkn.
*
* Token could be surrounded by spaces and tabs and delimited by comma.
* Case-insensitive match used for header names and tokens.
* @param r the response to query
* @param k header name
* @param tkn the static string of token to find
* @return true if token is found in specified header,
* false otherwise
*/
#define MHD_check_response_header_s_token_ci(r,k,tkn) \
MHD_check_response_header_token_ci ((r),(k),MHD_STATICSTR_LEN_ (k), \
(tkn),MHD_STATICSTR_LEN_ (tkn))
/**
* Internal version of #MHD_suspend_connection().
*
* @remark In thread-per-connection mode: can be called from any thread,
* in any other mode: to be called only from thread that process
* daemon's select()/poll()/etc.
*
* @param connection the connection to suspend
*/
void
internal_suspend_connection_ (struct MHD_Connection *connection);
/**
* Trace up to and return master daemon. If the supplied daemon
* is a master, then return the daemon itself.
*
* @param daemon handle to a daemon
* @return master daemon handle
*/
_MHD_static_inline struct MHD_Daemon *
MHD_get_master (struct MHD_Daemon *const daemon)
{
struct MHD_Daemon *ret;
if (NULL != daemon->master)
ret = daemon->master;
else
ret = daemon;
mhd_assert (NULL == ret->master);
return ret;
}
#ifdef UPGRADE_SUPPORT
/**
* Mark upgraded connection as closed by application.
*
* The @a connection pointer must not be used after call of this function
* as it may be freed in other thread immediately.
* @param connection the upgraded connection to mark as closed by application
*/
void
MHD_upgraded_connection_mark_app_closed_ (struct MHD_Connection *connection);
#endif /* UPGRADE_SUPPORT */
#endif
|