From 4aff6dde392780ea78c02d4d3ab7a8d5c2887bb0 Mon Sep 17 00:00:00 2001 From: Scott Smith Date: Thu, 4 Nov 2021 05:25:12 -0700 Subject: [PATCH] Support additional authorization schemes (#5845) The client always appends "Basic" to the authorization header, however there are other auth schemes that can be used: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication For example "Bearer" when using OAuth. This PR adds a `setAuthorizationType` method to the HTTPClient which allows this scheme to be configured by the caller. Authorization type is set to "Basic" by default so this will have no impact on existing usecases. --- libraries/HTTPClient/src/HTTPClient.cpp | 15 ++++++++++++++- libraries/HTTPClient/src/HTTPClient.h | 2 ++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/libraries/HTTPClient/src/HTTPClient.cpp b/libraries/HTTPClient/src/HTTPClient.cpp index cc0a31e2..c99c6332 100644 --- a/libraries/HTTPClient/src/HTTPClient.cpp +++ b/libraries/HTTPClient/src/HTTPClient.cpp @@ -463,6 +463,17 @@ void HTTPClient::setAuthorization(const char * auth) } } +/** + * set the Authorization type for the http request + * @param authType const char * + */ +void HTTPClient::setAuthorizationType(const char * authType) +{ + if(authType) { + _authorizationType = authType; + } +} + /** * set the timeout (ms) for establishing a connection to the server * @param connectTimeout int32_t @@ -1178,7 +1189,9 @@ bool HTTPClient::sendHeader(const char * type) if(_base64Authorization.length()) { _base64Authorization.replace("\n", ""); - header += F("Authorization: Basic "); + header += F("Authorization: "); + header += _authorizationType; + header += " "; header += _base64Authorization; header += "\r\n"; } diff --git a/libraries/HTTPClient/src/HTTPClient.h b/libraries/HTTPClient/src/HTTPClient.h index 1b454e33..1bb84d6d 100644 --- a/libraries/HTTPClient/src/HTTPClient.h +++ b/libraries/HTTPClient/src/HTTPClient.h @@ -171,6 +171,7 @@ public: void setUserAgent(const String& userAgent); void setAuthorization(const char * user, const char * password); void setAuthorization(const char * auth); + void setAuthorizationType(const char * authType); void setConnectTimeout(int32_t connectTimeout); void setTimeout(uint16_t timeout); @@ -251,6 +252,7 @@ protected: String _headers; String _userAgent = "ESP32HTTPClient"; String _base64Authorization; + String _authorizationType = "Basic"; /// Response handling RequestArgument* _currentHeaders = nullptr;