Add patch for client credential support to cpprest package. #443
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| From 708a5df2bb328705622c42f84b4167ea2c7c98c9 Mon Sep 17 00:00:00 2001 | ||
| From: Ivan Cherniukh <ivan.cherniukh@gmail.com> | ||
| Date: Wed, 9 Sep 2020 09:09:04 -0700 | ||
| Subject: [PATCH] Add support for oauth2 using only client credentials | ||
|
|
||
| --- | ||
| .../cpprest/details/http_constants.dat | 1 + | ||
| Release/include/cpprest/oauth2.h | 15 ++++ | ||
| .../functional/http/client/oauth2_tests.cpp | 68 +++++++++++++++++++ | ||
| 3 files changed, 84 insertions(+) | ||
|
|
||
| diff --git a/Release/include/cpprest/details/http_constants.dat b/Release/include/cpprest/details/http_constants.dat | ||
| index c3b1a53c..3deb24a1 100644 | ||
| --- a/Release/include/cpprest/details/http_constants.dat | ||
| +++ b/Release/include/cpprest/details/http_constants.dat | ||
| @@ -190,6 +190,7 @@ DAT(expires_in, "expires_in") | ||
| DAT(grant_type, "grant_type") | ||
| DAT(redirect_uri, "redirect_uri") | ||
| DAT(refresh_token, "refresh_token") | ||
| +DAT(client_credentials, "client_credentials") | ||
| DAT(response_type, "response_type") | ||
| DAT(scope, "scope") | ||
| DAT(state, "state") | ||
| diff --git a/Release/include/cpprest/oauth2.h b/Release/include/cpprest/oauth2.h | ||
| index 693ebbe3..68a7c7b9 100644 | ||
| --- a/Release/include/cpprest/oauth2.h | ||
| +++ b/Release/include/cpprest/oauth2.h | ||
| @@ -284,6 +284,21 @@ public: | ||
| return _request_token(ub); | ||
| } | ||
|
|
||
| + /// <summary> | ||
| + /// Fetches an access token from the token endpoint using client credentials grant type. | ||
| + /// The task creates an HTTP request to the token_endpoint() using | ||
| + /// client authentication as the authorization grant. | ||
| + /// See: http://tools.ietf.org/html/rfc6749#section-4.4 | ||
| + /// </summary> | ||
| + /// <returns>Task that fetches token(s) using client credentials.</returns> | ||
| + pplx::task<void> token_from_client_credentials() | ||
| + { | ||
| + uri_builder ub; | ||
| + ub.append_query( | ||
| + details::oauth2_strings::grant_type, details::oauth2_strings::client_credentials, false); | ||
| + return _request_token(ub); | ||
| + } | ||
| + | ||
| /// <summary> | ||
| /// Returns enabled state of the configuration. | ||
| /// The oauth2_handler will perform OAuth 2.0 authentication only if | ||
| diff --git a/Release/tests/functional/http/client/oauth2_tests.cpp b/Release/tests/functional/http/client/oauth2_tests.cpp | ||
| index e1f54085..08bb12a6 100644 | ||
| --- a/Release/tests/functional/http/client/oauth2_tests.cpp | ||
| +++ b/Release/tests/functional/http/client/oauth2_tests.cpp | ||
| @@ -291,6 +291,74 @@ SUITE(oauth2_tests) | ||
| VERIFY_ARE_EQUAL(U("done"), m_oauth2_config.token().access_token()); | ||
| } | ||
|
|
||
| + TEST_FIXTURE(oauth2_test_setup, oauth2_token_from_client_credentials) | ||
| + { | ||
| + VERIFY_IS_FALSE(m_oauth2_config.is_enabled()); | ||
| + | ||
| + m_oauth2_config.set_user_agent(U("test_user_agent")); | ||
| + | ||
| + // Fetch using HTTP Basic authentication. | ||
| + { | ||
| + m_scoped.server()->next_request().then([](test_request* request) { | ||
| + VERIFY_ARE_EQUAL(request->m_method, methods::POST); | ||
| + | ||
| + VERIFY_IS_TRUE(is_application_x_www_form_urlencoded(request)); | ||
| + | ||
| + VERIFY_ARE_EQUAL( | ||
| + U("Basic MTIzQUJDOjQ1NkRFRg=="), | ||
| + request->m_headers[header_names::authorization]); | ||
| + | ||
| + VERIFY_ARE_EQUAL( | ||
| + to_body_data(U("grant_type=client_credentials")), | ||
| + request->m_body); | ||
| + | ||
| + VERIFY_ARE_EQUAL( | ||
| + U("test_user_agent"), | ||
| + get_request_user_agent(request)); | ||
| + | ||
| + std::map<utility::string_t, utility::string_t> headers; | ||
| + headers[header_names::content_type] = mime_types::application_json; | ||
| + request->reply( | ||
| + status_codes::OK, U(""), headers, "{\"access_token\":\"xyzzy123\",\"token_type\":\"bearer\"}"); | ||
| + }); | ||
| + | ||
| + m_oauth2_config.token_from_client_credentials().wait(); | ||
| + VERIFY_ARE_EQUAL(U("xyzzy123"), m_oauth2_config.token().access_token()); | ||
| + VERIFY_IS_TRUE(m_oauth2_config.is_enabled()); | ||
| + } | ||
| + | ||
| + // Fetch using client key & secret in request body (x-www-form-urlencoded). | ||
| + { | ||
| + m_scoped.server()->next_request().then([](test_request* request) { | ||
| + VERIFY_IS_TRUE(is_application_x_www_form_urlencoded(request)); | ||
| + | ||
| + VERIFY_ARE_EQUAL(U(""), request->m_headers[header_names::authorization]); | ||
| + | ||
| + VERIFY_ARE_EQUAL( | ||
| + to_body_data(U("grant_type=client_credentials&client_id=123ABC&client_secret=456DEF")), | ||
| + request->m_body); | ||
| + | ||
| + VERIFY_ARE_EQUAL(U("test_user_agent"), get_request_user_agent(request)); | ||
| + | ||
| + std::map<utility::string_t, utility::string_t> headers; | ||
| + headers[header_names::content_type] = mime_types::application_json; | ||
| + request->reply( | ||
| + status_codes::OK, U(""), headers, "{\"access_token\":\"xyzzy123\",\"token_type\":\"bearer\"}"); | ||
| + }); | ||
| + | ||
| + m_oauth2_config.set_token(oauth2_token()); // Clear token. | ||
| + VERIFY_IS_FALSE(m_oauth2_config.is_enabled()); | ||
| + | ||
| + m_oauth2_config.set_http_basic_auth(false); | ||
| + m_oauth2_config.token_from_client_credentials().wait(); | ||
| + | ||
| + VERIFY_ARE_EQUAL( | ||
| + U("xyzzy123"), | ||
| + m_oauth2_config.token().access_token()); | ||
| + VERIFY_IS_TRUE(m_oauth2_config.is_enabled()); | ||
| + } | ||
| + } | ||
| + | ||
| TEST_FIXTURE(oauth2_test_setup, oauth2_bearer_token) | ||
| { | ||
| m_oauth2_config.set_token(oauth2_token(U("12345678"))); | ||
| -- | ||
| 2.23.3 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a public API change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This particular change to http_constants.dat is part of a private header (
include/cpprest/details), so no. This adds aconst std::stringto a private helper class, as below (note thedetailsnamespace):To add some more color, the added constant
client_credentialsis used in the impl of a newly added public functiontoken_from_client_credentials()to add a uri parameter requiring a specific name for the oauth2 protocol. Since this is a new function that must be called explicitly, there should be no way for it to cause back-compat issues.