Loading...
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 | /* * Copyright (c) 2018 Intel Corporation * Copyright (c) 2018 Nordic Semiconductor ASA * * SPDX-License-Identifier: Apache-2.0 */ #include <stdbool.h> #include <fcntl.h> #include <zephyr/logging/log.h> LOG_MODULE_REGISTER(net_sock_tls, CONFIG_NET_SOCKETS_LOG_LEVEL); #include <zephyr/init.h> #include <zephyr/sys/util.h> #include <zephyr/net/socket.h> #include <zephyr/random/rand32.h> #include <zephyr/syscall_handler.h> #include <zephyr/sys/fdtable.h> /* TODO: Remove all direct access to private fields. * According with Mbed TLS migration guide: * * Direct access to fields of structures * (`struct` types) declared in public headers is no longer * supported. In Mbed TLS 3, the layout of structures is not * considered part of the stable API, and minor versions (3.1, 3.2, * etc.) may add, remove, rename, reorder or change the type of * structure fields. */ #if !defined(MBEDTLS_ALLOW_PRIVATE_ACCESS) #define MBEDTLS_ALLOW_PRIVATE_ACCESS #endif #if defined(CONFIG_MBEDTLS) #if !defined(CONFIG_MBEDTLS_CFG_FILE) #include "mbedtls/config.h" #else #include CONFIG_MBEDTLS_CFG_FILE #endif /* CONFIG_MBEDTLS_CFG_FILE */ #include <mbedtls/net_sockets.h> #include <mbedtls/x509.h> #include <mbedtls/x509_crt.h> #include <mbedtls/ssl.h> #include <mbedtls/ssl_cookie.h> #include <mbedtls/error.h> #include <mbedtls/debug.h> #include <mbedtls/platform.h> #include <mbedtls/ssl_cache.h> #endif /* CONFIG_MBEDTLS */ #include "sockets_internal.h" #include "tls_internal.h" #if defined(CONFIG_NET_SOCKETS_TLS_MAX_APP_PROTOCOLS) #define ALPN_MAX_PROTOCOLS (CONFIG_NET_SOCKETS_TLS_MAX_APP_PROTOCOLS + 1) #else #define ALPN_MAX_PROTOCOLS 0 #endif /* CONFIG_NET_SOCKETS_TLS_MAX_APP_PROTOCOLS */ static const struct socket_op_vtable tls_sock_fd_op_vtable; #ifndef MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE #endif /** A list of secure tags that TLS context should use. */ struct sec_tag_list { /** An array of secure tags referencing TLS credentials. */ sec_tag_t sec_tags[CONFIG_NET_SOCKETS_TLS_MAX_CREDENTIALS]; /** Number of configured secure tags. */ int sec_tag_count; }; /** Timer context for DTLS. */ struct dtls_timing_context { /** Current time, stored during timer set. */ uint32_t snapshot; /** Intermediate delay value. For details, refer to mbedTLS API * documentation (mbedtls_ssl_set_timer_t). */ uint32_t int_ms; /** Final delay value. For details, refer to mbedTLS API documentation * (mbedtls_ssl_set_timer_t). */ uint32_t fin_ms; }; /** TLS peer address/session ID mapping. */ struct tls_session_cache { /** Creation time. */ int64_t timestamp; /** Peer address. */ struct sockaddr peer_addr; /** Session buffer. */ uint8_t *session; /** Session length. */ size_t session_len; }; /** TLS context information. */ __net_socket struct tls_context { /** Information whether TLS context is used. */ bool is_used; /** Underlying TCP/UDP socket. */ int sock; /** Socket type. */ enum net_sock_type type; /** Secure protocol version running on TLS context. */ enum net_ip_protocol_secure tls_version; /** Socket flags passed to a socket call. */ int flags; /** Information whether TLS context was initialized. */ bool is_initialized; /** Information whether underlying socket is listening. */ bool is_listening; /** Information whether TLS handshake is currently in progress. */ bool handshake_in_progress; /** Information whether TLS handshake is complete or not. */ struct k_sem tls_established; /** TLS specific option values. */ struct { /** Select which credentials to use with TLS. */ struct sec_tag_list sec_tag_list; /** 0-terminated list of allowed ciphersuites (mbedTLS format). */ int ciphersuites[CONFIG_NET_SOCKETS_TLS_MAX_CIPHERSUITES + 1]; /** Information if hostname was explicitly set on a socket. */ bool is_hostname_set; /** Peer verification level. */ int8_t verify_level; /** Indicating on whether DER certificates should not be copied * to the heap. */ int8_t cert_nocopy; /** DTLS role, client by default. */ int8_t role; /** NULL-terminated list of allowed application layer * protocols. */ const char *alpn_list[ALPN_MAX_PROTOCOLS]; /** Session cache enabled on a socket. */ bool cache_enabled; #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* DTLS handshake timeout */ uint32_t dtls_handshake_timeout_min; uint32_t dtls_handshake_timeout_max; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ } options; #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /** Context information for DTLS timing. */ struct dtls_timing_context dtls_timing; /** mbedTLS cookie context for DTLS */ mbedtls_ssl_cookie_ctx cookie; /** DTLS peer address. */ struct sockaddr dtls_peer_addr; /** DTLS peer address length. */ socklen_t dtls_peer_addrlen; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ #if defined(CONFIG_MBEDTLS) /** mbedTLS context. */ mbedtls_ssl_context ssl; /** mbedTLS configuration. */ mbedtls_ssl_config config; #if defined(MBEDTLS_X509_CRT_PARSE_C) /** mbedTLS structure for CA chain. */ mbedtls_x509_crt ca_chain; /** mbedTLS structure for own certificate. */ mbedtls_x509_crt own_cert; /** mbedTLS structure for own private key. */ mbedtls_pk_context priv_key; #endif /* MBEDTLS_X509_CRT_PARSE_C */ #endif /* CONFIG_MBEDTLS */ }; /* A global pool of TLS contexts. */ static struct tls_context tls_contexts[CONFIG_NET_SOCKETS_TLS_MAX_CONTEXTS]; static struct tls_session_cache client_cache[CONFIG_NET_SOCKETS_TLS_MAX_CLIENT_SESSION_COUNT]; #if defined(MBEDTLS_SSL_CACHE_C) static mbedtls_ssl_cache_context server_cache; #endif /* A mutex for protecting TLS context allocation. */ static struct k_mutex context_lock; static void tls_session_cache_reset(void) { for (int i = 0; i < ARRAY_SIZE(client_cache); i++) { if (client_cache[i].session != NULL) { mbedtls_free(client_cache[i].session); } } (void)memset(client_cache, 0, sizeof(client_cache)); } bool net_socket_is_tls(void *obj) { return PART_OF_ARRAY(tls_contexts, (struct tls_context *)obj); } #if defined(MBEDTLS_DEBUG_C) && (CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG) static void tls_debug(void *ctx, int level, const char *file, int line, const char *str) { const char *p, *basename; ARG_UNUSED(ctx); if (!file || !str) { return; } /* Extract basename from file */ for (p = basename = file; *p != '\0'; p++) { if (*p == '/' || *p == '\\') { basename = p + 1; } } NET_DBG("%s:%04d: |%d| %s", basename, line, level, log_strdup(str)); } #endif /* defined(MBEDTLS_DEBUG_C) && (CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG) */ static int tls_ctr_drbg_random(void *ctx, unsigned char *buf, size_t len) { ARG_UNUSED(ctx); #if defined(CONFIG_ENTROPY_HAS_DRIVER) return sys_csrand_get(buf, len); #else sys_rand_get(buf, len); return 0; #endif } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* mbedTLS-defined function for setting timer. */ static void dtls_timing_set_delay(void *data, uint32_t int_ms, uint32_t fin_ms) { struct dtls_timing_context *ctx = data; ctx->int_ms = int_ms; ctx->fin_ms = fin_ms; if (fin_ms != 0U) { ctx->snapshot = k_uptime_get_32(); } } /* mbedTLS-defined function for getting timer status. * The return values are specified by mbedTLS. The callback must return: * -1 if cancelled (fin_ms == 0), * 0 if none of the delays have passed, * 1 if only the intermediate delay has passed, * 2 if the final delay has passed. */ static int dtls_timing_get_delay(void *data) { struct dtls_timing_context *timing = data; unsigned long elapsed_ms; NET_ASSERT(timing); if (timing->fin_ms == 0U) { return -1; } elapsed_ms = k_uptime_get_32() - timing->snapshot; if (elapsed_ms >= timing->fin_ms) { return 2; } if (elapsed_ms >= timing->int_ms) { return 1; } return 0; } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ /* Initialize TLS internals. */ static int tls_init(const struct device *unused) { ARG_UNUSED(unused); #if !defined(CONFIG_ENTROPY_HAS_DRIVER) NET_WARN("No entropy device on the system, " "TLS communication is insecure!"); #endif (void)memset(tls_contexts, 0, sizeof(tls_contexts)); (void)memset(client_cache, 0, sizeof(client_cache)); k_mutex_init(&context_lock); #if defined(MBEDTLS_DEBUG_C) && (CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG) mbedtls_debug_set_threshold(CONFIG_MBEDTLS_DEBUG_LEVEL); #endif #if defined(MBEDTLS_SSL_CACHE_C) mbedtls_ssl_cache_init(&server_cache); #endif return 0; } SYS_INIT(tls_init, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT); static inline bool is_handshake_complete(struct tls_context *ctx) { return k_sem_count_get(&ctx->tls_established) != 0; } /* * Copied from include/mbedtls/ssl_internal.h * * Maximum length we can advertise as our max content length for * RFC 6066 max_fragment_length extension negotiation purposes * (the lesser of both sizes, if they are unequal.) */ #define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \ (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \ ? (MBEDTLS_SSL_OUT_CONTENT_LEN) \ : (MBEDTLS_SSL_IN_CONTENT_LEN) \ ) #if defined(CONFIG_NET_SOCKETS_TLS_SET_MAX_FRAGMENT_LENGTH) && \ defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \ (MBEDTLS_TLS_EXT_ADV_CONTENT_LEN < 16384) BUILD_ASSERT(MBEDTLS_TLS_EXT_ADV_CONTENT_LEN >= 512, "Too small content length!"); static inline unsigned char tls_mfl_code_from_content_len(void) { size_t len = MBEDTLS_TLS_EXT_ADV_CONTENT_LEN; if (len >= 4096) { return MBEDTLS_SSL_MAX_FRAG_LEN_4096; } else if (len >= 2048) { return MBEDTLS_SSL_MAX_FRAG_LEN_2048; } else if (len >= 1024) { return MBEDTLS_SSL_MAX_FRAG_LEN_1024; } else if (len >= 512) { return MBEDTLS_SSL_MAX_FRAG_LEN_512; } else { return MBEDTLS_SSL_MAX_FRAG_LEN_INVALID; } } static inline void tls_set_max_frag_len(mbedtls_ssl_config *config) { unsigned char mfl_code = tls_mfl_code_from_content_len(); mbedtls_ssl_conf_max_frag_len(config, mfl_code); } #else static inline void tls_set_max_frag_len(mbedtls_ssl_config *config) {} #endif /* Allocate TLS context. */ static struct tls_context *tls_alloc(void) { int i; struct tls_context *tls = NULL; k_mutex_lock(&context_lock, K_FOREVER); for (i = 0; i < ARRAY_SIZE(tls_contexts); i++) { if (!tls_contexts[i].is_used) { tls = &tls_contexts[i]; (void)memset(tls, 0, sizeof(*tls)); tls->is_used = true; tls->options.verify_level = -1; tls->sock = -1; NET_DBG("Allocated TLS context, %p", tls); break; } } k_mutex_unlock(&context_lock); if (tls) { k_sem_init(&tls->tls_established, 0, 1); mbedtls_ssl_init(&tls->ssl); mbedtls_ssl_config_init(&tls->config); tls_set_max_frag_len(&tls->config); #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) mbedtls_ssl_cookie_init(&tls->cookie); tls->options.dtls_handshake_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN; tls->options.dtls_handshake_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX; #endif #if defined(MBEDTLS_X509_CRT_PARSE_C) mbedtls_x509_crt_init(&tls->ca_chain); mbedtls_x509_crt_init(&tls->own_cert); mbedtls_pk_init(&tls->priv_key); #endif #if defined(MBEDTLS_DEBUG_C) && (CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG) mbedtls_ssl_conf_dbg(&tls->config, tls_debug, NULL); #endif } else { NET_WARN("Failed to allocate TLS context"); } return tls; } /* Allocate new TLS context and copy the content from the source context. */ static struct tls_context *tls_clone(struct tls_context *source_tls) { struct tls_context *target_tls; target_tls = tls_alloc(); if (!target_tls) { return NULL; } target_tls->tls_version = source_tls->tls_version; target_tls->type = source_tls->type; memcpy(&target_tls->options, &source_tls->options, sizeof(target_tls->options)); #if defined(MBEDTLS_X509_CRT_PARSE_C) if (target_tls->options.is_hostname_set) { mbedtls_ssl_set_hostname(&target_tls->ssl, source_tls->ssl.hostname); } #endif return target_tls; } /* Release TLS context. */ static int tls_release(struct tls_context *tls) { if (!PART_OF_ARRAY(tls_contexts, tls)) { NET_ERR("Invalid TLS context"); return -EBADF; } if (!tls->is_used) { NET_ERR("Deallocating unused TLS context"); return -EBADF; } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) mbedtls_ssl_cookie_free(&tls->cookie); #endif mbedtls_ssl_config_free(&tls->config); mbedtls_ssl_free(&tls->ssl); #if defined(MBEDTLS_X509_CRT_PARSE_C) mbedtls_x509_crt_free(&tls->ca_chain); mbedtls_x509_crt_free(&tls->own_cert); mbedtls_pk_free(&tls->priv_key); #endif tls->is_used = false; return 0; } static bool peer_addr_cmp(const struct sockaddr *addr, const struct sockaddr *peer_addr) { if (addr->sa_family != peer_addr->sa_family) { return false; } if (IS_ENABLED(CONFIG_NET_IPV6) && peer_addr->sa_family == AF_INET6) { struct sockaddr_in6 *addr1 = net_sin6(peer_addr); struct sockaddr_in6 *addr2 = net_sin6(addr); return (addr1->sin6_port == addr2->sin6_port) && net_ipv6_addr_cmp(&addr1->sin6_addr, &addr2->sin6_addr); } else if (IS_ENABLED(CONFIG_NET_IPV4) && peer_addr->sa_family == AF_INET) { struct sockaddr_in *addr1 = net_sin(peer_addr); struct sockaddr_in *addr2 = net_sin(addr); return (addr1->sin_port == addr2->sin_port) && net_ipv4_addr_cmp(&addr1->sin_addr, &addr2->sin_addr); } return false; } static int tls_session_save(const struct sockaddr *peer_addr, mbedtls_ssl_session *session) { struct tls_session_cache *entry = NULL; size_t session_len; int ret; for (int i = 0; i < ARRAY_SIZE(client_cache); i++) { if (client_cache[i].session == NULL) { /* New entry. */ if (entry == NULL || entry->session != NULL) { entry = &client_cache[i]; } } else { if (peer_addr_cmp(&client_cache[i].peer_addr, peer_addr)) { /* Reuse old entry for given address. */ entry = &client_cache[i]; break; } /* Remember the oldest entry and reuse if needed. */ if (entry == NULL || (entry->session != NULL && entry->timestamp < client_cache[i].timestamp)) { entry = &client_cache[i]; } } } /* Allocate session and save */ if (entry->session != NULL) { mbedtls_free(entry->session); entry->session = NULL; } (void)mbedtls_ssl_session_save(session, NULL, 0, &session_len); entry->session = mbedtls_calloc(1, session_len); if (entry->session == NULL) { NET_ERR("Failed to allocate session buffer."); return -ENOMEM; } ret = mbedtls_ssl_session_save(session, entry->session, session_len, &session_len); if (ret < 0) { NET_ERR("Failed to serialize session, err: 0x%x.", -ret); mbedtls_free(entry->session); entry->session = NULL; return -ENOMEM; } entry->session_len = session_len; entry->timestamp = k_uptime_get(); memcpy(&entry->peer_addr, peer_addr, sizeof(*peer_addr)); return 0; } static int tls_session_get(const struct sockaddr *peer_addr, mbedtls_ssl_session *session) { struct tls_session_cache *entry = NULL; int ret; for (int i = 0; i < ARRAY_SIZE(client_cache); i++) { if (client_cache[i].session != NULL && peer_addr_cmp(&client_cache[i].peer_addr, peer_addr)) { entry = &client_cache[i]; break; } } if (entry == NULL) { return -ENOENT; } ret = mbedtls_ssl_session_load(session, entry->session, entry->session_len); if (ret < 0) { /* Discard corrupted session data. */ mbedtls_free(entry->session); entry->session = NULL; return -EIO; } return 0; } static void tls_session_store(struct tls_context *context, const struct sockaddr *addr, socklen_t addrlen) { mbedtls_ssl_session session; struct sockaddr peer_addr = { 0 }; int ret; if (!context->options.cache_enabled) { return; } memcpy(&peer_addr, addr, addrlen); mbedtls_ssl_session_init(&session); ret = mbedtls_ssl_get_session(&context->ssl, &session); if (ret < 0) { NET_ERR("Failed to obtain session for %p", context); goto exit; } ret = tls_session_save(&peer_addr, &session); if (ret < 0) { NET_ERR("Failed to save session for %p", context); } exit: mbedtls_ssl_session_free(&session); } static void tls_session_restore(struct tls_context *context, const struct sockaddr *addr, socklen_t addrlen) { mbedtls_ssl_session session; struct sockaddr peer_addr = { 0 }; int ret; if (!context->options.cache_enabled) { return; } memcpy(&peer_addr, addr, addrlen); mbedtls_ssl_session_init(&session); ret = tls_session_get(&peer_addr, &session); if (ret < 0) { NET_DBG("Session not found for %p", context); goto exit; } ret = mbedtls_ssl_set_session(&context->ssl, &session); if (ret < 0) { NET_ERR("Failed to set session for %p", context); } exit: mbedtls_ssl_session_free(&session); } static void tls_session_purge(void) { tls_session_cache_reset(); #if defined(MBEDTLS_SSL_CACHE_C) mbedtls_ssl_cache_free(&server_cache); mbedtls_ssl_cache_init(&server_cache); #endif } static inline int time_left(uint32_t start, uint32_t timeout) { uint32_t elapsed = k_uptime_get_32() - start; return timeout - elapsed; } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) static bool dtls_is_peer_addr_valid(struct tls_context *context, const struct sockaddr *peer_addr, socklen_t addrlen) { if (context->dtls_peer_addrlen != addrlen) { return false; } return peer_addr_cmp(&context->dtls_peer_addr, peer_addr); } static void dtls_peer_address_set(struct tls_context *context, const struct sockaddr *peer_addr, socklen_t addrlen) { if (addrlen <= sizeof(context->dtls_peer_addr)) { memcpy(&context->dtls_peer_addr, peer_addr, addrlen); context->dtls_peer_addrlen = addrlen; } } static void dtls_peer_address_get(struct tls_context *context, struct sockaddr *peer_addr, socklen_t *addrlen) { socklen_t len = MIN(context->dtls_peer_addrlen, *addrlen); memcpy(peer_addr, &context->dtls_peer_addr, len); *addrlen = len; } static int dtls_tx(void *ctx, const unsigned char *buf, size_t len) { struct tls_context *tls_ctx = ctx; ssize_t sent; sent = zsock_sendto(tls_ctx->sock, buf, len, tls_ctx->flags, &tls_ctx->dtls_peer_addr, tls_ctx->dtls_peer_addrlen); if (sent < 0) { if (errno == EAGAIN) { return MBEDTLS_ERR_SSL_WANT_WRITE; } return MBEDTLS_ERR_NET_SEND_FAILED; } return sent; } static int dtls_rx(void *ctx, unsigned char *buf, size_t len, uint32_t dtls_timeout) { struct tls_context *tls_ctx = ctx; int sock_flags = zsock_fcntl(tls_ctx->sock, F_GETFL, 0); bool is_block; int timeout = (dtls_timeout == 0U) ? -1 : dtls_timeout; uint32_t entry_time = k_uptime_get_32(); socklen_t addrlen = sizeof(struct sockaddr); struct sockaddr addr; int err; ssize_t received; bool retry; struct zsock_pollfd fds; int flags = tls_ctx->flags & ~ZSOCK_MSG_TRUNC; if (sock_flags == -1) { return MBEDTLS_ERR_SSL_INTERNAL_ERROR; } is_block = !((tls_ctx->flags & ZSOCK_MSG_DONTWAIT) || (sock_flags & O_NONBLOCK)); do { retry = false; /* mbedtLS does not allow blocking rx for DTLS, therefore use * k_poll for timeout functionality. */ if (is_block) { fds.fd = tls_ctx->sock; fds.events = ZSOCK_POLLIN; if (zsock_poll(&fds, 1, timeout) == 0) { return MBEDTLS_ERR_SSL_TIMEOUT; } } received = zsock_recvfrom(tls_ctx->sock, buf, len, flags, &addr, &addrlen); if (received < 0) { if (errno == EAGAIN) { return MBEDTLS_ERR_SSL_WANT_READ; } return MBEDTLS_ERR_NET_RECV_FAILED; } if (tls_ctx->dtls_peer_addrlen == 0) { /* Only allow to store peer address for DTLS servers. */ if (tls_ctx->options.role == MBEDTLS_SSL_IS_SERVER) { dtls_peer_address_set(tls_ctx, &addr, addrlen); err = mbedtls_ssl_set_client_transport_id( &tls_ctx->ssl, (const unsigned char *)&addr, addrlen); if (err < 0) { return err; } } else { /* For clients it's incorrect to receive when * no peer has been set up. */ return MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED; } } else if (!dtls_is_peer_addr_valid(tls_ctx, &addr, addrlen)) { /* Received data from different peer, ignore it. */ retry = true; if (timeout != -1) { /* Recalculate the timeout value. */ timeout = time_left(entry_time, dtls_timeout); if (timeout <= 0) { return MBEDTLS_ERR_SSL_TIMEOUT; } } } } while (retry); return received; } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ static int tls_tx(void *ctx, const unsigned char *buf, size_t len) { struct tls_context *tls_ctx = ctx; ssize_t sent; sent = zsock_sendto(tls_ctx->sock, buf, len, tls_ctx->flags, NULL, 0); if (sent < 0) { if (errno == EAGAIN) { return MBEDTLS_ERR_SSL_WANT_WRITE; } return MBEDTLS_ERR_NET_SEND_FAILED; } return sent; } static int tls_rx(void *ctx, unsigned char *buf, size_t len) { struct tls_context *tls_ctx = ctx; int flags = tls_ctx->flags & ~ZSOCK_MSG_WAITALL; ssize_t received; received = zsock_recvfrom(tls_ctx->sock, buf, len, flags, NULL, 0); if (received < 0) { if (errno == EAGAIN) { return MBEDTLS_ERR_SSL_WANT_READ; } return MBEDTLS_ERR_NET_RECV_FAILED; } return received; } #if defined(MBEDTLS_X509_CRT_PARSE_C) static bool crt_is_pem(const unsigned char *buf, size_t buflen) { return (buflen != 0 && buf[buflen - 1] == '\0' && strstr((const char *)buf, "-----BEGIN CERTIFICATE-----") != NULL); } #endif static int tls_add_ca_certificate(struct tls_context *tls, struct tls_credential *ca_cert) { #if defined(MBEDTLS_X509_CRT_PARSE_C) int err; if (tls->options.cert_nocopy == TLS_CERT_NOCOPY_NONE || crt_is_pem(ca_cert->buf, ca_cert->len)) { err = mbedtls_x509_crt_parse(&tls->ca_chain, ca_cert->buf, ca_cert->len); } else { err = mbedtls_x509_crt_parse_der_nocopy(&tls->ca_chain, ca_cert->buf, ca_cert->len); } if (err != 0) { return -EINVAL; } return 0; #endif /* MBEDTLS_X509_CRT_PARSE_C */ return -ENOTSUP; } static void tls_set_ca_chain(struct tls_context *tls) { #if defined(MBEDTLS_X509_CRT_PARSE_C) mbedtls_ssl_conf_ca_chain(&tls->config, &tls->ca_chain, NULL); mbedtls_ssl_conf_cert_profile(&tls->config, &mbedtls_x509_crt_profile_default); #endif /* MBEDTLS_X509_CRT_PARSE_C */ } static int tls_add_own_cert(struct tls_context *tls, struct tls_credential *own_cert) { #if defined(MBEDTLS_X509_CRT_PARSE_C) int err; if (tls->options.cert_nocopy == TLS_CERT_NOCOPY_NONE || crt_is_pem(own_cert->buf, own_cert->len)) { err = mbedtls_x509_crt_parse(&tls->own_cert, own_cert->buf, own_cert->len); } else { err = mbedtls_x509_crt_parse_der_nocopy(&tls->own_cert, own_cert->buf, own_cert->len); } if (err != 0) { return -EINVAL; } return 0; #endif /* MBEDTLS_X509_CRT_PARSE_C */ return -ENOTSUP; } static int tls_set_own_cert(struct tls_context *tls) { #if defined(MBEDTLS_X509_CRT_PARSE_C) int err = mbedtls_ssl_conf_own_cert(&tls->config, &tls->own_cert, &tls->priv_key); if (err != 0) { err = -ENOMEM; } return err; #endif /* MBEDTLS_X509_CRT_PARSE_C */ return -ENOTSUP; } static int tls_set_private_key(struct tls_context *tls, struct tls_credential *priv_key) { #if defined(MBEDTLS_X509_CRT_PARSE_C) int err; err = mbedtls_pk_parse_key(&tls->priv_key, priv_key->buf, priv_key->len, NULL, 0, tls_ctr_drbg_random, NULL); if (err != 0) { return -EINVAL; } return 0; #endif /* MBEDTLS_X509_CRT_PARSE_C */ return -ENOTSUP; } static int tls_set_psk(struct tls_context *tls, struct tls_credential *psk, struct tls_credential *psk_id) { #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) int err = mbedtls_ssl_conf_psk(&tls->config, psk->buf, psk->len, (const unsigned char *)psk_id->buf, psk_id->len); if (err != 0) { return -EINVAL; } return 0; #endif return -ENOTSUP; } static int tls_set_credential(struct tls_context *tls, struct tls_credential *cred) { switch (cred->type) { case TLS_CREDENTIAL_CA_CERTIFICATE: return tls_add_ca_certificate(tls, cred); case TLS_CREDENTIAL_SERVER_CERTIFICATE: return tls_add_own_cert(tls, cred); case TLS_CREDENTIAL_PRIVATE_KEY: return tls_set_private_key(tls, cred); break; case TLS_CREDENTIAL_PSK: { struct tls_credential *psk_id = credential_get(cred->tag, TLS_CREDENTIAL_PSK_ID); if (!psk_id) { return -ENOENT; } return tls_set_psk(tls, cred, psk_id); } case TLS_CREDENTIAL_PSK_ID: /* Ignore PSK ID - it will be used together * with PSK */ break; default: return -EINVAL; } return 0; } static int tls_mbedtls_set_credentials(struct tls_context *tls) { struct tls_credential *cred; sec_tag_t tag; int i, err = 0; bool tag_found, ca_cert_present = false, own_cert_present = false; credentials_lock(); for (i = 0; i < tls->options.sec_tag_list.sec_tag_count; i++) { tag = tls->options.sec_tag_list.sec_tags[i]; cred = NULL; tag_found = false; while ((cred = credential_next_get(tag, cred)) != NULL) { tag_found = true; err = tls_set_credential(tls, cred); if (err != 0) { goto exit; } if (cred->type == TLS_CREDENTIAL_CA_CERTIFICATE) { ca_cert_present = true; } else if (cred->type == TLS_CREDENTIAL_SERVER_CERTIFICATE) { own_cert_present = true; } } if (!tag_found) { err = -ENOENT; goto exit; } } exit: credentials_unlock(); if (err == 0) { if (ca_cert_present) { tls_set_ca_chain(tls); } if (own_cert_present) { err = tls_set_own_cert(tls); } } return err; } static int tls_mbedtls_reset(struct tls_context *context) { int ret; ret = mbedtls_ssl_session_reset(&context->ssl); if (ret != 0) { return ret; } k_sem_reset(&context->tls_established); #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* Server role: reset the address so that a new * client can connect w/o a need to reopen a socket * Client role: keep peer addr so socket can continue to be used * even on handshake timeout */ if (context->options.role == MBEDTLS_SSL_IS_SERVER) { (void)memset(&context->dtls_peer_addr, 0, sizeof(context->dtls_peer_addr)); context->dtls_peer_addrlen = 0; } #endif return 0; } static int tls_mbedtls_handshake(struct tls_context *context, bool block) { int ret; int sock_flags; sock_flags = zsock_fcntl(context->sock, F_GETFL, 0); if (sock_flags < 0) { return -EIO; } if (block && sock_flags & O_NONBLOCK) { /* Clear the O_NONBLOCK flag for the handshake to prevent busy * looping in the handshake thread. */ (void)zsock_fcntl(context->sock, F_SETFL, sock_flags & ~O_NONBLOCK); } context->handshake_in_progress = true; while ((ret = mbedtls_ssl_handshake(&context->ssl)) != 0) { if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE || ret == MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS || ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) { if (block) { continue; } ret = -EAGAIN; break; } else if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) { ret = tls_mbedtls_reset(context); if (ret == 0) { if (block) { continue; } ret = -EAGAIN; break; } } else if (ret == MBEDTLS_ERR_SSL_TIMEOUT) { /* MbedTLS API documentation requires session to * be reset in this case */ ret = tls_mbedtls_reset(context); if (ret == 0) { NET_ERR("TLS handshake timeout"); ret = -ETIMEDOUT; break; } } else { /* MbedTLS API documentation requires session to * be reset in other error cases */ NET_ERR("TLS handshake error: -%x", -ret); ret = tls_mbedtls_reset(context); if (ret == 0) { ret = -ECONNABORTED; break; } } /* Avoid constant loop if tls_mbedtls_reset fails */ NET_ERR("TLS reset error: -%x", -ret); ret = -ECONNABORTED; break; } if (block && sock_flags & O_NONBLOCK) { (void)zsock_fcntl(context->sock, F_SETFL, sock_flags); } if (ret == 0) { k_sem_give(&context->tls_established); } context->handshake_in_progress = false; return ret; } static int tls_mbedtls_init(struct tls_context *context, bool is_server) { int role, type, ret; role = is_server ? MBEDTLS_SSL_IS_SERVER : MBEDTLS_SSL_IS_CLIENT; type = (context->type == SOCK_STREAM) ? MBEDTLS_SSL_TRANSPORT_STREAM : MBEDTLS_SSL_TRANSPORT_DATAGRAM; if (type == MBEDTLS_SSL_TRANSPORT_STREAM) { mbedtls_ssl_set_bio(&context->ssl, context, tls_tx, tls_rx, NULL); } else { #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) mbedtls_ssl_set_bio(&context->ssl, context, dtls_tx, NULL, dtls_rx); #else return -ENOTSUP; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ } ret = mbedtls_ssl_config_defaults(&context->config, role, type, MBEDTLS_SSL_PRESET_DEFAULT); if (ret != 0) { /* According to mbedTLS API documentation, * mbedtls_ssl_config_defaults can fail due to memory * allocation failure */ return -ENOMEM; } #if defined(MBEDTLS_SSL_RENEGOTIATION) mbedtls_ssl_conf_legacy_renegotiation(&context->config, MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE); mbedtls_ssl_conf_renegotiation(&context->config, MBEDTLS_SSL_RENEGOTIATION_ENABLED); #endif #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) if (type == MBEDTLS_SSL_TRANSPORT_DATAGRAM) { /* DTLS requires timer callbacks to operate */ mbedtls_ssl_set_timer_cb(&context->ssl, &context->dtls_timing, dtls_timing_set_delay, dtls_timing_get_delay); mbedtls_ssl_conf_handshake_timeout(&context->config, context->options.dtls_handshake_timeout_min, context->options.dtls_handshake_timeout_max); /* Configure cookie for DTLS server */ if (role == MBEDTLS_SSL_IS_SERVER) { ret = mbedtls_ssl_cookie_setup(&context->cookie, tls_ctr_drbg_random, NULL); if (ret != 0) { return -ENOMEM; } mbedtls_ssl_conf_dtls_cookies(&context->config, mbedtls_ssl_cookie_write, mbedtls_ssl_cookie_check, &context->cookie); mbedtls_ssl_conf_read_timeout( &context->config, CONFIG_NET_SOCKETS_DTLS_TIMEOUT); } } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ #if defined(MBEDTLS_X509_CRT_PARSE_C) /* For TLS clients, set hostname to empty string to enforce it's * verification - only if hostname option was not set. Otherwise * depend on user configuration. */ if (!is_server && !context->options.is_hostname_set) { mbedtls_ssl_set_hostname(&context->ssl, ""); } #endif /* If verification level was specified explicitly, set it. Otherwise, * use mbedTLS default values (required for client, none for server) */ if (context->options.verify_level != -1) { mbedtls_ssl_conf_authmode(&context->config, context->options.verify_level); } mbedtls_ssl_conf_rng(&context->config, tls_ctr_drbg_random, NULL); ret = tls_mbedtls_set_credentials(context); if (ret != 0) { return ret; } if (context->options.ciphersuites[0] != 0) { /* Specific ciphersuites configured, so use them */ NET_DBG("Using user-specified ciphersuites"); mbedtls_ssl_conf_ciphersuites(&context->config, context->options.ciphersuites); } #if defined(CONFIG_MBEDTLS_SSL_ALPN) if (ALPN_MAX_PROTOCOLS && context->options.alpn_list[0] != NULL) { ret = mbedtls_ssl_conf_alpn_protocols(&context->config, context->options.alpn_list); if (ret != 0) { return -EINVAL; } } #endif /* CONFIG_MBEDTLS_SSL_ALPN */ #if defined(MBEDTLS_SSL_CACHE_C) if (is_server && context->options.cache_enabled) { mbedtls_ssl_conf_session_cache(&context->config, &server_cache, mbedtls_ssl_cache_get, mbedtls_ssl_cache_set); } #endif ret = mbedtls_ssl_setup(&context->ssl, &context->config); if (ret != 0) { /* According to mbedTLS API documentation, * mbedtls_ssl_setup can fail due to memory allocation failure */ return -ENOMEM; } context->is_initialized = true; return 0; } static int tls_opt_sec_tag_list_set(struct tls_context *context, const void *optval, socklen_t optlen) { int sec_tag_cnt; if (!optval) { return -EINVAL; } if (optlen % sizeof(sec_tag_t) != 0) { return -EINVAL; } sec_tag_cnt = optlen / sizeof(sec_tag_t); if (sec_tag_cnt > ARRAY_SIZE(context->options.sec_tag_list.sec_tags)) { return -EINVAL; } memcpy(context->options.sec_tag_list.sec_tags, optval, optlen); context->options.sec_tag_list.sec_tag_count = sec_tag_cnt; return 0; } static int sock_opt_protocol_get(struct tls_context *context, void *optval, socklen_t *optlen) { int protocol = (int)context->tls_version; if (*optlen != sizeof(protocol)) { return -EINVAL; } *(int *)optval = protocol; return 0; } static int tls_opt_sec_tag_list_get(struct tls_context *context, void *optval, socklen_t *optlen) { int len; if (*optlen % sizeof(sec_tag_t) != 0 || *optlen == 0) { return -EINVAL; } len = MIN(context->options.sec_tag_list.sec_tag_count * sizeof(sec_tag_t), *optlen); memcpy(optval, context->options.sec_tag_list.sec_tags, len); *optlen = len; return 0; } static int tls_opt_hostname_set(struct tls_context *context, const void *optval, socklen_t optlen) { ARG_UNUSED(optlen); #if defined(MBEDTLS_X509_CRT_PARSE_C) if (mbedtls_ssl_set_hostname(&context->ssl, optval) != 0) { return -EINVAL; } #else return -ENOPROTOOPT; #endif context->options.is_hostname_set = true; return 0; } static int tls_opt_ciphersuite_list_set(struct tls_context *context, const void *optval, socklen_t optlen) { int cipher_cnt; if (!optval) { return -EINVAL; } if (optlen % sizeof(int) != 0) { return -EINVAL; } cipher_cnt = optlen / sizeof(int); /* + 1 for 0-termination. */ if (cipher_cnt + 1 > ARRAY_SIZE(context->options.ciphersuites)) { return -EINVAL; } memcpy(context->options.ciphersuites, optval, optlen); context->options.ciphersuites[cipher_cnt] = 0; mbedtls_ssl_conf_ciphersuites(&context->config, context->options.ciphersuites); return 0; } static int tls_opt_ciphersuite_list_get(struct tls_context *context, void *optval, socklen_t *optlen) { const int *selected_ciphers; int cipher_cnt, i = 0; int *ciphers = optval; if (*optlen % sizeof(int) != 0 || *optlen == 0) { return -EINVAL; } if (context->options.ciphersuites[0] == 0) { /* No specific ciphersuites configured, return all available. */ selected_ciphers = mbedtls_ssl_list_ciphersuites(); } else { selected_ciphers = context->options.ciphersuites; } cipher_cnt = *optlen / sizeof(int); while (selected_ciphers[i] != 0) { ciphers[i] = selected_ciphers[i]; if (++i == cipher_cnt) { break; } } *optlen = i * sizeof(int); return 0; } static int tls_opt_ciphersuite_used_get(struct tls_context *context, void *optval, socklen_t *optlen) { const char *ciph; if (*optlen != sizeof(int)) { return -EINVAL; } ciph = mbedtls_ssl_get_ciphersuite(&context->ssl); if (ciph == NULL) { return -ENOTCONN; } *(int *)optval = mbedtls_ssl_get_ciphersuite_id(ciph); return 0; } static int tls_opt_alpn_list_set(struct tls_context *context, const void *optval, socklen_t optlen) { int alpn_cnt; if (!ALPN_MAX_PROTOCOLS) { return -EINVAL; } if (!optval) { return -EINVAL; } if (optlen % sizeof(const char *) != 0) { return -EINVAL; } alpn_cnt = optlen / sizeof(const char *); /* + 1 for NULL-termination. */ if (alpn_cnt + 1 > ARRAY_SIZE(context->options.alpn_list)) { return -EINVAL; } memcpy(context->options.alpn_list, optval, optlen); context->options.alpn_list[alpn_cnt] = NULL; return 0; } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) static int tls_opt_dtls_handshake_timeout_get(struct tls_context *context, void *optval, socklen_t *optlen, bool is_max) { uint32_t *val = (uint32_t *)optval; if (sizeof(uint32_t) != *optlen) { return -EINVAL; } if (is_max) { *val = context->options.dtls_handshake_timeout_max; } else { *val = context->options.dtls_handshake_timeout_min; } return 0; } static int tls_opt_dtls_handshake_timeout_set(struct tls_context *context, const void *optval, socklen_t optlen, bool is_max) { uint32_t *val = (uint32_t *)optval; if (!optval) { return -EINVAL; } if (sizeof(uint32_t) != optlen) { return -EINVAL; } /* If mbedTLS context not inited, it will * use these values upon init. */ if (is_max) { context->options.dtls_handshake_timeout_max = *val; } else { context->options.dtls_handshake_timeout_min = *val; } /* If mbedTLS context already inited, we need to * update mbedTLS config for it to take effect */ mbedtls_ssl_conf_handshake_timeout(&context->config, context->options.dtls_handshake_timeout_min, context->options.dtls_handshake_timeout_max); return 0; } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ static int tls_opt_alpn_list_get(struct tls_context *context, void *optval, socklen_t *optlen) { const char **alpn_list = context->options.alpn_list; int alpn_cnt, i = 0; const char **ret_list = optval; if (!ALPN_MAX_PROTOCOLS) { return -EINVAL; } if (*optlen % sizeof(const char *) != 0 || *optlen == 0) { return -EINVAL; } alpn_cnt = *optlen / sizeof(const char *); while (alpn_list[i] != NULL) { ret_list[i] = alpn_list[i]; if (++i == alpn_cnt) { break; } } *optlen = i * sizeof(const char *); return 0; } static int tls_opt_session_cache_set(struct tls_context *context, const void *optval, socklen_t optlen) { int *val = (int *)optval; if (!optval) { return -EINVAL; } if (sizeof(int) != optlen) { return -EINVAL; } context->options.cache_enabled = (*val == TLS_SESSION_CACHE_ENABLED); return 0; } static int tls_opt_session_cache_get(struct tls_context *context, void *optval, socklen_t *optlen) { int cache_enabled = context->options.cache_enabled ? TLS_SESSION_CACHE_ENABLED : TLS_SESSION_CACHE_DISABLED; if (*optlen != sizeof(cache_enabled)) { return -EINVAL; } *(int *)optval = cache_enabled; return 0; } static int tls_opt_session_cache_purge_set(struct tls_context *context, const void *optval, socklen_t optlen) { ARG_UNUSED(context); ARG_UNUSED(optval); ARG_UNUSED(optlen); tls_session_purge(); return 0; } static int tls_opt_peer_verify_set(struct tls_context *context, const void *optval, socklen_t optlen) { int *peer_verify; if (!optval) { return -EINVAL; } if (optlen != sizeof(int)) { return -EINVAL; } peer_verify = (int *)optval; if (*peer_verify != MBEDTLS_SSL_VERIFY_NONE && *peer_verify != MBEDTLS_SSL_VERIFY_OPTIONAL && *peer_verify != MBEDTLS_SSL_VERIFY_REQUIRED) { return -EINVAL; } context->options.verify_level = *peer_verify; return 0; } static int tls_opt_cert_nocopy_set(struct tls_context *context, const void *optval, socklen_t optlen) { int *cert_nocopy; if (!optval) { return -EINVAL; } if (optlen != sizeof(int)) { return -EINVAL; } cert_nocopy = (int *)optval; if (*cert_nocopy != TLS_CERT_NOCOPY_NONE && *cert_nocopy != TLS_CERT_NOCOPY_OPTIONAL) { return -EINVAL; } context->options.cert_nocopy = *cert_nocopy; return 0; } static int tls_opt_dtls_role_set(struct tls_context *context, const void *optval, socklen_t optlen) { int *role; if (!optval) { return -EINVAL; } if (optlen != sizeof(int)) { return -EINVAL; } role = (int *)optval; if (*role != MBEDTLS_SSL_IS_CLIENT && *role != MBEDTLS_SSL_IS_SERVER) { return -EINVAL; } context->options.role = *role; return 0; } static int protocol_check(int family, int type, int *proto) { if (family != AF_INET && family != AF_INET6) { return -EAFNOSUPPORT; } if (*proto >= IPPROTO_TLS_1_0 && *proto <= IPPROTO_TLS_1_2) { if (type != SOCK_STREAM) { return -EPROTOTYPE; } *proto = IPPROTO_TCP; } else if (*proto >= IPPROTO_DTLS_1_0 && *proto <= IPPROTO_DTLS_1_2) { if (!IS_ENABLED(CONFIG_NET_SOCKETS_ENABLE_DTLS)) { return -EPROTONOSUPPORT; } if (type != SOCK_DGRAM) { return -EPROTOTYPE; } *proto = IPPROTO_UDP; } else { return -EPROTONOSUPPORT; } return 0; } static int ztls_socket(int family, int type, int proto) { enum net_ip_protocol_secure tls_proto = proto; int fd = z_reserve_fd(); int sock = -1; int ret; struct tls_context *ctx; if (fd < 0) { return -1; } ret = protocol_check(family, type, &proto); if (ret < 0) { errno = -ret; return -1; } ctx = tls_alloc(); if (ctx == NULL) { errno = ENOMEM; goto free_fd; } sock = zsock_socket(family, type, proto); if (sock < 0) { goto release_tls; } ctx->tls_version = tls_proto; ctx->type = (proto == IPPROTO_TCP) ? SOCK_STREAM : SOCK_DGRAM; ctx->sock = sock; z_finalize_fd( fd, ctx, (const struct fd_op_vtable *)&tls_sock_fd_op_vtable); return fd; release_tls: (void)tls_release(ctx); free_fd: z_free_fd(fd); return -1; } int ztls_close_ctx(struct tls_context *ctx) { int ret, err = 0; /* Try to send close notification. */ ctx->flags = 0; (void)mbedtls_ssl_close_notify(&ctx->ssl); err = tls_release(ctx); ret = zsock_close(ctx->sock); /* In case close fails, we propagate errno value set by close. * In case close succeeds, but tls_release fails, set errno * according to tls_release return value. */ if (ret == 0 && err < 0) { errno = -err; ret = -1; } return ret; } int ztls_connect_ctx(struct tls_context *ctx, const struct sockaddr *addr, socklen_t addrlen) { int ret; ret = zsock_connect(ctx->sock, addr, addrlen); if (ret < 0) { return ret; } if (ctx->type == SOCK_STREAM) { /* Do the handshake for TLS, not DTLS. */ ret = tls_mbedtls_init(ctx, false); if (ret < 0) { goto error; } /* Do not use any socket flags during the handshake. */ ctx->flags = 0; tls_session_restore(ctx, addr, addrlen); /* TODO For simplicity, TLS handshake blocks the socket * even for non-blocking socket. */ ret = tls_mbedtls_handshake(ctx, true); if (ret < 0) { goto error; } tls_session_store(ctx, addr, addrlen); } else { #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* Just store the address. */ dtls_peer_address_set(ctx, addr, addrlen); #else ret = -ENOTSUP; goto error; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ } return 0; error: errno = -ret; return -1; } int ztls_accept_ctx(struct tls_context *parent, struct sockaddr *addr, socklen_t *addrlen) { struct tls_context *child = NULL; int ret, err, fd, sock; fd = z_reserve_fd(); if (fd < 0) { return -1; } sock = zsock_accept(parent->sock, addr, addrlen); if (sock < 0) { ret = -errno; goto error; } child = tls_clone(parent); if (child == NULL) { ret = -ENOMEM; goto error; } z_finalize_fd( fd, child, (const struct fd_op_vtable *)&tls_sock_fd_op_vtable); child->sock = sock; ret = tls_mbedtls_init(child, true); if (ret < 0) { goto error; } /* Do not use any socket flags during the handshake. */ child->flags = 0; /* TODO For simplicity, TLS handshake blocks the socket even for * non-blocking socket. */ ret = tls_mbedtls_handshake(child, true); if (ret < 0) { goto error; } return fd; error: if (child != NULL) { err = tls_release(child); __ASSERT(err == 0, "TLS context release failed"); } if (sock >= 0) { err = zsock_close(sock); __ASSERT(err == 0, "Child socket close failed"); } z_free_fd(fd); errno = -ret; return -1; } static ssize_t send_tls(struct tls_context *ctx, const void *buf, size_t len, int flags) { int ret; ret = mbedtls_ssl_write(&ctx->ssl, buf, len); if (ret >= 0) { return ret; } if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE || ret == MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS || ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) { errno = EAGAIN; } else { (void)tls_mbedtls_reset(ctx); errno = EIO; } return -1; } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) static ssize_t sendto_dtls_client(struct tls_context *ctx, const void *buf, size_t len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen) { int ret; if (!dest_addr) { /* No address provided, check if we have stored one, * otherwise return error. */ if (ctx->dtls_peer_addrlen == 0) { ret = -EDESTADDRREQ; goto error; } } else if (ctx->dtls_peer_addrlen == 0) { /* Address provided and no peer address stored. */ dtls_peer_address_set(ctx, dest_addr, addrlen); } else if (!dtls_is_peer_addr_valid(ctx, dest_addr, addrlen) != 0) { /* Address provided but it does not match stored one */ ret = -EISCONN; goto error; } if (!ctx->is_initialized) { ret = tls_mbedtls_init(ctx, false); if (ret < 0) { goto error; } } if (!is_handshake_complete(ctx)) { tls_session_restore(ctx, &ctx->dtls_peer_addr, ctx->dtls_peer_addrlen); /* TODO For simplicity, TLS handshake blocks the socket even for * non-blocking socket. */ ret = tls_mbedtls_handshake(ctx, true); if (ret < 0) { goto error; } tls_session_store(ctx, &ctx->dtls_peer_addr, ctx->dtls_peer_addrlen); } return send_tls(ctx, buf, len, flags); error: errno = -ret; return -1; } static ssize_t sendto_dtls_server(struct tls_context *ctx, const void *buf, size_t len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen) { /* For DTLS server, require to have established DTLS connection * in order to send data. */ if (!is_handshake_complete(ctx)) { errno = ENOTCONN; return -1; } /* Verify we are sending to a peer that we have connection with. */ if (dest_addr && !dtls_is_peer_addr_valid(ctx, dest_addr, addrlen) != 0) { errno = EISCONN; return -1; } return send_tls(ctx, buf, len, flags); } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ ssize_t ztls_sendto_ctx(struct tls_context *ctx, const void *buf, size_t len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen) { ctx->flags = flags; /* TLS */ if (ctx->type == SOCK_STREAM) { return send_tls(ctx, buf, len, flags); } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* DTLS */ if (ctx->options.role == MBEDTLS_SSL_IS_SERVER) { return sendto_dtls_server(ctx, buf, len, flags, dest_addr, addrlen); } return sendto_dtls_client(ctx, buf, len, flags, dest_addr, addrlen); #else errno = ENOTSUP; return -1; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ } ssize_t ztls_sendmsg_ctx(struct tls_context *ctx, const struct msghdr *msg, int flags) { ssize_t len; ssize_t ret; int i; if (IS_ENABLED(CONFIG_NET_SOCKETS_ENABLE_DTLS) && ctx->type == SOCK_DGRAM) { /* * Current mbedTLS API (i.e. mbedtls_ssl_write()) allows only to send a single * contiguous buffer. This means that gather write using sendmsg() can only be * handled correctly if there is a single non-empty buffer in msg->msg_iov. */ if (msghdr_non_empty_iov_count(msg) > 1) { errno = EMSGSIZE; return -1; } } len = 0; if (msg) { for (i = 0; i < msg->msg_iovlen; i++) { struct iovec *vec = msg->msg_iov + i; size_t sent = 0; if (vec->iov_len == 0) { continue; } while (sent < vec->iov_len) { uint8_t *ptr = (uint8_t *)vec->iov_base + sent; ret = ztls_sendto_ctx(ctx, ptr, vec->iov_len - sent, flags, msg->msg_name, msg->msg_namelen); if (ret < 0) { return ret; } sent += ret; } len += sent; } } return len; } static ssize_t recv_tls(struct tls_context *ctx, void *buf, size_t max_len, int flags) { size_t recv_len = 0; const bool waitall = flags & ZSOCK_MSG_WAITALL; int ret; do { size_t read_len = max_len - recv_len; ret = mbedtls_ssl_read(&ctx->ssl, (uint8_t *)buf + recv_len, read_len); if (ret < 0) { if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) { /* Peer notified that it's closing the * connection. */ break; } if (ret == MBEDTLS_ERR_SSL_CLIENT_RECONNECT) { /* Client reconnect on the same socket is not * supported. See mbedtls_ssl_read API * documentation. */ break; } if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE) { if (recv_len > 0) { break; } ret = -EAGAIN; } else { ret = -EIO; } errno = -ret; return -1; } if (ret == 0) { break; } recv_len += ret; } while (waitall && (recv_len < max_len)); return recv_len; } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) static ssize_t recvfrom_dtls_common(struct tls_context *ctx, void *buf, size_t max_len, int flags, struct sockaddr *src_addr, socklen_t *addrlen) { int ret; ret = mbedtls_ssl_read(&ctx->ssl, buf, max_len); if (ret >= 0) { size_t remaining; if (src_addr && addrlen) { dtls_peer_address_get(ctx, src_addr, addrlen); } /* mbedtls_ssl_get_bytes_avail() indicate the data length * remaining in the current datagram. */ remaining = mbedtls_ssl_get_bytes_avail(&ctx->ssl); /* No more data in the datagram, or dummy read. */ if ((remaining == 0) || (max_len == 0)) { return ret; } if (flags & ZSOCK_MSG_TRUNC) { ret += remaining; } for (int i = 0; i < remaining; i++) { uint8_t byte; int err; err = mbedtls_ssl_read(&ctx->ssl, &byte, sizeof(byte)); if (err <= 0) { NET_ERR("Error while flushing the rest of the" " datagram, err %d", err); ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR; break; } } } return ret; } static ssize_t recvfrom_dtls_client(struct tls_context *ctx, void *buf, size_t max_len, int flags, struct sockaddr *src_addr, socklen_t *addrlen) { int ret; if (!is_handshake_complete(ctx)) { ret = -ENOTCONN; goto error; } ret = recvfrom_dtls_common(ctx, buf, max_len, flags, src_addr, addrlen); if (ret >= 0) { return ret; } switch (ret) { case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY: /* Peer notified that it's closing the connection. */ ret = tls_mbedtls_reset(ctx); if (ret == 0) { ret = -ENOTCONN; } else { ret = -ENOMEM; } break; case MBEDTLS_ERR_SSL_TIMEOUT: (void)mbedtls_ssl_close_notify(&ctx->ssl); ret = -ETIMEDOUT; break; case MBEDTLS_ERR_SSL_WANT_READ: case MBEDTLS_ERR_SSL_WANT_WRITE: ret = -EAGAIN; break; default: ret = -EIO; break; } error: errno = -ret; return -1; } static ssize_t recvfrom_dtls_server(struct tls_context *ctx, void *buf, size_t max_len, int flags, struct sockaddr *src_addr, socklen_t *addrlen) { int ret; bool repeat; int sock_flags = zsock_fcntl(ctx->sock, F_GETFL, 0); bool is_block; if (sock_flags == -1) { ret = -errno; goto error; } if (!ctx->is_initialized) { ret = tls_mbedtls_init(ctx, true); if (ret < 0) { goto error; } } is_block = !((flags & ZSOCK_MSG_DONTWAIT) || (sock_flags & O_NONBLOCK)); /* Loop to enable DTLS reconnection for servers without closing * a socket. */ do { repeat = false; if (!is_handshake_complete(ctx)) { ret = tls_mbedtls_handshake(ctx, is_block); if (ret < 0) { /* In case of EAGAIN, just exit. */ if (ret == -EAGAIN) { break; } ret = tls_mbedtls_reset(ctx); if (ret == 0) { repeat = true; } else { ret = -ENOMEM; } continue; } } ret = recvfrom_dtls_common(ctx, buf, max_len, flags, src_addr, addrlen); if (ret >= 0) { return ret; } switch (ret) { case MBEDTLS_ERR_SSL_TIMEOUT: (void)mbedtls_ssl_close_notify(&ctx->ssl); __fallthrough; /* fallthrough */ case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY: case MBEDTLS_ERR_SSL_CLIENT_RECONNECT: ret = tls_mbedtls_reset(ctx); if (ret == 0) { repeat = true; } else { ret = -ENOMEM; } break; case MBEDTLS_ERR_SSL_WANT_READ: case MBEDTLS_ERR_SSL_WANT_WRITE: ret = -EAGAIN; break; default: ret = -EIO; break; } } while (repeat); error: errno = -ret; return -1; } #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ ssize_t ztls_recvfrom_ctx(struct tls_context *ctx, void *buf, size_t max_len, int flags, struct sockaddr *src_addr, socklen_t *addrlen) { if (flags & ZSOCK_MSG_PEEK) { /* TODO mbedTLS does not support 'peeking' This could be * bypassed by having intermediate buffer for peeking */ errno = ENOTSUP; return -1; } ctx->flags = flags; /* TLS */ if (ctx->type == SOCK_STREAM) { return recv_tls(ctx, buf, max_len, flags); } #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) /* DTLS */ if (ctx->options.role == MBEDTLS_SSL_IS_SERVER) { return recvfrom_dtls_server(ctx, buf, max_len, flags, src_addr, addrlen); } return recvfrom_dtls_client(ctx, buf, max_len, flags, src_addr, addrlen); #else errno = ENOTSUP; return -1; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ } static int ztls_poll_prepare_pollin(struct tls_context *ctx) { /* If there already is mbedTLS data to read, there is no * need to set the k_poll_event object. Return EALREADY * so we won't block in the k_poll. */ if (!ctx->is_listening) { if (mbedtls_ssl_get_bytes_avail(&ctx->ssl) > 0) { return -EALREADY; } } return 0; } static int ztls_poll_prepare_ctx(struct tls_context *ctx, struct zsock_pollfd *pfd, struct k_poll_event **pev, struct k_poll_event *pev_end) { const struct fd_op_vtable *vtable; struct k_mutex *lock; void *obj; int ret; short events = pfd->events; /* DTLS client should wait for the handshake to complete before * it actually starts to poll for data. */ if ((pfd->events & ZSOCK_POLLIN) && (ctx->type == SOCK_DGRAM) && (ctx->options.role == MBEDTLS_SSL_IS_CLIENT) && !is_handshake_complete(ctx)) { (*pev)->obj = &ctx->tls_established; (*pev)->type = K_POLL_TYPE_SEM_AVAILABLE; (*pev)->mode = K_POLL_MODE_NOTIFY_ONLY; (*pev)->state = K_POLL_STATE_NOT_READY; (*pev)++; /* Since k_poll_event is configured by the TLS layer in this * case, do not forward ZSOCK_POLLIN to the underlying socket. */ pfd->events &= ~ZSOCK_POLLIN; } obj = z_get_fd_obj_and_vtable( ctx->sock, (const struct fd_op_vtable **)&vtable, &lock); if (obj == NULL) { ret = -EBADF; goto exit; } (void)k_mutex_lock(lock, K_FOREVER); ret = z_fdtable_call_ioctl(vtable, obj, ZFD_IOCTL_POLL_PREPARE, pfd, pev, pev_end); if (ret != 0) { goto exit; } if (pfd->events & ZSOCK_POLLIN) { ret = ztls_poll_prepare_pollin(ctx); } exit: /* Restore original events. */ pfd->events = events; k_mutex_unlock(lock); return ret; } static int ztls_socket_data_check(struct tls_context *ctx) { int ret; ctx->flags = ZSOCK_MSG_DONTWAIT; ret = mbedtls_ssl_read(&ctx->ssl, NULL, 0); if (ret < 0) { if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) { /* Don't reset the context for STREAM socket - the * application needs to reopen the socket anyway, and * resetting the context would result in an error instead * of 0 in a consecutive recv() call. */ if (ctx->type == SOCK_DGRAM) { ret = tls_mbedtls_reset(ctx); if (ret != 0) { return -ENOMEM; } } return -ENOTCONN; } if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return 0; } /* Treat any other error as fatal. */ return -EIO; } return mbedtls_ssl_get_bytes_avail(&ctx->ssl); } static int ztls_poll_update_pollin(int fd, struct tls_context *ctx, struct zsock_pollfd *pfd) { int ret; if (!ctx->is_listening) { /* Already had TLS data to read on socket. */ if (mbedtls_ssl_get_bytes_avail(&ctx->ssl) > 0) { pfd->revents |= ZSOCK_POLLIN; goto next; } } if (!(pfd->revents & ZSOCK_POLLIN)) { /* No new data on a socket. */ goto next; } if (ctx->is_listening) { goto next; } ret = ztls_socket_data_check(ctx); if (ret == -ENOTCONN || (pfd->revents & ZSOCK_POLLHUP)) { /* Datagram does not return 0 on consecutive recv, but an error * code, hence clear POLLIN. */ if (ctx->type == SOCK_DGRAM) { pfd->revents &= ~ZSOCK_POLLIN; } pfd->revents |= ZSOCK_POLLHUP; goto next; } else if (ret < 0) { pfd->revents |= ZSOCK_POLLERR; goto next; } else if (ret == 0) { goto again; } next: return 0; again: /* Received encrypted data, but still not enough * to decrypt it and return data through socket, * ask for retry if no other events are set. */ pfd->revents &= ~ZSOCK_POLLIN; return -EAGAIN; } static int ztls_poll_update_ctx(struct tls_context *ctx, struct zsock_pollfd *pfd, struct k_poll_event **pev) { const struct fd_op_vtable *vtable; struct k_mutex *lock; void *obj; int ret; short events = pfd->events; obj = z_get_fd_obj_and_vtable( ctx->sock, (const struct fd_op_vtable **)&vtable, &lock); if (obj == NULL) { return -EBADF; } (void)k_mutex_lock(lock, K_FOREVER); /* Check if the socket was waiting for the handshake to complete. */ if ((pfd->events & ZSOCK_POLLIN) && ((*pev)->obj == &ctx->tls_established)) { /* In case handshake is complete, reconfigure the k_poll_event * to monitor the underlying socket now. */ if ((*pev)->state != K_POLL_STATE_NOT_READY) { ret = z_fdtable_call_ioctl(vtable, obj, ZFD_IOCTL_POLL_PREPARE, pfd, pev, *pev + 1); if (ret != 0 && ret != -EALREADY) { goto out; } /* Return -EAGAIN to signal to poll() that it should * make another iteration with the event reconfigured * above (if needed). */ ret = -EAGAIN; goto out; } /* Handshake still not ready - skip ZSOCK_POLLIN verification * for the underlying socket. */ (*pev)++; pfd->events &= ~ZSOCK_POLLIN; } ret = z_fdtable_call_ioctl(vtable, obj, ZFD_IOCTL_POLL_UPDATE, pfd, pev); if (ret != 0) { goto exit; } if (pfd->events & ZSOCK_POLLIN) { ret = ztls_poll_update_pollin(pfd->fd, ctx, pfd); if (ret == -EAGAIN && pfd->revents != 0) { (*pev - 1)->state = K_POLL_STATE_NOT_READY; goto exit; } } exit: /* Restore original events. */ pfd->events = events; out: k_mutex_unlock(lock); return ret; } /* Return true if needed to retry rightoff or false otherwise. */ static bool poll_offload_dtls_client_retry(struct tls_context *ctx, struct zsock_pollfd *pfd) { /* DTLS client should wait for the handshake to complete before it * reports that data is ready. */ if ((ctx->type != SOCK_DGRAM) || (ctx->options.role != MBEDTLS_SSL_IS_CLIENT)) { return false; } if (ctx->handshake_in_progress) { /* Add some sleep to allow lower priority threads to proceed * with handshake. */ k_msleep(10); pfd->revents &= ~ZSOCK_POLLIN; return true; } else if (!is_handshake_complete(ctx)) { uint8_t byte; int ret; /* Handshake didn't start yet - just drop the incoming data - * it's the client who should initiate the handshake. */ ret = zsock_recv(ctx->sock, &byte, sizeof(byte), ZSOCK_MSG_DONTWAIT); if (ret < 0) { pfd->revents |= ZSOCK_POLLERR; } pfd->revents &= ~ZSOCK_POLLIN; return true; } /* Handshake complete, just proceed. */ return false; } static int ztls_poll_offload(struct zsock_pollfd *fds, int nfds, int timeout) { int fd_backup[CONFIG_NET_SOCKETS_POLL_MAX]; const struct fd_op_vtable *vtable; void *ctx; int ret = 0; int result; int i; bool retry; int remaining; uint32_t entry = k_uptime_get_32(); /* Overwrite TLS file descriptors with underlying ones. */ for (i = 0; i < nfds; i++) { fd_backup[i] = fds[i].fd; ctx = z_get_fd_obj(fds[i].fd, (const struct fd_op_vtable *) &tls_sock_fd_op_vtable, 0); if (ctx == NULL) { continue; } if (fds[i].events & ZSOCK_POLLIN) { ret = ztls_poll_prepare_pollin(ctx); /* In case data is already available in mbedtls, * do not wait in poll. */ if (ret == -EALREADY) { timeout = 0; } } fds[i].fd = ((struct tls_context *)ctx)->sock; } /* Get offloaded sockets vtable. */ ctx = z_get_fd_obj_and_vtable(fds[0].fd, (const struct fd_op_vtable **)&vtable, NULL); if (ctx == NULL) { errno = EINVAL; goto exit; } remaining = timeout; do { for (i = 0; i < nfds; i++) { fds[i].revents = 0; } ret = z_fdtable_call_ioctl(vtable, ctx, ZFD_IOCTL_POLL_OFFLOAD, fds, nfds, remaining); if (ret < 0) { goto exit; } retry = false; ret = 0; for (i = 0; i < nfds; i++) { ctx = z_get_fd_obj(fd_backup[i], (const struct fd_op_vtable *) &tls_sock_fd_op_vtable, 0); if (ctx != NULL) { if (fds[i].events & ZSOCK_POLLIN) { if (poll_offload_dtls_client_retry( ctx, &fds[i])) { retry = true; continue; } result = ztls_poll_update_pollin( fd_backup[i], ctx, &fds[i]); if (result == -EAGAIN) { retry = true; } } } if (fds[i].revents != 0) { ret++; } } if (retry) { if (ret > 0 || timeout == 0) { goto exit; } if (timeout > 0) { remaining = time_left(entry, timeout); if (remaining <= 0) { goto exit; } } } } while (retry); exit: /* Restore original fds. */ for (i = 0; i < nfds; i++) { fds[i].fd = fd_backup[i]; } return ret; } int ztls_getsockopt_ctx(struct tls_context *ctx, int level, int optname, void *optval, socklen_t *optlen) { int err; if (!optval || !optlen) { errno = EINVAL; return -1; } if ((level == SOL_SOCKET) && (optname == SO_PROTOCOL)) { /* Protocol type is overridden during socket creation. Its * value is restored here to return current value. */ err = sock_opt_protocol_get(ctx, optval, optlen); if (err < 0) { errno = -err; return -1; } return err; } else if (level != SOL_TLS) { return zsock_getsockopt(ctx->sock, level, optname, optval, optlen); } switch (optname) { case TLS_SEC_TAG_LIST: err = tls_opt_sec_tag_list_get(ctx, optval, optlen); break; case TLS_CIPHERSUITE_LIST: err = tls_opt_ciphersuite_list_get(ctx, optval, optlen); break; case TLS_CIPHERSUITE_USED: err = tls_opt_ciphersuite_used_get(ctx, optval, optlen); break; case TLS_ALPN_LIST: err = tls_opt_alpn_list_get(ctx, optval, optlen); break; case TLS_SESSION_CACHE: err = tls_opt_session_cache_get(ctx, optval, optlen); break; #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) case TLS_DTLS_HANDSHAKE_TIMEOUT_MIN: err = tls_opt_dtls_handshake_timeout_get(ctx, optval, optlen, false); break; case TLS_DTLS_HANDSHAKE_TIMEOUT_MAX: err = tls_opt_dtls_handshake_timeout_get(ctx, optval, optlen, true); break; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ default: /* Unknown or write-only option. */ err = -ENOPROTOOPT; break; } if (err < 0) { errno = -err; return -1; } return 0; } int ztls_setsockopt_ctx(struct tls_context *ctx, int level, int optname, const void *optval, socklen_t optlen) { int err; if (level != SOL_TLS) { return zsock_setsockopt(ctx->sock, level, optname, optval, optlen); } switch (optname) { case TLS_SEC_TAG_LIST: err = tls_opt_sec_tag_list_set(ctx, optval, optlen); break; case TLS_HOSTNAME: err = tls_opt_hostname_set(ctx, optval, optlen); break; case TLS_CIPHERSUITE_LIST: err = tls_opt_ciphersuite_list_set(ctx, optval, optlen); break; case TLS_PEER_VERIFY: err = tls_opt_peer_verify_set(ctx, optval, optlen); break; case TLS_CERT_NOCOPY: err = tls_opt_cert_nocopy_set(ctx, optval, optlen); break; case TLS_DTLS_ROLE: err = tls_opt_dtls_role_set(ctx, optval, optlen); break; case TLS_ALPN_LIST: err = tls_opt_alpn_list_set(ctx, optval, optlen); break; case TLS_SESSION_CACHE: err = tls_opt_session_cache_set(ctx, optval, optlen); break; case TLS_SESSION_CACHE_PURGE: err = tls_opt_session_cache_purge_set(ctx, optval, optlen); break; #if defined(CONFIG_NET_SOCKETS_ENABLE_DTLS) case TLS_DTLS_HANDSHAKE_TIMEOUT_MIN: err = tls_opt_dtls_handshake_timeout_set(ctx, optval, optlen, false); break; case TLS_DTLS_HANDSHAKE_TIMEOUT_MAX: err = tls_opt_dtls_handshake_timeout_set(ctx, optval, optlen, true); break; #endif /* CONFIG_NET_SOCKETS_ENABLE_DTLS */ case TLS_NATIVE: /* Option handled at the socket dispatcher level. */ err = 0; break; default: /* Unknown or read-only option. */ err = -ENOPROTOOPT; break; } if (err < 0) { errno = -err; return -1; } return 0; } static ssize_t tls_sock_read_vmeth(void *obj, void *buffer, size_t count) { return ztls_recvfrom_ctx(obj, buffer, count, 0, NULL, 0); } static ssize_t tls_sock_write_vmeth(void *obj, const void *buffer, size_t count) { return ztls_sendto_ctx(obj, buffer, count, 0, NULL, 0); } static int tls_sock_ioctl_vmeth(void *obj, unsigned int request, va_list args) { struct tls_context *ctx = obj; switch (request) { /* fcntl() commands */ case F_GETFL: case F_SETFL: { const struct fd_op_vtable *vtable; struct k_mutex *lock; void *obj; int ret; obj = z_get_fd_obj_and_vtable(ctx->sock, (const struct fd_op_vtable **)&vtable, &lock); if (obj == NULL) { errno = EBADF; return -1; } (void)k_mutex_lock(lock, K_FOREVER); /* Pass the call to the core socket implementation. */ ret = vtable->ioctl(obj, request, args); k_mutex_unlock(lock); return ret; } case ZFD_IOCTL_POLL_PREPARE: { struct zsock_pollfd *pfd; struct k_poll_event **pev; struct k_poll_event *pev_end; pfd = va_arg(args, struct zsock_pollfd *); pev = va_arg(args, struct k_poll_event **); pev_end = va_arg(args, struct k_poll_event *); return ztls_poll_prepare_ctx(obj, pfd, pev, pev_end); } case ZFD_IOCTL_POLL_UPDATE: { struct zsock_pollfd *pfd; struct k_poll_event **pev; pfd = va_arg(args, struct zsock_pollfd *); pev = va_arg(args, struct k_poll_event **); return ztls_poll_update_ctx(obj, pfd, pev); } case ZFD_IOCTL_POLL_OFFLOAD: { struct zsock_pollfd *fds; int nfds; int timeout; fds = va_arg(args, struct zsock_pollfd *); nfds = va_arg(args, int); timeout = va_arg(args, int); return ztls_poll_offload(fds, nfds, timeout); } default: errno = EOPNOTSUPP; return -1; } } static int tls_sock_shutdown_vmeth(void *obj, int how) { struct tls_context *ctx = obj; return zsock_shutdown(ctx->sock, how); } static int tls_sock_bind_vmeth(void *obj, const struct sockaddr *addr, socklen_t addrlen) { struct tls_context *ctx = obj; return zsock_bind(ctx->sock, addr, addrlen); } static int tls_sock_connect_vmeth(void *obj, const struct sockaddr *addr, socklen_t addrlen) { return ztls_connect_ctx(obj, addr, addrlen); } static int tls_sock_listen_vmeth(void *obj, int backlog) { struct tls_context *ctx = obj; ctx->is_listening = true; return zsock_listen(ctx->sock, backlog); } static int tls_sock_accept_vmeth(void *obj, struct sockaddr *addr, socklen_t *addrlen) { return ztls_accept_ctx(obj, addr, addrlen); } static ssize_t tls_sock_sendto_vmeth(void *obj, const void *buf, size_t len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen) { return ztls_sendto_ctx(obj, buf, len, flags, dest_addr, addrlen); } static ssize_t tls_sock_sendmsg_vmeth(void *obj, const struct msghdr *msg, int flags) { return ztls_sendmsg_ctx(obj, msg, flags); } static ssize_t tls_sock_recvfrom_vmeth(void *obj, void *buf, size_t max_len, int flags, struct sockaddr *src_addr, socklen_t *addrlen) { return ztls_recvfrom_ctx(obj, buf, max_len, flags, src_addr, addrlen); } static int tls_sock_getsockopt_vmeth(void *obj, int level, int optname, void *optval, socklen_t *optlen) { return ztls_getsockopt_ctx(obj, level, optname, optval, optlen); } static int tls_sock_setsockopt_vmeth(void *obj, int level, int optname, const void *optval, socklen_t optlen) { return ztls_setsockopt_ctx(obj, level, optname, optval, optlen); } static int tls_sock_close_vmeth(void *obj) { return ztls_close_ctx(obj); } static int tls_sock_getpeername_vmeth(void *obj, struct sockaddr *addr, socklen_t *addrlen) { struct tls_context *ctx = obj; return zsock_getpeername(ctx->sock, addr, addrlen); } static int tls_sock_getsockname_vmeth(void *obj, struct sockaddr *addr, socklen_t *addrlen) { struct tls_context *ctx = obj; return zsock_getsockname(ctx->sock, addr, addrlen); } static const struct socket_op_vtable tls_sock_fd_op_vtable = { .fd_vtable = { .read = tls_sock_read_vmeth, .write = tls_sock_write_vmeth, .close = tls_sock_close_vmeth, .ioctl = tls_sock_ioctl_vmeth, }, .shutdown = tls_sock_shutdown_vmeth, .bind = tls_sock_bind_vmeth, .connect = tls_sock_connect_vmeth, .listen = tls_sock_listen_vmeth, .accept = tls_sock_accept_vmeth, .sendto = tls_sock_sendto_vmeth, .sendmsg = tls_sock_sendmsg_vmeth, .recvfrom = tls_sock_recvfrom_vmeth, .getsockopt = tls_sock_getsockopt_vmeth, .setsockopt = tls_sock_setsockopt_vmeth, .getpeername = tls_sock_getpeername_vmeth, .getsockname = tls_sock_getsockname_vmeth, }; static bool |