-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ARROW-10487 [FlightRPC][C++] Header-based auth in clients
Added support for header based authentication in clients. - Added support for base 64 encoded username / password auth to match Java implementation - Added bearer token receiving and populating of call options to send back - Added unit tests that connects C++ client and a mock C++ server to test authentication Closes #8724 from lyndonb-bq/jduo/lyndon/flight-auth-cpp-redesign-client Authored-by: Lyndon Bauto <lyndonb@bitquilltech.com> Signed-off-by: David Li <li.davidm96@gmail.com>
- Loading branch information
1 parent
47b2dd5
commit 65aa527
Showing
6 changed files
with
378 additions
and
0 deletions.
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,92 @@ | ||
| // 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 "arrow/flight/client_header_internal.h" | ||
| #include "arrow/flight/client.h" | ||
| #include "arrow/flight/client_auth.h" | ||
| #include "arrow/util/base64.h" | ||
| #include "arrow/util/make_unique.h" | ||
|
|
||
| #include <algorithm> | ||
| #include <cctype> | ||
| #include <memory> | ||
| #include <string> | ||
|
|
||
| const char kAuthHeader[] = "authorization"; | ||
| const char kBearerPrefix[] = "Bearer "; | ||
| const char kBasicPrefix[] = "Basic "; | ||
|
|
||
| namespace arrow { | ||
| namespace flight { | ||
| namespace internal { | ||
|
|
||
| /// \brief Add base64 encoded credentials to the outbound headers. | ||
| /// | ||
| /// \param context Context object to add the headers to. | ||
| /// \param username Username to format and encode. | ||
| /// \param password Password to format and encode. | ||
| void AddBasicAuthHeaders(grpc::ClientContext* context, const std::string& username, | ||
| const std::string& password) { | ||
| const std::string credentials = username + ":" + password; | ||
| context->AddMetadata( | ||
| kAuthHeader, | ||
| kBasicPrefix + arrow::util::base64_encode( | ||
| reinterpret_cast<const unsigned char*>(credentials.c_str()), | ||
| static_cast<unsigned int>(credentials.size()))); | ||
| } | ||
|
|
||
| /// \brief Get bearer token from inbound headers. | ||
| /// | ||
| /// \param context Incoming ClientContext that contains headers. | ||
| /// \return Arrow result with bearer token (empty if no bearer token found). | ||
| arrow::Result<std::pair<std::string, std::string>> GetBearerTokenHeader( | ||
| grpc::ClientContext& context) { | ||
| // Lambda function to compare characters without case sensitivity. | ||
| auto char_compare = [](const char& char1, const char& char2) { | ||
| return (::toupper(char1) == ::toupper(char2)); | ||
| }; | ||
|
|
||
| // Get the auth token if it exists, this can be in the initial or the trailing metadata. | ||
| auto trailing_headers = context.GetServerTrailingMetadata(); | ||
| auto initial_headers = context.GetServerInitialMetadata(); | ||
| auto bearer_iter = trailing_headers.find(kAuthHeader); | ||
| if (bearer_iter == trailing_headers.end()) { | ||
| bearer_iter = initial_headers.find(kAuthHeader); | ||
| if (bearer_iter == initial_headers.end()) { | ||
| return std::make_pair("", ""); | ||
| } | ||
| } | ||
|
|
||
| // Check if the value of the auth token starts with the bearer prefix and latch it. | ||
| std::string bearer_val(bearer_iter->second.data(), bearer_iter->second.size()); | ||
| if (bearer_val.size() > strlen(kBearerPrefix)) { | ||
| if (std::equal(bearer_val.begin(), bearer_val.begin() + strlen(kBearerPrefix), | ||
| kBearerPrefix, char_compare)) { | ||
| return std::make_pair(kAuthHeader, bearer_val); | ||
| } | ||
| } | ||
|
|
||
| // The server is not required to provide a bearer token. | ||
| return std::make_pair("", ""); | ||
| } | ||
|
|
||
| } // namespace internal | ||
| } // 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,57 @@ | ||
| // 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. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "arrow/flight/client_middleware.h" | ||
| #include "arrow/result.h" | ||
|
|
||
| #ifdef GRPCPP_PP_INCLUDE | ||
| #include <grpcpp/grpcpp.h> | ||
| #if defined(GRPC_NAMESPACE_FOR_TLS_CREDENTIALS_OPTIONS) | ||
| #include <grpcpp/security/tls_credentials_options.h> | ||
| #endif | ||
| #else | ||
| #include <grpc++/grpc++.h> | ||
| #endif | ||
|
|
||
| namespace arrow { | ||
| namespace flight { | ||
| namespace internal { | ||
|
|
||
| /// \brief Add basic authentication header key value pair to context. | ||
| /// | ||
| /// \param context grpc context variable to add header to. | ||
| /// \param username username to encode into header. | ||
| /// \param password password to to encode into header. | ||
| void ARROW_FLIGHT_EXPORT AddBasicAuthHeaders(grpc::ClientContext* context, | ||
| const std::string& username, | ||
| const std::string& password); | ||
|
|
||
| /// \brief Get bearer token from incoming headers. | ||
| /// | ||
| /// \param context context that contains headers which hold the bearer token. | ||
| /// \return Bearer token, parsed from headers, empty if one is not present. | ||
| arrow::Result<std::pair<std::string, std::string>> ARROW_FLIGHT_EXPORT | ||
| GetBearerTokenHeader(grpc::ClientContext& context); | ||
|
|
||
| } // namespace internal | ||
| } // namespace flight | ||
| } // namespace arrow |
Oops, something went wrong.