ARROW-10487 [FlightRPC][C++] Header-based auth in clients #8724
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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,124 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| // Interfaces for defining middleware for Flight clients. Currently | ||
| // experimental. | ||
|
|
||
| #include "client_header_auth_middleware.h" | ||
| #include "client_middleware.h" | ||
| #include "client_auth.h" | ||
| #include "client.h" | ||
|
|
||
| namespace arrow { | ||
| namespace flight { | ||
|
|
||
| std::string base64_encode(const std::string& input); | ||
|
|
||
| ClientBearerTokenMiddleware::ClientBearerTokenMiddleware( | ||
| std::pair<std::string, std::string>* bearer_token_) | ||
| : bearer_token(bearer_token_) { } | ||
|
|
||
| void ClientBearerTokenMiddleware::SendingHeaders(AddCallHeaders* outgoing_headers) { } | ||
|
|
||
| void ClientBearerTokenMiddleware::ReceivedHeaders( | ||
| const CallHeaders& incoming_headers) { | ||
| // Grab the auth token if one exists. | ||
| auto bearer_iter = incoming_headers.find(AUTH_HEADER); | ||
|
|
||
| if (bearer_iter == incoming_headers.end()) { | ||
| return; | ||
| } | ||
|
|
||
| // Check if the value of the auth token starts with the bearer prefix, latch the token. | ||
| std::string bearer_val = bearer_iter->second.to_string(); | ||
| if (bearer_val.size() > BEARER_PREFIX.size()) { | ||
| bool hasPrefix = std::equal(bearer_val.begin(), bearer_val.begin() + BEARER_PREFIX.size(), BEARER_PREFIX.begin(), | ||
|
There was a problem hiding this comment. Seems like they use snake_case instead of camelCase. |
||
| [] (const char& char1, const char& char2) { | ||
| return (std::toupper(char1) == std::toupper(char2)); | ||
| } | ||
| ); | ||
| if (hasPrefix) { | ||
| *bearer_token = std::make_pair(AUTH_HEADER, bearer_val); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| void ClientBearerTokenMiddleware::CallCompleted(const Status& status) { } | ||
|
|
||
| void ClientBearerTokenFactory::StartCall(const CallInfo& info, std::unique_ptr<ClientMiddleware>* middleware) { | ||
|
There was a problem hiding this comment. Would it be better to pass a reference instead of a pointer? There was a problem hiding this comment. Can't this is a method of the base class, I think it's done this way to allow you to assign a new unique pointer to it without exposing the other middlewares they are already holding in their vector. |
||
| *middleware = std::unique_ptr<ClientBearerTokenMiddleware>(new ClientBearerTokenMiddleware(bearer_token)); | ||
|
|
||
| } | ||
|
|
||
| void ClientBearerTokenFactory::Reset() { | ||
| *bearer_token = std::make_pair("", ""); | ||
| } | ||
|
|
||
| template<typename ... Args> | ||
|
There was a problem hiding this comment. I don't think we need an entire templated function to concatenate two strings. |
||
| std::string string_format(const std::string& format, const Args... args) { | ||
| // Check size requirement for new string and increment by 1 for null terminator. | ||
| size_t size = std::snprintf(nullptr, 0, format.c_str(), args ...) + 1; | ||
| if(size <= 0){ | ||
|
|
||
| throw std::runtime_error("Error during string formatting. Format: '" + format + "'."); | ||
|
There was a problem hiding this comment. And Arrow disallows exceptions. |
||
| } | ||
|
|
||
| // Create buffer for new string and write string in. | ||
| std::unique_ptr<char[]> buf(new char[size]); | ||
| std::snprintf(buf.get(), size, format.c_str(), args...); | ||
|
|
||
| // Convert to std::string, subtracting size by 1 to trim null terminator. | ||
| return std::string(buf.get(), buf.get() + size - 1); | ||
| } | ||
|
|
||
| void AddBasicAuthHeaders(grpc::ClientContext* context, const std::string& username, const std::string& password) { | ||
| const std::string formatted_credentials = string_format("%s:%s", username.c_str(), password.c_str()); | ||
| context->AddMetadata(AUTH_HEADER, BASIC_PREFIX + base64_encode(formatted_credentials)); | ||
| } | ||
|
|
||
| std::string base64_encode(const std::string& input) { | ||
| static const std::string base64_chars = | ||
|
There was a problem hiding this comment. This doesn't exist in the codebase already? There was a problem hiding this comment. Yes, I found it. Will remove this. |
||
| "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; | ||
| auto get_encoded_length = [] (const std::string& in) { | ||
| return 4 * ((in.size() + 2) / 3); | ||
| }; | ||
| auto get_overwrite_count = [] (const std::string& in) { | ||
| const std::string::size_type remainder = in.length() % 3; | ||
| return (remainder > 0) ? (3 - (remainder % 3)) : 0; | ||
| }; | ||
|
|
||
| // Generate string with required length for encoding. | ||
| std::string encoded; | ||
| encoded.reserve(get_encoded_length(input)); | ||
|
|
||
| // Loop through input writing base64 characters to string. | ||
| for (int i = 0; i < input.length();) { | ||
| uint32_t octet_1 = i < input.length() ? (unsigned char)input[i++] : 0; | ||
| uint32_t octet_2 = i < input.length() ? (unsigned char)input[i++] : 0; | ||
| uint32_t octet_3 = i < input.length() ? (unsigned char)input[i++] : 0; | ||
| uint32_t octriple = (octet_1 << 0x10) + (octet_2 << 0x08) + octet_3; | ||
| for (int j = 3; j >= 0; j--) { | ||
| encoded.push_back(base64_chars[(octriple >> j * 6) & 0x3F]); | ||
| } | ||
| } | ||
|
|
||
| // Round up to nearest multiple of 3 and replace characters at end based on rounding. | ||
| int overwrite_count = get_overwrite_count(input); | ||
| encoded.replace(encoded.length() - overwrite_count, | ||
| encoded.length(), | ||
| overwrite_count, '='); | ||
| return encoded; | ||
| } | ||
| } // namespace flight | ||
| } // namespace arrow | ||
This file contains 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,78 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
|
There was a problem hiding this comment. This should probably be an _internal.h header since I don't think any of this is intended to be directly used outside of the implementation here. |
||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| // Interfaces for defining middleware for Flight clients. Currently | ||
| // experimental. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "arrow/flight/client_middleware.h" | ||
| #include "arrow/flight/client_auth.h" | ||
| #include "arrow/flight/client.h" | ||
|
|
||
| #ifdef GRPCPP_PP_INCLUDE | ||
| #include <grpcpp/grpcpp.h> | ||
| #if defined(GRPC_NAMESPACE_FOR_TLS_CREDENTIALS_OPTIONS) | ||
| #include <grpcpp/security/tls_credentials_options.h> | ||
|
There was a problem hiding this comment. I don't think we need this include? |
||
| #endif | ||
| #else | ||
| #include <grpc++/grpc++.h> | ||
| #endif | ||
|
|
||
| #include <algorithm> | ||
| #include <iostream> | ||
| #include <cctype> | ||
| #include <string> | ||
|
|
||
| const std::string AUTH_HEADER = "authorization"; | ||
|
There was a problem hiding this comment. Do these need to be in the header, or should they be only in the CC. There was a problem hiding this comment. These should be named kAuthHeader etc. and should go in the .cc file unless we actually want to expose these to users. Or alternatively, the other constants are currently in one of the _internal.h headers. |
||
| const std::string BEARER_PREFIX = "Bearer "; | ||
| const std::string BASIC_PREFIX = "Basic "; | ||
|
|
||
| namespace arrow { | ||
| namespace flight { | ||
|
|
||
| // TODO: Need to add documentation in this file. | ||
| void ARROW_FLIGHT_EXPORT AddBasicAuthHeaders(grpc::ClientContext* context, | ||
|
There was a problem hiding this comment. This is internal - it shouldn't be in a public header. (Ditto for the grpc include.) |
||
| const std::string& username, | ||
| const std::string& password); | ||
|
|
||
| class ARROW_FLIGHT_EXPORT ClientBearerTokenMiddleware : public ClientMiddleware { | ||
| public: | ||
| explicit ClientBearerTokenMiddleware( | ||
| std::pair<std::string, std::string>* bearer_token_); | ||
|
|
||
| void SendingHeaders(AddCallHeaders* outgoing_headers); | ||
| void ReceivedHeaders(const CallHeaders& incoming_headers); | ||
| void CallCompleted(const Status& status); | ||
|
|
||
| private: | ||
| std::pair<std::string, std::string>* bearer_token; | ||
| }; | ||
|
|
||
| class ARROW_FLIGHT_EXPORT ClientBearerTokenFactory : public ClientMiddlewareFactory { | ||
| public: | ||
| explicit ClientBearerTokenFactory(std::pair<std::string, std::string>* bearer_token_) | ||
| : bearer_token(bearer_token_) {} | ||
|
|
||
| void StartCall(const CallInfo& info, std::unique_ptr<ClientMiddleware>* middleware); | ||
| void Reset(); | ||
|
|
||
| private: | ||
| std::pair<std::string, std::string>* bearer_token; | ||
| }; | ||
| } // namespace flight | ||
| } // namespace arrow | ||
Oops, something went wrong.
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 ordering alphabetical? If so this should be up one...
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.
Yes, was waiting for feedback on design before proper formatting. I will correct this.