summaryrefslogtreecommitdiffstats
path: root/contrib/libs/apache/arrow_next/cpp/src/arrow/flight/client_auth.h
blob: 806cc095af936caf7df6d7b958f3f8898ce6b737 (plain) (blame)
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
#pragma clang system_header
// 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.

#pragma once

#include <string>

#include "contrib/libs/apache/arrow_next/cpp/src/arrow/flight/visibility.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/status.h"

namespace arrow20 {

namespace flight {

/// \brief A reader for messages from the server during an
/// authentication handshake.
class ARROW_FLIGHT_EXPORT ClientAuthReader {
 public:
  virtual ~ClientAuthReader() = default;
  virtual Status Read(std::string* response) = 0;
};

/// \brief A writer for messages to the server during an
/// authentication handshake.
class ARROW_FLIGHT_EXPORT ClientAuthSender {
 public:
  virtual ~ClientAuthSender() = default;
  virtual Status Write(const std::string& token) = 0;
};

/// \brief An authentication implementation for a Flight service.
/// Authentication includes both an initial negotiation and a per-call
/// token validation. Implementations may choose to use either or both
/// mechanisms.
class ARROW_FLIGHT_EXPORT ClientAuthHandler {
 public:
  virtual ~ClientAuthHandler() = default;
  /// \brief Authenticate the client on initial connection. The client
  /// can send messages to/read responses from the server at any time.
  /// \return Status OK if authenticated successfully
  virtual Status Authenticate(ClientAuthSender* outgoing, ClientAuthReader* incoming) = 0;
  /// \brief Get a per-call token.
  /// \param[out] token The token to send to the server.
  virtual Status GetToken(std::string* token) = 0;
};

}  // namespace flight
}  // namespace arrow20