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
#![warn(missing_docs)] #![allow(clippy::unreadable_literal, clippy::type_complexity)] #![cfg_attr(test, allow(clippy::cognitive_complexity))] //! //! [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) library. //! //! This library provides extensible, strongly-typed interfaces for the OpenID Connect protocol. //! For convenience, the [`core`] module provides type aliases for common usage that adheres to the //! [OpenID Connect Core](https://openid.net/specs/openid-connect-core-1_0.html) spec. Users of //! this crate may define their own extensions and custom type parameters in lieu of using the //! [`core`] module. //! //! # Contents //! * [Importing `openidconnect`: selecting an HTTP client interface](#importing-openidconnect-selecting-an-http-client-interface) //! * [OpenID Connect Relying Party (Client) Interface](#openid-connect-relying-party-client-interface) //! * [Examples](#examples) //! * [Getting started: Authorization Code Grant w/ PKCE](#getting-started-authorization-code-grant-w-pkce) //! * [OpenID Connect Provider (Server) Interface](#openid-connect-provider-server-interface) //! * [OpenID Connect Discovery document](#openid-connect-discovery-document) //! * [OpenID Connect Discovery JSON Web Key Set](#openid-connect-discovery-json-web-key-set) //! * [OpenID Connect ID Token](#openid-connect-id-token) //! * [Asynchronous API](#asynchronous-api) //! //! # Importing `openidconnect`: 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`] //! //! * **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 //! openidconnect = { version = "...", default-features = false } //! ``` //! //! Synchronous HTTP clients should implement the following trait: //! ```text,ignore //! FnOnce(HttpRequest) -> Result<HttpResponse, RE> //! where RE: std::error::Error + 'static //! ``` //! //! Asynchronous HTTP clients should implement the following trait: //! ```text,ignore //! FnOnce(HttpRequest) -> F //! where //! F: Future<Output = Result<HttpResponse, RE>>, //! RE: std::error::Error + 'static //! ``` //! //! # OpenID Connect Relying Party (Client) Interface //! //! The [`Client`] struct provides the OpenID Connect Relying Party interface. The most common //! usage is provided by the [`core::CoreClient`] type alias. //! //! ## Examples //! //! * [Google](https://github.com/ramosbugs/openidconnect-rs/tree/main/examples/google.rs) //! //! ## Getting started: Authorization Code Grant w/ PKCE //! //! This is the most common OIDC/OAuth2 flow. PKCE is recommended whenever the client has no //! client secret or has a client secret that cannot remain confidential (e.g., native, mobile, or //! client-side web applications). //! //! ### Example //! //! ```rust,no_run //! use openidconnect::{ //! AccessTokenHash, //! AuthenticationFlow, //! AuthorizationCode, //! ClientId, //! ClientSecret, //! CsrfToken, //! Nonce, //! IssuerUrl, //! PkceCodeChallenge, //! RedirectUrl, //! Scope, //! }; //! use openidconnect::core::{ //! CoreAuthenticationFlow, //! CoreClient, //! CoreProviderMetadata, //! CoreResponseType, //! CoreUserInfoClaims, //! }; //! use anyhow::anyhow; //! //! # #[cfg(feature = "reqwest")] //! use openidconnect::reqwest::http_client; //! use url::Url; //! //! # #[cfg(feature = "reqwest")] //! # fn err_wrapper() -> Result<(), anyhow::Error> { //! // Use OpenID Connect Discovery to fetch the provider metadata. //! use openidconnect::{OAuth2TokenResponse, TokenResponse}; //! let provider_metadata = CoreProviderMetadata::discover( //! &IssuerUrl::new("https://accounts.example.com".to_string())?, //! http_client, //! )?; //! //! // Create an OpenID Connect client by specifying the client ID, client secret, authorization URL //! // and token URL. //! let client = //! CoreClient::from_provider_metadata( //! provider_metadata, //! ClientId::new("client_id".to_string()), //! Some(ClientSecret::new("client_secret".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, nonce) = client //! .authorize_url( //! CoreAuthenticationFlow::AuthorizationCode, //! CsrfToken::new_random, //! Nonce::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 exchange it for an access token and ID token. //! let token_response = //! client //! .exchange_code(AuthorizationCode::new("some authorization code".to_string())) //! // Set the PKCE code verifier. //! .set_pkce_verifier(pkce_verifier) //! .request(http_client)?; //! //! // Extract the ID token claims after verifying its authenticity and nonce. //! let id_token = token_response //! .id_token() //! .ok_or_else(|| anyhow!("Server did not return an ID token"))?; //! let claims = id_token.claims(&client.id_token_verifier(), &nonce)?; //! //! // Verify the access token hash to ensure that the access token hasn't been substituted for //! // another user's. //! if let Some(expected_access_token_hash) = claims.access_token_hash() { //! let actual_access_token_hash = AccessTokenHash::from_token( //! token_response.access_token(), //! &id_token.signing_alg()? //! )?; //! if actual_access_token_hash != *expected_access_token_hash { //! return Err(anyhow!("Invalid access token")); //! } //! } //! //! // The authenticated user's identity is now available. See the IdTokenClaims struct for a //! // complete listing of the available claims. //! println!( //! "User {} with e-mail address {} has authenticated successfully", //! claims.subject().as_str(), //! claims.email().map(|email| email.as_str()).unwrap_or("<not provided>"), //! ); //! //! // If available, we can use the UserInfo endpoint to request additional information. //! //! // The user_info request uses the AccessToken returned in the token response. To parse custom //! // claims, use UserInfoClaims directly (with the desired type parameters) rather than using the //! // CoreUserInfoClaims type alias. //! let userinfo: CoreUserInfoClaims = client //! .user_info(token_response.access_token().to_owned(), None) //! .map_err(|err| anyhow!("No user info endpoint: {:?}", err))? //! .request(http_client) //! .map_err(|err| anyhow!("Failed requesting user info: {:?}", err))?; //! //! // See the OAuth2TokenResponse trait for a listing of other available fields such as //! // access_token() and refresh_token(). //! //! # Ok(()) //! # } //! ``` //! //! # OpenID Connect Provider (Server) Interface //! //! This library does not implement a complete OpenID Connect Provider, which requires //! functionality such as credential and session management. However, it does provide //! strongly-typed interfaces for parsing and building OpenID Connect protocol messages. //! //! ## OpenID Connect Discovery document //! //! The [`ProviderMetadata`] struct implements the //! [OpenID Connect Discovery document](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). //! This data structure should be serialized to JSON and served via the //! `GET .well-known/openid-configuration` path relative to your provider's issuer URL. //! //! ### Example //! //! ```rust,no_run //! use openidconnect::{ //! AuthUrl, //! EmptyAdditionalProviderMetadata, //! IssuerUrl, //! JsonWebKeySetUrl, //! ResponseTypes, //! Scope, //! TokenUrl, //! UserInfoUrl, //! }; //! use openidconnect::core::{ //! CoreClaimName, //! CoreJwsSigningAlgorithm, //! CoreProviderMetadata, //! CoreResponseType, //! CoreSubjectIdentifierType //! }; //! use url::Url; //! use anyhow; //! //! # fn err_wrapper() -> Result<String, anyhow::Error> { //! let provider_metadata = CoreProviderMetadata::new( //! // Parameters required by the OpenID Connect Discovery spec. //! IssuerUrl::new("https://accounts.example.com".to_string())?, //! AuthUrl::new("https://accounts.example.com/authorize".to_string())?, //! // Use the JsonWebKeySet struct to serve the JWK Set at this URL. //! JsonWebKeySetUrl::new("https://accounts.example.com/jwk".to_string())?, //! // Supported response types (flows). //! vec![ //! // Recommended: support the code flow. //! ResponseTypes::new(vec![CoreResponseType::Code]), //! // Optional: support the implicit flow. //! ResponseTypes::new(vec![CoreResponseType::Token, CoreResponseType::IdToken]) //! // Other flows including hybrid flows may also be specified here. //! ], //! // For user privacy, the Pairwise subject identifier type is preferred. This prevents //! // distinct relying parties (clients) from knowing whether their users represent the same //! // real identities. This identifier type is only useful for relying parties that don't //! // receive the 'email', 'profile' or other personally-identifying scopes. //! // The Public subject identifier type is also supported. //! vec![CoreSubjectIdentifierType::Pairwise], //! // Support the RS256 signature algorithm. //! vec![CoreJwsSigningAlgorithm::RsaSsaPssSha256], //! // OpenID Connect Providers may supply custom metadata by providing a struct that //! // implements the AdditionalProviderMetadata trait. This requires manually using the //! // generic ProviderMetadata struct rather than the CoreProviderMetadata type alias, //! // however. //! EmptyAdditionalProviderMetadata {}, //! ) //! // Specify the token endpoint (required for the code flow). //! .set_token_endpoint(Some(TokenUrl::new("https://accounts.example.com/token".to_string())?)) //! // Recommended: support the UserInfo endpoint. //! .set_userinfo_endpoint( //! Some(UserInfoUrl::new("https://accounts.example.com/userinfo".to_string())?) //! ) //! // Recommended: specify the supported scopes. //! .set_scopes_supported(Some(vec![ //! Scope::new("openid".to_string()), //! Scope::new("email".to_string()), //! Scope::new("profile".to_string()), //! ])) //! // Recommended: specify the supported ID token claims. //! .set_claims_supported(Some(vec![ //! // Providers may also define an enum instead of using CoreClaimName. //! CoreClaimName::new("sub".to_string()), //! CoreClaimName::new("aud".to_string()), //! CoreClaimName::new("email".to_string()), //! CoreClaimName::new("email_verified".to_string()), //! CoreClaimName::new("exp".to_string()), //! CoreClaimName::new("iat".to_string()), //! CoreClaimName::new("iss".to_string()), //! CoreClaimName::new("name".to_string()), //! CoreClaimName::new("given_name".to_string()), //! CoreClaimName::new("family_name".to_string()), //! CoreClaimName::new("picture".to_string()), //! CoreClaimName::new("locale".to_string()), //! ])); //! //! serde_json::to_string(&provider_metadata).map_err(From::from) //! # } //! ``` //! //! ## OpenID Connect Discovery JSON Web Key Set //! //! The JSON Web Key Set (JWKS) provides the public keys that relying parties (clients) use to //! verify the authenticity of ID tokens returned by this OpenID Connect Provider. The //! [`JsonWebKeySet`] data structure should be serialized as JSON and served at the URL specified //! in the `jwks_uri` field of the [`ProviderMetadata`] returned in the OpenID Connect Discovery //! document. //! //! ### Example //! //! ```rust,no_run //! use openidconnect::{JsonWebKeyId, PrivateSigningKey}; //! use openidconnect::core::{CoreJsonWebKey, CoreJsonWebKeySet, CoreRsaPrivateSigningKey}; //! use anyhow; //! //! # fn err_wrapper() -> Result<String, anyhow::Error> { //! # let rsa_pem = ""; //! let jwks = CoreJsonWebKeySet::new( //! vec![ //! // RSA keys may also be constructed directly using CoreJsonWebKey::new_rsa(). Providers //! // aiming to support other key types may provide their own implementation of the //! // JsonWebKey trait or submit a PR to add the desired support to this crate. //! CoreRsaPrivateSigningKey::from_pem( //! &rsa_pem, //! Some(JsonWebKeyId::new("key1".to_string())) //! ) //! .expect("Invalid RSA private key") //! .as_verification_key() //! ] //! ); //! //! serde_json::to_string(&jwks).map_err(From::from) //! # } //! ``` //! //! ## OpenID Connect ID Token //! //! The [`IdToken::new`] method is used for signing ID token claims, which can then be returned //! from the token endpoint as part of the [`StandardTokenResponse`] struct //! (or [`core::CoreTokenResponse`] type alias). The ID token can also be serialized to a string //! using the `IdToken::to_string` method and returned directly from the authorization endpoint //! when the implicit flow or certain hybrid flows are used. Note that in these flows, ID tokens //! must only be returned in the URL fragment, and never as a query parameter. //! //! The ID token contains a combination of the //! [OpenID Connect Standard Claims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) //! (see [`StandardClaims`]) and claims specific to the //! [OpenID Connect ID Token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) //! (see [`IdTokenClaims`]). //! //! ### Example //! //! ```rust,no_run //! use chrono::{Duration, Utc}; //! use openidconnect::{ //! AccessToken, //! Audience, //! EmptyAdditionalClaims, //! EmptyExtraTokenFields, //! EndUserEmail, //! IssuerUrl, //! JsonWebKeyId, //! StandardClaims, //! SubjectIdentifier, //! }; //! use openidconnect::core::{ //! CoreIdToken, //! CoreIdTokenClaims, //! CoreIdTokenFields, //! CoreJwsSigningAlgorithm, //! CoreRsaPrivateSigningKey, //! CoreTokenResponse, //! CoreTokenType, //! }; //! use anyhow; //! //! # fn err_wrapper() -> Result<CoreTokenResponse, anyhow::Error> { //! # let rsa_pem = ""; //! # let access_token = AccessToken::new("".to_string()); //! let id_token = CoreIdToken::new( //! CoreIdTokenClaims::new( //! // Specify the issuer URL for the OpenID Connect Provider. //! IssuerUrl::new("https://accounts.example.com".to_string())?, //! // The audience is usually a single entry with the client ID of the client for whom //! // the ID token is intended. This is a required claim. //! vec![Audience::new("client-id-123".to_string())], //! // The ID token expiration is usually much shorter than that of the access or refresh //! // tokens issued to clients. //! Utc::now() + Duration::seconds(300), //! // The issue time is usually the current time. //! Utc::now(), //! // Set the standard claims defined by the OpenID Connect Core spec. //! StandardClaims::new( //! // Stable subject identifiers are recommended in place of e-mail addresses or other //! // potentially unstable identifiers. This is the only required claim. //! SubjectIdentifier::new("5f83e0ca-2b8e-4e8c-ba0a-f80fe9bc3632".to_string()) //! ) //! // Optional: specify the user's e-mail address. This should only be provided if the //! // client has been granted the 'profile' or 'email' scopes. //! .set_email(Some(EndUserEmail::new("bob@example.com".to_string()))) //! // Optional: specify whether the provider has verified the user's e-mail address. //! .set_email_verified(Some(true)), //! // OpenID Connect Providers may supply custom claims by providing a struct that //! // implements the AdditionalClaims trait. This requires manually using the //! // generic IdTokenClaims struct rather than the CoreIdTokenClaims type alias, //! // however. //! EmptyAdditionalClaims {}, //! ), //! // The private key used for signing the ID token. For confidential clients (those able //! // to maintain a client secret), a CoreHmacKey can also be used, in conjunction //! // with one of the CoreJwsSigningAlgorithm::HmacSha* signing algorithms. When using an //! // HMAC-based signing algorithm, the UTF-8 representation of the client secret should //! // be used as the HMAC key. //! &CoreRsaPrivateSigningKey::from_pem( //! &rsa_pem, //! Some(JsonWebKeyId::new("key1".to_string())) //! ) //! .expect("Invalid RSA private key"), //! // Uses the RS256 signature algorithm. This crate supports any RS*, PS*, or HS* //! // signature algorithm. //! CoreJwsSigningAlgorithm::RsaSsaPkcs1V15Sha256, //! // When returning the ID token alongside an access token (e.g., in the Authorization Code //! // flow), it is recommended to pass the access token here to set the `at_hash` claim //! // automatically. //! Some(&access_token), //! // When returning the ID token alongside an authorization code (e.g., in the implicit //! // flow), it is recommended to pass the authorization code here to set the `c_hash` claim //! // automatically. //! None, //! )?; //! //! Ok(CoreTokenResponse::new( //! AccessToken::new("some_secret".to_string()), //! CoreTokenType::Bearer, //! CoreIdTokenFields::new(Some(id_token), EmptyExtraTokenFields {}), //! )) //! # } //! ``` //! //! # Asynchronous API //! //! An asynchronous API for async/await is also provided. //! //! ## Example //! //! ```rust,no_run //! # #[cfg(feature = "reqwest")] //! use openidconnect::{ //! AccessTokenHash, //! AuthenticationFlow, //! AuthorizationCode, //! ClientId, //! ClientSecret, //! CsrfToken, //! Nonce, //! IssuerUrl, //! PkceCodeChallenge, //! RedirectUrl, //! Scope, //! }; //! use openidconnect::core::{ //! CoreAuthenticationFlow, //! CoreClient, //! CoreProviderMetadata, //! CoreResponseType, //! }; //! # #[cfg(feature = "reqwest")] //! use openidconnect::reqwest::async_http_client; //! use url::Url; //! use anyhow::anyhow; //! //! //! # #[cfg(feature = "reqwest")] //! # async fn err_wrapper() -> Result<(), anyhow::Error> { //! // Use OpenID Connect Discovery to fetch the provider metadata. //! use openidconnect::{OAuth2TokenResponse, TokenResponse}; //! let provider_metadata = CoreProviderMetadata::discover_async( //! IssuerUrl::new("https://accounts.example.com".to_string())?, //! async_http_client, //! ) //! .await?; //! //! // Create an OpenID Connect client by specifying the client ID, client secret, authorization URL //! // and token URL. //! let client = //! CoreClient::from_provider_metadata( //! provider_metadata, //! ClientId::new("client_id".to_string()), //! Some(ClientSecret::new("client_secret".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, nonce) = client //! .authorize_url( //! CoreAuthenticationFlow::AuthorizationCode, //! CsrfToken::new_random, //! Nonce::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 exchange it for an access token and ID token. //! let token_response = //! 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?; //! //! // Extract the ID token claims after verifying its authenticity and nonce. //! let id_token = token_response //! .id_token() //! .ok_or_else(|| anyhow!("Server did not return an ID token"))?; //! let claims = id_token.claims(&client.id_token_verifier(), &nonce)?; //! //! // Verify the access token hash to ensure that the access token hasn't been substituted for //! // another user's. //! if let Some(expected_access_token_hash) = claims.access_token_hash() { //! let actual_access_token_hash = AccessTokenHash::from_token( //! token_response.access_token(), //! &id_token.signing_alg()? //! )?; //! if actual_access_token_hash != *expected_access_token_hash { //! return Err(anyhow!("Invalid access token")); //! } //! } //! //! // The authenticated user's identity is now available. See the IdTokenClaims struct for a //! // complete listing of the available claims. //! println!( //! "User {} with e-mail address {} has authenticated successfully", //! claims.subject().as_str(), //! claims.email().map(|email| email.as_str()).unwrap_or("<not provided>"), //! ); //! //! // See the OAuth2TokenResponse trait for a listing of other available fields such as //! // access_token() and refresh_token(). //! //! # Ok(()) //! # } //! ``` //! #[cfg(test)] #[macro_use] extern crate pretty_assertions; #[macro_use] extern crate serde_derive; use oauth2::helpers::variant_name; use oauth2::ResponseType as OAuth2ResponseType; use url::Url; use std::borrow::Cow; use std::marker::PhantomData; use std::str; use std::time::Duration; pub use oauth2::{ AccessToken, AuthType, AuthUrl, AuthorizationCode, ClientCredentialsTokenRequest, ClientId, ClientSecret, CodeTokenRequest, ConfigurationError, CsrfToken, EmptyExtraTokenFields, ErrorResponse, ErrorResponseType, ExtraTokenFields, HttpRequest, HttpResponse, IntrospectionRequest, IntrospectionUrl, PasswordTokenRequest, PkceCodeChallenge, PkceCodeChallengeMethod, PkceCodeVerifier, RedirectUrl, RefreshToken, RefreshTokenRequest, RequestTokenError, ResourceOwnerPassword, ResourceOwnerUsername, RevocableToken, RevocationErrorResponseType, RevocationRequest, RevocationUrl, Scope, StandardErrorResponse, StandardTokenIntrospectionResponse, StandardTokenResponse, TokenIntrospectionResponse, TokenResponse as OAuth2TokenResponse, TokenType, TokenUrl, }; /// /// Public re-exports of types used for HTTP client interfaces. /// pub use oauth2::http; pub use oauth2::url; #[cfg(feature = "curl")] pub use oauth2::curl; #[cfg(feature = "reqwest")] pub use oauth2::reqwest; pub use claims::{ AdditionalClaims, AddressClaim, EmptyAdditionalClaims, GenderClaim, StandardClaims, }; pub use discovery::{ AdditionalProviderMetadata, DiscoveryError, EmptyAdditionalProviderMetadata, ProviderMetadata, }; pub use id_token::IdTokenFields; pub use id_token::{IdToken, IdTokenClaims}; pub use jwt::JsonWebTokenError; use jwt::{JsonWebToken, JsonWebTokenAccess, JsonWebTokenAlgorithm, JsonWebTokenHeader}; // Flatten the module hierarchy involving types. They're only separated to improve code // organization. pub use types::{ AccessTokenHash, AddressCountry, AddressLocality, AddressPostalCode, AddressRegion, ApplicationType, Audience, AuthDisplay, AuthPrompt, AuthenticationContextClass, AuthenticationMethodReference, AuthorizationCodeHash, ClaimName, ClaimType, ClientAuthMethod, ClientConfigUrl, ClientContactEmail, ClientName, ClientUrl, EndUserBirthday, EndUserEmail, EndUserFamilyName, EndUserGivenName, EndUserMiddleName, EndUserName, EndUserNickname, EndUserPhoneNumber, EndUserPictureUrl, EndUserProfileUrl, EndUserTimezone, EndUserUsername, EndUserWebsiteUrl, FormattedAddress, GrantType, InitiateLoginUrl, IssuerUrl, JsonWebKey, JsonWebKeyId, JsonWebKeySet, JsonWebKeySetUrl, JsonWebKeyType, JsonWebKeyUse, JweContentEncryptionAlgorithm, JweKeyManagementAlgorithm, JwsSigningAlgorithm, LanguageTag, LocalizedClaim, LoginHint, LogoUrl, Nonce, OpPolicyUrl, OpTosUrl, PolicyUrl, PrivateSigningKey, RegistrationAccessToken, RegistrationUrl, RequestUrl, ResponseMode, ResponseType, ResponseTypes, SectorIdentifierUrl, ServiceDocUrl, SigningError, StreetAddress, SubjectIdentifier, SubjectIdentifierType, ToSUrl, }; pub use user_info::{ UserInfoClaims, UserInfoError, UserInfoJsonWebToken, UserInfoRequest, UserInfoUrl, }; use verification::{AudiencesClaim, IssuerClaim}; pub use verification::{ ClaimsVerificationError, IdTokenVerifier, NonceVerifier, SignatureVerificationError, UserInfoVerifier, }; // Defined first since other modules need the macros, and definition order is significant for // macros. This module is private. #[macro_use] mod macros; /// Baseline OpenID Connect implementation and types. pub mod core; /// OpenID Connect Dynamic Client Registration. pub mod registration; // Private modules since we may move types between different modules; these are exported publicly // via the pub use above. mod claims; mod discovery; mod helpers; mod id_token; pub(crate) mod types; mod user_info; mod verification; // Private module for HTTP(S) utilities. mod http_utils; // Private module for JWT utilities. mod jwt; const CONFIG_URL_SUFFIX: &str = ".well-known/openid-configuration"; const OPENID_SCOPE: &str = "openid"; /// /// Authentication flow, which determines how the Authorization Server returns the OpenID Connect /// ID token and OAuth2 access token to the Relying Party. /// #[derive(Clone, Debug, PartialEq)] #[non_exhaustive] pub enum AuthenticationFlow<RT: ResponseType> { /// /// Authorization Code Flow. /// /// The authorization server will return an OAuth2 authorization code. Clients must subsequently /// call `Client::exchange_code()` with the authorization code in order to retrieve an /// OpenID Connect ID token and OAuth2 access token. /// AuthorizationCode, /// /// Implicit Flow. /// /// Boolean value indicates whether an OAuth2 access token should also be returned. If `true`, /// the Authorization Server will return both an OAuth2 access token and OpenID Connect ID /// token. If `false`, it will return only an OpenID Connect ID token. /// Implicit(bool), /// /// Hybrid Flow. /// /// A hybrid flow according to [OAuth 2.0 Multiple Response Type Encoding Practices]( /// https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html). The enum value /// contains the desired `response_type`s. See /// [Section 3](https://openid.net/specs/openid-connect-core-1_0.html#Authentication) for /// details. /// Hybrid(Vec<RT>), } /// /// OpenID Connect 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::*; /// # use openidconnect::{*, core::*}; /// # let client = CoreClient::new( /// # ClientId::new("aaa".to_string()), /// # Some(ClientSecret::new("bbb".to_string())), /// # IssuerUrl::new("https://example".to_string()).unwrap(), /// # AuthUrl::new("https://example/authorize".to_string()).unwrap(), /// # Some(TokenUrl::new("https://example/token".to_string()).unwrap()), /// # None, /// # JsonWebKeySet::default(), /// # ) /// # .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<AC, AD, GC, JE, JS, JT, JU, K, P, TE, TR, TT, TIR, RT, TRE> where AC: AdditionalClaims, AD: AuthDisplay, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType, JU: JsonWebKeyUse, K: JsonWebKey<JS, JT, JU>, P: AuthPrompt, TE: ErrorResponse, TR: TokenResponse<AC, GC, JE, JS, JT, TT>, TT: TokenType + 'static, TIR: TokenIntrospectionResponse<TT>, RT: RevocableToken, TRE: ErrorResponse, { oauth2_client: oauth2::Client<TE, TR, TT, TIR, RT, TRE>, client_id: ClientId, client_secret: Option<ClientSecret>, issuer: IssuerUrl, userinfo_endpoint: Option<UserInfoUrl>, jwks: JsonWebKeySet<JS, JT, JU, K>, use_openid_scope: bool, _phantom: PhantomData<(AC, AD, GC, JE, P)>, } impl<AC, AD, GC, JE, JS, JT, JU, K, P, TE, TR, TT, TIR, RT, TRE> Client<AC, AD, GC, JE, JS, JT, JU, K, P, TE, TR, TT, TIR, RT, TRE> where AC: AdditionalClaims, AD: AuthDisplay, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType, JU: JsonWebKeyUse, K: JsonWebKey<JS, JT, JU>, P: AuthPrompt, TE: ErrorResponse + 'static, TR: TokenResponse<AC, GC, JE, JS, JT, TT>, TT: TokenType + 'static, TIR: TokenIntrospectionResponse<TT>, RT: RevocableToken, TRE: ErrorResponse + 'static, { /// /// Initializes an OpenID Connect client. /// pub fn new( client_id: ClientId, client_secret: Option<ClientSecret>, issuer: IssuerUrl, auth_url: AuthUrl, token_url: Option<TokenUrl>, userinfo_endpoint: Option<UserInfoUrl>, jwks: JsonWebKeySet<JS, JT, JU, K>, ) -> Self { Client { oauth2_client: oauth2::Client::new( client_id.clone(), client_secret.clone(), auth_url, token_url, ), client_id, client_secret, issuer, userinfo_endpoint, jwks, use_openid_scope: true, _phantom: PhantomData, } } /// /// Initializes an OpenID Connect client from OpenID Connect Discovery provider metadata. /// /// Use [`ProviderMetadata::discover`] or /// [`ProviderMetadata::discover_async`] to fetch the provider metadata. /// pub fn from_provider_metadata<A, CA, CN, CT, G, JK, RM, RS, S>( provider_metadata: ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RS, S>, client_id: ClientId, client_secret: Option<ClientSecret>, ) -> Self where A: AdditionalProviderMetadata, CA: ClientAuthMethod, CN: ClaimName, CT: ClaimType, G: GrantType, JK: JweKeyManagementAlgorithm, RM: ResponseMode, RS: ResponseType, S: SubjectIdentifierType, { Self::new( client_id, client_secret, provider_metadata.issuer().clone(), provider_metadata.authorization_endpoint().clone(), provider_metadata.token_endpoint().cloned(), provider_metadata.userinfo_endpoint().cloned(), provider_metadata.jwks().to_owned(), ) } /// /// 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). /// pub fn set_auth_type(mut self, auth_type: AuthType) -> Self { self.oauth2_client = self.oauth2_client.set_auth_type(auth_type); self } /// /// Sets the the redirect URL used by the authorization endpoint. /// pub fn set_redirect_uri(mut self, redirect_url: RedirectUrl) -> Self { self.oauth2_client = self.oauth2_client.set_redirect_uri(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.oauth2_client = self.oauth2_client.set_introspection_uri(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.oauth2_client = self.oauth2_client.set_revocation_uri(revocation_url); self } /// /// Enables the `openid` scope to be requested automatically. /// /// This scope is requested by default, so this function is only useful after previous calls to /// [`disable_openid_scope`][Client::disable_openid_scope]. /// pub fn enable_openid_scope(mut self) -> Self { self.use_openid_scope = true; self } /// /// Disables the `openid` scope from being requested automatically. /// pub fn disable_openid_scope(mut self) -> Self { self.use_openid_scope = true; self } /// /// Returns an ID token verifier for use with the [`IdToken::claims`] method. /// pub fn id_token_verifier(&self) -> IdTokenVerifier<JS, JT, JU, K> { if let Some(ref client_secret) = self.client_secret { IdTokenVerifier::new_confidential_client( self.client_id.clone(), client_secret.clone(), self.issuer.clone(), self.jwks.clone(), ) } else { IdTokenVerifier::new_public_client( self.client_id.clone(), self.issuer.clone(), self.jwks.clone(), ) } } /// /// Generates an authorization URL for a new authorization request. /// /// NOTE: [Passing authorization request parameters as a JSON Web Token /// ](https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests) /// instead of URL query parameters is not currently supported. The /// [`claims` parameter](https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter) /// is also not directly supported, although the [`AuthorizationRequest::add_extra_param`] /// method can be used to add custom parameters, including `claims`. /// /// # Arguments /// /// * `authentication_flow` - The authentication flow to use (code, implicit, or hybrid). /// * `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. /// * `nonce_fn` - Similar to `state_fn`, but used to generate an opaque nonce to be used /// when verifying the ID token returned by the OpenID Connect Provider. /// /// # 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. /// /// Similarly, callers should use a fresh, unpredictable `nonce` to help protect against ID /// token reuse and forgery. /// pub fn authorize_url<NF, RS, SF>( &self, authentication_flow: AuthenticationFlow<RS>, state_fn: SF, nonce_fn: NF, ) -> AuthorizationRequest<AD, P, RS> where NF: FnOnce() -> Nonce + 'static, RS: ResponseType, SF: FnOnce() -> CsrfToken + 'static, { let request = AuthorizationRequest { inner: self.oauth2_client.authorize_url(state_fn), acr_values: Vec::new(), authentication_flow, claims_locales: Vec::new(), display: None, id_token_hint: None, login_hint: None, max_age: None, nonce: nonce_fn(), prompts: Vec::new(), ui_locales: Vec::new(), }; if self.use_openid_scope { request.add_scope(Scope::new(OPENID_SCOPE.to_string())) } else { request } } /// /// Creates a request builder for exchanging an authorization code for 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> { self.oauth2_client.exchange_code(code) } /// /// Creates a request builder for exchanging 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, { self.oauth2_client.exchange_refresh_token(refresh_token) } /// /// Creates a request builder for exchanging credentials for an access token. /// /// See https://tools.ietf.org/html/rfc6749#section-6 /// pub fn exchange_password<'a, 'b>( &'a self, username: &'b ResourceOwnerUsername, password: &'b ResourceOwnerPassword, ) -> PasswordTokenRequest<'b, TE, TR, TT> where 'a: 'b, { self.oauth2_client.exchange_password(username, password) } /// /// Creates a request builder for exchanging client credentials for an access token. /// /// See https://tools.ietf.org/html/rfc6749#section-4.4 /// pub fn exchange_client_credentials<'a, 'b>( &'a self, ) -> ClientCredentialsTokenRequest<'b, TE, TR, TT> where 'a: 'b, { self.oauth2_client.exchange_client_credentials() } /// /// Creates a request builder for info about the user associated with the given access token. /// /// This function requires that this [`Client`] be configured with a user info endpoint, /// which is an optional feature for OpenID Connect Providers to implement. If this `Client` /// does not know the provider's user info endpoint, it returns the [`ConfigurationError`] /// error. /// /// To help protect against token substitution attacks, this function optionally allows clients /// to provide the subject identifier whose user info they expect to receive. If provided and /// the subject returned by the OpenID Connect Provider does not match, the /// [`UserInfoRequest::request`] or [`UserInfoRequest::request_async`] functions will return /// [`UserInfoError::ClaimsVerification`]. If set to `None`, any subject is accepted. /// pub fn user_info( &self, access_token: AccessToken, expected_subject: Option<SubjectIdentifier>, ) -> Result<UserInfoRequest<JE, JS, JT, JU, K>, ConfigurationError> { Ok(UserInfoRequest { url: self .userinfo_endpoint .as_ref() .ok_or(ConfigurationError::MissingUrl("userinfo"))?, access_token, require_signed_response: false, signed_response_verifier: UserInfoVerifier::new( self.client_id.clone(), self.issuer.clone(), self.jwks.clone(), expected_subject, ), }) } /// /// Creates a request builder for obtaining metadata about a previously received token. /// /// See https://tools.ietf.org/html/rfc7662 /// pub fn introspect<'a>( &'a self, token: &'a AccessToken, ) -> Result<IntrospectionRequest<'a, TE, TIR, TT>, ConfigurationError> { self.oauth2_client.introspect(token) } /// /// Creates a request builder for revoking a previously received token. /// /// 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. /// /// See https://tools.ietf.org/html/rfc7009 /// pub fn revoke_token( &self, token: RT, ) -> Result<RevocationRequest<RT, TRE>, ConfigurationError> { self.oauth2_client.revoke_token(token) } } /// /// A request to the authorization endpoint. /// pub struct AuthorizationRequest<'a, AD, P, RT> where AD: AuthDisplay, P: AuthPrompt, RT: ResponseType, { inner: oauth2::AuthorizationRequest<'a>, acr_values: Vec<AuthenticationContextClass>, authentication_flow: AuthenticationFlow<RT>, claims_locales: Vec<LanguageTag>, display: Option<AD>, id_token_hint: Option<String>, login_hint: Option<LoginHint>, max_age: Option<Duration>, nonce: Nonce, prompts: Vec<P>, ui_locales: Vec<LanguageTag>, } impl<'a, AD, P, RT> AuthorizationRequest<'a, AD, P, RT> where AD: AuthDisplay, P: AuthPrompt, RT: ResponseType, { /// /// Appends a new scope to the authorization URL. /// pub fn add_scope(mut self, scope: Scope) -> Self { self.inner = self.inner.add_scope(scope); 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.inner = self.inner.add_extra_param(name, value); 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.inner = self.inner.set_pkce_challenge(pkce_code_challenge); self } /// /// Requests Authentication Context Class Reference values. /// /// ACR values should be added in order of preference. The Authentication Context Class /// satisfied by the authentication performed is accessible from the ID token via the /// [`IdTokenClaims::auth_context_ref`] method. /// pub fn add_auth_context_value(mut self, acr_value: AuthenticationContextClass) -> Self { self.acr_values.push(acr_value); self } /// /// Requests the preferred languages for claims returned by the OpenID Connect Provider. /// /// Languages should be added in order of preference. /// pub fn add_claims_locale(mut self, claims_locale: LanguageTag) -> Self { self.claims_locales.push(claims_locale); self } // TODO: support 'claims' parameter // https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter /// /// Specifies how the OpenID Connect Provider displays the authentication and consent user /// interfaces to the end user. /// pub fn set_display(mut self, display: AD) -> Self { self.display = Some(display); self } /// /// Provides an ID token previously issued by this OpenID Connect Provider as a hint about /// the user's identity. /// /// This field should be set whenever [`core::CoreAuthPrompt::None`] is used (see /// [`AuthorizationRequest::add_prompt`]), it but may be provided for any authorization /// request. /// pub fn set_id_token_hint<AC, GC, JE, JS, JT>( mut self, id_token_hint: &'a IdToken<AC, GC, JE, JS, JT>, ) -> Self where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType, { self.id_token_hint = Some(id_token_hint.to_string()); self } /// /// Provides the OpenID Connect Provider with a hint about the user's identity. /// /// The nature of this hint is specific to each provider. /// pub fn set_login_hint(mut self, login_hint: LoginHint) -> Self { self.login_hint = Some(login_hint); self } /// /// Sets a maximum amount of time since the user has last authenticated with the OpenID /// Connect Provider. /// /// If more time has elapsed, the provider forces the user to re-authenticate. /// pub fn set_max_age(mut self, max_age: Duration) -> Self { self.max_age = Some(max_age); self } /// /// Specifies what level of authentication and consent prompts the OpenID Connect Provider /// should present to the user. /// pub fn add_prompt(mut self, prompt: P) -> Self { self.prompts.push(prompt); self } /// /// Requests the preferred languages for the user interface presented by the OpenID Connect /// Provider. /// /// Languages should be added in order of preference. /// pub fn add_ui_locale(mut self, ui_locale: LanguageTag) -> Self { self.ui_locales.push(ui_locale); self } /// /// Overrides the `redirect_url` to the one specified. /// pub fn set_redirect_uri(mut self, redirect_url: Cow<'a, RedirectUrl>) -> Self { self.inner = self.inner.set_redirect_uri(redirect_url); self } /// /// Returns the full authorization URL and CSRF state for this authorization /// request. /// pub fn url(self) -> (Url, CsrfToken, Nonce) { let response_type = match self.authentication_flow { AuthenticationFlow::AuthorizationCode => core::CoreResponseType::Code.to_oauth2(), AuthenticationFlow::Implicit(include_token) => { if include_token { OAuth2ResponseType::new( vec![ core::CoreResponseType::IdToken, core::CoreResponseType::Token, ] .iter() .map(variant_name) .collect::<Vec<_>>() .join(" "), ) } else { core::CoreResponseType::IdToken.to_oauth2() } } AuthenticationFlow::Hybrid(ref response_types) => OAuth2ResponseType::new( response_types .iter() .map(variant_name) .collect::<Vec<_>>() .join(" "), ), }; let (mut inner, nonce) = ( self.inner .set_response_type(&response_type) .add_extra_param("nonce", self.nonce.secret().clone()), self.nonce, ); if !self.acr_values.is_empty() { inner = inner.add_extra_param("acr_values", join_vec(&self.acr_values)); } if !self.claims_locales.is_empty() { inner = inner.add_extra_param("claims_locales", join_vec(&self.claims_locales)); } if let Some(ref display) = self.display { inner = inner.add_extra_param("display", display.as_ref()); } if let Some(ref id_token_hint) = self.id_token_hint { inner = inner.add_extra_param("id_token_hint", id_token_hint); } if let Some(ref login_hint) = self.login_hint { inner = inner.add_extra_param("login_hint", login_hint.secret()); } if let Some(max_age) = self.max_age { inner = inner.add_extra_param("max_age", max_age.as_secs().to_string()); } if !self.prompts.is_empty() { inner = inner.add_extra_param("prompt", join_vec(&self.prompts)); } if !self.ui_locales.is_empty() { inner = inner.add_extra_param("ui_locales", join_vec(&self.ui_locales)); } let (url, state) = inner.url(); (url, state, nonce) } } /// /// Extends the base OAuth2 token response with an ID token. /// pub trait TokenResponse<AC, GC, JE, JS, JT, TT>: OAuth2TokenResponse<TT> where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType, TT: TokenType, { /// /// Returns the ID token provided by the token response. /// /// OpenID Connect authorization servers should always return this field, but it is optional /// to allow for interoperability with authorization servers that only support OAuth2. /// fn id_token(&self) -> Option<&IdToken<AC, GC, JE, JS, JT>>; } impl<AC, EF, GC, JE, JS, JT, TT> TokenResponse<AC, GC, JE, JS, JT, TT> for StandardTokenResponse<IdTokenFields<AC, EF, GC, JE, JS, JT>, TT> where AC: AdditionalClaims, EF: ExtraTokenFields, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType, TT: TokenType, { fn id_token(&self) -> Option<&IdToken<AC, GC, JE, JS, JT>> { self.extra_fields().id_token() } } fn join_vec<T>(entries: &[T]) -> String where T: AsRef<str>, { entries .iter() .map(AsRef::as_ref) .collect::<Vec<_>>() .join(" ") } #[cfg(test)] mod tests { use std::borrow::Cow; use std::time::Duration; use oauth2::{AuthUrl, ClientId, ClientSecret, CsrfToken, RedirectUrl, Scope, TokenUrl}; use crate::core::CoreAuthenticationFlow; use crate::core::{CoreAuthDisplay, CoreAuthPrompt, CoreClient, CoreIdToken, CoreResponseType}; use crate::IssuerUrl; use crate::{ AuthenticationContextClass, AuthenticationFlow, JsonWebKeySet, LanguageTag, LoginHint, Nonce, }; fn new_client() -> CoreClient { color_backtrace::install(); CoreClient::new( ClientId::new("aaa".to_string()), Some(ClientSecret::new("bbb".to_string())), IssuerUrl::new("https://example".to_string()).unwrap(), AuthUrl::new("https://example/authorize".to_string()).unwrap(), Some(TokenUrl::new("https://example/token".to_string()).unwrap()), None, JsonWebKeySet::default(), ) } #[test] fn test_authorize_url_minimal() { let client = new_client(); let (authorize_url, _, _) = client .authorize_url( AuthenticationFlow::AuthorizationCode::<CoreResponseType>, || CsrfToken::new("CSRF123".to_string()), || Nonce::new("NONCE456".to_string()), ) .url(); assert_eq!( "https://example/authorize?response_type=code&client_id=aaa&\ state=CSRF123&scope=openid&nonce=NONCE456", authorize_url.to_string() ); } #[test] fn test_authorize_url_full() { let client = new_client() .set_redirect_uri(RedirectUrl::new("http://localhost:8888/".to_string()).unwrap()); let flow = CoreAuthenticationFlow::AuthorizationCode; fn new_csrf() -> CsrfToken { CsrfToken::new("CSRF123".to_string()) } fn new_nonce() -> Nonce { Nonce::new("NONCE456".to_string()) } let (authorize_url, _, _) = client .authorize_url(flow.clone(), new_csrf, new_nonce) .add_scope(Scope::new("email".to_string())) .set_display(CoreAuthDisplay::Touch) .add_prompt(CoreAuthPrompt::Login) .add_prompt(CoreAuthPrompt::Consent) .set_max_age(Duration::from_secs(1800)) .add_ui_locale(LanguageTag::new("fr-CA".to_string())) .add_ui_locale(LanguageTag::new("fr".to_string())) .add_ui_locale(LanguageTag::new("en".to_string())) .add_auth_context_value(AuthenticationContextClass::new( "urn:mace:incommon:iap:silver".to_string(), )) .url(); assert_eq!( "https://example/authorize?response_type=code&client_id=aaa&\ state=CSRF123&redirect_uri=http%3A%2F%2Flocalhost%3A8888%2F&scope=openid+email&\ nonce=NONCE456&acr_values=urn%3Amace%3Aincommon%3Aiap%3Asilver&display=touch&\ max_age=1800&prompt=login+consent&ui_locales=fr-CA+fr+en", authorize_url.to_string() ); let serialized_jwt = "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuY29tIiwiYXVkIjpbIm15X2NsaWVudCJdL\ CJleHAiOjE1NDQ5MzIxNDksImlhdCI6MTU0NDkyODU0OSwiYXV0aF90aW1lIjoxNTQ0OTI4NTQ4LCJub25jZSI\ 6InRoZV9ub25jZSIsImFjciI6InRoZV9hY3IiLCJzdWIiOiJzdWJqZWN0In0.gb5HuuyDMu-LvYvG-jJNIJPEZ\ 823qNwvgNjdAtW0HJpgwJWhJq0hOHUuZz6lvf8ud5xbg5GOo0Q37v3Ke08TvGu6E1USWjecZzp1aYVm9BiMvw5\ EBRUrwAaOCG2XFjuOKUVfglSMJnRnoNqVVIWpCAr1ETjZzRIbkU3n5GQRguC5CwN5n45I3dtjoKuNGc2Ni-IMl\ J2nRiCJOl2FtStdgs-doc-A9DHtO01x-5HCwytXvcE28Snur1JnqpUgmWrQ8gZMGuijKirgNnze2Dd5BsZRHZ2\ CLGIwBsCnauBrJy_NNlQg4hUcSlGsuTa0dmZY7mCf4BN2WCpyOh0wgtkAgQ"; let id_token = serde_json::from_value::<CoreIdToken>(serde_json::Value::String( serialized_jwt.to_string(), )) .unwrap(); let (authorize_url, _, _) = client .authorize_url(flow, new_csrf, new_nonce) .add_scope(Scope::new("email".to_string())) .set_display(CoreAuthDisplay::Touch) .set_id_token_hint(&id_token) .set_login_hint(LoginHint::new("foo@bar.com".to_string())) .add_prompt(CoreAuthPrompt::Login) .add_prompt(CoreAuthPrompt::Consent) .set_max_age(Duration::from_secs(1800)) .add_ui_locale(LanguageTag::new("fr-CA".to_string())) .add_ui_locale(LanguageTag::new("fr".to_string())) .add_ui_locale(LanguageTag::new("en".to_string())) .add_auth_context_value(AuthenticationContextClass::new( "urn:mace:incommon:iap:silver".to_string(), )) .add_extra_param("foo", "bar") .url(); assert_eq!( format!( "https://example/authorize?response_type=code&client_id=aaa&state=CSRF123&\ redirect_uri=http%3A%2F%2Flocalhost%3A8888%2F&scope=openid+email&foo=bar&\ nonce=NONCE456&acr_values=urn%3Amace%3Aincommon%3Aiap%3Asilver&display=touch&\ id_token_hint={}&login_hint=foo%40bar.com&\ max_age=1800&prompt=login+consent&ui_locales=fr-CA+fr+en", serialized_jwt ), authorize_url.to_string() ); } #[test] fn test_authorize_url_redirect_url_override() { let client = new_client() .set_redirect_uri(RedirectUrl::new("http://localhost:8888/".to_string()).unwrap()); let flow = CoreAuthenticationFlow::AuthorizationCode; fn new_csrf() -> CsrfToken { CsrfToken::new("CSRF123".to_string()) } fn new_nonce() -> Nonce { Nonce::new("NONCE456".to_string()) } let (authorize_url, _, _) = client .authorize_url(flow, new_csrf, new_nonce) .add_scope(Scope::new("email".to_string())) .set_display(CoreAuthDisplay::Touch) .add_prompt(CoreAuthPrompt::Login) .add_prompt(CoreAuthPrompt::Consent) .set_max_age(Duration::from_secs(1800)) .add_ui_locale(LanguageTag::new("fr-CA".to_string())) .add_ui_locale(LanguageTag::new("fr".to_string())) .add_ui_locale(LanguageTag::new("en".to_string())) .add_auth_context_value(AuthenticationContextClass::new( "urn:mace:incommon:iap:silver".to_string(), )) .set_redirect_uri(Cow::Owned( RedirectUrl::new("http://localhost:8888/alternative".to_string()).unwrap(), )) .url(); assert_eq!( "https://example/authorize?response_type=code&client_id=aaa&\ state=CSRF123&redirect_uri=http%3A%2F%2Flocalhost%3A8888%2Falternative&scope=openid+email&\ nonce=NONCE456&acr_values=urn%3Amace%3Aincommon%3Aiap%3Asilver&display=touch&\ max_age=1800&prompt=login+consent&ui_locales=fr-CA+fr+en", authorize_url.to_string() ); } }