oauth2/lib.rs
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
#![warn(missing_docs)]
//!
//! An extensible, strongly-typed implementation of OAuth2
//! ([RFC 6749](https://tools.ietf.org/html/rfc6749)) including token introspection ([RFC 7662](https://tools.ietf.org/html/rfc7662))
//! and token revocation ([RFC 7009](https://tools.ietf.org/html/rfc7009)).
//!
//! # Contents
//! * [Importing `oauth2`: selecting an HTTP client interface](#importing-oauth2-selecting-an-http-client-interface)
//! * [Getting started: Authorization Code Grant w/ PKCE](#getting-started-authorization-code-grant-w-pkce)
//! * [Example: Synchronous (blocking) API](#example-synchronous-blocking-api)
//! * [Example: Asynchronous API](#example-asynchronous-api)
//! * [Implicit Grant](#implicit-grant)
//! * [Resource Owner Password Credentials Grant](#resource-owner-password-credentials-grant)
//! * [Client Credentials Grant](#client-credentials-grant)
//! * [Device Code Flow](#device-code-flow)
//! * [Other examples](#other-examples)
//! * [Contributed Examples](#contributed-examples)
//!
//! # Importing `oauth2`: selecting an HTTP client interface
//!
//! This library offers a flexible HTTP client interface with two modes:
//! * **Synchronous (blocking)**
//! * **Asynchronous**
//!
//! For the HTTP client modes described above, the following HTTP client implementations can be
//! used:
//! * **[`reqwest`]**
//!
//! The `reqwest` HTTP client supports both the synchronous and asynchronous modes and is enabled
//! by default.
//!
//! Synchronous client: [`reqwest::http_client`]
//!
//! Asynchronous client: [`reqwest::async_http_client`]
//!
//! * **[`curl`]**
//!
//! The `curl` HTTP client only supports the synchronous HTTP client mode and can be enabled in
//! `Cargo.toml` via the `curl` feature flag.
//!
//! Synchronous client: [`curl::http_client`]
//!
//! * **[`ureq`]**
//!
//! The `ureq` HTTP client is a simple HTTP client with minimal dependencies. It only supports
//! the synchronous HTTP client mode and can be enabled in `Cargo.toml` via the `ureq` feature
//! flag.
//!
//! * **Custom**
//!
//! In addition to the clients above, users may define their own HTTP clients, which must accept
//! an [`HttpRequest`] and return an [`HttpResponse`] or error. Users writing their own clients
//! may wish to disable the default `reqwest` dependency by specifying
//! `default-features = false` in `Cargo.toml` (replacing `...` with the desired version of this
//! crate):
//! ```toml
//! oauth2 = { version = "...", default-features = false }
//! ```
//!
//! Synchronous HTTP clients should implement the following trait:
//! ```rust,ignore
//! FnOnce(HttpRequest) -> Result<HttpResponse, RE>
//! where RE: std::error::Error + 'static
//! ```
//!
//! Asynchronous HTTP clients should implement the following trait:
//! ```rust,ignore
//! FnOnce(HttpRequest) -> F
//! where
//! F: Future<Output = Result<HttpResponse, RE>>,
//! RE: std::error::Error + 'static
//! ```
//!
//! # Getting started: Authorization Code Grant w/ PKCE
//!
//! This is the most common OAuth2 flow. PKCE is recommended whenever the OAuth2 client has no
//! client secret or has a client secret that cannot remain confidential (e.g., native, mobile, or
//! client-side web applications).
//!
//! ## Example: Synchronous (blocking) API
//!
//! This example works with `oauth2`'s default feature flags, which include `reqwest`.
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthorizationCode,
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! CsrfToken,
//! PkceCodeChallenge,
//! RedirectUrl,
//! Scope,
//! TokenResponse,
//! TokenUrl
//! };
//! use oauth2::basic::BasicClient;
//! use oauth2::reqwest::http_client;
//! use url::Url;
//!
//! # fn err_wrapper() -> Result<(), anyhow::Error> {
//! // Create an OAuth2 client by specifying the client ID, client secret, authorization URL and
//! // token URL.
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! Some(TokenUrl::new("http://token".to_string())?)
//! )
//! // Set the URL the user will be redirected to after the authorization process.
//! .set_redirect_uri(RedirectUrl::new("http://redirect".to_string())?);
//!
//! // Generate a PKCE challenge.
//! let (pkce_challenge, pkce_verifier) = PkceCodeChallenge::new_random_sha256();
//!
//! // Generate the full authorization URL.
//! let (auth_url, csrf_token) = client
//! .authorize_url(CsrfToken::new_random)
//! // Set the desired scopes.
//! .add_scope(Scope::new("read".to_string()))
//! .add_scope(Scope::new("write".to_string()))
//! // Set the PKCE code challenge.
//! .set_pkce_challenge(pkce_challenge)
//! .url();
//!
//! // This is the URL you should redirect the user to, in order to trigger the authorization
//! // process.
//! println!("Browse to: {}", auth_url);
//!
//! // Once the user has been redirected to the redirect URL, you'll have access to the
//! // authorization code. For security reasons, your code should verify that the `state`
//! // parameter returned by the server matches `csrf_state`.
//!
//! // Now you can trade it for an access token.
//! let token_result =
//! client
//! .exchange_code(AuthorizationCode::new("some authorization code".to_string()))
//! // Set the PKCE code verifier.
//! .set_pkce_verifier(pkce_verifier)
//! .request(http_client)?;
//!
//! // Unwrapping token_result will either produce a Token or a RequestTokenError.
//! # Ok(())
//! # }
//! ```
//!
//! ## Example: Asynchronous API
//!
//! The example below uses async/await:
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthorizationCode,
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! CsrfToken,
//! PkceCodeChallenge,
//! RedirectUrl,
//! Scope,
//! TokenResponse,
//! TokenUrl
//! };
//! use oauth2::basic::BasicClient;
//! # #[cfg(feature = "reqwest")]
//! use oauth2::reqwest::async_http_client;
//! use url::Url;
//!
//! # #[cfg(feature = "reqwest")]
//! # async fn err_wrapper() -> Result<(), anyhow::Error> {
//! // Create an OAuth2 client by specifying the client ID, client secret, authorization URL and
//! // token URL.
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! Some(TokenUrl::new("http://token".to_string())?)
//! )
//! // Set the URL the user will be redirected to after the authorization process.
//! .set_redirect_uri(RedirectUrl::new("http://redirect".to_string())?);
//!
//! // Generate a PKCE challenge.
//! let (pkce_challenge, pkce_verifier) = PkceCodeChallenge::new_random_sha256();
//!
//! // Generate the full authorization URL.
//! let (auth_url, csrf_token) = client
//! .authorize_url(CsrfToken::new_random)
//! // Set the desired scopes.
//! .add_scope(Scope::new("read".to_string()))
//! .add_scope(Scope::new("write".to_string()))
//! // Set the PKCE code challenge.
//! .set_pkce_challenge(pkce_challenge)
//! .url();
//!
//! // This is the URL you should redirect the user to, in order to trigger the authorization
//! // process.
//! println!("Browse to: {}", auth_url);
//!
//! // Once the user has been redirected to the redirect URL, you'll have access to the
//! // authorization code. For security reasons, your code should verify that the `state`
//! // parameter returned by the server matches `csrf_state`.
//!
//! // Now you can trade it for an access token.
//! let token_result = client
//! .exchange_code(AuthorizationCode::new("some authorization code".to_string()))
//! // Set the PKCE code verifier.
//! .set_pkce_verifier(pkce_verifier)
//! .request_async(async_http_client)
//! .await?;
//!
//! // Unwrapping token_result will either produce a Token or a RequestTokenError.
//! # Ok(())
//! # }
//! ```
//!
//! # Implicit Grant
//!
//! This flow fetches an access token directly from the authorization endpoint. Be sure to
//! understand the security implications of this flow before using it. In most cases, the
//! Authorization Code Grant flow is preferable to the Implicit Grant flow.
//!
//! ## Example
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! CsrfToken,
//! RedirectUrl,
//! Scope
//! };
//! use oauth2::basic::BasicClient;
//! use url::Url;
//!
//! # fn err_wrapper() -> Result<(), anyhow::Error> {
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! None
//! );
//!
//! // Generate the full authorization URL.
//! let (auth_url, csrf_token) = client
//! .authorize_url(CsrfToken::new_random)
//! .use_implicit_flow()
//! .url();
//!
//! // This is the URL you should redirect the user to, in order to trigger the authorization
//! // process.
//! println!("Browse to: {}", auth_url);
//!
//! // Once the user has been redirected to the redirect URL, you'll have the access code.
//! // For security reasons, your code should verify that the `state` parameter returned by the
//! // server matches `csrf_state`.
//!
//! # Ok(())
//! # }
//! ```
//!
//! # Resource Owner Password Credentials Grant
//!
//! You can ask for a *password* access token by calling the `Client::exchange_password` method,
//! while including the username and password.
//!
//! ## Example
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! ResourceOwnerPassword,
//! ResourceOwnerUsername,
//! Scope,
//! TokenResponse,
//! TokenUrl
//! };
//! use oauth2::basic::BasicClient;
//! use oauth2::reqwest::http_client;
//! use url::Url;
//!
//! # fn err_wrapper() -> Result<(), anyhow::Error> {
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! Some(TokenUrl::new("http://token".to_string())?)
//! );
//!
//! let token_result =
//! client
//! .exchange_password(
//! &ResourceOwnerUsername::new("user".to_string()),
//! &ResourceOwnerPassword::new("pass".to_string())
//! )
//! .add_scope(Scope::new("read".to_string()))
//! .request(http_client)?;
//! # Ok(())
//! # }
//! ```
//!
//! # Client Credentials Grant
//!
//! You can ask for a *client credentials* access token by calling the
//! `Client::exchange_client_credentials` method.
//!
//! ## Example
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! Scope,
//! TokenResponse,
//! TokenUrl
//! };
//! use oauth2::basic::BasicClient;
//! use oauth2::reqwest::http_client;
//! use url::Url;
//!
//! # fn err_wrapper() -> Result<(), anyhow::Error> {
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! Some(TokenUrl::new("http://token".to_string())?),
//! );
//!
//! let token_result = client
//! .exchange_client_credentials()
//! .add_scope(Scope::new("read".to_string()))
//! .request(http_client)?;
//! # Ok(())
//! # }
//! ```
//!
//! # Device Code Flow
//!
//! Device Code Flow allows users to sign in on browserless or input-constrained
//! devices. This is a two-stage process; first a user-code and verification
//! URL are obtained by using the `Client::exchange_client_credentials`
//! method. Those are displayed to the user, then are used in a second client
//! to poll the token endpoint for a token.
//!
//! ## Example
//!
//! ```rust,no_run
//! use anyhow;
//! use oauth2::{
//! AuthUrl,
//! ClientId,
//! ClientSecret,
//! DeviceAuthorizationUrl,
//! Scope,
//! TokenResponse,
//! TokenUrl
//! };
//! use oauth2::basic::BasicClient;
//! use oauth2::devicecode::StandardDeviceAuthorizationResponse;
//! use oauth2::reqwest::http_client;
//! use url::Url;
//!
//! # fn err_wrapper() -> Result<(), anyhow::Error> {
//! let device_auth_url = DeviceAuthorizationUrl::new("http://deviceauth".to_string())?;
//! let client =
//! BasicClient::new(
//! ClientId::new("client_id".to_string()),
//! Some(ClientSecret::new("client_secret".to_string())),
//! AuthUrl::new("http://authorize".to_string())?,
//! Some(TokenUrl::new("http://token".to_string())?),
//! )
//! .set_device_authorization_url(device_auth_url);
//!
//! let details: StandardDeviceAuthorizationResponse = client
//! .exchange_device_code()?
//! .add_scope(Scope::new("read".to_string()))
//! .request(http_client)?;
//!
//! println!(
//! "Open this URL in your browser:\n{}\nand enter the code: {}",
//! details.verification_uri().to_string(),
//! details.user_code().secret().to_string()
//! );
//!
//! let token_result =
//! client
//! .exchange_device_access_token(&details)
//! .request(http_client, std::thread::sleep, None)?;
//!
//! # Ok(())
//! # }
//! ```
//!
//! # Other examples
//!
//! More specific implementations are available as part of the examples:
//!
//! - [Google](https://github.com/ramosbugs/oauth2-rs/blob/main/examples/google.rs) (includes token revocation)
//! - [Github](https://github.com/ramosbugs/oauth2-rs/blob/main/examples/github.rs)
//! - [Microsoft Device Code Flow (async)](https://github.com/ramosbugs/oauth2-rs/blob/main/examples/microsoft_devicecode.rs)
//! - [Microsoft Graph](https://github.com/ramosbugs/oauth2-rs/blob/main/examples/msgraph.rs)
//! - [Wunderlist](https://github.com/ramosbugs/oauth2-rs/blob/main/examples/wunderlist.rs)
//!
//! ## Contributed Examples
//!
//! - [`actix-web-oauth2`](https://github.com/pka/actix-web-oauth2) (version 2.x of this crate)
//!
use std::borrow::Cow;
use std::error::Error;
use std::fmt::Error as FormatterError;
use std::fmt::{Debug, Display, Formatter};
use std::future::Future;
use std::marker::PhantomData;
use std::sync::Arc;
use std::time::Duration;
use chrono::serde::ts_seconds_option;
use chrono::{DateTime, Utc};
use http::header::{HeaderMap, HeaderValue, ACCEPT, AUTHORIZATION, CONTENT_TYPE};
use http::status::StatusCode;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use url::{form_urlencoded, Url};
use crate::devicecode::DeviceAccessTokenPollResult;
///
/// Basic OAuth2 implementation with no extensions
/// ([RFC 6749](https://tools.ietf.org/html/rfc6749)).
///
pub mod basic;
///
/// HTTP client backed by the [curl](https://crates.io/crates/curl) crate.
/// Requires "curl" feature.
///
#[cfg(all(feature = "curl", not(target_arch = "wasm32")))]
pub mod curl;
#[cfg(all(feature = "curl", target_arch = "wasm32"))]
compile_error!("wasm32 is not supported with the `curl` feature. Use the `reqwest` backend or a custom backend for wasm32 support");
///
/// Device Code Flow OAuth2 implementation
/// ([RFC 8628](https://tools.ietf.org/html/rfc8628)).
///
pub mod devicecode;
///
/// OAuth 2.0 Token Revocation implementation
/// ([RFC 7009](https://tools.ietf.org/html/rfc7009)).
///
pub mod revocation;
///
/// Helper methods used by OAuth2 implementations/extensions.
///
pub mod helpers;
///
/// HTTP client backed by the [reqwest](https://crates.io/crates/reqwest) crate.
/// Requires "reqwest" feature.
///
#[cfg(feature = "reqwest")]
pub mod reqwest;
#[cfg(test)]
mod tests;
mod types;
///
/// HTTP client backed by the [ureq](https://crates.io/crates/ureq) crate.
/// Requires "ureq" feature.
///
#[cfg(feature = "ureq")]
pub mod ureq;
///
/// Public re-exports of types used for HTTP client interfaces.
///
pub use http;
pub use url;
pub use devicecode::{
DeviceAuthorizationResponse, DeviceCodeErrorResponse, DeviceCodeErrorResponseType,
EmptyExtraDeviceAuthorizationFields, ExtraDeviceAuthorizationFields,
StandardDeviceAuthorizationResponse,
};
pub use types::{
AccessToken, AuthUrl, AuthorizationCode, ClientId, ClientSecret, CsrfToken,
DeviceAuthorizationUrl, DeviceCode, EndUserVerificationUrl, IntrospectionUrl,
PkceCodeChallenge, PkceCodeChallengeMethod, PkceCodeVerifier, RedirectUrl, RefreshToken,
ResourceOwnerPassword, ResourceOwnerUsername, ResponseType, RevocationUrl, Scope, TokenUrl,
UserCode, VerificationUriComplete,
};
pub use revocation::{RevocableToken, RevocationErrorResponseType, StandardRevocableToken};
const CONTENT_TYPE_JSON: &str = "application/json";
const CONTENT_TYPE_FORMENCODED: &str = "application/x-www-form-urlencoded";
///
/// There was a problem configuring the request.
///
#[non_exhaustive]
#[derive(Debug, thiserror::Error)]
pub enum ConfigurationError {
///
/// The endpoint URL tp be contacted is missing.
///
#[error("No {0} endpoint URL specified")]
MissingUrl(&'static str),
///
/// The endpoint URL to be contacted MUST be HTTPS.
///
#[error("Scheme for {0} endpoint URL must be HTTPS")]
InsecureUrl(&'static str),
}
///
/// Indicates whether requests to the authorization server should use basic authentication or
/// include the parameters in the request body for requests in which either is valid.
///
/// The default AuthType is *BasicAuth*, following the recommendation of
/// [Section 2.3.1 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-2.3.1).
///
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum AuthType {
/// The client_id and client_secret (if set) will be included as part of the request body.
RequestBody,
/// The client_id and client_secret will be included using the basic auth authentication scheme.
BasicAuth,
}
///
/// Stores the configuration for an OAuth2 client.
///
/// # Error Types
///
/// To enable compile time verification that only the correct and complete set of errors for the `Client` function being
/// invoked are exposed to the caller, the `Client` type is specialized on multiple implementations of the
/// [`ErrorResponse`] trait. The exact [`ErrorResponse`] implementation returned varies by the RFC that the invoked
/// `Client` function implements:
///
/// - Generic type `TE` (aka Token Error) for errors defined by [RFC 6749 OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749).
/// - Generic type `TRE` (aka Token Revocation Error) for errors defined by [RFC 7009 OAuth 2.0 Token Revocation](https://tools.ietf.org/html/rfc7009).
///
/// For example when revoking a token, error code `unsupported_token_type` (from RFC 7009) may be returned:
/// ```rust
/// # use thiserror::Error;
/// # use http::status::StatusCode;
/// # use http::header::{HeaderValue, CONTENT_TYPE};
/// # use oauth2::{*, basic::*};
/// # let client = BasicClient::new(
/// # ClientId::new("aaa".to_string()),
/// # Some(ClientSecret::new("bbb".to_string())),
/// # AuthUrl::new("https://example.com/auth".to_string()).unwrap(),
/// # Some(TokenUrl::new("https://example.com/token".to_string()).unwrap()),
/// # )
/// # .set_revocation_uri(RevocationUrl::new("https://revocation/url".to_string()).unwrap());
/// #
/// # #[derive(Debug, Error)]
/// # enum FakeError {
/// # #[error("error")]
/// # Err,
/// # }
/// #
/// # let http_client = |_| -> Result<HttpResponse, FakeError> {
/// # Ok(HttpResponse {
/// # status_code: StatusCode::BAD_REQUEST,
/// # headers: vec![(
/// # CONTENT_TYPE,
/// # HeaderValue::from_str("application/json").unwrap(),
/// # )]
/// # .into_iter()
/// # .collect(),
/// # body: "{\"error\": \"unsupported_token_type\", \"error_description\": \"stuff happened\", \
/// # \"error_uri\": \"https://errors\"}"
/// # .to_string()
/// # .into_bytes(),
/// # })
/// # };
/// #
/// let res = client
/// .revoke_token(AccessToken::new("some token".to_string()).into())
/// .unwrap()
/// .request(http_client);
///
/// assert!(matches!(res, Err(
/// RequestTokenError::ServerResponse(err)) if matches!(err.error(),
/// RevocationErrorResponseType::UnsupportedTokenType)));
/// ```
///
#[derive(Clone, Debug)]
pub struct Client<TE, TR, TT, TIR, RT, TRE>
where
TE: ErrorResponse,
TR: TokenResponse<TT>,
TT: TokenType,
TIR: TokenIntrospectionResponse<TT>,
RT: RevocableToken,
TRE: ErrorResponse,
{
client_id: ClientId,
client_secret: Option<ClientSecret>,
auth_url: AuthUrl,
auth_type: AuthType,
token_url: Option<TokenUrl>,
redirect_url: Option<RedirectUrl>,
introspection_url: Option<IntrospectionUrl>,
revocation_url: Option<RevocationUrl>,
device_authorization_url: Option<DeviceAuthorizationUrl>,
phantom: PhantomData<(TE, TR, TT, TIR, RT, TRE)>,
}
impl<TE, TR, TT, TIR, RT, TRE> Client<TE, TR, TT, TIR, RT, TRE>
where
TE: ErrorResponse + 'static,
TR: TokenResponse<TT>,
TT: TokenType,
TIR: TokenIntrospectionResponse<TT>,
RT: RevocableToken,
TRE: ErrorResponse + 'static,
{
///
/// Initializes an OAuth2 client with the fields common to most OAuth2 flows.
///
/// # Arguments
///
/// * `client_id` - Client ID
/// * `client_secret` - Optional client secret. A client secret is generally used for private
/// (server-side) OAuth2 clients and omitted from public (client-side or native app) OAuth2
/// clients (see [RFC 8252](https://tools.ietf.org/html/rfc8252)).
/// * `auth_url` - Authorization endpoint: used by the client to obtain authorization from
/// the resource owner via user-agent redirection. This URL is used in all standard OAuth2
/// flows except the [Resource Owner Password Credentials
/// Grant](https://tools.ietf.org/html/rfc6749#section-4.3) and the
/// [Client Credentials Grant](https://tools.ietf.org/html/rfc6749#section-4.4).
/// * `token_url` - Token endpoint: used by the client to exchange an authorization grant
/// (code) for an access token, typically with client authentication. This URL is used in
/// all standard OAuth2 flows except the
/// [Implicit Grant](https://tools.ietf.org/html/rfc6749#section-4.2). If this value is set
/// to `None`, the `exchange_*` methods will return `Err(RequestTokenError::Other(_))`.
///
pub fn new(
client_id: ClientId,
client_secret: Option<ClientSecret>,
auth_url: AuthUrl,
token_url: Option<TokenUrl>,
) -> Self {
Client {
client_id,
client_secret,
auth_url,
auth_type: AuthType::BasicAuth,
token_url,
redirect_url: None,
introspection_url: None,
revocation_url: None,
device_authorization_url: None,
phantom: PhantomData,
}
}
///
/// Configures the type of client authentication used for communicating with the authorization
/// server.
///
/// The default is to use HTTP Basic authentication, as recommended in
/// [Section 2.3.1 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-2.3.1). Note that
/// if a client secret is omitted (i.e., `client_secret` is set to `None` when calling
/// [`Client::new`]), [`AuthType::RequestBody`] is used regardless of the `auth_type` passed to
/// this function.
///
pub fn set_auth_type(mut self, auth_type: AuthType) -> Self {
self.auth_type = auth_type;
self
}
///
/// Sets the redirect URL used by the authorization endpoint.
///
pub fn set_redirect_uri(mut self, redirect_url: RedirectUrl) -> Self {
self.redirect_url = Some(redirect_url);
self
}
///
/// Sets the introspection URL for contacting the ([RFC 7662](https://tools.ietf.org/html/rfc7662))
/// introspection endpoint.
///
pub fn set_introspection_uri(mut self, introspection_url: IntrospectionUrl) -> Self {
self.introspection_url = Some(introspection_url);
self
}
///
/// Sets the revocation URL for contacting the revocation endpoint ([RFC 7009](https://tools.ietf.org/html/rfc7009)).
///
/// See: [`revoke_token()`](Self::revoke_token())
///
pub fn set_revocation_uri(mut self, revocation_url: RevocationUrl) -> Self {
self.revocation_url = Some(revocation_url);
self
}
///
/// Sets the the device authorization URL used by the device authorization endpoint.
/// Used for Device Code Flow, as per [RFC 8628](https://tools.ietf.org/html/rfc8628).
///
pub fn set_device_authorization_url(
mut self,
device_authorization_url: DeviceAuthorizationUrl,
) -> Self {
self.device_authorization_url = Some(device_authorization_url);
self
}
///
/// Generates an authorization URL for a new authorization request.
///
/// # Arguments
///
/// * `state_fn` - A function that returns an opaque value used by the client to maintain state
/// between the request and callback. The authorization server includes this value when
/// redirecting the user-agent back to the client.
///
/// # Security Warning
///
/// Callers should use a fresh, unpredictable `state` for each authorization request and verify
/// that this value matches the `state` parameter passed by the authorization server to the
/// redirect URI. Doing so mitigates
/// [Cross-Site Request Forgery](https://tools.ietf.org/html/rfc6749#section-10.12)
/// attacks. To disable CSRF protections (NOT recommended), use `insecure::authorize_url`
/// instead.
///
pub fn authorize_url<S>(&self, state_fn: S) -> AuthorizationRequest
where
S: FnOnce() -> CsrfToken,
{
AuthorizationRequest {
auth_url: &self.auth_url,
client_id: &self.client_id,
extra_params: Vec::new(),
pkce_challenge: None,
redirect_url: self.redirect_url.as_ref().map(Cow::Borrowed),
response_type: "code".into(),
scopes: Vec::new(),
state: state_fn(),
}
}
///
/// Exchanges a code produced by a successful authorization process with an access token.
///
/// Acquires ownership of the `code` because authorization codes may only be used once to
/// retrieve an access token from the authorization server.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.1.3>.
///
pub fn exchange_code(&self, code: AuthorizationCode) -> CodeTokenRequest<TE, TR, TT> {
CodeTokenRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
code,
extra_params: Vec::new(),
pkce_verifier: None,
token_url: self.token_url.as_ref(),
redirect_url: self.redirect_url.as_ref().map(Cow::Borrowed),
_phantom: PhantomData,
}
}
///
/// Requests an access token for the *password* grant type.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.3.2>.
///
pub fn exchange_password<'a, 'b>(
&'a self,
username: &'b ResourceOwnerUsername,
password: &'b ResourceOwnerPassword,
) -> PasswordTokenRequest<'b, TE, TR, TT>
where
'a: 'b,
{
PasswordTokenRequest::<'b> {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
username,
password,
extra_params: Vec::new(),
scopes: Vec::new(),
token_url: self.token_url.as_ref(),
_phantom: PhantomData,
}
}
///
/// Requests an access token for the *client credentials* grant type.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.4.2>.
///
pub fn exchange_client_credentials(&self) -> ClientCredentialsTokenRequest<TE, TR, TT> {
ClientCredentialsTokenRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
scopes: Vec::new(),
token_url: self.token_url.as_ref(),
_phantom: PhantomData,
}
}
///
/// Exchanges a refresh token for an access token
///
/// See <https://tools.ietf.org/html/rfc6749#section-6>.
///
pub fn exchange_refresh_token<'a, 'b>(
&'a self,
refresh_token: &'b RefreshToken,
) -> RefreshTokenRequest<'b, TE, TR, TT>
where
'a: 'b,
{
RefreshTokenRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
refresh_token,
scopes: Vec::new(),
token_url: self.token_url.as_ref(),
_phantom: PhantomData,
}
}
///
/// Perform a device authorization request as per
/// <https://tools.ietf.org/html/rfc8628#section-3.1>.
///
pub fn exchange_device_code(
&self,
) -> Result<DeviceAuthorizationRequest<TE>, ConfigurationError> {
Ok(DeviceAuthorizationRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
scopes: Vec::new(),
device_authorization_url: self
.device_authorization_url
.as_ref()
.ok_or(ConfigurationError::MissingUrl("device authorization_url"))?,
_phantom: PhantomData,
})
}
///
/// Perform a device access token request as per
/// <https://tools.ietf.org/html/rfc8628#section-3.4>.
///
pub fn exchange_device_access_token<'a, 'b, 'c, EF>(
&'a self,
auth_response: &'b DeviceAuthorizationResponse<EF>,
) -> DeviceAccessTokenRequest<'b, 'c, TR, TT, EF>
where
'a: 'b,
EF: ExtraDeviceAuthorizationFields,
{
DeviceAccessTokenRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
token_url: self.token_url.as_ref(),
dev_auth_resp: auth_response,
time_fn: Arc::new(Utc::now),
max_backoff_interval: None,
_phantom: PhantomData,
}
}
///
/// Query the authorization server [`RFC 7662 compatible`](https://tools.ietf.org/html/rfc7662) introspection
/// endpoint to determine the set of metadata for a previously received token.
///
/// Requires that [`set_introspection_uri()`](Self::set_introspection_uri()) have already been called to set the
/// introspection endpoint URL.
///
/// Attempting to submit the generated request without calling [`set_introspection_uri()`](Self::set_introspection_uri())
/// first will result in an error.
///
pub fn introspect<'a>(
&'a self,
token: &'a AccessToken,
) -> Result<IntrospectionRequest<'a, TE, TIR, TT>, ConfigurationError> {
Ok(IntrospectionRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
introspection_url: self
.introspection_url
.as_ref()
.ok_or(ConfigurationError::MissingUrl("introspection"))?,
token,
token_type_hint: None,
_phantom: PhantomData,
})
}
///
/// Attempts to revoke the given previously received token using an [RFC 7009 OAuth 2.0 Token Revocation](https://tools.ietf.org/html/rfc7009)
/// compatible endpoint.
///
/// Requires that [`set_revocation_uri()`](Self::set_revocation_uri()) have already been called to set the
/// revocation endpoint URL.
///
/// Attempting to submit the generated request without calling [`set_revocation_uri()`](Self::set_revocation_uri())
/// first will result in an error.
///
pub fn revoke_token(
&self,
token: RT,
) -> Result<RevocationRequest<RT, TRE>, ConfigurationError> {
// https://tools.ietf.org/html/rfc7009#section-2 states:
// "The client requests the revocation of a particular token by making an
// HTTP POST request to the token revocation endpoint URL. This URL
// MUST conform to the rules given in [RFC6749], Section 3.1. Clients
// MUST verify that the URL is an HTTPS URL."
let revocation_url = match self.revocation_url.as_ref() {
Some(url) if url.url().scheme() == "https" => Ok(url),
Some(_) => Err(ConfigurationError::InsecureUrl("revocation")),
None => Err(ConfigurationError::MissingUrl("revocation")),
}?;
Ok(RevocationRequest {
auth_type: &self.auth_type,
client_id: &self.client_id,
client_secret: self.client_secret.as_ref(),
extra_params: Vec::new(),
revocation_url,
token,
_phantom: PhantomData,
})
}
///
/// Returns the Client ID.
///
pub fn client_id(&self) -> &ClientId {
&self.client_id
}
///
/// Returns the authorization endpoint.
///
pub fn auth_url(&self) -> &AuthUrl {
&self.auth_url
}
///
/// Returns the type of client authentication used for communicating with the authorization
/// server.
///
pub fn auth_type(&self) -> &AuthType {
&self.auth_type
}
///
/// Returns the token endpoint.
///
pub fn token_url(&self) -> Option<&TokenUrl> {
self.token_url.as_ref()
}
///
/// Returns the redirect URL used by the authorization endpoint.
///
pub fn redirect_url(&self) -> Option<&RedirectUrl> {
self.redirect_url.as_ref()
}
///
/// Returns the introspection URL for contacting the ([RFC 7662](https://tools.ietf.org/html/rfc7662))
/// introspection endpoint.
///
pub fn introspection_url(&self) -> Option<&IntrospectionUrl> {
self.introspection_url.as_ref()
}
///
/// Returns the revocation URL for contacting the revocation endpoint ([RFC 7009](https://tools.ietf.org/html/rfc7009)).
///
/// See: [`revoke_token()`](Self::revoke_token())
///
pub fn revocation_url(&self) -> Option<&RevocationUrl> {
self.revocation_url.as_ref()
}
///
/// Returns the the device authorization URL used by the device authorization endpoint.
///
pub fn device_authorization_url(&self) -> Option<&DeviceAuthorizationUrl> {
self.device_authorization_url.as_ref()
}
}
///
/// A request to the authorization endpoint
///
#[derive(Debug)]
pub struct AuthorizationRequest<'a> {
auth_url: &'a AuthUrl,
client_id: &'a ClientId,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
pkce_challenge: Option<PkceCodeChallenge>,
redirect_url: Option<Cow<'a, RedirectUrl>>,
response_type: Cow<'a, str>,
scopes: Vec<Cow<'a, Scope>>,
state: CsrfToken,
}
impl<'a> AuthorizationRequest<'a> {
///
/// Appends a new scope to the authorization URL.
///
pub fn add_scope(mut self, scope: Scope) -> Self {
self.scopes.push(Cow::Owned(scope));
self
}
///
/// Appends a collection of scopes to the token request.
///
pub fn add_scopes<I>(mut self, scopes: I) -> Self
where
I: IntoIterator<Item = Scope>,
{
self.scopes.extend(scopes.into_iter().map(Cow::Owned));
self
}
///
/// Appends an extra param to the authorization URL.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Enables the [Implicit Grant](https://tools.ietf.org/html/rfc6749#section-4.2) flow.
///
pub fn use_implicit_flow(mut self) -> Self {
self.response_type = "token".into();
self
}
///
/// Enables custom flows other than the `code` and `token` (implicit flow) grant.
///
pub fn set_response_type(mut self, response_type: &ResponseType) -> Self {
self.response_type = (&**response_type).to_owned().into();
self
}
///
/// Enables the use of [Proof Key for Code Exchange](https://tools.ietf.org/html/rfc7636)
/// (PKCE).
///
/// PKCE is *highly recommended* for all public clients (i.e., those for which there
/// is no client secret or for which the client secret is distributed with the client,
/// such as in a native, mobile app, or browser app).
///
pub fn set_pkce_challenge(mut self, pkce_code_challenge: PkceCodeChallenge) -> Self {
self.pkce_challenge = Some(pkce_code_challenge);
self
}
///
/// Overrides the `redirect_url` to the one specified.
///
pub fn set_redirect_uri(mut self, redirect_url: Cow<'a, RedirectUrl>) -> Self {
self.redirect_url = Some(redirect_url);
self
}
///
/// Returns the full authorization URL and CSRF state for this authorization
/// request.
///
pub fn url(self) -> (Url, CsrfToken) {
let scopes = self
.scopes
.iter()
.map(|s| s.to_string())
.collect::<Vec<_>>()
.join(" ");
let url = {
let mut pairs: Vec<(&str, &str)> = vec![
("response_type", self.response_type.as_ref()),
("client_id", &self.client_id),
("state", self.state.secret()),
];
if let Some(ref pkce_challenge) = self.pkce_challenge {
pairs.push(("code_challenge", &pkce_challenge.as_str()));
pairs.push(("code_challenge_method", &pkce_challenge.method().as_str()));
}
if let Some(ref redirect_url) = self.redirect_url {
pairs.push(("redirect_uri", redirect_url.as_str()));
}
if !scopes.is_empty() {
pairs.push(("scope", &scopes));
}
let mut url: Url = self.auth_url.url().to_owned();
url.query_pairs_mut()
.extend_pairs(pairs.iter().map(|&(k, v)| (k, &v[..])));
url.query_pairs_mut()
.extend_pairs(self.extra_params.iter().cloned());
url
};
(url, self.state)
}
}
///
/// An HTTP request.
///
#[derive(Clone, Debug)]
pub struct HttpRequest {
// These are all owned values so that the request can safely be passed between
// threads.
/// URL to which the HTTP request is being made.
pub url: Url,
/// HTTP request method for this request.
pub method: http::method::Method,
/// HTTP request headers to send.
pub headers: HeaderMap,
/// HTTP request body (typically for POST requests only).
pub body: Vec<u8>,
}
///
/// An HTTP response.
///
#[derive(Clone, Debug)]
pub struct HttpResponse {
/// HTTP status code returned by the server.
pub status_code: http::status::StatusCode,
/// HTTP response headers returned by the server.
pub headers: HeaderMap,
/// HTTP response body returned by the server.
pub body: Vec<u8>,
}
///
/// A request to exchange an authorization code for an access token.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.1.3>.
///
#[derive(Debug)]
pub struct CodeTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse,
TR: TokenResponse<TT>,
TT: TokenType,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
code: AuthorizationCode,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
pkce_verifier: Option<PkceCodeVerifier>,
token_url: Option<&'a TokenUrl>,
redirect_url: Option<Cow<'a, RedirectUrl>>,
_phantom: PhantomData<(TE, TR, TT)>,
}
impl<'a, TE, TR, TT> CodeTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse + 'static,
TR: TokenResponse<TT>,
TT: TokenType,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Completes the [Proof Key for Code Exchange](https://tools.ietf.org/html/rfc7636)
/// (PKCE) protocol flow.
///
/// This method must be called if `set_pkce_challenge` was used during the authorization
/// request.
///
pub fn set_pkce_verifier(mut self, pkce_verifier: PkceCodeVerifier) -> Self {
self.pkce_verifier = Some(pkce_verifier);
self
}
///
/// Overrides the `redirect_url` to the one specified.
///
pub fn set_redirect_uri(mut self, redirect_url: Cow<'a, RedirectUrl>) -> Self {
self.redirect_url = Some(redirect_url);
self
}
fn prepare_request<RE>(self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
let mut params = vec![
("grant_type", "authorization_code"),
("code", self.code.secret()),
];
if let Some(ref pkce_verifier) = self.pkce_verifier {
params.push(("code_verifier", pkce_verifier.secret()));
}
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
self.redirect_url,
None,
self.token_url
.ok_or_else(|| RequestTokenError::Other("no token_url provided".to_string()))?
.url(),
params,
))
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE>(self, http_client: F) -> Result<TR, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and returns a Future.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<TR, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
}
///
/// A request to exchange a refresh token for an access token.
///
/// See <https://tools.ietf.org/html/rfc6749#section-6>.
///
#[derive(Debug)]
pub struct RefreshTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse,
TR: TokenResponse<TT>,
TT: TokenType,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
refresh_token: &'a RefreshToken,
scopes: Vec<Cow<'a, Scope>>,
token_url: Option<&'a TokenUrl>,
_phantom: PhantomData<(TE, TR, TT)>,
}
impl<'a, TE, TR, TT> RefreshTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse + 'static,
TR: TokenResponse<TT>,
TT: TokenType,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Appends a new scope to the token request.
///
pub fn add_scope(mut self, scope: Scope) -> Self {
self.scopes.push(Cow::Owned(scope));
self
}
///
/// Appends a collection of scopes to the token request.
///
pub fn add_scopes<I>(mut self, scopes: I) -> Self
where
I: IntoIterator<Item = Scope>,
{
self.scopes.extend(scopes.into_iter().map(Cow::Owned));
self
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE>(self, http_client: F) -> Result<TR, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and awaits a response.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<TR, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
fn prepare_request<RE>(&self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
Some(&self.scopes),
self.token_url
.ok_or_else(|| RequestTokenError::Other("no token_url provided".to_string()))?
.url(),
vec![
("grant_type", "refresh_token"),
("refresh_token", self.refresh_token.secret()),
],
))
}
}
///
/// A request to exchange resource owner credentials for an access token.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.3>.
///
#[derive(Debug)]
pub struct PasswordTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse,
TR: TokenResponse<TT>,
TT: TokenType,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
username: &'a ResourceOwnerUsername,
password: &'a ResourceOwnerPassword,
scopes: Vec<Cow<'a, Scope>>,
token_url: Option<&'a TokenUrl>,
_phantom: PhantomData<(TE, TR, TT)>,
}
impl<'a, TE, TR, TT> PasswordTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse + 'static,
TR: TokenResponse<TT>,
TT: TokenType,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Appends a new scope to the token request.
///
pub fn add_scope(mut self, scope: Scope) -> Self {
self.scopes.push(Cow::Owned(scope));
self
}
///
/// Appends a collection of scopes to the token request.
///
pub fn add_scopes<I>(mut self, scopes: I) -> Self
where
I: IntoIterator<Item = Scope>,
{
self.scopes.extend(scopes.into_iter().map(Cow::Owned));
self
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE>(self, http_client: F) -> Result<TR, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and awaits a response.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<TR, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
fn prepare_request<RE>(&self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
Some(&self.scopes),
self.token_url
.ok_or_else(|| RequestTokenError::Other("no token_url provided".to_string()))?
.url(),
vec![
("grant_type", "password"),
("username", self.username),
("password", self.password.secret()),
],
))
}
}
///
/// A request to exchange client credentials for an access token.
///
/// See <https://tools.ietf.org/html/rfc6749#section-4.4>.
///
#[derive(Debug)]
pub struct ClientCredentialsTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse,
TR: TokenResponse<TT>,
TT: TokenType,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
scopes: Vec<Cow<'a, Scope>>,
token_url: Option<&'a TokenUrl>,
_phantom: PhantomData<(TE, TR, TT)>,
}
impl<'a, TE, TR, TT> ClientCredentialsTokenRequest<'a, TE, TR, TT>
where
TE: ErrorResponse + 'static,
TR: TokenResponse<TT>,
TT: TokenType,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Appends a new scope to the token request.
///
pub fn add_scope(mut self, scope: Scope) -> Self {
self.scopes.push(Cow::Owned(scope));
self
}
///
/// Appends a collection of scopes to the token request.
///
pub fn add_scopes<I>(mut self, scopes: I) -> Self
where
I: IntoIterator<Item = Scope>,
{
self.scopes.extend(scopes.into_iter().map(Cow::Owned));
self
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE>(self, http_client: F) -> Result<TR, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and awaits a response.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<TR, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
fn prepare_request<RE>(&self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
Some(&self.scopes),
self.token_url
.ok_or_else(|| RequestTokenError::Other("no token_url provided".to_string()))?
.url(),
vec![("grant_type", "client_credentials")],
))
}
}
///
/// A request to introspect an access token.
///
/// See <https://tools.ietf.org/html/rfc7662#section-2.1>.
///
#[derive(Debug)]
pub struct IntrospectionRequest<'a, TE, TIR, TT>
where
TE: ErrorResponse,
TIR: TokenIntrospectionResponse<TT>,
TT: TokenType,
{
token: &'a AccessToken,
token_type_hint: Option<Cow<'a, str>>,
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
introspection_url: &'a IntrospectionUrl,
_phantom: PhantomData<(TE, TIR, TT)>,
}
impl<'a, TE, TIR, TT> IntrospectionRequest<'a, TE, TIR, TT>
where
TE: ErrorResponse + 'static,
TIR: TokenIntrospectionResponse<TT>,
TT: TokenType,
{
///
/// Sets the optional token_type_hint parameter.
///
/// See <https://tools.ietf.org/html/rfc7662#section-2.1>.
///
/// OPTIONAL. A hint about the type of the token submitted for
/// introspection. The protected resource MAY pass this parameter to
/// help the authorization server optimize the token lookup. If the
/// server is unable to locate the token using the given hint, it MUST
/// extend its search across all of its supported token types. An
/// authorization server MAY ignore this parameter, particularly if it
/// is able to detect the token type automatically. Values for this
/// field are defined in the "OAuth Token Type Hints" registry defined
/// in OAuth Token Revocation [RFC7009](https://tools.ietf.org/html/rfc7009).
///
pub fn set_token_type_hint<V>(mut self, value: V) -> Self
where
V: Into<Cow<'a, str>>,
{
self.token_type_hint = Some(value.into());
self
}
///
/// Appends an extra param to the token introspection request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7662](https://tools.ietf.org/html/rfc7662).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
fn prepare_request<RE>(self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
let mut params: Vec<(&str, &str)> = vec![("token", self.token.secret())];
if let Some(ref token_type_hint) = self.token_type_hint {
params.push(("token_type_hint", token_type_hint));
}
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
None,
self.introspection_url.url(),
params,
))
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE>(self, http_client: F) -> Result<TIR, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and returns a Future.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<TIR, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
}
///
/// A request to revoke a token via an [`RFC 7009`](https://tools.ietf.org/html/rfc7009#section-2.1) compatible
/// endpoint.
///
#[derive(Debug)]
pub struct RevocationRequest<'a, RT, TE>
where
RT: RevocableToken,
TE: ErrorResponse,
{
token: RT,
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
revocation_url: &'a RevocationUrl,
_phantom: PhantomData<(RT, TE)>,
}
impl<'a, RT, TE> RevocationRequest<'a, RT, TE>
where
RT: RevocableToken,
TE: ErrorResponse + 'static,
{
///
/// Appends an extra param to the token revocation request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7662](https://tools.ietf.org/html/rfc7662).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
fn prepare_request<RE>(self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
let mut params: Vec<(&str, &str)> = vec![("token", self.token.secret())];
if let Some(type_hint) = self.token.type_hint() {
params.push(("token_type_hint", type_hint));
}
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
None,
self.revocation_url.url(),
params,
))
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
/// A successful response indicates that the server either revoked the token or the token was not known to the
/// server.
///
/// Error [`UnsupportedTokenType`](crate::revocation::RevocationErrorResponseType::UnsupportedTokenType) will be returned if the
/// type of token type given is not supported by the server.
///
pub fn request<F, RE>(self, http_client: F) -> Result<(), RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
{
// From https://tools.ietf.org/html/rfc7009#section-2.2:
// "The content of the response body is ignored by the client as all
// necessary information is conveyed in the response code."
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response_status_only)
}
///
/// Asynchronously sends the request to the authorization server and returns a Future.
///
pub async fn request_async<C, F, RE>(
self,
http_client: C,
) -> Result<(), RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response_status_only(http_response)
}
}
#[allow(clippy::too_many_arguments)]
fn endpoint_request<'a>(
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: &'a [(Cow<'a, str>, Cow<'a, str>)],
redirect_url: Option<Cow<'a, RedirectUrl>>,
scopes: Option<&'a Vec<Cow<'a, Scope>>>,
url: &'a Url,
params: Vec<(&'a str, &'a str)>,
) -> HttpRequest {
let mut headers = HeaderMap::new();
headers.append(ACCEPT, HeaderValue::from_static(CONTENT_TYPE_JSON));
headers.append(
CONTENT_TYPE,
HeaderValue::from_static(CONTENT_TYPE_FORMENCODED),
);
let scopes_opt = scopes.and_then(|scopes| {
if !scopes.is_empty() {
Some(
scopes
.iter()
.map(|s| s.to_string())
.collect::<Vec<_>>()
.join(" "),
)
} else {
None
}
});
let mut params: Vec<(&str, &str)> = params;
if let Some(ref scopes) = scopes_opt {
params.push(("scope", scopes));
}
// FIXME: add support for auth extensions? e.g., client_secret_jwt and private_key_jwt
match (auth_type, client_secret) {
// Basic auth only makes sense when a client secret is provided. Otherwise, always pass the
// client ID in the request body.
(AuthType::BasicAuth, Some(secret)) => {
// Section 2.3.1 of RFC 6749 requires separately url-encoding the id and secret
// before using them as HTTP Basic auth username and password. Note that this is
// not standard for ordinary Basic auth, so curl won't do it for us.
let urlencoded_id: String =
form_urlencoded::byte_serialize(&client_id.as_bytes()).collect();
let urlencoded_secret: String =
form_urlencoded::byte_serialize(secret.secret().as_bytes()).collect();
let b64_credential =
base64::encode(&format!("{}:{}", &urlencoded_id, urlencoded_secret));
headers.append(
AUTHORIZATION,
HeaderValue::from_str(&format!("Basic {}", &b64_credential)).unwrap(),
);
}
(AuthType::RequestBody, _) | (AuthType::BasicAuth, None) => {
params.push(("client_id", client_id));
if let Some(ref client_secret) = client_secret {
params.push(("client_secret", client_secret.secret()));
}
}
}
if let Some(ref redirect_url) = redirect_url {
params.push(("redirect_uri", redirect_url.as_str()));
}
params.extend_from_slice(
extra_params
.iter()
.map(|&(ref k, ref v)| (k.as_ref(), v.as_ref()))
.collect::<Vec<_>>()
.as_slice(),
);
let body = url::form_urlencoded::Serializer::new(String::new())
.extend_pairs(params)
.finish()
.into_bytes();
HttpRequest {
url: url.to_owned(),
method: http::method::Method::POST,
headers,
body,
}
}
fn endpoint_response<RE, TE, DO>(
http_response: HttpResponse,
) -> Result<DO, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
TE: ErrorResponse,
DO: DeserializeOwned,
{
check_response_status(&http_response)?;
check_response_body(&http_response)?;
let response_body = http_response.body.as_slice();
serde_path_to_error::deserialize(&mut serde_json::Deserializer::from_slice(response_body))
.map_err(|e| RequestTokenError::Parse(e, response_body.to_vec()))
}
fn endpoint_response_status_only<RE, TE>(
http_response: HttpResponse,
) -> Result<(), RequestTokenError<RE, TE>>
where
RE: Error + 'static,
TE: ErrorResponse,
{
check_response_status(&http_response)
}
fn check_response_status<RE, TE>(
http_response: &HttpResponse,
) -> Result<(), RequestTokenError<RE, TE>>
where
RE: Error + 'static,
TE: ErrorResponse,
{
if http_response.status_code != StatusCode::OK {
let reason = http_response.body.as_slice();
if reason.is_empty() {
return Err(RequestTokenError::Other(
"Server returned empty error response".to_string(),
));
} else {
let error = match serde_path_to_error::deserialize::<_, TE>(
&mut serde_json::Deserializer::from_slice(reason),
) {
Ok(error) => RequestTokenError::ServerResponse(error),
Err(error) => RequestTokenError::Parse(error, reason.to_vec()),
};
return Err(error);
}
}
Ok(())
}
fn check_response_body<RE, TE>(
http_response: &HttpResponse,
) -> Result<(), RequestTokenError<RE, TE>>
where
RE: Error + 'static,
TE: ErrorResponse,
{
// Validate that the response Content-Type is JSON.
http_response
.headers
.get(CONTENT_TYPE)
.map_or(Ok(()), |content_type|
// Section 3.1.1.1 of RFC 7231 indicates that media types are case insensitive and
// may be followed by optional whitespace and/or a parameter (e.g., charset).
// See https://tools.ietf.org/html/rfc7231#section-3.1.1.1.
if content_type.to_str().ok().filter(|ct| ct.to_lowercase().starts_with(CONTENT_TYPE_JSON)).is_none() {
Err(
RequestTokenError::Other(
format!(
"Unexpected response Content-Type: {:?}, should be `{}`",
content_type,
CONTENT_TYPE_JSON
)
)
)
} else {
Ok(())
}
)?;
if http_response.body.is_empty() {
return Err(RequestTokenError::Other(
"Server returned empty response body".to_string(),
));
}
Ok(())
}
///
/// The request for a set of verification codes from the authorization server.
///
/// See <https://tools.ietf.org/html/rfc8628#section-3.1>.
///
#[derive(Debug)]
pub struct DeviceAuthorizationRequest<'a, TE>
where
TE: ErrorResponse,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
scopes: Vec<Cow<'a, Scope>>,
device_authorization_url: &'a DeviceAuthorizationUrl,
_phantom: PhantomData<TE>,
}
impl<'a, TE> DeviceAuthorizationRequest<'a, TE>
where
TE: ErrorResponse + 'static,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Appends a new scope to the token request.
///
pub fn add_scope(mut self, scope: Scope) -> Self {
self.scopes.push(Cow::Owned(scope));
self
}
///
/// Appends a collection of scopes to the token request.
///
pub fn add_scopes<I>(mut self, scopes: I) -> Self
where
I: IntoIterator<Item = Scope>,
{
self.scopes.extend(scopes.into_iter().map(Cow::Owned));
self
}
fn prepare_request<RE>(self) -> Result<HttpRequest, RequestTokenError<RE, TE>>
where
RE: Error + 'static,
{
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
Some(&self.scopes),
self.device_authorization_url.url(),
vec![],
))
}
///
/// Synchronously sends the request to the authorization server and awaits a response.
///
pub fn request<F, RE, EF>(
self,
http_client: F,
) -> Result<DeviceAuthorizationResponse<EF>, RequestTokenError<RE, TE>>
where
F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
RE: Error + 'static,
EF: ExtraDeviceAuthorizationFields,
{
http_client(self.prepare_request()?)
.map_err(RequestTokenError::Request)
.and_then(endpoint_response)
}
///
/// Asynchronously sends the request to the authorization server and returns a Future.
///
pub async fn request_async<C, F, RE, EF>(
self,
http_client: C,
) -> Result<DeviceAuthorizationResponse<EF>, RequestTokenError<RE, TE>>
where
C: FnOnce(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
RE: Error + 'static,
EF: ExtraDeviceAuthorizationFields,
{
let http_request = self.prepare_request()?;
let http_response = http_client(http_request)
.await
.map_err(RequestTokenError::Request)?;
endpoint_response(http_response)
}
}
///
/// The request for an device access token from the authorization server.
///
/// See <https://tools.ietf.org/html/rfc8628#section-3.4>.
///
#[derive(Clone)]
pub struct DeviceAccessTokenRequest<'a, 'b, TR, TT, EF>
where
TR: TokenResponse<TT>,
TT: TokenType,
EF: ExtraDeviceAuthorizationFields,
{
auth_type: &'a AuthType,
client_id: &'a ClientId,
client_secret: Option<&'a ClientSecret>,
extra_params: Vec<(Cow<'a, str>, Cow<'a, str>)>,
token_url: Option<&'a TokenUrl>,
dev_auth_resp: &'a DeviceAuthorizationResponse<EF>,
time_fn: Arc<dyn Fn() -> DateTime<Utc> + 'b + Send + Sync>,
max_backoff_interval: Option<Duration>,
_phantom: PhantomData<(TR, TT, EF)>,
}
impl<'a, 'b, TR, TT, EF> DeviceAccessTokenRequest<'a, 'b, TR, TT, EF>
where
TR: TokenResponse<TT>,
TT: TokenType,
EF: ExtraDeviceAuthorizationFields,
{
///
/// Appends an extra param to the token request.
///
/// This method allows extensions to be used without direct support from
/// this crate. If `name` conflicts with a parameter managed by this crate, the
/// behavior is undefined. In particular, do not set parameters defined by
/// [RFC 6749](https://tools.ietf.org/html/rfc6749) or
/// [RFC 7636](https://tools.ietf.org/html/rfc7636).
///
/// # Security Warning
///
/// Callers should follow the security recommendations for any OAuth2 extensions used with
/// this function, which are beyond the scope of
/// [RFC 6749](https://tools.ietf.org/html/rfc6749).
///
pub fn add_extra_param<N, V>(mut self, name: N, value: V) -> Self
where
N: Into<Cow<'a, str>>,
V: Into<Cow<'a, str>>,
{
self.extra_params.push((name.into(), value.into()));
self
}
///
/// Specifies a function for returning the current time.
///
/// This function is used while polling the authorization server.
///
pub fn set_time_fn<T>(mut self, time_fn: T) -> Self
where
T: Fn() -> DateTime<Utc> + 'b + Send + Sync,
{
self.time_fn = Arc::new(time_fn);
self
}
///
/// Sets the upper limit of the sleep interval to use for polling the token endpoint when the
/// HTTP client returns an error (e.g., in case of connection timeout).
///
pub fn set_max_backoff_interval(mut self, interval: Duration) -> Self {
self.max_backoff_interval = Some(interval);
self
}
///
/// Synchronously polls the authorization server for a response, waiting
/// using a user defined sleep function.
///
pub fn request<F, S, RE>(
self,
http_client: F,
sleep_fn: S,
timeout: Option<Duration>,
) -> Result<TR, RequestTokenError<RE, DeviceCodeErrorResponse>>
where
F: Fn(HttpRequest) -> Result<HttpResponse, RE>,
S: Fn(Duration),
RE: Error + 'static,
{
// Get the request timeout and starting interval
let timeout_dt = self.compute_timeout(timeout)?;
let mut interval = self.dev_auth_resp.interval();
// Loop while requesting a token.
loop {
let now = (*self.time_fn)();
if now > timeout_dt {
break Err(RequestTokenError::ServerResponse(
DeviceCodeErrorResponse::new(
DeviceCodeErrorResponseType::ExpiredToken,
Some(String::from("This device code has expired.")),
None,
),
));
}
match self.process_response(http_client(self.prepare_request()?), interval) {
DeviceAccessTokenPollResult::ContinueWithNewPollInterval(new_interval) => {
interval = new_interval
}
DeviceAccessTokenPollResult::Done(res, _) => break res,
}
// Sleep here using the provided sleep function.
sleep_fn(interval);
}
}
///
/// Asynchronously sends the request to the authorization server and awaits a response.
///
pub async fn request_async<C, F, S, SF, RE>(
self,
http_client: C,
sleep_fn: S,
timeout: Option<Duration>,
) -> Result<TR, RequestTokenError<RE, DeviceCodeErrorResponse>>
where
C: Fn(HttpRequest) -> F,
F: Future<Output = Result<HttpResponse, RE>>,
S: Fn(Duration) -> SF,
SF: Future<Output = ()>,
RE: Error + 'static,
{
// Get the request timeout and starting interval
let timeout_dt = self.compute_timeout(timeout)?;
let mut interval = self.dev_auth_resp.interval();
// Loop while requesting a token.
loop {
let now = (*self.time_fn)();
if now > timeout_dt {
break Err(RequestTokenError::ServerResponse(
DeviceCodeErrorResponse::new(
DeviceCodeErrorResponseType::ExpiredToken,
Some(String::from("This device code has expired.")),
None,
),
));
}
match self.process_response(http_client(self.prepare_request()?).await, interval) {
DeviceAccessTokenPollResult::ContinueWithNewPollInterval(new_interval) => {
interval = new_interval
}
DeviceAccessTokenPollResult::Done(res, _) => break res,
}
// Sleep here using the provided sleep function.
sleep_fn(interval).await;
}
}
fn prepare_request<RE>(
&self,
) -> Result<HttpRequest, RequestTokenError<RE, DeviceCodeErrorResponse>>
where
RE: Error + 'static,
{
Ok(endpoint_request(
self.auth_type,
self.client_id,
self.client_secret,
&self.extra_params,
None,
None,
self.token_url
.ok_or_else(|| RequestTokenError::Other("no token_url provided".to_string()))?
.url(),
vec![
("grant_type", "urn:ietf:params:oauth:grant-type:device_code"),
("device_code", self.dev_auth_resp.device_code().secret()),
],
))
}
fn process_response<RE>(
&self,
res: Result<HttpResponse, RE>,
current_interval: Duration,
) -> DeviceAccessTokenPollResult<TR, RE, DeviceCodeErrorResponse, TT>
where
RE: Error + 'static,
{
let http_response = match res {
Ok(inner) => inner,
Err(_) => {
// RFC 8628 requires a backoff in cases of connection timeout, but we can't
// distinguish between connection timeouts and other HTTP client request errors
// here. Set a maximum backoff so that the client doesn't effectively backoff
// infinitely when there are network issues unrelated to server load.
const DEFAULT_MAX_BACKOFF_INTERVAL: Duration = Duration::from_secs(10);
let new_interval = std::cmp::min(
current_interval.checked_mul(2).unwrap_or(current_interval),
self.max_backoff_interval
.unwrap_or(DEFAULT_MAX_BACKOFF_INTERVAL),
);
return DeviceAccessTokenPollResult::ContinueWithNewPollInterval(new_interval);
}
};
// Explicitly process the response with a DeviceCodeErrorResponse
let res = endpoint_response::<RE, DeviceCodeErrorResponse, TR>(http_response);
match res {
// On a ServerResponse error, the error needs inspecting as a DeviceCodeErrorResponse
// to work out whether a retry needs to happen.
Err(RequestTokenError::ServerResponse(dcer)) => {
match dcer.error() {
// On AuthorizationPending, a retry needs to happen with the same poll interval.
DeviceCodeErrorResponseType::AuthorizationPending => {
DeviceAccessTokenPollResult::ContinueWithNewPollInterval(current_interval)
}
// On SlowDown, a retry needs to happen with a larger poll interval.
DeviceCodeErrorResponseType::SlowDown => {
DeviceAccessTokenPollResult::ContinueWithNewPollInterval(
current_interval + Duration::from_secs(5),
)
}
// On any other error, just return the error.
_ => DeviceAccessTokenPollResult::Done(
Err(RequestTokenError::ServerResponse(dcer)),
PhantomData,
),
}
}
// On any other success or failure, return the failure.
res => DeviceAccessTokenPollResult::Done(res, PhantomData),
}
}
fn compute_timeout<RE>(
&self,
timeout: Option<Duration>,
) -> Result<DateTime<Utc>, RequestTokenError<RE, DeviceCodeErrorResponse>>
where
RE: Error + 'static,
{
// Calculate the request timeout - if the user specified a timeout,
// use that, otherwise use the value given by the device authorization
// response.
let timeout_dur = timeout.unwrap_or_else(|| self.dev_auth_resp.expires_in());
let chrono_timeout = chrono::Duration::from_std(timeout_dur)
.map_err(|_| RequestTokenError::Other("Failed to convert duration".to_string()))?;
// Calculate the DateTime at which the request times out.
let timeout_dt = (*self.time_fn)()
.checked_add_signed(chrono_timeout)
.ok_or_else(|| RequestTokenError::Other("Failed to calculate timeout".to_string()))?;
Ok(timeout_dt)
}
}
///
/// Trait for OAuth2 access tokens.
///
pub trait TokenType: Clone + DeserializeOwned + Debug + PartialEq + Serialize {}
///
/// Trait for adding extra fields to the `TokenResponse`.
///
pub trait ExtraTokenFields: DeserializeOwned + Debug + Serialize {}
///
/// Empty (default) extra token fields.
///
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct EmptyExtraTokenFields {}
impl ExtraTokenFields for EmptyExtraTokenFields {}
///
/// Common methods shared by all OAuth2 token implementations.
///
/// The methods in this trait are defined in
/// [Section 5.1 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-5.1). This trait exists
/// separately from the `StandardTokenResponse` struct to support customization by clients,
/// such as supporting interoperability with non-standards-complaint OAuth2 providers.
///
pub trait TokenResponse<TT>: Debug + DeserializeOwned + Serialize
where
TT: TokenType,
{
///
/// REQUIRED. The access token issued by the authorization server.
///
fn access_token(&self) -> &AccessToken;
///
/// REQUIRED. The type of the token issued as described in
/// [Section 7.1](https://tools.ietf.org/html/rfc6749#section-7.1).
/// Value is case insensitive and deserialized to the generic `TokenType` parameter.
///
fn token_type(&self) -> &TT;
///
/// RECOMMENDED. The lifetime in seconds of the access token. For example, the value 3600
/// denotes that the access token will expire in one hour from the time the response was
/// generated. If omitted, the authorization server SHOULD provide the expiration time via
/// other means or document the default value.
///
fn expires_in(&self) -> Option<Duration>;
///
/// OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same
/// authorization grant as described in
/// [Section 6](https://tools.ietf.org/html/rfc6749#section-6).
///
fn refresh_token(&self) -> Option<&RefreshToken>;
///
/// OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The
/// scope of the access token as described by
/// [Section 3.3](https://tools.ietf.org/html/rfc6749#section-3.3). If included in the response,
/// this space-delimited field is parsed into a `Vec` of individual scopes. If omitted from
/// the response, this field is `None`.
///
fn scopes(&self) -> Option<&Vec<Scope>>;
}
///
/// Standard OAuth2 token response.
///
/// This struct includes the fields defined in
/// [Section 5.1 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-5.1), as well as
/// extensions defined by the `EF` type parameter.
///
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct StandardTokenResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType,
{
access_token: AccessToken,
#[serde(bound = "TT: TokenType")]
#[serde(deserialize_with = "helpers::deserialize_untagged_enum_case_insensitive")]
token_type: TT,
#[serde(skip_serializing_if = "Option::is_none")]
expires_in: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
refresh_token: Option<RefreshToken>,
#[serde(rename = "scope")]
#[serde(deserialize_with = "helpers::deserialize_space_delimited_vec")]
#[serde(serialize_with = "helpers::serialize_space_delimited_vec")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(default)]
scopes: Option<Vec<Scope>>,
#[serde(bound = "EF: ExtraTokenFields")]
#[serde(flatten)]
extra_fields: EF,
}
impl<EF, TT> StandardTokenResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType,
{
///
/// Instantiate a new OAuth2 token response.
///
pub fn new(access_token: AccessToken, token_type: TT, extra_fields: EF) -> Self {
Self {
access_token,
token_type,
expires_in: None,
refresh_token: None,
scopes: None,
extra_fields,
}
}
///
/// Set the `access_token` field.
///
pub fn set_access_token(&mut self, access_token: AccessToken) {
self.access_token = access_token;
}
///
/// Set the `token_type` field.
///
pub fn set_token_type(&mut self, token_type: TT) {
self.token_type = token_type;
}
///
/// Set the `expires_in` field.
///
pub fn set_expires_in(&mut self, expires_in: Option<&Duration>) {
self.expires_in = expires_in.map(Duration::as_secs);
}
///
/// Set the `refresh_token` field.
///
pub fn set_refresh_token(&mut self, refresh_token: Option<RefreshToken>) {
self.refresh_token = refresh_token;
}
///
/// Set the `scopes` field.
///
pub fn set_scopes(&mut self, scopes: Option<Vec<Scope>>) {
self.scopes = scopes;
}
///
/// Extra fields defined by the client application.
///
pub fn extra_fields(&self) -> &EF {
&self.extra_fields
}
///
/// Set the extra fields defined by the client application.
///
pub fn set_extra_fields(&mut self, extra_fields: EF) {
self.extra_fields = extra_fields;
}
}
impl<EF, TT> TokenResponse<TT> for StandardTokenResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType,
{
///
/// REQUIRED. The access token issued by the authorization server.
///
fn access_token(&self) -> &AccessToken {
&self.access_token
}
///
/// REQUIRED. The type of the token issued as described in
/// [Section 7.1](https://tools.ietf.org/html/rfc6749#section-7.1).
/// Value is case insensitive and deserialized to the generic `TokenType` parameter.
///
fn token_type(&self) -> &TT {
&self.token_type
}
///
/// RECOMMENDED. The lifetime in seconds of the access token. For example, the value 3600
/// denotes that the access token will expire in one hour from the time the response was
/// generated. If omitted, the authorization server SHOULD provide the expiration time via
/// other means or document the default value.
///
fn expires_in(&self) -> Option<Duration> {
self.expires_in.map(Duration::from_secs)
}
///
/// OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same
/// authorization grant as described in
/// [Section 6](https://tools.ietf.org/html/rfc6749#section-6).
///
fn refresh_token(&self) -> Option<&RefreshToken> {
self.refresh_token.as_ref()
}
///
/// OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The
/// scope of the access token as described by
/// [Section 3.3](https://tools.ietf.org/html/rfc6749#section-3.3). If included in the response,
/// this space-delimited field is parsed into a `Vec` of individual scopes. If omitted from
/// the response, this field is `None`.
///
fn scopes(&self) -> Option<&Vec<Scope>> {
self.scopes.as_ref()
}
}
///
/// Common methods shared by all OAuth2 token introspection implementations.
///
/// The methods in this trait are defined in
/// [Section 2.2 of RFC 7662](https://tools.ietf.org/html/rfc7662#section-2.2). This trait exists
/// separately from the `StandardTokenIntrospectionResponse` struct to support customization by
/// clients, such as supporting interoperability with non-standards-complaint OAuth2 providers.
///
pub trait TokenIntrospectionResponse<TT>: Debug + DeserializeOwned + Serialize
where
TT: TokenType,
{
///
/// REQUIRED. Boolean indicator of whether or not the presented token
/// is currently active. The specifics of a token's "active" state
/// will vary depending on the implementation of the authorization
/// server and the information it keeps about its tokens, but a "true"
/// value return for the "active" property will generally indicate
/// that a given token has been issued by this authorization server,
/// has not been revoked by the resource owner, and is within its
/// given time window of validity (e.g., after its issuance time and
/// before its expiration time).
///
fn active(&self) -> bool;
///
///
/// OPTIONAL. A JSON string containing a space-separated list of
/// scopes associated with this token, in the format described in
/// [Section 3.3 of RFC 7662](https://tools.ietf.org/html/rfc7662#section-3.3).
/// If included in the response,
/// this space-delimited field is parsed into a `Vec` of individual scopes. If omitted from
/// the response, this field is `None`.
///
fn scopes(&self) -> Option<&Vec<Scope>>;
///
/// OPTIONAL. Client identifier for the OAuth 2.0 client that
/// requested this token.
///
fn client_id(&self) -> Option<&ClientId>;
///
/// OPTIONAL. Human-readable identifier for the resource owner who
/// authorized this token.
///
fn username(&self) -> Option<&str>;
///
/// OPTIONAL. Type of the token as defined in
/// [Section 5.1 of RFC 7662](https://tools.ietf.org/html/rfc7662#section-5.1).
/// Value is case insensitive and deserialized to the generic `TokenType` parameter.
///
fn token_type(&self) -> Option<&TT>;
///
/// OPTIONAL. Integer timestamp, measured in the number of seconds
/// since January 1 1970 UTC, indicating when this token will expire,
/// as defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn exp(&self) -> Option<DateTime<Utc>>;
///
/// OPTIONAL. Integer timestamp, measured in the number of seconds
/// since January 1 1970 UTC, indicating when this token was
/// originally issued, as defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn iat(&self) -> Option<DateTime<Utc>>;
///
/// OPTIONAL. Integer timestamp, measured in the number of seconds
/// since January 1 1970 UTC, indicating when this token is not to be
/// used before, as defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn nbf(&self) -> Option<DateTime<Utc>>;
///
/// OPTIONAL. Subject of the token, as defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
/// Usually a machine-readable identifier of the resource owner who
/// authorized this token.
///
fn sub(&self) -> Option<&str>;
///
/// OPTIONAL. Service-specific string identifier or list of string
/// identifiers representing the intended audience for this token, as
/// defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn aud(&self) -> Option<&Vec<String>>;
///
/// OPTIONAL. String representing the issuer of this token, as
/// defined in JWT [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn iss(&self) -> Option<&str>;
///
/// OPTIONAL. String identifier for the token, as defined in JWT
/// [RFC7519](https://tools.ietf.org/html/rfc7519).
///
fn jti(&self) -> Option<&str>;
}
///
/// Standard OAuth2 token introspection response.
///
/// This struct includes the fields defined in
/// [Section 2.2 of RFC 7662](https://tools.ietf.org/html/rfc7662#section-2.2), as well as
/// extensions defined by the `EF` type parameter.
///
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct StandardTokenIntrospectionResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType + 'static,
{
active: bool,
#[serde(rename = "scope")]
#[serde(deserialize_with = "helpers::deserialize_space_delimited_vec")]
#[serde(serialize_with = "helpers::serialize_space_delimited_vec")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(default)]
scopes: Option<Vec<Scope>>,
#[serde(skip_serializing_if = "Option::is_none")]
client_id: Option<ClientId>,
#[serde(skip_serializing_if = "Option::is_none")]
username: Option<String>,
#[serde(
bound = "TT: TokenType",
skip_serializing_if = "Option::is_none",
deserialize_with = "helpers::deserialize_untagged_enum_case_insensitive",
default = "none_field"
)]
token_type: Option<TT>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(with = "ts_seconds_option")]
#[serde(default)]
exp: Option<DateTime<Utc>>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(with = "ts_seconds_option")]
#[serde(default)]
iat: Option<DateTime<Utc>>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(with = "ts_seconds_option")]
#[serde(default)]
nbf: Option<DateTime<Utc>>,
#[serde(skip_serializing_if = "Option::is_none")]
sub: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(default)]
#[serde(deserialize_with = "helpers::deserialize_optional_string_or_vec_string")]
aud: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
iss: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
jti: Option<String>,
#[serde(bound = "EF: ExtraTokenFields")]
#[serde(flatten)]
extra_fields: EF,
}
fn none_field<T>() -> Option<T> {
None
}
impl<EF, TT> StandardTokenIntrospectionResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType,
{
///
/// Instantiate a new OAuth2 token introspection response.
///
pub fn new(active: bool, extra_fields: EF) -> Self {
Self {
active,
scopes: None,
client_id: None,
username: None,
token_type: None,
exp: None,
iat: None,
nbf: None,
sub: None,
aud: None,
iss: None,
jti: None,
extra_fields,
}
}
///
/// Sets the `set_active` field.
///
pub fn set_active(&mut self, active: bool) {
self.active = active;
}
///
/// Sets the `set_scopes` field.
///
pub fn set_scopes(&mut self, scopes: Option<Vec<Scope>>) {
self.scopes = scopes;
}
///
/// Sets the `set_client_id` field.
///
pub fn set_client_id(&mut self, client_id: Option<ClientId>) {
self.client_id = client_id;
}
///
/// Sets the `set_username` field.
///
pub fn set_username(&mut self, username: Option<String>) {
self.username = username;
}
///
/// Sets the `set_token_type` field.
///
pub fn set_token_type(&mut self, token_type: Option<TT>) {
self.token_type = token_type;
}
///
/// Sets the `set_exp` field.
///
pub fn set_exp(&mut self, exp: Option<DateTime<Utc>>) {
self.exp = exp;
}
///
/// Sets the `set_iat` field.
///
pub fn set_iat(&mut self, iat: Option<DateTime<Utc>>) {
self.iat = iat;
}
///
/// Sets the `set_nbf` field.
///
pub fn set_nbf(&mut self, nbf: Option<DateTime<Utc>>) {
self.nbf = nbf;
}
///
/// Sets the `set_sub` field.
///
pub fn set_sub(&mut self, sub: Option<String>) {
self.sub = sub;
}
///
/// Sets the `set_aud` field.
///
pub fn set_aud(&mut self, aud: Option<Vec<String>>) {
self.aud = aud;
}
///
/// Sets the `set_iss` field.
///
pub fn set_iss(&mut self, iss: Option<String>) {
self.iss = iss;
}
///
/// Sets the `set_jti` field.
///
pub fn set_jti(&mut self, jti: Option<String>) {
self.jti = jti;
}
///
/// Extra fields defined by the client application.
///
pub fn extra_fields(&self) -> &EF {
&self.extra_fields
}
///
/// Sets the `set_extra_fields` field.
///
pub fn set_extra_fields(&mut self, extra_fields: EF) {
self.extra_fields = extra_fields;
}
}
impl<EF, TT> TokenIntrospectionResponse<TT> for StandardTokenIntrospectionResponse<EF, TT>
where
EF: ExtraTokenFields,
TT: TokenType,
{
fn active(&self) -> bool {
self.active
}
fn scopes(&self) -> Option<&Vec<Scope>> {
self.scopes.as_ref()
}
fn client_id(&self) -> Option<&ClientId> {
self.client_id.as_ref()
}
fn username(&self) -> Option<&str> {
self.username.as_deref()
}
fn token_type(&self) -> Option<&TT> {
self.token_type.as_ref()
}
fn exp(&self) -> Option<DateTime<Utc>> {
self.exp
}
fn iat(&self) -> Option<DateTime<Utc>> {
self.iat
}
fn nbf(&self) -> Option<DateTime<Utc>> {
self.nbf
}
fn sub(&self) -> Option<&str> {
self.sub.as_deref()
}
fn aud(&self) -> Option<&Vec<String>> {
self.aud.as_ref()
}
fn iss(&self) -> Option<&str> {
self.iss.as_deref()
}
fn jti(&self) -> Option<&str> {
self.jti.as_deref()
}
}
///
/// Server Error Response
///
/// This trait exists separately from the `StandardErrorResponse` struct
/// to support customization by clients, such as supporting interoperability with
/// non-standards-complaint OAuth2 providers
///
pub trait ErrorResponse: Debug + DeserializeOwned + Serialize {}
///
/// Error types enum.
///
/// NOTE: The serialization must return the `snake_case` representation of
/// this error type. This value must match the error type from the relevant OAuth 2.0 standards
/// (RFC 6749 or an extension).
///
pub trait ErrorResponseType: Debug + DeserializeOwned + Serialize {}
///
/// Error response returned by server after requesting an access token.
///
/// The fields in this structure are defined in
/// [Section 5.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-5.2). This
/// trait is parameterized by a `ErrorResponseType` to support error types specific to future OAuth2
/// authentication schemes and extensions.
///
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct StandardErrorResponse<T: ErrorResponseType> {
#[serde(bound = "T: ErrorResponseType")]
error: T,
#[serde(default)]
#[serde(skip_serializing_if = "Option::is_none")]
error_description: Option<String>,
#[serde(default)]
#[serde(skip_serializing_if = "Option::is_none")]
error_uri: Option<String>,
}
impl<T: ErrorResponseType> StandardErrorResponse<T> {
///
/// Instantiate a new `ErrorResponse`.
///
/// # Arguments
///
/// * `error` - REQUIRED. A single ASCII error code deserialized to the generic parameter.
/// `ErrorResponseType`.
/// * `error_description` - OPTIONAL. Human-readable ASCII text providing additional
/// information, used to assist the client developer in understanding the error that
/// occurred. Values for this parameter MUST NOT include characters outside the set
/// `%x20-21 / %x23-5B / %x5D-7E`.
/// * `error_uri` - OPTIONAL. A URI identifying a human-readable web page with information
/// about the error used to provide the client developer with additional information about
/// the error. Values for the "error_uri" parameter MUST conform to the URI-reference
/// syntax and thus MUST NOT include characters outside the set `%x21 / %x23-5B / %x5D-7E`.
///
pub fn new(error: T, error_description: Option<String>, error_uri: Option<String>) -> Self {
Self {
error,
error_description,
error_uri,
}
}
///
/// REQUIRED. A single ASCII error code deserialized to the generic parameter
/// `ErrorResponseType`.
///
pub fn error(&self) -> &T {
&self.error
}
///
/// OPTIONAL. Human-readable ASCII text providing additional information, used to assist
/// the client developer in understanding the error that occurred. Values for this
/// parameter MUST NOT include characters outside the set `%x20-21 / %x23-5B / %x5D-7E`.
///
pub fn error_description(&self) -> Option<&String> {
self.error_description.as_ref()
}
///
/// OPTIONAL. URI identifying a human-readable web page with information about the error,
/// used to provide the client developer with additional information about the error.
/// Values for the "error_uri" parameter MUST conform to the URI-reference syntax and
/// thus MUST NOT include characters outside the set `%x21 / %x23-5B / %x5D-7E`.
///
pub fn error_uri(&self) -> Option<&String> {
self.error_uri.as_ref()
}
}
impl<T> ErrorResponse for StandardErrorResponse<T> where T: ErrorResponseType + 'static {}
impl<TE> Display for StandardErrorResponse<TE>
where
TE: ErrorResponseType + Display,
{
fn fmt(&self, f: &mut Formatter) -> Result<(), FormatterError> {
let mut formatted = self.error().to_string();
if let Some(error_description) = self.error_description() {
formatted.push_str(": ");
formatted.push_str(error_description);
}
if let Some(error_uri) = self.error_uri() {
formatted.push_str(" / See ");
formatted.push_str(error_uri);
}
write!(f, "{}", formatted)
}
}
///
/// Error encountered while requesting access token.
///
#[derive(Debug, thiserror::Error)]
pub enum RequestTokenError<RE, T>
where
RE: Error + 'static,
T: ErrorResponse + 'static,
{
///
/// Error response returned by authorization server. Contains the parsed `ErrorResponse`
/// returned by the server.
///
#[error("Server returned error response")]
ServerResponse(T),
///
/// An error occurred while sending the request or receiving the response (e.g., network
/// connectivity failed).
///
#[error("Request failed")]
Request(#[source] RE),
///
/// Failed to parse server response. Parse errors may occur while parsing either successful
/// or error responses.
///
#[error("Failed to parse server response")]
Parse(
#[source] serde_path_to_error::Error<serde_json::error::Error>,
Vec<u8>,
),
///
/// Some other type of error occurred (e.g., an unexpected server response).
///
#[error("Other error: {}", _0)]
Other(String),
}