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
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
|
#include "node_quic_session-inl.h" // NOLINT(build/include)
#include "aliased_buffer.h"
#include "aliased_struct-inl.h"
#include "allocated_buffer-inl.h"
#include "async_wrap-inl.h"
#include "debug_utils-inl.h"
#include "env-inl.h"
#include "node_crypto_common.h"
#include "ngtcp2/ngtcp2.h"
#include "nghttp3/nghttp3.h" // NGHTTP3_ALPN_H3
#include "ngtcp2/ngtcp2_crypto.h"
#include "ngtcp2/ngtcp2_crypto_openssl.h"
#include "node.h"
#include "node_buffer.h"
#include "node_crypto.h"
#include "node_errors.h"
#include "node_internals.h"
#include "node_http_common-inl.h"
#include "node_mem-inl.h"
#include "node_process.h"
#include "node_quic_buffer-inl.h"
#include "node_quic_crypto.h"
#include "node_quic_socket-inl.h"
#include "node_quic_stream-inl.h"
#include "node_quic_util-inl.h"
#include "node_quic_default_application.h"
#include "node_quic_http3_application.h"
#include "node_sockaddr-inl.h"
#include "stream_base-inl.h"
#include "v8.h"
#include "uv.h"
#include <algorithm>
#include <memory>
#include <vector>
#include <string>
#include <utility>
namespace node {
using crypto::EntropySource;
using crypto::SecureContext;
using v8::Array;
using v8::ArrayBufferView;
using v8::Context;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::HandleScope;
using v8::Integer;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::ObjectTemplate;
using v8::PropertyAttribute;
using v8::String;
using v8::Undefined;
using v8::Value;
using TryCatchScope = node::errors::TryCatchScope;
namespace quic {
QuicCallbackScope::QuicCallbackScope(QuicSession* session)
: session_(session),
private_(new InternalCallbackScope(
session->env(),
session->object(),
{
session->get_async_id(),
session->get_trigger_async_id()
})),
try_catch_(session->env()->isolate()) {
try_catch_.SetVerbose(true);
}
QuicCallbackScope::~QuicCallbackScope() {
Environment* env = session_->env();
if (UNLIKELY(try_catch_.HasCaught())) {
session_->crypto_context()->set_in_client_hello(false);
session_->crypto_context()->set_in_ocsp_request(false);
if (!try_catch_.HasTerminated() && env->can_call_into_js()) {
session_->set_last_error({
QUIC_ERROR_SESSION,
uint64_t{NGTCP2_INTERNAL_ERROR}
});
session_->Close();
CHECK(session_->is_destroyed());
}
private_->MarkAsFailed();
}
}
typedef ssize_t(*ngtcp2_close_fn)(
ngtcp2_conn* conn,
ngtcp2_path* path,
uint8_t* dest,
size_t destlen,
uint64_t error_code,
ngtcp2_tstamp ts);
namespace {
void SetConfig(QuicState* quic_state, int idx, uint64_t* val) {
AliasedFloat64Array& buffer = quic_state->quicsessionconfig_buffer;
uint64_t flags = static_cast<uint64_t>(buffer[IDX_QUIC_SESSION_CONFIG_COUNT]);
if (flags & (1ULL << idx))
*val = static_cast<uint64_t>(buffer[idx]);
}
// Forwards detailed(verbose) debugging information from ngtcp2. Enabled using
// the NODE_DEBUG_NATIVE=NGTCP2_DEBUG category.
void Ngtcp2DebugLog(void* user_data, const char* fmt, ...) {
va_list ap;
va_start(ap, fmt);
std::string format(fmt, strlen(fmt) + 1);
format[strlen(fmt)] = '\n';
// Debug() does not work with the va_list here. So we use vfprintf
// directly instead. Ngtcp2DebugLog is only enabled when the debug
// category is enabled.
vfprintf(stderr, format.c_str(), ap);
va_end(ap);
}
void CopyPreferredAddress(
uint8_t* dest,
size_t destlen,
uint16_t* port,
const sockaddr* addr) {
const sockaddr_in* src = reinterpret_cast<const sockaddr_in*>(addr);
memcpy(dest, &src->sin_addr, destlen);
*port = SocketAddress::GetPort(addr);
}
ngtcp2_close_fn SelectCloseFn(uint32_t family) {
return family == QUIC_ERROR_APPLICATION ?
ngtcp2_conn_write_application_close :
ngtcp2_conn_write_connection_close;
}
} // namespace
std::string QuicSession::RemoteTransportParamsDebug::ToString() const {
ngtcp2_transport_params params;
ngtcp2_conn_get_remote_transport_params(session->connection(), ¶ms);
std::string out = "Remote Transport Params:\n";
out += " Ack Delay Exponent: " +
std::to_string(params.ack_delay_exponent) + "\n";
out += " Active Connection ID Limit: " +
std::to_string(params.active_connection_id_limit) + "\n";
out += " Disable Active Migration: " +
std::string(params.disable_active_migration ? "Yes" : "No") + "\n";
out += " Initial Max Data: " +
std::to_string(params.initial_max_data) + "\n";
out += " Initial Max Stream Data Bidi Local: " +
std::to_string(params.initial_max_stream_data_bidi_local) + "\n";
out += " Initial Max Stream Data Bidi Remote: " +
std::to_string(params.initial_max_stream_data_bidi_remote) + "\n";
out += " Initial Max Stream Data Uni: " +
std::to_string(params.initial_max_stream_data_uni) + "\n";
out += " Initial Max Streams Bidi: " +
std::to_string(params.initial_max_streams_bidi) + "\n";
out += " Initial Max Streams Uni: " +
std::to_string(params.initial_max_streams_uni) + "\n";
out += " Max Ack Delay: " +
std::to_string(params.max_ack_delay) + "\n";
out += " Max Idle Timeout: " +
std::to_string(params.max_idle_timeout) + "\n";
out += " Max Packet Size: " +
std::to_string(params.max_udp_payload_size) + "\n";
if (!session->is_server()) {
if (params.retry_scid_present) {
QuicCID cid(params.original_dcid);
QuicCID retry(params.retry_scid);
out += " Original Connection ID: " + cid.ToString() + "\n";
out += " Retry SCID: " + retry.ToString() + "\n";
} else {
out += " Original Connection ID: N/A \n";
}
if (params.preferred_address_present) {
out += " Preferred Address Present: Yes\n";
// TODO(@jasnell): Serialize the IPv4 and IPv6 address options
} else {
out += " Preferred Address Present: No\n";
}
if (params.stateless_reset_token_present) {
StatelessResetToken token(params.stateless_reset_token);
out += " Stateless Reset Token: " + token.ToString() + "\n";
} else {
out += " Stateless Reset Token: N/A";
}
}
return out;
}
void QuicSessionConfig::ResetToDefaults(QuicState* quic_state) {
ngtcp2_settings_default(this);
initial_ts = uv_hrtime();
// Detailed(verbose) logging provided by ngtcp2 is only enabled
// when the NODE_DEBUG_NATIVE=NGTCP2_DEBUG category is used.
if (UNLIKELY(quic_state->env()->enabled_debug_list()->enabled(
DebugCategory::NGTCP2_DEBUG))) {
log_printf = Ngtcp2DebugLog;
}
transport_params.active_connection_id_limit =
DEFAULT_ACTIVE_CONNECTION_ID_LIMIT;
transport_params.initial_max_stream_data_bidi_local =
DEFAULT_MAX_STREAM_DATA_BIDI_LOCAL;
transport_params.initial_max_stream_data_bidi_remote =
DEFAULT_MAX_STREAM_DATA_BIDI_REMOTE;
transport_params.initial_max_stream_data_uni =
DEFAULT_MAX_STREAM_DATA_UNI;
transport_params.initial_max_streams_bidi =
DEFAULT_MAX_STREAMS_BIDI;
transport_params.initial_max_streams_uni =
DEFAULT_MAX_STREAMS_UNI;
transport_params.initial_max_data = DEFAULT_MAX_DATA;
transport_params.max_idle_timeout = DEFAULT_MAX_IDLE_TIMEOUT;
transport_params.max_udp_payload_size =
NGTCP2_DEFAULT_MAX_UDP_PAYLOAD_SIZE;
transport_params.max_ack_delay =
NGTCP2_DEFAULT_MAX_ACK_DELAY;
transport_params.disable_active_migration = 0;
transport_params.preferred_address_present = 0;
transport_params.stateless_reset_token_present = 0;
cc_algo = NGTCP2_CC_ALGO_RENO;
}
// Sets the QuicSessionConfig using an AliasedBuffer for efficiency.
void QuicSessionConfig::Set(
QuicState* quic_state,
const sockaddr* preferred_addr) {
ResetToDefaults(quic_state);
SetConfig(quic_state, IDX_QUIC_SESSION_ACTIVE_CONNECTION_ID_LIMIT,
&transport_params.active_connection_id_limit);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_STREAM_DATA_BIDI_LOCAL,
&transport_params.initial_max_stream_data_bidi_local);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_STREAM_DATA_BIDI_REMOTE,
&transport_params.initial_max_stream_data_bidi_remote);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_STREAM_DATA_UNI,
&transport_params.initial_max_stream_data_uni);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_DATA,
&transport_params.initial_max_data);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_STREAMS_BIDI,
&transport_params.initial_max_streams_bidi);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_STREAMS_UNI,
&transport_params.initial_max_streams_uni);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_IDLE_TIMEOUT,
&transport_params.max_idle_timeout);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_UDP_PAYLOAD_SIZE,
&transport_params.max_udp_payload_size);
SetConfig(quic_state, IDX_QUIC_SESSION_MAX_ACK_DELAY,
&transport_params.max_ack_delay);
SetConfig(quic_state,
IDX_QUIC_SESSION_CC_ALGO,
reinterpret_cast<uint64_t *>(&cc_algo));
transport_params.max_idle_timeout =
transport_params.max_idle_timeout * 1000000000;
// TODO(@jasnell): QUIC allows both IPv4 and IPv6 addresses to be
// specified. Here we're specifying one or the other. Need to
// determine if that's what we want or should we support both.
if (preferred_addr != nullptr) {
transport_params.preferred_address_present = 1;
switch (preferred_addr->sa_family) {
case AF_INET: {
CopyPreferredAddress(
transport_params.preferred_address.ipv4_addr,
sizeof(transport_params.preferred_address.ipv4_addr),
&transport_params.preferred_address.ipv4_port,
preferred_addr);
break;
}
case AF_INET6: {
CopyPreferredAddress(
transport_params.preferred_address.ipv6_addr,
sizeof(transport_params.preferred_address.ipv6_addr),
&transport_params.preferred_address.ipv6_port,
preferred_addr);
break;
}
default:
UNREACHABLE();
}
}
}
void QuicSessionListener::OnKeylog(const char* line, size_t len) {
if (previous_listener_ != nullptr)
previous_listener_->OnKeylog(line, len);
}
void QuicSessionListener::OnClientHello(
const char* alpn,
const char* server_name) {
if (previous_listener_ != nullptr)
previous_listener_->OnClientHello(alpn, server_name);
}
QuicSessionListener::~QuicSessionListener() {
if (session_)
session_->RemoveListener(this);
}
void QuicSessionListener::OnCert(const char* server_name) {
if (previous_listener_ != nullptr)
previous_listener_->OnCert(server_name);
}
void QuicSessionListener::OnOCSP(Local<Value> ocsp) {
if (previous_listener_ != nullptr)
previous_listener_->OnOCSP(ocsp);
}
void QuicSessionListener::OnStreamHeaders(
int64_t stream_id,
int kind,
const std::vector<std::unique_ptr<QuicHeader>>& headers,
int64_t push_id) {
if (previous_listener_ != nullptr)
previous_listener_->OnStreamHeaders(stream_id, kind, headers, push_id);
}
void QuicSessionListener::OnStreamClose(
int64_t stream_id,
uint64_t app_error_code) {
if (previous_listener_ != nullptr)
previous_listener_->OnStreamClose(stream_id, app_error_code);
}
void QuicSessionListener::OnStreamReset(
int64_t stream_id,
uint64_t app_error_code) {
if (previous_listener_ != nullptr)
previous_listener_->OnStreamReset(stream_id, app_error_code);
}
void QuicSessionListener::OnSessionClose(QuicError error, int flags) {
if (previous_listener_ != nullptr)
previous_listener_->OnSessionClose(error, flags);
}
void QuicSessionListener::OnStreamReady(BaseObjectPtr<QuicStream> stream) {
if (previous_listener_ != nullptr)
previous_listener_->OnStreamReady(stream);
}
void QuicSessionListener::OnHandshakeCompleted() {
if (previous_listener_ != nullptr)
previous_listener_->OnHandshakeCompleted();
}
void QuicSessionListener::OnPathValidation(
ngtcp2_path_validation_result res,
const sockaddr* local,
const sockaddr* remote) {
if (previous_listener_ != nullptr)
previous_listener_->OnPathValidation(res, local, remote);
}
void QuicSessionListener::OnSessionTicket(int size, SSL_SESSION* session) {
if (previous_listener_ != nullptr) {
previous_listener_->OnSessionTicket(size, session);
}
}
void QuicSessionListener::OnStreamBlocked(int64_t stream_id) {
if (previous_listener_ != nullptr) {
previous_listener_->OnStreamBlocked(stream_id);
}
}
void QuicSessionListener::OnUsePreferredAddress(
int family,
const PreferredAddress& preferred_address) {
if (previous_listener_ != nullptr)
previous_listener_->OnUsePreferredAddress(family, preferred_address);
}
void QuicSessionListener::OnVersionNegotiation(
uint32_t supported_version,
const uint32_t* versions,
size_t vcnt) {
if (previous_listener_ != nullptr)
previous_listener_->OnVersionNegotiation(supported_version, versions, vcnt);
}
void QuicSessionListener::OnQLog(QLogStream* qlog_stream) {
if (previous_listener_ != nullptr)
previous_listener_->OnQLog(qlog_stream);
}
void JSQuicSessionListener::OnKeylog(const char* line, size_t len) {
Environment* env = session()->env();
HandleScope handle_scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> line_buf;
if (!Buffer::Copy(env, line, 1 + len).ToLocal(&line_buf))
return;
char* data = Buffer::Data(line_buf);
data[len] = '\n';
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_keylog_function()->Call(
env->context(),
session()->object(),
1,
&line_buf));
}
void JSQuicSessionListener::OnStreamBlocked(int64_t stream_id) {
Environment* env = session()->env();
HandleScope handle_scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
BaseObjectPtr<QuicStream> stream = session()->FindStream(stream_id);
USE(env->quic_on_stream_blocked_function()->Call(
env->context(),
stream->object(),
0, nullptr));
}
void JSQuicSessionListener::OnClientHello(
const char* alpn,
const char* server_name) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
// Why this instead of using MakeCallback? We need to catch any
// errors that happen both when preparing the arguments and
// invoking the callback so that we can properly signal a failure
// to the peer.
QuicCallbackScope cb_scope(session());
Local<Array> ciphers;
Local<Value> alpn_string = Undefined(env->isolate());
Local<Value> servername = Undefined(env->isolate());
if (!session()->crypto_context()->hello_ciphers().ToLocal(&ciphers) ||
(alpn != nullptr &&
!String::NewFromUtf8(
env->isolate(),
alpn).ToLocal(&alpn_string)) ||
(server_name != nullptr &&
!String::NewFromUtf8(
env->isolate(),
server_name).ToLocal(&servername))) {
return;
}
Local<Value> argv[] = {
alpn_string,
servername,
ciphers
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_client_hello_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnCert(const char* server_name) {
Environment* env = session()->env();
HandleScope handle_scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> servername = Undefined(env->isolate());
if (UNLIKELY(server_name != nullptr &&
!String::NewFromUtf8(
env->isolate(),
server_name,
v8::NewStringType::kNormal,
strlen(server_name)).ToLocal(&servername))) {
return;
}
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_cert_function()->Call(
env->context(),
session()->object(),
1, &servername));
}
void JSQuicSessionListener::OnStreamHeaders(
int64_t stream_id,
int kind,
const std::vector<std::unique_ptr<QuicHeader>>& headers,
int64_t push_id) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
MaybeStackBuffer<Local<Value>, 16> head(headers.size());
size_t n = 0;
QuicCallbackScope cb_scope(session());
for (const auto& header : headers) {
Local<Value> pair[2];
if (UNLIKELY(!header->GetName(session()->application()).ToLocal(&pair[0])))
return;
if (UNLIKELY(!header->GetValue(session()->application()).ToLocal(&pair[1])))
return;
head[n++] = Array::New(env->isolate(), pair, arraysize(pair));
}
Local<Value> argv[] = {
Number::New(env->isolate(), static_cast<double>(stream_id)),
Array::New(env->isolate(), head.out(), n),
Integer::New(env->isolate(), kind),
Undefined(env->isolate())
};
if (kind == QUICSTREAM_HEADERS_KIND_PUSH)
argv[3] = Number::New(env->isolate(), static_cast<double>(push_id));
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_stream_headers_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnOCSP(Local<Value> ocsp) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_status_function()->Call(
env->context(),
session()->object(),
1, &ocsp));
}
void JSQuicSessionListener::OnStreamClose(
int64_t stream_id,
uint64_t app_error_code) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
Number::New(env->isolate(), static_cast<double>(stream_id)),
Number::New(env->isolate(), static_cast<double>(app_error_code))
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_stream_close_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnStreamReset(
int64_t stream_id,
uint64_t app_error_code) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
Number::New(env->isolate(), static_cast<double>(stream_id)),
Number::New(env->isolate(), static_cast<double>(app_error_code))
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_stream_reset_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnSessionClose(QuicError error, int flags) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
Number::New(env->isolate(), static_cast<double>(error.code)),
Integer::New(env->isolate(), error.family),
flags & SESSION_CLOSE_FLAG_SILENT
? v8::True(env->isolate())
: v8::False(env->isolate()),
flags & SESSION_CLOSE_FLAG_STATELESS_RESET
? v8::True(env->isolate())
: v8::False(env->isolate())
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_close_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnStreamReady(BaseObjectPtr<QuicStream> stream) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
stream->object(),
Number::New(env->isolate(), static_cast<double>(stream->id())),
Number::New(env->isolate(), static_cast<double>(stream->push_id()))
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_stream_ready_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnHandshakeCompleted() {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCryptoContext* ctx = session()->crypto_context();
QuicCallbackScope cb_scope(session());
Local<Value> servername = Undefined(env->isolate());
Local<Value> validationErrorReason = v8::Null(env->isolate());
Local<Value> validationErrorCode = v8::Null(env->isolate());
Local<Value> cipher_name;
Local<Value> cipher_version;
const char* hostname = ctx->servername();
if (hostname != nullptr &&
!String::NewFromUtf8(env->isolate(), hostname).ToLocal(&servername)) {
return;
}
if (!ctx->cipher_name().ToLocal(&cipher_name) ||
!ctx->cipher_version().ToLocal(&cipher_version)) {
return;
}
int err = ctx->VerifyPeerIdentity();
if (err != X509_V_OK &&
(!crypto::GetValidationErrorReason(env, err)
.ToLocal(&validationErrorReason) ||
!crypto::GetValidationErrorCode(env, err)
.ToLocal(&validationErrorCode))) {
return;
}
Local<Value> argv[] = {
servername,
GetALPNProtocol(*session()),
cipher_name,
cipher_version,
Integer::New(env->isolate(), session()->max_pktlen_),
validationErrorReason,
validationErrorCode,
session()->crypto_context()->early_data() ?
v8::True(env->isolate()) :
v8::False(env->isolate())
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_handshake_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnPathValidation(
ngtcp2_path_validation_result res,
const sockaddr* local,
const sockaddr* remote) {
// This is a fairly expensive operation because both the local and
// remote addresses have to converted into JavaScript objects. We
// only do this if a pathValidation handler is registered.
Environment* env = session()->env();
HandleScope scope(env->isolate());
Local<Context> context = env->context();
Context::Scope context_scope(context);
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
Integer::New(env->isolate(), res),
AddressToJS(env, local),
AddressToJS(env, remote)
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_path_validation_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnSessionTicket(int size, SSL_SESSION* sess) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> argv[] = {
v8::Undefined(env->isolate()),
v8::Undefined(env->isolate())
};
if (size > 0) {
AllocatedBuffer session_ticket =
AllocatedBuffer::AllocateManaged(env, size);
unsigned char* session_data =
reinterpret_cast<unsigned char*>(session_ticket.data());
memset(session_data, 0, size);
if (i2d_SSL_SESSION(sess, &session_data) > 0 &&
!session_ticket.ToBuffer().ToLocal(&argv[0])) {
return;
}
}
if (session()->is_transport_params_set() &&
!Buffer::Copy(env,
reinterpret_cast<const char*>(&session()->transport_params_),
sizeof(session()->transport_params_)).ToLocal(&argv[1])) {
return;
}
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_ticket_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnUsePreferredAddress(
int family,
const PreferredAddress& preferred_address) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Local<Context> context = env->context();
Context::Scope context_scope(context);
QuicCallbackScope cb_scope(session());
std::string hostname = family == AF_INET ?
preferred_address.ipv4_address():
preferred_address.ipv6_address();
uint16_t port =
family == AF_INET ?
preferred_address.ipv4_port() :
preferred_address.ipv6_port();
Local<Value> argv[] = {
OneByteString(env->isolate(), hostname.c_str()),
Integer::NewFromUnsigned(env->isolate(), port),
Integer::New(env->isolate(), family)
};
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_use_preferred_address_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnVersionNegotiation(
uint32_t supported_version,
const uint32_t* vers,
size_t vcnt) {
Environment* env = session()->env();
HandleScope scope(env->isolate());
Local<Context> context = env->context();
Context::Scope context_scope(context);
QuicCallbackScope cb_scope(session());
MaybeStackBuffer<Local<Value>, 4> versions(vcnt);
for (size_t n = 0; n < vcnt; n++)
versions[n] = Integer::New(env->isolate(), vers[n]);
// Currently, we only support one version of QUIC but in
// the future that may change. The callback below passes
// an array back to the JavaScript side to future-proof.
Local<Value> supported =
Integer::New(env->isolate(), supported_version);
Local<Value> argv[] = {
Integer::New(env->isolate(), NGTCP2_PROTO_VER),
Array::New(env->isolate(), versions.out(), vcnt),
Array::New(env->isolate(), &supported, 1)
};
// Grab a shared pointer to this to prevent the QuicSession
// from being freed while the MakeCallback is running.
BaseObjectPtr<QuicSession> ptr(session());
USE(env->quic_on_session_version_negotiation_function()->Call(
env->context(),
session()->object(),
arraysize(argv),
argv));
}
void JSQuicSessionListener::OnQLog(QLogStream* qlog_stream) {
CHECK_NOT_NULL(qlog_stream);
Environment* env = session()->env();
HandleScope handle_scope(env->isolate());
Context::Scope context_scope(env->context());
QuicCallbackScope cb_scope(session());
Local<Value> obj = qlog_stream->object();
USE(env->quic_on_session_qlog_function()->Call(
env->context(),
session()->object(),
1, &obj));
}
// Generates a new random connection ID.
void QuicSession::RandomConnectionIDStrategy(
QuicSession* session,
ngtcp2_cid* cid,
size_t cidlen) {
// CID min and max length is determined by the QUIC specification.
CHECK_LE(cidlen, NGTCP2_MAX_CIDLEN);
CHECK_GE(cidlen, NGTCP2_MIN_CIDLEN);
cid->datalen = cidlen;
// cidlen shouldn't ever be zero here but just in case that
// behavior changes in ngtcp2 in the future...
if (LIKELY(cidlen > 0))
EntropySource(cid->data, cidlen);
}
// Check required capabilities were not excluded from the OpenSSL build:
// - OPENSSL_NO_SSL_TRACE excludes SSL_trace()
// - OPENSSL_NO_STDIO excludes BIO_new_fp()
// HAVE_SSL_TRACE is available on the internal tcp_wrap binding for the tests.
#if defined(OPENSSL_NO_SSL_TRACE) || defined(OPENSSL_NO_STDIO)
# define HAVE_SSL_TRACE 0
#else
# define HAVE_SSL_TRACE 1
#endif
QuicCryptoContext::~QuicCryptoContext() {
// Free any remaining crypto handshake data (if any)
Cancel();
}
void QuicCryptoContext::MemoryInfo(MemoryTracker* tracker) const {
tracker->TrackField("initial_crypto", handshake_[0]);
tracker->TrackField("handshake_crypto", handshake_[1]);
tracker->TrackField("app_crypto", handshake_[2]);
tracker->TrackField("ocsp_response", ocsp_response_);
}
bool QuicCryptoContext::SetSecrets(
ngtcp2_crypto_level level,
const uint8_t* rx_secret,
const uint8_t* tx_secret,
size_t secretlen) {
static constexpr int kCryptoKeylen = 64;
static constexpr int kCryptoIvlen = 64;
static constexpr char kQuicClientEarlyTrafficSecret[] =
"QUIC_CLIENT_EARLY_TRAFFIC_SECRET";
static constexpr char kQuicClientHandshakeTrafficSecret[] =
"QUIC_CLIENT_HANDSHAKE_TRAFFIC_SECRET";
static constexpr char kQuicClientTrafficSecret0[] =
"QUIC_CLIENT_TRAFFIC_SECRET_0";
static constexpr char kQuicServerHandshakeTrafficSecret[] =
"QUIC_SERVER_HANDSHAKE_TRAFFIC_SECRET";
static constexpr char kQuicServerTrafficSecret[] =
"QUIC_SERVER_TRAFFIC_SECRET_0";
uint8_t rx_key[kCryptoKeylen];
uint8_t rx_hp[kCryptoKeylen];
uint8_t tx_key[kCryptoKeylen];
uint8_t tx_hp[kCryptoKeylen];
uint8_t rx_iv[kCryptoIvlen];
uint8_t tx_iv[kCryptoIvlen];
if (NGTCP2_ERR(ngtcp2_crypto_derive_and_install_rx_key(
session()->connection(),
rx_key,
rx_iv,
rx_hp,
level,
rx_secret,
secretlen))) {
return false;
}
if (NGTCP2_ERR(ngtcp2_crypto_derive_and_install_tx_key(
session()->connection(),
tx_key,
tx_iv,
tx_hp,
level,
tx_secret,
secretlen))) {
return false;
}
switch (level) {
case NGTCP2_CRYPTO_LEVEL_EARLY:
crypto::LogSecret(
ssl_,
kQuicClientEarlyTrafficSecret,
rx_secret,
secretlen);
break;
case NGTCP2_CRYPTO_LEVEL_HANDSHAKE:
crypto::LogSecret(
ssl_,
kQuicClientHandshakeTrafficSecret,
rx_secret,
secretlen);
crypto::LogSecret(
ssl_,
kQuicServerHandshakeTrafficSecret,
tx_secret,
secretlen);
break;
case NGTCP2_CRYPTO_LEVEL_APP:
crypto::LogSecret(
ssl_,
kQuicClientTrafficSecret0,
rx_secret,
secretlen);
crypto::LogSecret(
ssl_,
kQuicServerTrafficSecret,
tx_secret,
secretlen);
break;
default:
UNREACHABLE();
}
return true;
}
void QuicCryptoContext::AcknowledgeCryptoData(
ngtcp2_crypto_level level,
uint64_t datalen) {
// It is possible for the QuicSession to have been destroyed but not yet
// deconstructed. In such cases, we want to ignore the callback as there
// is nothing to do but wait for further cleanup to happen.
if (UNLIKELY(session_->is_destroyed()))
return;
Debug(session(),
"Acknowledging %" PRIu64 " crypto bytes for %s level",
datalen,
crypto_level_name(level));
// Consumes (frees) the given number of bytes in the handshake buffer.
handshake_[level].Consume(static_cast<size_t>(datalen));
// Update the statistics for the handshake, allowing us to track
// how long the handshake is taking to be acknowledged. A malicious
// peer could potentially force the QuicSession to hold on to
// crypto data for a long time by not sending an acknowledgement.
// The histogram will allow us to track the time periods between
// acknowlegements.
session()->RecordAck(&QuicSessionStats::handshake_acked_at);
}
void QuicCryptoContext::EnableTrace() {
#if HAVE_SSL_TRACE
if (!bio_trace_) {
bio_trace_.reset(BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT));
SSL_set_msg_callback(
ssl_.get(),
[](int write_p,
int version,
int content_type,
const void* buf,
size_t len,
SSL* ssl,
void* arg) -> void {
crypto::MarkPopErrorOnReturn mark_pop_error_on_return;
SSL_trace(write_p, version, content_type, buf, len, ssl, arg);
});
SSL_set_msg_callback_arg(ssl_.get(), bio_trace_.get());
}
#endif
}
// If a 'clientHello' event listener is registered on the JavaScript
// QuicServerSession object, the STATE_CLIENT_HELLO_ENABLED state
// will be set and the OnClientHello will cause the 'clientHello'
// event to be emitted.
//
// The 'clientHello' callback will be given it's own callback function
// that must be called when the client has completed handling the event.
// The handshake will not continue until it is called.
//
// The intent here is to allow user code the ability to modify or
// replace the SecurityContext based on the server name, ALPN, or
// other handshake characteristics.
//
// The user can also set a 'cert' event handler that will be called
// when the peer certificate is received, allowing additional tweaks
// and verifications to be performed.
int QuicCryptoContext::OnClientHello() {
if (LIKELY(session_->state_->client_hello_enabled == 0))
return 0;
TLSCallbackScope callback_scope(this);
if (is_in_client_hello())
return -1;
set_in_client_hello();
QuicCryptoContext* ctx = session_->crypto_context();
session_->listener()->OnClientHello(
ctx->hello_alpn(),
ctx->hello_servername());
// Returning -1 here will keep the TLS handshake paused until the
// client hello callback is invoked. Returning 0 means that the
// handshake is ready to proceed. When the OnClientHello callback
// is called above, it may be resolved synchronously or asynchronously.
// In case it is resolved synchronously, we need the check below.
return is_in_client_hello() ? -1 : 0;
}
// The OnCert callback provides an opportunity to prompt the server to
// perform on OCSP request on behalf of the client (when the client
// requests it). If there is a listener for the 'OCSPRequest' event
// on the JavaScript side, the IDX_QUIC_SESSION_STATE_CERT_ENABLED
// session state slot will equal 1, which will cause the callback to
// be invoked. The callback will be given a reference to a JavaScript
// function that must be called in order for the TLS handshake to
// continue.
int QuicCryptoContext::OnOCSP() {
if (LIKELY(session_->state_->ocsp_enabled == 0)) {
Debug(session(), "No OCSPRequest handler registered");
return 1;
}
if (!session_->is_server())
return 1;
Debug(session(), "Client is requesting an OCSP Response");
TLSCallbackScope callback_scope(this);
// As in node_crypto.cc, this is not an error, but does suspend the
// handshake to continue when OnOCSP is complete.
if (is_in_ocsp_request())
return -1;
set_in_ocsp_request();
session_->listener()->OnCert(session_->crypto_context()->servername());
// Returning -1 here means that we are still waiting for the OCSP
// request to be completed. When the OnCert handler is invoked
// above, it can be resolve synchronously or asynchonously. If
// resolved synchronously, we need the check below.
return is_in_ocsp_request() ? -1 : 1;
}
void QuicCryptoContext::OnClientHelloDone(
BaseObjectPtr<SecureContext> context) {
Debug(session(),
"ClientHello completed. Context Provided? %s\n",
context ? "Yes" : "No");
// Continue the TLS handshake when this function exits
// otherwise it will stall and fail.
TLSHandshakeScope handshake_scope(
this,
[&]() { set_in_client_hello(false); });
// Disable the callback at this point so we don't loop continuously
session_->state_->client_hello_enabled = 0;
if (context) {
int err = crypto::UseSNIContext(ssl_, context);
if (!err) {
unsigned long err = ERR_get_error(); // NOLINT(runtime/int)
return !err ?
THROW_ERR_QUIC_FAILURE_SETTING_SNI_CONTEXT(session_->env()) :
crypto::ThrowCryptoError(session_->env(), err);
}
secure_context_ = context;
}
}
// The OnCertDone function is called by the QuicSessionOnCertDone
// function when usercode is done handling the OCSPRequest event.
void QuicCryptoContext::OnOCSPDone(Local<Value> ocsp_response) {
Debug(session(),
"OCSPRequest completed. Response Provided? %s",
ocsp_response->IsArrayBufferView() ? "Yes" : "No");
// Continue the TLS handshake when this function exits
// otherwise it will stall and fail.
TLSHandshakeScope handshake_scope(
this,
[&]() { set_in_ocsp_request(false); });
// Disable the callback at this point so we don't loop continuously
session_->state_->ocsp_enabled = 0;
if (ocsp_response->IsArrayBufferView()) {
ocsp_response_.Reset(
session_->env()->isolate(),
ocsp_response.As<ArrayBufferView>());
}
}
// At this point in time, the TLS handshake secrets have been
// generated by openssl for this end of the connection and are
// ready to be used. Within this function, we need to install
// the secrets into the ngtcp2 connection object, store the
// remote transport parameters, and begin initialization of
// the QuicApplication that was selected.
bool QuicCryptoContext::OnSecrets(
ngtcp2_crypto_level level,
const uint8_t* rx_secret,
const uint8_t* tx_secret,
size_t secretlen) {
Debug(session(),
"Received secrets for %s crypto level",
crypto_level_name(level));
if (!SetSecrets(level, rx_secret, tx_secret, secretlen))
return false;
if (level == NGTCP2_CRYPTO_LEVEL_APP) {
session_->set_remote_transport_params();
if (!session()->InitApplication())
return false;
}
return true;
}
// When the client has requested OSCP, this function will be called to provide
// the OSCP response. The OnCert() callback should have already been called
// by this point if any data is to be provided. If it hasn't, and ocsp_response_
// is empty, no OCSP response will be sent.
int QuicCryptoContext::OnTLSStatus() {
Environment* env = session_->env();
HandleScope scope(env->isolate());
Context::Scope context_scope(env->context());
switch (side_) {
case NGTCP2_CRYPTO_SIDE_SERVER: {
if (ocsp_response_.IsEmpty()) {
Debug(session(), "There is no OCSP response");
return SSL_TLSEXT_ERR_NOACK;
}
Local<ArrayBufferView> obj =
PersistentToLocal::Default(
env->isolate(),
ocsp_response_);
size_t len = obj->ByteLength();
unsigned char* data = crypto::MallocOpenSSL<unsigned char>(len);
obj->CopyContents(data, len);
Debug(session(), "There is an OCSP response of %d bytes", len);
if (!SSL_set_tlsext_status_ocsp_resp(ssl_.get(), data, len))
OPENSSL_free(data);
ocsp_response_.Reset();
return SSL_TLSEXT_ERR_OK;
}
case NGTCP2_CRYPTO_SIDE_CLIENT: {
// Only invoke the callback if the ocsp handler is actually set
if (LIKELY(session_->state_->ocsp_enabled == 0))
return 1;
Local<Value> res;
if (ocsp_response().ToLocal(&res))
session_->listener()->OnOCSP(res);
return 1;
}
default:
UNREACHABLE();
}
}
// Called by ngtcp2 when a chunk of peer TLS handshake data is received.
// For every chunk, we move the TLS handshake further along until it
// is complete.
int QuicCryptoContext::Receive(
ngtcp2_crypto_level crypto_level,
uint64_t offset,
const uint8_t* data,
size_t datalen) {
if (UNLIKELY(session_->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
// Statistics are collected so we can monitor how long the
// handshake is taking to operate and complete.
if (session_->GetStat(&QuicSessionStats::handshake_start_at) == 0)
session_->RecordTimestamp(&QuicSessionStats::handshake_start_at);
session_->RecordTimestamp(&QuicSessionStats::handshake_continue_at);
Debug(session(), "Receiving %d bytes of crypto data", datalen);
// Internally, this passes the handshake data off to openssl
// for processing. The handshake may or may not complete.
int ret = ngtcp2_crypto_read_write_crypto_data(
session_->connection(),
crypto_level,
data,
datalen);
switch (ret) {
case 0:
return 0;
// In either of following cases, the handshake is being
// paused waiting for user code to take action (for instance
// OCSP requests or client hello modification)
case NGTCP2_CRYPTO_ERR_TLS_WANT_X509_LOOKUP:
Debug(session(), "TLS handshake wants X509 Lookup");
return 0;
case NGTCP2_CRYPTO_ERR_TLS_WANT_CLIENT_HELLO_CB:
Debug(session(), "TLS handshake wants client hello callback");
return 0;
default:
return ret;
}
}
// Triggers key update to begin. This will fail and return false
// if either a previous key update is in progress and has not been
// confirmed or if the initial handshake has not yet been confirmed.
bool QuicCryptoContext::InitiateKeyUpdate() {
if (UNLIKELY(session_->is_destroyed()))
return false;
// There's no user code that should be able to run while UpdateKey
// is running, but we need to gate on it just to be safe.
auto leave = OnScopeLeave([&]() { set_in_key_update(false); });
CHECK(!is_in_key_update());
set_in_key_update();
Debug(session(), "Initiating Key Update");
session_->IncrementStat(&QuicSessionStats::keyupdate_count);
return ngtcp2_conn_initiate_key_update(
session_->connection(),
uv_hrtime()) == 0;
}
int QuicCryptoContext::VerifyPeerIdentity() {
return crypto::VerifyPeerCertificate(ssl_);
}
// Write outbound TLS handshake data into the ngtcp2 connection
// to prepare it to be serialized. The outbound data must be
// stored in the handshake_ until it is acknowledged by the
// remote peer. It's important to keep in mind that there is
// a potential security risk here -- that is, a malicious peer
// can cause the local session to keep sent handshake data in
// memory by failing to acknowledge it or slowly acknowledging
// it. We currently do not track how much data is being buffered
// here but we do record statistics on how long the handshake
// data is foreced to be kept in memory.
void QuicCryptoContext::WriteHandshake(
ngtcp2_crypto_level level,
const uint8_t* data,
size_t datalen) {
Debug(session(),
"Writing %d bytes of %s handshake data.",
datalen,
crypto_level_name(level));
std::unique_ptr<QuicBufferChunk> buffer =
std::make_unique<QuicBufferChunk>(datalen);
memcpy(buffer->out(), data, datalen);
session_->RecordTimestamp(&QuicSessionStats::handshake_send_at);
CHECK_EQ(
ngtcp2_conn_submit_crypto_data(
session_->connection(),
level,
buffer->out(),
datalen), 0);
handshake_[level].Push(std::move(buffer));
}
void QuicApplication::Acknowledge(
int64_t stream_id,
uint64_t offset,
size_t datalen) {
BaseObjectPtr<QuicStream> stream = session()->FindStream(stream_id);
if (LIKELY(stream)) {
stream->Acknowledge(offset, datalen);
ResumeStream(stream_id);
}
}
bool QuicApplication::SendPendingData() {
// The maximum number of packets to send per call
static constexpr size_t kMaxPackets = 16;
QuicPathStorage path;
std::unique_ptr<QuicPacket> packet;
uint8_t* pos = nullptr;
size_t packets_sent = 0;
int err;
for (;;) {
ssize_t ndatalen;
StreamData stream_data;
err = GetStreamData(&stream_data);
if (err < 0) {
session()->set_last_error(QUIC_ERROR_APPLICATION, err);
return false;
}
// If stream_data.id is -1, then we're not serializing any data for any
// specific stream. We still need to process QUIC session packets tho.
if (stream_data.id > -1)
Debug(session(), "Serializing packets for stream id %" PRId64,
stream_data.id);
else
Debug(session(), "Serializing session packets");
// If the packet was sent previously, then packet will have been reset.
if (!packet) {
packet = CreateStreamDataPacket();
pos = packet->data();
}
ssize_t nwrite = WriteVStream(&path, pos, &ndatalen, stream_data);
if (nwrite <= 0) {
switch (nwrite) {
case 0:
goto congestion_limited;
case NGTCP2_ERR_PKT_NUM_EXHAUSTED:
// There is a finite number of packets that can be sent
// per connection. Once those are exhausted, there's
// absolutely nothing we can do except immediately
// and silently tear down the QuicSession. This has
// to be silent because we can't even send a
// CONNECTION_CLOSE since even those require a
// packet number.
session()->Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
return false;
case NGTCP2_ERR_STREAM_DATA_BLOCKED:
session()->StreamDataBlocked(stream_data.id);
if (session()->max_data_left() == 0)
goto congestion_limited;
// Fall through
case NGTCP2_ERR_STREAM_SHUT_WR:
if (UNLIKELY(!BlockStream(stream_data.id)))
return false;
continue;
case NGTCP2_ERR_STREAM_NOT_FOUND:
continue;
case NGTCP2_ERR_WRITE_STREAM_MORE:
CHECK_GT(ndatalen, 0);
CHECK(StreamCommit(&stream_data, ndatalen));
pos += ndatalen;
continue;
}
session()->set_last_error(QUIC_ERROR_SESSION, static_cast<int>(nwrite));
return false;
}
pos += nwrite;
if (ndatalen >= 0)
CHECK(StreamCommit(&stream_data, ndatalen));
Debug(session(), "Sending %" PRIu64 " bytes in serialized packet", nwrite);
packet->set_length(nwrite);
if (!session()->SendPacket(std::move(packet), path))
return false;
packet.reset();
pos = nullptr;
MaybeSetFin(stream_data);
if (++packets_sent == kMaxPackets)
break;
}
return true;
congestion_limited:
// We are either congestion limited or done.
if (pos - packet->data()) {
// Some data was serialized into the packet. We need to send it.
packet->set_length(pos - packet->data());
Debug(session(), "Congestion limited, but %" PRIu64 " bytes pending",
packet->length());
if (!session()->SendPacket(std::move(packet), path))
return false;
}
return true;
}
ssize_t QuicApplication::WriteVStream(
QuicPathStorage* path,
uint8_t* buf,
ssize_t* ndatalen,
const StreamData& stream_data) {
CHECK_LE(stream_data.count, kMaxVectorCount);
uint32_t flags = NGTCP2_WRITE_STREAM_FLAG_NONE;
if (stream_data.remaining > 0)
flags |= NGTCP2_WRITE_STREAM_FLAG_MORE;
if (stream_data.fin)
flags |= NGTCP2_WRITE_STREAM_FLAG_FIN;
return ngtcp2_conn_writev_stream(
session()->connection(),
&path->path,
buf,
session()->max_packet_length(),
ndatalen,
flags,
stream_data.id,
stream_data.buf,
stream_data.count,
uv_hrtime());
}
void QuicApplication::MaybeSetFin(const StreamData& stream_data) {
if (ShouldSetFin(stream_data))
set_stream_fin(stream_data.id);
}
void QuicApplication::StreamHeaders(
int64_t stream_id,
int kind,
const std::vector<std::unique_ptr<QuicHeader>>& headers,
int64_t push_id) {
session()->listener()->OnStreamHeaders(stream_id, kind, headers, push_id);
}
void QuicApplication::StreamClose(
int64_t stream_id,
uint64_t app_error_code) {
BaseObjectPtr<QuicStream> stream = session()->FindStream(stream_id);
if (stream) {
CHECK(!stream->is_destroyed()); // Should not be possible
stream->set_destroyed();
stream->CancelPendingWrites();
session()->RemoveStream(stream_id);
session()->listener()->OnStreamClose(stream_id, app_error_code);
}
}
void QuicApplication::StreamReset(
int64_t stream_id,
uint64_t app_error_code) {
session()->listener()->OnStreamReset(stream_id, app_error_code);
}
// Determines which QuicApplication variant the QuicSession will be using
// based on the alpn configured for the application. For now, this is
// determined through configuration when tghe QuicSession is created
// and is not negotiable. In the future, we may allow it to be negotiated.
QuicApplication* QuicSession::SelectApplication(QuicSession* session) {
std::string alpn = session->alpn();
if (alpn == NGHTTP3_ALPN_H3) {
Debug(this, "Selecting HTTP/3 Application");
return new Http3Application(session);
}
// In the future, we may end up supporting additional
// QUIC protocols. As they are added, extend the cases
// here to create and return them.
Debug(this, "Selecting Default Application");
return new DefaultApplication(session);
}
// Server QuicSession Constructor
QuicSession::QuicSession(
QuicSocket* socket,
const QuicSessionConfig& config,
Local<Object> wrap,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
const QuicCID& dcid,
const QuicCID& scid,
const QuicCID& ocid,
uint32_t version,
const std::string& alpn,
uint32_t options,
QlogMode qlog)
: QuicSession(
NGTCP2_CRYPTO_SIDE_SERVER,
socket,
wrap,
socket->server_secure_context(),
AsyncWrap::PROVIDER_QUICSERVERSESSION,
alpn,
std::string(""), // empty hostname. not used on server side
dcid,
options,
nullptr) {
// The config is copied by assignment in the call below.
InitServer(config, local_addr, remote_addr, dcid, scid, ocid, version, qlog);
}
// Client QuicSession Constructor
QuicSession::QuicSession(
QuicSocket* socket,
v8::Local<v8::Object> wrap,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
BaseObjectPtr<SecureContext> secure_context,
ngtcp2_transport_params* early_transport_params,
crypto::SSLSessionPointer early_session_ticket,
Local<Value> dcid,
PreferredAddressStrategy preferred_address_strategy,
const std::string& alpn,
const std::string& hostname,
uint32_t options,
QlogMode qlog)
: QuicSession(
NGTCP2_CRYPTO_SIDE_CLIENT,
socket,
wrap,
secure_context,
AsyncWrap::PROVIDER_QUICCLIENTSESSION,
alpn,
hostname,
QuicCID(),
options,
preferred_address_strategy) {
set_wrapped();
InitClient(
local_addr,
remote_addr,
early_transport_params,
std::move(early_session_ticket),
dcid,
qlog);
}
// QuicSession is an abstract base class that defines the code used by both
// server and client sessions.
QuicSession::QuicSession(
ngtcp2_crypto_side side,
QuicSocket* socket,
Local<Object> wrap,
BaseObjectPtr<SecureContext> secure_context,
AsyncWrap::ProviderType provider_type,
const std::string& alpn,
const std::string& hostname,
const QuicCID& dcid,
uint32_t options,
PreferredAddressStrategy preferred_address_strategy)
: AsyncWrap(socket->env(), wrap, provider_type),
StatsBase(socket->env(), wrap,
HistogramOptions::ACK |
HistogramOptions::RATE),
alloc_info_(MakeAllocator()),
socket_(socket),
alpn_(alpn),
hostname_(hostname),
idle_(socket->env(), [this]() { OnIdleTimeout(); }),
retransmit_(socket->env(), [this]() { OnRetransmitTimeout(); }),
dcid_(dcid),
state_(env()->isolate()),
quic_state_(socket->quic_state()) {
PushListener(&default_listener_);
set_connection_id_strategy(RandomConnectionIDStrategy);
set_preferred_address_strategy(preferred_address_strategy);
crypto_context_ = std::make_unique<QuicCryptoContext>(
this,
secure_context,
side,
options);
application_.reset(SelectApplication(this));
wrap->DefineOwnProperty(
env()->context(),
env()->state_string(),
state_.GetArrayBuffer(),
PropertyAttribute::ReadOnly).Check();
idle_.Unref();
retransmit_.Unref();
// TODO(@jasnell): memory accounting
// env_->isolate()->AdjustAmountOfExternalAllocatedMemory(kExternalSize);
}
QuicSession::~QuicSession() {
CHECK(!NgCallbackScope::InNgCallbackScope(this));
// The next write should be the final one
if (qlog_stream_)
qlog_stream_->End();
QuicSessionListener* listener_ = listener();
if (listener_ == listener())
RemoveListener(listener_);
// Stop and free the idle and retransmission timers if they are active.
// In a clean shutdown, using Close(), these will have already been
// stopped, but if Close() was not called and we're being destroyed
// in GC, for instance, we need to make sure they get stopped here.
idle_.Stop();
retransmit_.Stop();
DebugStats();
}
template <typename Fn>
void QuicSessionStatsTraits::ToString(const QuicSession& ptr, Fn&& add_field) {
#define V(_n, name, label) \
add_field(label, ptr.GetStat(&QuicSessionStats::name));
SESSION_STATS(V)
#undef V
}
void QuicSession::PushListener(QuicSessionListener* listener) {
CHECK_NOT_NULL(listener);
CHECK(!listener->session_);
listener->previous_listener_ = listener_;
listener->session_.reset(this);
listener_ = listener;
}
void QuicSession::RemoveListener(QuicSessionListener* listener) {
CHECK_NOT_NULL(listener);
QuicSessionListener* previous;
QuicSessionListener* current;
for (current = listener_, previous = nullptr;
/* No loop condition because we want a crash if listener is not found */
; previous = current, current = current->previous_listener_) {
CHECK_NOT_NULL(current);
if (current == listener) {
if (previous != nullptr)
previous->previous_listener_ = current->previous_listener_;
else
listener_ = listener->previous_listener_;
break;
}
}
listener->session_.reset();
listener->previous_listener_ = nullptr;
}
// The diagnostic_name is used in Debug output.
std::string QuicSession::diagnostic_name() const {
return std::string("QuicSession ") +
(is_server() ? "Server" : "Client") +
" (" + alpn().substr(1) + ", " +
std::to_string(static_cast<int64_t>(get_async_id())) + ")";
}
// Locate the QuicStream with the given id or return nullptr
BaseObjectPtr<QuicStream> QuicSession::FindStream(int64_t id) const {
auto it = streams_.find(id);
return it == std::end(streams_) ? BaseObjectPtr<QuicStream>() : it->second;
}
// Invoked when ngtcp2 receives an acknowledgement for stream data.
void QuicSession::AckedStreamDataOffset(
int64_t stream_id,
uint64_t offset,
uint64_t datalen) {
Debug(this,
"Received acknowledgement for %" PRIu64
" bytes of stream %" PRId64 " data",
datalen, stream_id);
application_->AcknowledgeStreamData(
stream_id,
offset,
static_cast<size_t>(datalen));
}
// Attaches the session to the given QuicSocket. The complexity
// here is that any CID's associated with the session have to
// be associated with the new QuicSocket.
void QuicSession::AddToSocket(QuicSocket* socket) {
CHECK_NOT_NULL(socket);
Debug(this, "Adding QuicSession to %s", socket->diagnostic_name());
socket->AddSession(scid_, BaseObjectPtr<QuicSession>(this));
switch (crypto_context_->side()) {
case NGTCP2_CRYPTO_SIDE_SERVER: {
socket->AssociateCID(dcid_, scid_);
socket->AssociateCID(pscid_, scid_);
break;
}
case NGTCP2_CRYPTO_SIDE_CLIENT: {
std::vector<ngtcp2_cid> cids(ngtcp2_conn_get_num_scid(connection()));
ngtcp2_conn_get_scid(connection(), cids.data());
for (const ngtcp2_cid& cid : cids) {
socket->AssociateCID(QuicCID(&cid), scid_);
}
break;
}
default:
UNREACHABLE();
}
std::vector<ngtcp2_cid_token> tokens(
ngtcp2_conn_get_num_active_dcid(connection()));
ngtcp2_conn_get_active_dcid(connection(), tokens.data());
for (const ngtcp2_cid_token& token : tokens) {
if (token.token_present) {
socket->AssociateStatelessResetToken(
StatelessResetToken(token.token),
BaseObjectPtr<QuicSession>(this));
}
}
}
// Add the given QuicStream to this QuicSession's collection of streams. All
// streams added must be removed before the QuicSession instance is freed.
void QuicSession::AddStream(BaseObjectPtr<QuicStream> stream) {
DCHECK(!is_graceful_closing());
Debug(this, "Adding stream %" PRId64 " to session", stream->id());
streams_.emplace(stream->id(), stream);
// Update tracking statistics for the number of streams associated with
// this session.
switch (stream->origin()) {
case QuicStreamOrigin::QUIC_STREAM_CLIENT:
if (is_server())
IncrementStat(&QuicSessionStats::streams_in_count);
else
IncrementStat(&QuicSessionStats::streams_out_count);
break;
case QuicStreamOrigin::QUIC_STREAM_SERVER:
if (is_server())
IncrementStat(&QuicSessionStats::streams_out_count);
else
IncrementStat(&QuicSessionStats::streams_in_count);
}
IncrementStat(&QuicSessionStats::streams_out_count);
switch (stream->direction()) {
case QuicStreamDirection::QUIC_STREAM_BIRECTIONAL:
IncrementStat(&QuicSessionStats::bidi_stream_count);
break;
case QuicStreamDirection::QUIC_STREAM_UNIDIRECTIONAL:
IncrementStat(&QuicSessionStats::uni_stream_count);
break;
}
}
// Creates a new stream object and passes it off to the javascript side.
// This has to be called from within a handlescope/contextscope.
BaseObjectPtr<QuicStream> QuicSession::CreateStream(int64_t stream_id) {
CHECK(!is_destroyed());
CHECK(!is_graceful_closing());
CHECK(!is_closing());
BaseObjectPtr<QuicStream> stream = QuicStream::New(this, stream_id);
CHECK(stream);
listener()->OnStreamReady(stream);
return stream;
}
// Initiate a shutdown of the QuicSession.
void QuicSession::Close(int close_flags) {
if (is_destroyed())
return;
bool silent = close_flags & QuicSessionListener::SESSION_CLOSE_FLAG_SILENT;
bool stateless_reset = is_stateless_reset();
// If we're not running within a ngtcp2 callback scope, schedule
// a CONNECTION_CLOSE to be sent when Close exits. If we are
// within a ngtcp2 callback scope, sending the CONNECTION_CLOSE
// will be deferred.
ConnectionCloseScope close_scope(this, silent);
// Once Close has been called, we cannot re-enter
if (UNLIKELY(is_closing()))
return;
set_closing();
set_silent_closing(silent);
if (stateless_reset && silent)
close_flags |= QuicSessionListener::SESSION_CLOSE_FLAG_STATELESS_RESET;
QuicError error = last_error();
Debug(this, "Closing with code %" PRIu64
" (family: %s, silent: %s, stateless reset: %s)",
error.code,
error.family_name(),
silent ? "Y" : "N",
stateless_reset ? "Y" : "N");
// Ensure that the QuicSession is not freed at least until after we
// exit this scope.
BaseObjectPtr<QuicSession> ptr(this);
// If the QuicSession has been wrapped by a JS object, we have to
// notify the JavaScript side that the session is being closed.
// If it hasn't yet been wrapped, we can skip the call and and
// go straight to destroy.
if (is_wrapped())
listener()->OnSessionClose(error, close_flags);
else
Destroy();
}
// Mark the QuicSession instance destroyed. This will either be invoked
// synchronously within the callstack of the QuicSession::Close() method
// or not. If it is invoked within QuicSession::Close(), the
// QuicSession::Close() will handle sending the CONNECTION_CLOSE
// frame.
void QuicSession::Destroy() {
if (is_destroyed())
return;
Debug(this, "Destroying the QuicSession");
// Mark the session destroyed.
set_destroyed();
set_closing(false);
set_graceful_closing(false);
// TODO(@jasnell): Allow overriding the close code
// If we're not already in a ConnectionCloseScope, schedule
// sending a CONNECTION_CLOSE when destroy exits. If we are
// running within an ngtcp2 callback scope, sending the
// CONNECTION_CLOSE will be deferred.
ConnectionCloseScope close_scope(this, is_silent_closing());
// All existing streams should have already been destroyed
CHECK(streams_.empty());
// Stop and free the idle and retransmission timers if they are active.
idle_.Stop();
retransmit_.Stop();
// The QuicSession instances are kept alive using
// BaseObjectPtr. The only persistent BaseObjectPtr
// is the map in the associated QuicSocket. Removing
// the QuicSession from the QuicSocket will free
// that pointer, allowing the QuicSession to be
// deconstructed once the stack unwinds and any
// remaining BaseObjectPtr<QuicSession> instances
// fall out of scope.
RemoveFromSocket();
}
// Generates and associates a new connection ID for this QuicSession.
// ngtcp2 will call this multiple times at the start of a new connection
// in order to build a pool of available CIDs.
void QuicSession::GetNewConnectionID(
ngtcp2_cid* cid,
uint8_t* token,
size_t cidlen) {
CHECK_NOT_NULL(connection_id_strategy_);
connection_id_strategy_(this, cid, cidlen);
QuicCID cid_(cid);
StatelessResetToken(token, socket()->session_reset_secret(), cid_);
socket()->AssociateCID(cid_, scid_);
}
void QuicSession::HandleError() {
if (is_destroyed())
return;
// If the QuicSession is a server, send a CONNECTION_CLOSE. In either
// case, the closing timer will be set and the QuicSession will be
// destroyed.
if (is_server())
SendConnectionClose();
else
UpdateClosingTimer();
}
// The the retransmit libuv timer fires, it will call OnRetransmitTimeout,
// which determines whether or not we need to retransmit data to
// to packet loss or ack delay.
void QuicSession::OnRetransmitTimeout() {
if (is_destroyed())
return;
uint64_t now = uv_hrtime();
if (ngtcp2_conn_loss_detection_expiry(connection()) <= now) {
Debug(this, "Retransmitting due to loss detection");
IncrementStat(&QuicSessionStats::loss_retransmit_count);
}
if (ngtcp2_conn_ack_delay_expiry(connection()) <= now) {
Debug(this, "Retransmitting due to ack delay");
IncrementStat(&QuicSessionStats::ack_delay_retransmit_count);
}
int rv = ngtcp2_conn_handle_expiry(connection(), now);
if (rv != 0) {
Debug(this, "Error handling retransmit timeout: %s", ngtcp2_strerror(rv));
set_last_error(QUIC_ERROR_SESSION, rv);
HandleError();
}
SendPendingData();
}
bool QuicSession::OpenBidirectionalStream(int64_t* stream_id) {
DCHECK(!is_destroyed());
DCHECK(!is_closing());
DCHECK(!is_graceful_closing());
return ngtcp2_conn_open_bidi_stream(connection(), stream_id, nullptr) == 0;
}
bool QuicSession::OpenUnidirectionalStream(int64_t* stream_id) {
DCHECK(!is_destroyed());
DCHECK(!is_closing());
DCHECK(!is_graceful_closing());
return ngtcp2_conn_open_uni_stream(connection(), stream_id, nullptr) == 0;
}
// When ngtcp2 receives a successfull response to a PATH_CHALLENGE,
// it will trigger the OnPathValidation callback which will, in turn
// invoke this. There's really nothing to do here but update stats and
// and optionally notify the javascript side if there is a handler registered.
// Notifying the JavaScript side is purely informational.
void QuicSession::PathValidation(
const ngtcp2_path* path,
ngtcp2_path_validation_result res) {
if (res == NGTCP2_PATH_VALIDATION_RESULT_SUCCESS) {
IncrementStat(&QuicSessionStats::path_validation_success_count);
} else {
IncrementStat(&QuicSessionStats::path_validation_failure_count);
}
// Only emit the callback if there is a handler for the pathValidation
// event on the JavaScript QuicSession object.
if (UNLIKELY(state_->path_validated_enabled == 1)) {
listener_->OnPathValidation(
res,
reinterpret_cast<const sockaddr*>(path->local.addr),
reinterpret_cast<const sockaddr*>(path->remote.addr));
}
}
// Calling Ping will trigger the ngtcp2_conn to serialize any
// packets it currently has pending along with a probe frame
// that should keep the connection alive. This is a fire and
// forget and any errors that may occur will be ignored. The
// idle_timeout and retransmit timers will be updated. If Ping
// is called while processing an ngtcp2 callback, or if the
// closing or draining period has started, this is a non-op.
void QuicSession::Ping() {
if (NgCallbackScope::InNgCallbackScope(this) ||
is_destroyed() ||
is_closing() ||
is_in_closing_period() ||
is_in_draining_period()) {
return;
}
// TODO(@jasnell): We might want to revisit whether to handle
// errors right here. For now, we're ignoring them with the
// intent of capturing them elsewhere.
WritePackets("ping");
UpdateIdleTimer();
ScheduleRetransmit();
}
// When the QuicSocket receives a QUIC packet, it is forwarded on to here
// for processing.
bool QuicSession::Receive(
ssize_t nread,
const uint8_t* data,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
unsigned int flags) {
CHECK(!is_destroyed());
Debug(this, "Receiving QUIC packet");
IncrementStat(&QuicSessionStats::bytes_received, nread);
if (is_in_closing_period() && is_server()) {
Debug(this, "Packet received while in closing period");
IncrementConnectionCloseAttempts();
// For server QuicSession instances, we serialize the connection close
// packet once but may sent it multiple times. If the client keeps
// transmitting, then the connection close may have gotten lost.
// We don't want to send the connection close in response to
// every received packet, however, so we use an exponential
// backoff, increasing the ratio of packets received to connection
// close frame sent with every one we send.
if (UNLIKELY(ShouldAttemptConnectionClose() &&
!SendConnectionClose())) {
Debug(this, "Failure sending another connection close");
return false;
}
}
{
// These are within a scope to ensure that the InternalCallbackScope
// and HandleScope are both exited before continuing on with the
// function. This allows any nextTicks and queued tasks to be processed
// before we continue.
auto update_stats = OnScopeLeave([&](){
UpdateDataStats();
});
HandleScope handle_scope(env()->isolate());
InternalCallbackScope callback_scope(this);
remote_address_ = remote_addr;
QuicPath path(local_addr, remote_address_);
if (!ReceivePacket(&path, data, nread)) {
HandleError();
return false;
}
}
// Only send pending data if we haven't entered draining mode.
// We enter the draining period when a CONNECTION_CLOSE has been
// received from the remote peer.
if (is_in_draining_period()) {
Debug(this, "In draining period after processing packet");
// If processing the packet puts us into draining period, there's
// absolutely nothing left for us to do except silently close
// and destroy this QuicSession, which we do by updating the
// closing timer.
GetConnectionCloseInfo();
UpdateClosingTimer();
return true;
}
if (!is_destroyed())
UpdateIdleTimer();
SendPendingData();
UpdateRecoveryStats();
Debug(this, "Successfully processed received packet");
return true;
}
// Performs intake processing on a received QUIC packet. The received
// data is passed on to ngtcp2 for parsing and processing. ngtcp2 will,
// in turn, invoke a series of callbacks to handle the received packet.
bool QuicSession::ReceivePacket(
ngtcp2_path* path,
const uint8_t* data,
ssize_t nread) {
CHECK(!is_destroyed());
uint64_t now = uv_hrtime();
SetStat(&QuicSessionStats::received_at, now);
int err = ngtcp2_conn_read_pkt(connection(), path, data, nread, now);
if (err < 0) {
switch (err) {
case NGTCP2_ERR_CALLBACK_FAILURE:
case NGTCP2_ERR_DRAINING:
case NGTCP2_ERR_RECV_VERSION_NEGOTIATION:
break;
case NGTCP2_ERR_RETRY:
// This should only ever happen on the server
CHECK(is_server());
socket()->SendRetry(scid_, dcid_, local_address_, remote_address_);
Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
break;
case NGTCP2_ERR_DROP_CONN:
Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
break;
default:
set_last_error(QUIC_ERROR_SESSION, err);
return false;
}
}
// If the QuicSession has been destroyed but it is not
// in the closing period, a CONNECTION_CLOSE has not yet
// been sent to the peer. Let's attempt to send one. This
// will have the effect of setting the idle timer to the
// closing/draining period, after which the QuicSession
// will be destroyed.
if (is_destroyed() && !is_in_closing_period()) {
Debug(this, "Session was destroyed while processing the packet");
return SendConnectionClose();
}
return true;
}
// Called by ngtcp2 when a chunk of stream data has been received. If
// the stream does not yet exist, it is created, then the data is
// forwarded on.
bool QuicSession::ReceiveStreamData(
uint32_t flags,
int64_t stream_id,
const uint8_t* data,
size_t datalen,
uint64_t offset) {
auto leave = OnScopeLeave([&]() {
// Unconditionally extend the flow control window for the entire
// session but not for the individual Stream.
ExtendOffset(datalen);
});
return application_->ReceiveStreamData(
flags,
stream_id,
data,
datalen,
offset);
}
// Removes the QuicSession from the current socket. This is
// done with when the session is being destroyed or being
// migrated to another QuicSocket. It is important to keep in mind
// that the QuicSocket uses a BaseObjectPtr for the QuicSession.
// If the session is removed and there are no other references held,
// the session object will be destroyed automatically.
void QuicSession::RemoveFromSocket() {
CHECK(socket_);
Debug(this, "Removing QuicSession from %s", socket_->diagnostic_name());
if (is_server()) {
socket_->DisassociateCID(dcid_);
socket_->DisassociateCID(pscid_);
}
std::vector<ngtcp2_cid> cids(ngtcp2_conn_get_num_scid(connection()));
std::vector<ngtcp2_cid_token> tokens(
ngtcp2_conn_get_num_active_dcid(connection()));
ngtcp2_conn_get_scid(connection(), cids.data());
ngtcp2_conn_get_active_dcid(connection(), tokens.data());
for (const ngtcp2_cid& cid : cids)
socket_->DisassociateCID(QuicCID(&cid));
for (const ngtcp2_cid_token& token : tokens) {
if (token.token_present) {
socket_->DisassociateStatelessResetToken(
StatelessResetToken(token.token));
}
}
Debug(this, "Removed from the QuicSocket");
BaseObjectPtr<QuicSocket> socket = std::move(socket_);
socket->RemoveSession(scid_, remote_address_);
}
// Removes the given stream from the QuicSession. All streams must
// be removed before the QuicSession is destroyed.
void QuicSession::RemoveStream(int64_t stream_id) {
Debug(this, "Removing stream %" PRId64, stream_id);
// ngtcp2 does not extend the max streams count automatically
// except in very specific conditions, none of which apply
// once we've gotten this far. We need to manually extend when
// a remote peer initiated stream is removed.
if (!is_in_draining_period() &&
!is_in_closing_period() &&
!is_silent_closing() &&
!ngtcp2_conn_is_local_stream(connection_.get(), stream_id)) {
if (ngtcp2_is_bidi_stream(stream_id))
ngtcp2_conn_extend_max_streams_bidi(connection_.get(), 1);
else
ngtcp2_conn_extend_max_streams_uni(connection_.get(), 1);
}
// This will have the side effect of destroying the QuicStream
// instance.
streams_.erase(stream_id);
}
// The retransmit timer allows us to trigger retransmission
// of packets in case they are considered lost. The exact amount
// of time is determined internally by ngtcp2 according to the
// guidelines established by the QUIC spec but we use a libuv
// timer to actually monitor.
void QuicSession::ScheduleRetransmit() {
uint64_t now = uv_hrtime();
uint64_t expiry = ngtcp2_conn_get_expiry(connection());
uint64_t interval = (expiry - now) / 1000000UL;
if (expiry < now || interval == 0) interval = 1;
Debug(this, "Scheduling the retransmit timer for %" PRIu64, interval);
UpdateRetransmitTimer(interval);
}
bool QuicSession::InitApplication() {
Debug(this, "Initializing application handler for ALPN %s",
alpn().c_str() + 1);
return application_->Initialize();
}
// Captures the error code and family information from a received
// connection close frame.
void QuicSession::GetConnectionCloseInfo() {
ngtcp2_connection_close_error_code close_code;
ngtcp2_conn_get_connection_close_error_code(connection(), &close_code);
set_last_error(QuicError(close_code));
}
// The HandshakeCompleted function is called by ngtcp2 once it
// determines that the TLS Handshake is done. The only thing we
// need to do at this point is let the javascript side know.
void QuicSession::HandshakeCompleted() {
RemoteTransportParamsDebug transport_params(this);
Debug(this, "Handshake is completed. %s", transport_params);
RecordTimestamp(&QuicSessionStats::handshake_completed_at);
if (is_server()) HandshakeConfirmed();
listener()->OnHandshakeCompleted();
}
void QuicSession::HandshakeConfirmed() {
Debug(this, "Handshake is confirmed");
RecordTimestamp(&QuicSessionStats::handshake_confirmed_at);
state_->handshake_confirmed = 1;
}
// Every QUIC session has a remote address and local address.
// Those endpoints can change through the lifetime of a connection,
// so whenever a packet is successfully processed, or when a
// response is to be sent, we have to keep track of the path
// and update as we go.
void QuicSession::UpdateEndpoint(const ngtcp2_path& path) {
remote_address_.Update(path.remote.addr, path.remote.addrlen);
local_address_.Update(path.local.addr, path.local.addrlen);
// If the updated remote address is IPv6, set the flow label
if (remote_address_.family() == AF_INET6) {
// TODO(@jasnell): Currently, this reuses the session reset secret.
// That may or may not be a good idea, we need to verify and may
// need to have a distinct secret for flow labels.
uint32_t flow_label =
GenerateFlowLabel(
local_address_,
remote_address_,
scid_,
socket()->session_reset_secret(),
NGTCP2_STATELESS_RESET_TOKENLEN);
remote_address_.set_flow_label(flow_label);
}
}
// Called by the OnVersionNegotiation callback when a version
// negotiation frame has been received by the client. The sv
// parameter is an array of versions supported by the remote peer.
void QuicSession::VersionNegotiation(const uint32_t* sv, size_t nsv) {
CHECK(!is_server());
listener()->OnVersionNegotiation(NGTCP2_PROTO_VER, sv, nsv);
}
// The retransmit timer allows us to trigger retransmission
// of packets in case they are considered lost. The exact amount
// of time is determined internally by ngtcp2 according to the
// guidelines established by the QUIC spec but we use a libuv
// timer to actually monitor. Here we take the calculated timeout
// and extend out the libuv timer.
void QuicSession::UpdateRetransmitTimer(uint64_t timeout) {
retransmit_.Update(timeout, timeout);
}
void QuicSession::IncrementConnectionCloseAttempts() {
if (connection_close_attempts_ < kMaxSizeT)
connection_close_attempts_++;
}
bool QuicSession::ShouldAttemptConnectionClose() {
if (connection_close_attempts_ == connection_close_limit_) {
if (connection_close_limit_ * 2 <= kMaxSizeT)
connection_close_limit_ *= 2;
else
connection_close_limit_ = kMaxSizeT;
return true;
}
return false;
}
// Transmits either a protocol or application connection
// close to the peer. The choice of which is send is
// based on the current value of last_error_.
bool QuicSession::SendConnectionClose() {
CHECK(!NgCallbackScope::InNgCallbackScope(this));
// Do not send any frames at all if we're in the draining period
// or in the middle of a silent close
if (is_in_draining_period() || is_silent_closing())
return true;
// The specific handling of connection close varies for client
// and server QuicSession instances. For servers, we will
// serialize the connection close once but may end up transmitting
// it multiple times; whereas for clients, we will serialize it
// once and send once only.
QuicError error = last_error();
Debug(this, "Sending connection close with code: %" PRIu64 " (family: %s)",
error.code, error.family_name());
UpdateClosingTimer();
// If initial keys have not yet been installed, use the alternative
// ImmediateConnectionClose to send a stateless connection close to
// the peer.
if (crypto_context()->write_crypto_level() ==
NGTCP2_CRYPTO_LEVEL_INITIAL) {
socket()->ImmediateConnectionClose(
dcid(),
scid_,
local_address_,
remote_address_,
error.code);
return true;
}
switch (crypto_context_->side()) {
case NGTCP2_CRYPTO_SIDE_SERVER: {
if (!is_in_closing_period() && !StartClosingPeriod()) {
Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
return false;
}
CHECK_GT(conn_closebuf_->length(), 0);
return SendPacket(QuicPacket::Copy(conn_closebuf_));
}
case NGTCP2_CRYPTO_SIDE_CLIENT: {
auto packet = QuicPacket::Create("client connection close");
ssize_t nwrite =
SelectCloseFn(error.family)(
connection(),
nullptr,
packet->data(),
max_pktlen_,
error.code,
uv_hrtime());
if (UNLIKELY(nwrite < 0)) {
Debug(this, "Error writing connection close: %d", nwrite);
set_last_error(QUIC_ERROR_SESSION, static_cast<int>(nwrite));
Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
return false;
}
packet->set_length(nwrite);
return SendPacket(std::move(packet));
}
default:
UNREACHABLE();
}
}
void QuicSession::IgnorePreferredAddressStrategy(
QuicSession* session,
const PreferredAddress& preferred_address) {
Debug(session, "Ignoring server preferred address");
}
void QuicSession::UsePreferredAddressStrategy(
QuicSession* session,
const PreferredAddress& preferred_address) {
int family = session->socket()->local_address().family();
if (preferred_address.Use(family)) {
Debug(session, "Using server preferred address");
// Emit only if the QuicSession has a usePreferredAddress handler
// on the JavaScript side.
if (UNLIKELY(session->state_->use_preferred_address_enabled == 1)) {
session->listener()->OnUsePreferredAddress(family, preferred_address);
}
} else {
// If Use returns false, the advertised preferred address does not
// match the current local preferred endpoint IP version.
Debug(session,
"Not using server preferred address due to IP version mismatch");
}
}
// Passes a serialized packet to the associated QuicSocket.
bool QuicSession::SendPacket(std::unique_ptr<QuicPacket> packet) {
CHECK(!is_in_draining_period());
// There's nothing to send.
if (packet->length() == 0)
return true;
IncrementStat(&QuicSessionStats::bytes_sent, packet->length());
RecordTimestamp(&QuicSessionStats::sent_at);
ScheduleRetransmit();
Debug(this, "Sending %" PRIu64 " bytes to %s from %s",
packet->length(),
remote_address_,
local_address_);
int err = socket()->SendPacket(
local_address_,
remote_address_,
std::move(packet),
BaseObjectPtr<QuicSession>(this));
if (err != 0) {
set_last_error(QUIC_ERROR_SESSION, err);
return false;
}
return true;
}
// Sends any pending handshake or session packet data.
void QuicSession::SendPendingData() {
if (is_unable_to_send_packets())
return;
Debug(this, "Sending pending data");
if (!application_->SendPendingData()) {
Debug(this, "Error sending QUIC application data");
HandleError();
}
}
// When completing the TLS handshake, the TLS session information
// is provided to the QuicSession so that the session ticket and
// the remote transport parameters can be captured to support 0RTT
// session resumption.
int QuicSession::set_session(SSL_SESSION* session) {
CHECK(!is_server());
CHECK(!is_destroyed());
int size = i2d_SSL_SESSION(session, nullptr);
if (size > SecureContext::kMaxSessionSize)
return 0;
listener_->OnSessionTicket(size, session);
return 0;
}
// A client QuicSession can be migrated to a different QuicSocket instance.
// TODO(@jasnell): This will be revisited.
bool QuicSession::set_socket(QuicSocket* socket, bool nat_rebinding) {
CHECK(!is_server());
CHECK(!is_destroyed());
if (is_graceful_closing())
return false;
if (socket == nullptr || socket == socket_.get())
return true;
Debug(this, "Migrating to %s", socket->diagnostic_name());
SendSessionScope send(this);
// Ensure that we maintain a reference to keep this from being
// destroyed while we are starting the migration.
BaseObjectPtr<QuicSession> ptr(this);
// Step 1: Remove the session from the current socket
RemoveFromSocket();
// Step 2: Add this Session to the given Socket
AddToSocket(socket);
// Step 3: Update the internal references and make sure
// we are listening.
socket_.reset(socket);
socket->ReceiveStart();
// Step 4: Update ngtcp2
auto local_address = socket->local_address();
if (nat_rebinding) {
ngtcp2_addr addr;
ngtcp2_addr_init(
&addr,
local_address.data(),
local_address.length(),
nullptr);
ngtcp2_conn_set_local_addr(connection(), &addr);
} else {
QuicPath path(local_address, remote_address_);
if (ngtcp2_conn_initiate_migration(
connection(),
&path,
uv_hrtime()) != 0) {
return false;
}
}
return true;
}
void QuicSession::ResumeStream(int64_t stream_id) {
application()->ResumeStream(stream_id);
}
// Begin connection close by serializing the CONNECTION_CLOSE packet.
// There are two variants: one to serialize an application close, the
// other to serialize a protocol close. The frames are generally
// identical with the exception of a bit in the header. On server
// QuicSessions, we serialize the frame once and may retransmit it
// multiple times. On client QuicSession instances, we only ever
// serialize the connection close once.
bool QuicSession::StartClosingPeriod() {
if (is_destroyed())
return false;
if (is_in_closing_period())
return true;
QuicError error = last_error();
Debug(this, "Closing period has started. Error %d", error.code);
// Once the CONNECTION_CLOSE packet is written,
// is_in_closing_period will return true.
conn_closebuf_ = QuicPacket::Create("server connection close");
ssize_t nwrite =
SelectCloseFn(error.family)(
connection(),
nullptr,
conn_closebuf_->data(),
max_pktlen_,
error.code,
uv_hrtime());
if (nwrite < 0) {
set_last_error(QUIC_ERROR_SESSION, static_cast<int>(nwrite));
return false;
}
conn_closebuf_->set_length(nwrite);
return true;
}
// Called by ngtcp2 when a stream has been closed. If the stream does
// not exist, the close is ignored.
void QuicSession::StreamClose(int64_t stream_id, uint64_t app_error_code) {
Debug(this, "Closing stream %" PRId64 " with code %" PRIu64,
stream_id,
app_error_code);
application_->StreamClose(stream_id, app_error_code);
}
// Called when the QuicSession has received a RESET_STREAM frame from the
// peer, indicating that it will no longer send additional frames for the
// stream. If the stream is not yet known, reset is ignored. If the stream
// has already received a STREAM frame with fin set, the stream reset is
// ignored (the QUIC spec permits implementations to handle this situation
// however they want.) If the stream has not yet received a STREAM frame
// with the fin set, then the RESET_STREAM causes the readable side of the
// stream to be abruptly closed and any additional stream frames that may
// be received will be discarded if their offset is greater than final_size.
// On the JavaScript side, receiving a C is undistinguishable from
// a normal end-of-stream. No additional data events will be emitted, the
// end event will be emitted, and the readable side of the duplex will be
// closed.
//
// If the stream is still writable, no additional action is taken. If,
// however, the writable side of the stream has been closed (or was never
// open in the first place as in the case of peer-initiated unidirectional
// streams), the reset will cause the stream to be immediately destroyed.
void QuicSession::StreamReset(
int64_t stream_id,
uint64_t final_size,
uint64_t app_error_code) {
Debug(this,
"Reset stream %" PRId64 " with code %" PRIu64
" and final size %" PRIu64,
stream_id,
app_error_code,
final_size);
BaseObjectPtr<QuicStream> stream = FindStream(stream_id);
if (stream) {
stream->set_final_size(final_size);
application_->StreamReset(stream_id, app_error_code);
}
}
void QuicSession::UpdateConnectionID(
int type,
const QuicCID& cid,
const StatelessResetToken& token) {
switch (type) {
case NGTCP2_CONNECTION_ID_STATUS_TYPE_ACTIVATE:
socket_->AssociateStatelessResetToken(
token,
BaseObjectPtr<QuicSession>(this));
break;
case NGTCP2_CONNECTION_ID_STATUS_TYPE_DEACTIVATE:
socket_->DisassociateStatelessResetToken(token);
break;
}
}
// Updates the idle timer timeout. If the idle timer fires, the connection
// will be silently closed. It is important to update this as activity
// occurs to keep the idle timer from firing.
void QuicSession::UpdateIdleTimer() {
if (is_closing_timer_enabled())
return;
uint64_t now = uv_hrtime();
uint64_t expiry = ngtcp2_conn_get_idle_expiry(connection());
// nano to millis
uint64_t timeout = expiry > now ? (expiry - now) / 1000000ULL : 1;
if (timeout == 0) timeout = 1;
Debug(this, "Updating idle timeout to %" PRIu64, timeout);
idle_.Update(timeout, timeout);
}
void QuicSession::UpdateClosingTimer() {
set_closing_timer_enabled(true);
uint64_t timeout =
is_server() ? (ngtcp2_conn_get_pto(connection()) / 1000000ULL) * 3 : 0;
Debug(this, "Setting closing timeout to %" PRIu64, timeout);
retransmit_.Stop();
idle_.Update(timeout, 0);
idle_.Ref();
}
// Write any packets current pending for the ngtcp2 connection based on
// the current state of the QuicSession. If the QuicSession is in the
// closing period, only CONNECTION_CLOSE packets may be written. If the
// QuicSession is in the draining period, no packets may be written.
//
// Packets are flushed to the underlying QuicSocket uv_udp_t as soon
// as they are written. The WritePackets method may cause zero or more
// packets to be serialized.
//
// If there are any acks or retransmissions pending, those will be
// serialized at this point as well. However, WritePackets does not
// serialize stream data that is being sent initially.
bool QuicSession::WritePackets(const char* diagnostic_label) {
CHECK(!NgCallbackScope::InNgCallbackScope(this));
// During either the draining or closing period,
// we are not permitted to send any additional packets.
if (is_in_draining_period() || is_in_closing_period())
return true;
// Otherwise, serialize and send pending frames
QuicPathStorage path;
for (;;) {
auto packet = QuicPacket::Create(diagnostic_label, max_pktlen_);
// ngtcp2_conn_write_pkt will fill the created QuicPacket up
// as much as possible, and then should be called repeatedly
// until it returns 0 or fatally errors. On each call, it
// will return the number of bytes encoded into the packet.
ssize_t nwrite =
ngtcp2_conn_write_pkt(
connection(),
&path.path,
packet->data(),
max_pktlen_,
uv_hrtime());
if (nwrite <= 0) {
switch (nwrite) {
case 0:
// There was nothing to write.
return true;
case NGTCP2_ERR_PKT_NUM_EXHAUSTED:
// There is a finite number of packets that can be sent
// per connection. Once those are exhausted, there's
// absolutely nothing we can do except immediately
// and silently tear down the QuicSession. This has
// to be silent because we can't even send a
// CONNECTION_CLOSE since even those require a
// packet number.
Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
return false;
default:
set_last_error(QUIC_ERROR_SESSION, static_cast<int>(nwrite));
return false;
}
}
packet->set_length(nwrite);
UpdateEndpoint(path.path);
UpdateDataStats();
if (!SendPacket(std::move(packet)))
return false;
}
}
void QuicSession::MemoryInfo(MemoryTracker* tracker) const {
tracker->TrackField("crypto_context", crypto_context_.get());
tracker->TrackField("alpn", alpn_);
tracker->TrackField("hostname", hostname_);
tracker->TrackField("idle", idle_);
tracker->TrackField("retransmit", retransmit_);
tracker->TrackField("streams", streams_);
tracker->TrackFieldWithSize("current_ngtcp2_memory", current_ngtcp2_memory_);
tracker->TrackField("conn_closebuf", conn_closebuf_);
tracker->TrackField("application", application_);
tracker->TrackField("quic_state", quic_state_);
tracker->TrackField("qlog_stream", qlog_stream_);
StatsBase::StatsMemoryInfo(tracker);
}
void QuicSession::ExtendMaxStreamsBidi(uint64_t max_streams) {
state_->max_streams_bidi = max_streams;
}
void QuicSession::ExtendMaxStreamsUni(uint64_t max_streams) {
state_->max_streams_uni = max_streams;
}
void QuicSession::ExtendMaxStreamsRemoteUni(uint64_t max_streams) {
Debug(this, "Extend remote max unidirectional streams: %" PRIu64,
max_streams);
application_->ExtendMaxStreamsRemoteUni(max_streams);
}
void QuicSession::ExtendMaxStreamsRemoteBidi(uint64_t max_streams) {
Debug(this, "Extend remote max bidirectional streams: %" PRIu64,
max_streams);
application_->ExtendMaxStreamsRemoteBidi(max_streams);
}
void QuicSession::ExtendMaxStreamData(int64_t stream_id, uint64_t max_data) {
Debug(this,
"Extending max stream %" PRId64 " data to %" PRIu64,
stream_id, max_data);
application_->ExtendMaxStreamData(stream_id, max_data);
}
// Static function to create a new server QuicSession instance
BaseObjectPtr<QuicSession> QuicSession::CreateServer(
QuicSocket* socket,
const QuicSessionConfig& config,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
const QuicCID& dcid,
const QuicCID& scid,
const QuicCID& ocid,
uint32_t version,
const std::string& alpn,
uint32_t options,
QlogMode qlog) {
Local<Object> obj;
if (!socket->env()
->quicserversession_instance_template()
->NewInstance(socket->env()->context()).ToLocal(&obj)) {
return {};
}
BaseObjectPtr<QuicSession> session =
MakeDetachedBaseObject<QuicSession>(
socket,
config,
obj,
local_addr,
remote_addr,
dcid,
scid,
ocid,
version,
alpn,
options,
qlog);
session->AddToSocket(socket);
return session;
}
// Initializes a newly created server QuicSession.
void QuicSession::InitServer(
QuicSessionConfig config,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
const QuicCID& dcid,
const QuicCID& scid,
const QuicCID& ocid,
uint32_t version,
QlogMode qlog) {
CHECK_NULL(connection_);
ExtendMaxStreamsBidi(DEFAULT_MAX_STREAMS_BIDI);
ExtendMaxStreamsUni(DEFAULT_MAX_STREAMS_UNI);
local_address_ = local_addr;
remote_address_ = remote_addr;
max_pktlen_ = GetMaxPktLen(remote_addr);
config.set_original_connection_id(ocid, scid);
connection_id_strategy_(this, scid_.cid(), kScidLen);
config.GenerateStatelessResetToken(this, scid_);
config.GeneratePreferredAddressToken(connection_id_strategy_, this, &pscid_);
QuicPath path(local_addr, remote_address_);
// NOLINTNEXTLINE(readability/pointer_notation)
if (qlog == QlogMode::kEnabled) config.set_qlog({ *ocid, OnQlogWrite });
ngtcp2_conn* conn;
CHECK_EQ(
ngtcp2_conn_server_new(
&conn,
dcid.cid(),
scid_.cid(),
&path,
version,
&callbacks[crypto_context_->side()],
&config,
&alloc_info_,
static_cast<QuicSession*>(this)), 0);
connection_.reset(conn);
crypto_context_->Initialize();
UpdateDataStats();
UpdateIdleTimer();
}
namespace {
void QuicSessionOnClientHelloDone(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
Local<FunctionTemplate> cons = env->secure_context_constructor_template();
SecureContext* context = nullptr;
if (args[0]->IsObject() && cons->HasInstance(args[0]))
context = Unwrap<SecureContext>(args[0].As<Object>());
session->crypto_context()->OnClientHelloDone(
BaseObjectPtr<SecureContext>(context));
}
void QuicSessionOnCertDone(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
session->crypto_context()->OnOCSPDone(args[0]);
}
} // namespace
// Recovery stats are used to allow user code to keep track of
// important round-trip timing statistics that are updated through
// the lifetime of a connection. Effectively, these communicate how
// much time (from the perspective of the local peer) is being taken
// to exchange data reliably with the remote peer.
// TODO(@jasnell): Revisit
void QuicSession::UpdateRecoveryStats() {
ngtcp2_conn_stat stat;
ngtcp2_conn_get_conn_stat(connection(), &stat);
SetStat(&QuicSessionStats::min_rtt, stat.min_rtt);
SetStat(&QuicSessionStats::latest_rtt, stat.latest_rtt);
SetStat(&QuicSessionStats::smoothed_rtt, stat.smoothed_rtt);
}
// Data stats are used to allow user code to keep track of important
// statistics such as amount of data in flight through the lifetime
// of a connection.
void QuicSession::UpdateDataStats() {
if (is_destroyed())
return;
state_->max_data_left = ngtcp2_conn_get_max_data_left(connection());
ngtcp2_conn_stat stat;
ngtcp2_conn_get_conn_stat(connection(), &stat);
state_->bytes_in_flight = stat.bytes_in_flight;
// The max_bytes_in_flight is a highwater mark that can be used
// in performance analysis operations.
if (stat.bytes_in_flight > GetStat(&QuicSessionStats::max_bytes_in_flight))
SetStat(&QuicSessionStats::max_bytes_in_flight, stat.bytes_in_flight);
}
// Static method for creating a new client QuicSession instance.
BaseObjectPtr<QuicSession> QuicSession::CreateClient(
QuicSocket* socket,
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
BaseObjectPtr<SecureContext> secure_context,
ngtcp2_transport_params* early_transport_params,
crypto::SSLSessionPointer early_session_ticket,
Local<Value> dcid,
PreferredAddressStrategy preferred_address_strategy,
const std::string& alpn,
const std::string& hostname,
uint32_t options,
QlogMode qlog) {
Local<Object> obj;
if (!socket->env()
->quicclientsession_instance_template()
->NewInstance(socket->env()->context()).ToLocal(&obj)) {
return {};
}
BaseObjectPtr<QuicSession> session =
MakeDetachedBaseObject<QuicSession>(
socket,
obj,
local_addr,
remote_addr,
secure_context,
early_transport_params,
std::move(early_session_ticket),
dcid,
preferred_address_strategy,
alpn,
hostname,
options,
qlog);
session->AddToSocket(socket);
return session;
}
// Initialize a newly created client QuicSession.
// The early_transport_params and session_ticket are optional to
// perform a 0RTT resumption of a prior session.
// The dcid_value parameter is optional to allow user code the
// ability to provide an explicit dcid (this should be rare)
void QuicSession::InitClient(
const SocketAddress& local_addr,
const SocketAddress& remote_addr,
ngtcp2_transport_params* early_transport_params,
crypto::SSLSessionPointer early_session_ticket,
Local<Value> dcid_value,
QlogMode qlog) {
CHECK_NULL(connection_);
local_address_ = local_addr;
remote_address_ = remote_addr;
Debug(this, "Initializing connection from %s to %s",
local_address_,
remote_address_);
// The maximum packet length is determined largely
// by the IP version (IPv4 vs IPv6). Packet sizes
// should be limited to the maximum MTU necessary to
// prevent IP fragmentation.
max_pktlen_ = GetMaxPktLen(remote_address_);
QuicSessionConfig config(quic_state());
ExtendMaxStreamsBidi(DEFAULT_MAX_STREAMS_BIDI);
ExtendMaxStreamsUni(DEFAULT_MAX_STREAMS_UNI);
connection_id_strategy_(this, scid_.cid(), NGTCP2_MAX_CIDLEN);
ngtcp2_cid dcid;
if (dcid_value->IsArrayBufferView()) {
ArrayBufferViewContents<uint8_t> sbuf(
dcid_value.As<ArrayBufferView>());
CHECK_LE(sbuf.length(), NGTCP2_MAX_CIDLEN);
CHECK_GE(sbuf.length(), NGTCP2_MIN_CIDLEN);
memcpy(dcid.data, sbuf.data(), sbuf.length());
dcid.datalen = sbuf.length();
} else {
connection_id_strategy_(this, &dcid, NGTCP2_MAX_CIDLEN);
}
QuicPath path(local_address_, remote_address_);
if (qlog == QlogMode::kEnabled) config.set_qlog({ dcid, OnQlogWrite });
ngtcp2_conn* conn;
CHECK_EQ(
ngtcp2_conn_client_new(
&conn,
&dcid,
scid_.cid(),
&path,
NGTCP2_PROTO_VER,
&callbacks[crypto_context_->side()],
&config,
&alloc_info_,
static_cast<QuicSession*>(this)), 0);
connection_.reset(conn);
crypto_context_->Initialize();
if (early_transport_params != nullptr)
ngtcp2_conn_set_early_remote_transport_params(conn, early_transport_params);
crypto_context_->set_session(std::move(early_session_ticket));
UpdateIdleTimer();
UpdateDataStats();
}
// Static ngtcp2 callbacks are registered when ngtcp2 when a new ngtcp2_conn is
// created. These are static functions that, for the most part, simply defer to
// a QuicSession instance that is passed through as user_data.
// Called by ngtcp2 for both client and server connections when
// TLS handshake data has been received and needs to be processed.
// This will be called multiple times during the TLS handshake
// process and may be called during key updates.
int QuicSession::OnReceiveCryptoData(
ngtcp2_conn* conn,
ngtcp2_crypto_level crypto_level,
uint64_t offset,
const uint8_t* data,
size_t datalen,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
int ret = session->crypto_context()->Receive(
crypto_level,
offset,
data,
datalen);
return ret == 0 ? 0 : NGTCP2_ERR_CALLBACK_FAILURE;
}
// Called by ngtcp2 for both client and server connections
// when a request to extend the maximum number of bidirectional
// streams has been received.
int QuicSession::OnExtendMaxStreamsBidi(
ngtcp2_conn* conn,
uint64_t max_streams,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->ExtendMaxStreamsBidi(max_streams);
return 0;
}
// Called by ngtcp2 for both client and server connections
// when a request to extend the maximum number of unidirectional
// streams has been received
int QuicSession::OnExtendMaxStreamsUni(
ngtcp2_conn* conn,
uint64_t max_streams,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->ExtendMaxStreamsUni(max_streams);
return 0;
}
// Triggered by ngtcp2 when the local peer has received an
// indication from the remote peer indicating that additional
// unidirectional streams may be sent. The max_streams parameter
// identifies the highest unidirectional stream ID that may be
// opened.
int QuicSession::OnExtendMaxStreamsRemoteUni(
ngtcp2_conn* conn,
uint64_t max_streams,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->ExtendMaxStreamsRemoteUni(max_streams);
return 0;
}
// Triggered by ngtcp2 when the local peer has received an
// indication from the remote peer indicating that additional
// bidirectional streams may be sent. The max_streams parameter
// identifies the highest bidirectional stream ID that may be
// opened.
int QuicSession::OnExtendMaxStreamsRemoteBidi(
ngtcp2_conn* conn,
uint64_t max_streams,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->ExtendMaxStreamsRemoteUni(max_streams);
return 0;
}
// Triggered by ngtcp2 when the local peer has received a flow
// control signal from the remote peer indicating that additional
// data can be sent. The max_data parameter identifies the maximum
// data offset that may be sent. That is, a value of 99 means that
// out of a stream of 1000 bytes, only the first 100 may be sent.
// (offsets 0 through 99).
int QuicSession::OnExtendMaxStreamData(
ngtcp2_conn* conn,
int64_t stream_id,
uint64_t max_data,
void* user_data,
void* stream_user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->ExtendMaxStreamData(stream_id, max_data);
return 0;
}
int QuicSession::OnConnectionIDStatus(
ngtcp2_conn* conn,
int type,
uint64_t seq,
const ngtcp2_cid* cid,
const uint8_t* token,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
if (token != nullptr) {
QuicCID qcid(cid);
Debug(session, "Updating connection ID %s with reset token", qcid);
session->UpdateConnectionID(type, qcid, StatelessResetToken(token));
}
return 0;
}
// Called by ngtcp2 for both client and server connections
// when ngtcp2 has determined that the TLS handshake has
// been completed. It is important to understand that this
// is only an indication of the local peer's handshake state.
// The remote peer might not yet have completed its part
// of the handshake.
int QuicSession::OnHandshakeCompleted(
ngtcp2_conn* conn,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->HandshakeCompleted();
return 0;
}
// Called by ngtcp2 for clients when the handshake has been
// confirmed. Confirmation occurs *after* handshake completion.
int QuicSession::OnHandshakeConfirmed(
ngtcp2_conn* conn,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->HandshakeConfirmed();
return 0;
}
// Called by ngtcp2 when a chunk of stream data has been received.
// Currently, ngtcp2 ensures that this callback is always called
// with an offset parameter strictly larger than the previous call's
// offset + datalen (that is, data will never be delivered out of
// order). That behavior may change in the future but only via a
// configuration option.
int QuicSession::OnReceiveStreamData(
ngtcp2_conn* conn,
uint32_t flags,
int64_t stream_id,
uint64_t offset,
const uint8_t* data,
size_t datalen,
void* user_data,
void* stream_user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
return session->ReceiveStreamData(
flags,
stream_id,
data,
datalen,
offset) ? 0 : NGTCP2_ERR_CALLBACK_FAILURE;
}
// Called by ngtcp2 when a new stream has been opened
int QuicSession::OnStreamOpen(
ngtcp2_conn* conn,
int64_t stream_id,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
// We currently do not do anything with this callback.
// QuicStream instances are created implicitly once the
// first chunk of stream data is received.
return 0;
}
// Called by ngtcp2 when an acknowledgement for a chunk of
// TLS handshake data has been received by the remote peer.
// This is only an indication that data was received, not that
// it was successfully processed. Acknowledgements are a key
// part of the QUIC reliability mechanism.
int QuicSession::OnAckedCryptoOffset(
ngtcp2_conn* conn,
ngtcp2_crypto_level crypto_level,
uint64_t offset,
uint64_t datalen,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->crypto_context()->AcknowledgeCryptoData(crypto_level, datalen);
return 0;
}
// Called by ngtcp2 when an acknowledgement for a chunk of
// stream data has been received successfully by the remote peer.
// This is only an indication that data was received, not that
// it was successfully processed. Acknowledgements are a key
// part of the QUIC reliability mechanism.
int QuicSession::OnAckedStreamDataOffset(
ngtcp2_conn* conn,
int64_t stream_id,
uint64_t offset,
uint64_t datalen,
void* user_data,
void* stream_user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->AckedStreamDataOffset(stream_id, offset, datalen);
return 0;
}
// Called by ngtcp2 for a client connection when the server
// has indicated a preferred address in the transport
// params.
// For now, there are two modes: we can accept the preferred address
// or we can reject it. Later, we may want to implement a callback
// to ask the user if they want to accept the preferred address or
// not.
int QuicSession::OnSelectPreferredAddress(
ngtcp2_conn* conn,
ngtcp2_addr* dest,
const ngtcp2_preferred_addr* paddr,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
// The paddr parameter contains the server advertised preferred
// address. The dest parameter contains the address that is
// actually being used. If the preferred address is selected,
// then the contents of paddr are copied over to dest. It is
// important to remember that SelectPreferredAddress should
// return true regardless of whether the preferred address was
// selected or not. It should only return false if there was
// an actual failure processing things. Note, however, that
// even in such a failure, we debug log and ignore it.
// If the preferred address is not selected, dest remains
// unchanged.
PreferredAddress preferred_address(session->env(), dest, paddr);
session->SelectPreferredAddress(preferred_address);
return 0;
}
// Called by ngtcp2 when a stream has been closed.
int QuicSession::OnStreamClose(
ngtcp2_conn* conn,
int64_t stream_id,
uint64_t app_error_code,
void* user_data,
void* stream_user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->StreamClose(stream_id, app_error_code);
return 0;
}
// Stream reset means the remote peer will no longer send data
// on the identified stream. It is essentially a premature close.
// The final_size parameter is important here in that it identifies
// exactly how much data the *remote peer* is aware that it sent.
// If there are lost packets, then the local peer's idea of the final
// size might not match.
int QuicSession::OnStreamReset(
ngtcp2_conn* conn,
int64_t stream_id,
uint64_t final_size,
uint64_t app_error_code,
void* user_data,
void* stream_user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->StreamReset(stream_id, final_size, app_error_code);
return 0;
}
// Called by ngtcp2 when it needs to generate some random data.
// We currently do not use it, but the ngtcp2_rand_ctx identifies
// why the random data is necessary. When ctx is equal to
// NGTCP2_RAND_CTX_NONE, it typically means the random data
// is being used during the TLS handshake. When ctx is equal to
// NGTCP2_RAND_CTX_PATH_CHALLENGE, the random data is being
// used to construct a PATH_CHALLENGE. These *might* need more
// secure and robust random number generation given the
// sensitivity of PATH_CHALLENGE operations (an attacker
// could use a compromised PATH_CHALLENGE to trick an endpoint
// into redirecting traffic).
// TODO(@jasnell): In the future, we'll want to explore whether
// we want to handle the different cases of ngtcp2_rand_ctx
int QuicSession::OnRand(
ngtcp2_conn* conn,
uint8_t* dest,
size_t destlen,
ngtcp2_rand_ctx ctx,
void* user_data) {
EntropySource(dest, destlen);
return 0;
}
// When a new client connection is established, ngtcp2 will call
// this multiple times to generate a pool of connection IDs to use.
int QuicSession::OnGetNewConnectionID(
ngtcp2_conn* conn,
ngtcp2_cid* cid,
uint8_t* token,
size_t cidlen,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
CHECK(!NgCallbackScope::InNgCallbackScope(session));
session->GetNewConnectionID(cid, token, cidlen);
return 0;
}
// When a connection is closed, ngtcp2 will call this multiple
// times to retire connection IDs. It's also possible for this
// to be called at times throughout the lifecycle of the connection
// to remove a CID from the availability pool.
int QuicSession::OnRemoveConnectionID(
ngtcp2_conn* conn,
const ngtcp2_cid* cid,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
if (session->is_server())
session->socket()->DisassociateCID(QuicCID(cid));
return 0;
}
// Called by ngtcp2 to perform path validation. Path validation
// is necessary to ensure that a packet is originating from the
// expected source. If the res parameter indicates success, it
// means that the path specified has been verified as being
// valid.
//
// Validity here means only that there has been a successful
// exchange of PATH_CHALLENGE information between the peers.
// It's critical to understand that the validity of a path
// can change at any timee so this is only an indication of
// validity at a specific point in time.
int QuicSession::OnPathValidation(
ngtcp2_conn* conn,
const ngtcp2_path* path,
ngtcp2_path_validation_result res,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->PathValidation(path, res);
return 0;
}
// Triggered by ngtcp2 when a version negotiation is received.
// What this means is that the remote peer does not support the
// QUIC version requested. The only thing we can do here (per
// the QUIC specification) is silently discard the connection
// and notify the JavaScript side that a different version of
// QUIC should be used. The sv parameter does list the QUIC
// versions advertised as supported by the remote peer.
int QuicSession::OnVersionNegotiation(
ngtcp2_conn* conn,
const ngtcp2_pkt_hd* hd,
const uint32_t* sv,
size_t nsv,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
QuicSession::NgCallbackScope callback_scope(session);
session->VersionNegotiation(sv, nsv);
return 0;
}
// Triggered by ngtcp2 when a stateless reset is received. What this
// means is that the remote peer might recognize the CID but has lost
// all state necessary to successfully process it. The only thing we
// can do is silently close the connection. For server sessions, this
// means all session state is shut down and discarded, even on the
// JavaScript side. For client sessions, we discard session state at
// the C++ layer but -- at least in the future -- we can retain some
// state at the JavaScript level to allow for automatic session
// resumption.
int QuicSession::OnStatelessReset(
ngtcp2_conn* conn,
const ngtcp2_pkt_stateless_reset* sr,
void* user_data) {
QuicSession* session = static_cast<QuicSession*>(user_data);
if (UNLIKELY(session->is_destroyed()))
return NGTCP2_ERR_CALLBACK_FAILURE;
session->set_stateless_reset();
return 0;
}
const ngtcp2_conn_callbacks QuicSession::callbacks[2] = {
// NGTCP2_CRYPTO_SIDE_CLIENT
{
ngtcp2_crypto_client_initial_cb,
nullptr,
OnReceiveCryptoData,
OnHandshakeCompleted,
OnVersionNegotiation,
ngtcp2_crypto_encrypt_cb,
ngtcp2_crypto_decrypt_cb,
ngtcp2_crypto_hp_mask_cb,
OnReceiveStreamData,
OnAckedCryptoOffset,
OnAckedStreamDataOffset,
OnStreamOpen,
OnStreamClose,
OnStatelessReset,
ngtcp2_crypto_recv_retry_cb,
OnExtendMaxStreamsBidi,
OnExtendMaxStreamsUni,
OnRand,
OnGetNewConnectionID,
OnRemoveConnectionID,
ngtcp2_crypto_update_key_cb,
OnPathValidation,
OnSelectPreferredAddress,
OnStreamReset,
OnExtendMaxStreamsRemoteBidi,
OnExtendMaxStreamsRemoteUni,
OnExtendMaxStreamData,
OnConnectionIDStatus,
OnHandshakeConfirmed,
nullptr, // recv_new_token
},
// NGTCP2_CRYPTO_SIDE_SERVER
{
nullptr,
ngtcp2_crypto_recv_client_initial_cb,
OnReceiveCryptoData,
OnHandshakeCompleted,
nullptr, // recv_version_negotiation
ngtcp2_crypto_encrypt_cb,
ngtcp2_crypto_decrypt_cb,
ngtcp2_crypto_hp_mask_cb,
OnReceiveStreamData,
OnAckedCryptoOffset,
OnAckedStreamDataOffset,
OnStreamOpen,
OnStreamClose,
OnStatelessReset,
nullptr, // recv_retry
nullptr, // extend_max_streams_bidi
nullptr, // extend_max_streams_uni
OnRand,
OnGetNewConnectionID,
OnRemoveConnectionID,
ngtcp2_crypto_update_key_cb,
OnPathValidation,
nullptr, // select_preferred_addr
OnStreamReset,
OnExtendMaxStreamsRemoteBidi,
OnExtendMaxStreamsRemoteUni,
OnExtendMaxStreamData,
OnConnectionIDStatus,
nullptr, // handshake_confirmed
nullptr, // recv_new_token
}
};
BaseObjectPtr<QLogStream> QuicSession::qlog_stream() {
if (!qlog_stream_) {
CHECK(qlog_stream_ = QLogStream::Create(env()));
listener_->OnQLog(qlog_stream_.get());
}
return qlog_stream_;
}
void QuicSession::OnQlogWrite(void* user_data, const void* data, size_t len) {
QuicSession* session = static_cast<QuicSession*>(user_data);
Environment* env = session->env();
// Fun fact... ngtcp2 does not emit the final qlog statement until the
// ngtcp2_conn object is destroyed. Ideally, destroying is explicit,
// but sometimes the QuicSession object can be garbage collected without
// being explicitly destroyed. During those times, we cannot call out
// to JavaScript. Because we don't know for sure if we're in in a GC
// when this is called, it is safer to just defer writes to immediate.
BaseObjectPtr<QLogStream> ptr = session->qlog_stream();
std::vector<uint8_t> buffer(len);
memcpy(buffer.data(), data, len);
env->SetImmediate([ptr = std::move(ptr),
buffer = std::move(buffer)](Environment*) {
ptr->Emit(buffer.data(), buffer.size());
});
}
BaseObjectPtr<QLogStream> QLogStream::Create(Environment* env) {
HandleScope scope(env->isolate());
// TODO(@jasnell): There is identical code in heap_utils for the
// HeapSnapshotStream. We can consolidate the two.
if (env->qlogoutputstream_constructor_template().IsEmpty()) {
// Create FunctionTemplate for QLogStream
Local<FunctionTemplate> os = FunctionTemplate::New(env->isolate());
os->Inherit(AsyncWrap::GetConstructorTemplate(env));
Local<ObjectTemplate> ost = os->InstanceTemplate();
ost->SetInternalFieldCount(StreamBase::kInternalFieldCount);
os->SetClassName(
FIXED_ONE_BYTE_STRING(env->isolate(), "QLogStream"));
StreamBase::AddMethods(env, os);
env->set_qlogoutputstream_constructor_template(ost);
}
Local<Object> obj;
if (!env->qlogoutputstream_constructor_template()
->NewInstance(env->context())
.ToLocal(&obj)) {
return {};
}
return MakeBaseObject<QLogStream>(env, obj);
}
QLogStream::QLogStream(Environment* env, v8::Local<Object> obj)
: AsyncWrap(env, obj, AsyncWrap::PROVIDER_QLOGSTREAM),
StreamBase(env) {
MakeWeak();
StreamBase::AttachToObject(GetObject());
}
void QLogStream::Emit(const uint8_t* data, size_t len) {
size_t remaining = len;
while (remaining != 0) {
uv_buf_t buf = EmitAlloc(len);
ssize_t avail = std::min<size_t>(remaining, buf.len);
memcpy(buf.base, data, avail);
remaining -= avail;
data += avail;
EmitRead(avail, buf);
}
// The last chunk that ngtcp2 writes is 6 bytes. Unfortunately,
// this is the only way for us to know that ngtcp2 is definitely
// done sending qlog events.
if (ended_ && len == 6)
EmitRead(UV_EOF);
}
int QLogStream::DoShutdown(ShutdownWrap* req_wrap) {
UNREACHABLE();
}
int QLogStream::DoWrite(
WriteWrap* w,
uv_buf_t* bufs,
size_t count,
uv_stream_t* send_handle) {
UNREACHABLE();
}
bool QLogStream::IsAlive() { return true; }
bool QLogStream::IsClosing() { return false; }
// JavaScript API
namespace {
void QuicSessionSetSocket(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
QuicSocket* socket;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
CHECK(args[0]->IsObject());
ASSIGN_OR_RETURN_UNWRAP(&socket, args[0].As<Object>());
args.GetReturnValue().Set(session->set_socket(socket));
}
// GracefulClose flips a flag that prevents new local streams
// from being opened and new remote streams from being received. It is
// important to note that this does *NOT* send a CONNECTION_CLOSE packet
// to the peer. Existing streams are permitted to close gracefully.
void QuicSessionGracefulClose(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
session->StartGracefulClose();
}
// Destroying the QuicSession will trigger sending of a CONNECTION_CLOSE
// packet, after which the QuicSession will be immediately torn down.
void QuicSessionDestroy(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
session->set_last_error(QuicError(env, args[0], args[1]));
session->Destroy();
}
void QuicSessionGetEphemeralKeyInfo(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
Local<Object> ret;
if (session->crypto_context()->ephemeral_key().ToLocal(&ret))
args.GetReturnValue().Set(ret);
}
void QuicSessionGetPeerCertificate(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
Local<Value> ret;
if (session->crypto_context()->peer_cert(!args[0]->IsTrue()).ToLocal(&ret))
args.GetReturnValue().Set(ret);
}
void QuicSessionGetRemoteAddress(
const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
Environment* env = session->env();
CHECK(args[0]->IsObject());
args.GetReturnValue().Set(
session->remote_address().ToJS(env, args[0].As<Object>()));
}
void QuicSessionGetCertificate(
const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
Local<Value> ret;
if (session->crypto_context()->cert().ToLocal(&ret))
args.GetReturnValue().Set(ret);
}
void QuicSessionPing(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
session->Ping();
}
// Triggers a silent close of a QuicSession. This is currently only used
// (and should ever only be used) for testing purposes...
void QuicSessionSilentClose(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args[0].As<Object>());
ProcessEmitWarning(
session->env(),
"Forcing silent close of QuicSession for testing purposes only");
session->Close(QuicSessionListener::SESSION_CLOSE_FLAG_SILENT);
}
// TODO(addaleax): This is a temporary solution for testing and should be
// removed later.
void QuicSessionRemoveFromSocket(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
session->RemoveFromSocket();
}
void QuicSessionUpdateKey(const FunctionCallbackInfo<Value>& args) {
QuicSession* session;
ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder());
// Initiating a key update may fail if it is done too early (either
// before the TLS handshake has been confirmed or while a previous
// key update is being processed). When it fails, InitiateKeyUpdate()
// will return false.
args.GetReturnValue().Set(session->crypto_context()->InitiateKeyUpdate());
}
// When a client wishes to resume a prior TLS session, it must specify both
// the remember transport parameters and remembered TLS session ticket. Those
// will each be provided as a TypedArray. The DecodeTransportParams and
// DecodeSessionTicket functions handle those. If the argument is undefined,
// then resumption is not used.
bool DecodeTransportParams(
Local<Value> value,
ngtcp2_transport_params* params) {
if (value->IsUndefined())
return false;
CHECK(value->IsArrayBufferView());
ArrayBufferViewContents<uint8_t> sbuf(value.As<ArrayBufferView>());
if (sbuf.length() != sizeof(ngtcp2_transport_params))
return false;
memcpy(params, sbuf.data(), sizeof(ngtcp2_transport_params));
return true;
}
crypto::SSLSessionPointer DecodeSessionTicket(Local<Value> value) {
if (value->IsUndefined())
return {};
CHECK(value->IsArrayBufferView());
ArrayBufferViewContents<unsigned char> sbuf(value.As<ArrayBufferView>());
return crypto::GetTLSSession(sbuf.data(), sbuf.length());
}
void NewQuicClientSession(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
QuicSocket* socket;
int32_t family;
uint32_t port;
SecureContext* sc;
SocketAddress remote_addr;
int32_t preferred_address_policy;
PreferredAddressStrategy preferred_address_strategy;
uint32_t options = QUICCLIENTSESSION_OPTION_VERIFY_HOSTNAME_IDENTITY;
std::string alpn(NGHTTP3_ALPN_H3);
enum ARG_IDX : int {
SOCKET,
TYPE,
IP,
PORT,
SECURE_CONTEXT,
SNI,
REMOTE_TRANSPORT_PARAMS,
SESSION_TICKET,
DCID,
PREFERRED_ADDRESS_POLICY,
ALPN,
OPTIONS,
QLOG
};
CHECK(args[ARG_IDX::SOCKET]->IsObject());
CHECK(args[ARG_IDX::SECURE_CONTEXT]->IsObject());
CHECK(args[ARG_IDX::IP]->IsString());
CHECK(args[ARG_IDX::ALPN]->IsString());
CHECK(args[ARG_IDX::TYPE]->Int32Value(env->context()).To(&family));
CHECK(args[ARG_IDX::PORT]->Uint32Value(env->context()).To(&port));
CHECK(args[ARG_IDX::OPTIONS]->Uint32Value(env->context()).To(&options));
if (!args[ARG_IDX::SNI]->IsUndefined())
CHECK(args[ARG_IDX::SNI]->IsString());
ASSIGN_OR_RETURN_UNWRAP(&socket, args[ARG_IDX::SOCKET].As<Object>());
ASSIGN_OR_RETURN_UNWRAP(&sc, args[ARG_IDX::SECURE_CONTEXT].As<Object>());
CHECK(args[ARG_IDX::PREFERRED_ADDRESS_POLICY]->Int32Value(
env->context()).To(&preferred_address_policy));
switch (preferred_address_policy) {
case QUIC_PREFERRED_ADDRESS_USE:
preferred_address_strategy = QuicSession::UsePreferredAddressStrategy;
break;
default:
preferred_address_strategy = QuicSession::IgnorePreferredAddressStrategy;
}
node::Utf8Value address(env->isolate(), args[ARG_IDX::IP]);
node::Utf8Value servername(env->isolate(), args[ARG_IDX::SNI]);
if (!SocketAddress::New(family, *address, port, &remote_addr))
return args.GetReturnValue().Set(ERR_FAILED_TO_CREATE_SESSION);
// ALPN is a string prefixed by the length, followed by values
Utf8Value val(env->isolate(), args[ARG_IDX::ALPN]);
alpn = val.length();
alpn += *val;
crypto::SSLSessionPointer early_session_ticket =
DecodeSessionTicket(args[ARG_IDX::SESSION_TICKET]);
ngtcp2_transport_params early_transport_params;
bool has_early_transport_params =
DecodeTransportParams(
args[ARG_IDX::REMOTE_TRANSPORT_PARAMS],
&early_transport_params);
socket->ReceiveStart();
BaseObjectPtr<QuicSession> session =
QuicSession::CreateClient(
socket,
socket->local_address(),
remote_addr,
BaseObjectPtr<SecureContext>(sc),
has_early_transport_params ? &early_transport_params : nullptr,
std::move(early_session_ticket),
args[ARG_IDX::DCID],
preferred_address_strategy,
alpn,
std::string(*servername),
options,
args[ARG_IDX::QLOG]->IsTrue() ?
QlogMode::kEnabled :
QlogMode::kDisabled);
session->SendPendingData();
if (session->is_destroyed())
return args.GetReturnValue().Set(ERR_FAILED_TO_CREATE_SESSION);
args.GetReturnValue().Set(session->object());
}
// Add methods that are shared by both client and server QuicSessions
void AddMethods(Environment* env, Local<FunctionTemplate> session) {
env->SetProtoMethod(session, "destroy", QuicSessionDestroy);
env->SetProtoMethod(session, "getRemoteAddress", QuicSessionGetRemoteAddress);
env->SetProtoMethod(session, "getCertificate", QuicSessionGetCertificate);
env->SetProtoMethod(session, "getPeerCertificate",
QuicSessionGetPeerCertificate);
env->SetProtoMethod(session, "gracefulClose", QuicSessionGracefulClose);
env->SetProtoMethod(session, "updateKey", QuicSessionUpdateKey);
env->SetProtoMethod(session, "ping", QuicSessionPing);
env->SetProtoMethod(session, "removeFromSocket", QuicSessionRemoveFromSocket);
env->SetProtoMethod(session, "onClientHelloDone",
QuicSessionOnClientHelloDone);
env->SetProtoMethod(session, "onCertDone", QuicSessionOnCertDone);
}
} // namespace
void QuicSession::Initialize(
Environment* env,
Local<Object> target,
Local<Context> context) {
{
Local<String> class_name =
FIXED_ONE_BYTE_STRING(env->isolate(), "QuicServerSession");
Local<FunctionTemplate> session = FunctionTemplate::New(env->isolate());
session->SetClassName(class_name);
session->Inherit(AsyncWrap::GetConstructorTemplate(env));
Local<ObjectTemplate> sessiont = session->InstanceTemplate();
sessiont->SetInternalFieldCount(QuicSession::kInternalFieldCount);
sessiont->Set(env->owner_symbol(), Null(env->isolate()));
AddMethods(env, session);
env->set_quicserversession_instance_template(sessiont);
}
{
Local<String> class_name =
FIXED_ONE_BYTE_STRING(env->isolate(), "QuicClientSession");
Local<FunctionTemplate> session = FunctionTemplate::New(env->isolate());
session->SetClassName(class_name);
session->Inherit(AsyncWrap::GetConstructorTemplate(env));
Local<ObjectTemplate> sessiont = session->InstanceTemplate();
sessiont->SetInternalFieldCount(QuicSession::kInternalFieldCount);
sessiont->Set(env->owner_symbol(), Null(env->isolate()));
AddMethods(env, session);
env->SetProtoMethod(session,
"getEphemeralKeyInfo",
QuicSessionGetEphemeralKeyInfo);
env->SetProtoMethod(session,
"setSocket",
QuicSessionSetSocket);
env->set_quicclientsession_instance_template(sessiont);
env->SetMethod(target, "createClientSession", NewQuicClientSession);
env->SetMethod(target, "silentCloseSession", QuicSessionSilentClose);
}
}
} // namespace quic
} // namespace node
|