1 //
2 //
3 // Copyright 2018 gRPC authors.
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 //
18
19 #include <grpc/support/port_platform.h>
20
21 #include "src/core/lib/security/security_connector/fake/fake_security_connector.h"
22
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include <initializer_list>
27 #include <string>
28 #include <utility>
29
30 #include "absl/status/status.h"
31 #include "absl/strings/str_cat.h"
32 #include "absl/strings/str_format.h"
33 #include "absl/strings/string_view.h"
34 #include "absl/types/optional.h"
35
36 #include <grpc/grpc_security_constants.h>
37 #include <grpc/support/alloc.h>
38 #include <grpc/support/log.h>
39 #include <grpc/support/string_util.h>
40
41 #include "src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb.h"
42 #include "src/core/lib/channel/channel_args.h"
43 #include "src/core/lib/gpr/string.h"
44 #include "src/core/lib/gpr/useful.h"
45 #include "src/core/lib/gprpp/crash.h"
46 #include "src/core/lib/gprpp/debug_location.h"
47 #include "src/core/lib/gprpp/host_port.h"
48 #include "src/core/lib/gprpp/ref_counted_ptr.h"
49 #include "src/core/lib/iomgr/closure.h"
50 #include "src/core/lib/iomgr/endpoint.h"
51 #include "src/core/lib/iomgr/error.h"
52 #include "src/core/lib/iomgr/exec_ctx.h"
53 #include "src/core/lib/iomgr/iomgr_fwd.h"
54 #include "src/core/lib/promise/arena_promise.h"
55 #include "src/core/lib/promise/promise.h"
56 #include "src/core/lib/security/context/security_context.h"
57 #include "src/core/lib/security/credentials/credentials.h"
58 #include "src/core/lib/security/credentials/fake/fake_credentials.h"
59 #include "src/core/lib/security/transport/security_handshaker.h"
60 #include "src/core/lib/transport/handshaker.h"
61 #include "src/core/tsi/fake_transport_security.h"
62 #include "src/core/tsi/transport_security_interface.h"
63
64 namespace {
65 class grpc_fake_channel_security_connector final
66 : public grpc_channel_security_connector {
67 public:
grpc_fake_channel_security_connector(grpc_core::RefCountedPtr<grpc_channel_credentials> channel_creds,grpc_core::RefCountedPtr<grpc_call_credentials> request_metadata_creds,const char * target,const grpc_core::ChannelArgs & args)68 grpc_fake_channel_security_connector(
69 grpc_core::RefCountedPtr<grpc_channel_credentials> channel_creds,
70 grpc_core::RefCountedPtr<grpc_call_credentials> request_metadata_creds,
71 const char* target, const grpc_core::ChannelArgs& args)
72 : grpc_channel_security_connector(GRPC_FAKE_SECURITY_URL_SCHEME,
73 std::move(channel_creds),
74 std::move(request_metadata_creds)),
75 target_(gpr_strdup(target)),
76 expected_targets_(
77 args.GetOwnedString(GRPC_ARG_FAKE_SECURITY_EXPECTED_TARGETS)),
78 is_lb_channel_(args.GetBool(GRPC_ARG_ADDRESS_IS_GRPCLB_LOAD_BALANCER)
79 .value_or(false)),
80 target_name_override_(
81 args.GetOwnedString(GRPC_SSL_TARGET_NAME_OVERRIDE_ARG)) {}
82
~grpc_fake_channel_security_connector()83 ~grpc_fake_channel_security_connector() override { gpr_free(target_); }
84
85 void check_peer(tsi_peer peer, grpc_endpoint* ep,
86 const grpc_core::ChannelArgs& /*args*/,
87 grpc_core::RefCountedPtr<grpc_auth_context>* auth_context,
88 grpc_closure* on_peer_checked) override;
89
cancel_check_peer(grpc_closure *,grpc_error_handle)90 void cancel_check_peer(grpc_closure* /*on_peer_checked*/,
91 grpc_error_handle /*error*/) override {}
92
cmp(const grpc_security_connector * other_sc) const93 int cmp(const grpc_security_connector* other_sc) const override {
94 auto* other =
95 reinterpret_cast<const grpc_fake_channel_security_connector*>(other_sc);
96 int c = channel_security_connector_cmp(other);
97 if (c != 0) return c;
98 c = strcmp(target_, other->target_);
99 if (c != 0) return c;
100 c = grpc_core::QsortCompare(expected_targets_, other->expected_targets_);
101 if (c != 0) return c;
102 return grpc_core::QsortCompare(is_lb_channel_, other->is_lb_channel_);
103 }
104
add_handshakers(const grpc_core::ChannelArgs & args,grpc_pollset_set *,grpc_core::HandshakeManager * handshake_mgr)105 void add_handshakers(const grpc_core::ChannelArgs& args,
106 grpc_pollset_set* /*interested_parties*/,
107 grpc_core::HandshakeManager* handshake_mgr) override {
108 handshake_mgr->Add(grpc_core::SecurityHandshakerCreate(
109 tsi_create_fake_handshaker(/*is_client=*/true), this, args));
110 }
111
CheckCallHost(absl::string_view host,grpc_auth_context *)112 grpc_core::ArenaPromise<absl::Status> CheckCallHost(
113 absl::string_view host, grpc_auth_context*) override {
114 absl::string_view authority_hostname;
115 absl::string_view authority_ignored_port;
116 absl::string_view target_hostname;
117 absl::string_view target_ignored_port;
118 grpc_core::SplitHostPort(host, &authority_hostname,
119 &authority_ignored_port);
120 grpc_core::SplitHostPort(target_, &target_hostname, &target_ignored_port);
121 if (target_name_override_.has_value()) {
122 absl::string_view fake_security_target_name_override_hostname;
123 absl::string_view fake_security_target_name_override_ignored_port;
124 grpc_core::SplitHostPort(
125 target_name_override_->c_str(),
126 &fake_security_target_name_override_hostname,
127 &fake_security_target_name_override_ignored_port);
128 if (authority_hostname != fake_security_target_name_override_hostname) {
129 grpc_core::Crash(absl::StrFormat(
130 "Authority (host) '%s' != Fake Security Target override '%s'",
131 host.data(), fake_security_target_name_override_hostname.data()));
132 }
133 } else if (authority_hostname != target_hostname) {
134 grpc_core::Crash(absl::StrFormat("Authority (host) '%s' != Target '%s'",
135 host.data(), target_));
136 }
137 return grpc_core::ImmediateOkStatus();
138 }
139
target() const140 char* target() const { return target_; }
is_lb_channel() const141 bool is_lb_channel() const { return is_lb_channel_; }
142
143 private:
fake_check_target(const char * target,const char * set_str) const144 bool fake_check_target(const char* target, const char* set_str) const {
145 GPR_ASSERT(target != nullptr);
146 char** set = nullptr;
147 size_t set_size = 0;
148 gpr_string_split(set_str, ",", &set, &set_size);
149 bool found = false;
150 for (size_t i = 0; i < set_size; ++i) {
151 if (set[i] != nullptr && strcmp(target, set[i]) == 0) found = true;
152 }
153 for (size_t i = 0; i < set_size; ++i) {
154 gpr_free(set[i]);
155 }
156 gpr_free(set);
157 return found;
158 }
159
fake_secure_name_check() const160 void fake_secure_name_check() const {
161 if (!expected_targets_.has_value()) return;
162 char** lbs_and_backends = nullptr;
163 size_t lbs_and_backends_size = 0;
164 bool success = false;
165 gpr_string_split(expected_targets_->c_str(), ";", &lbs_and_backends,
166 &lbs_and_backends_size);
167 if (lbs_and_backends_size > 2 || lbs_and_backends_size == 0) {
168 gpr_log(GPR_ERROR, "Invalid expected targets arg value: '%s'",
169 expected_targets_->c_str());
170 goto done;
171 }
172 if (is_lb_channel_) {
173 if (lbs_and_backends_size != 2) {
174 gpr_log(GPR_ERROR,
175 "Invalid expected targets arg value: '%s'. Expectations for LB "
176 "channels must be of the form 'be1,be2,be3,...;lb1,lb2,...",
177 expected_targets_->c_str());
178 goto done;
179 }
180 if (!fake_check_target(target_, lbs_and_backends[1])) {
181 gpr_log(GPR_ERROR, "LB target '%s' not found in expected set '%s'",
182 target_, lbs_and_backends[1]);
183 goto done;
184 }
185 success = true;
186 } else {
187 if (!fake_check_target(target_, lbs_and_backends[0])) {
188 gpr_log(GPR_ERROR, "Backend target '%s' not found in expected set '%s'",
189 target_, lbs_and_backends[0]);
190 goto done;
191 }
192 success = true;
193 }
194 done:
195 for (size_t i = 0; i < lbs_and_backends_size; ++i) {
196 gpr_free(lbs_and_backends[i]);
197 }
198 gpr_free(lbs_and_backends);
199 if (!success) abort();
200 }
201
202 char* target_;
203 absl::optional<std::string> expected_targets_;
204 bool is_lb_channel_;
205 absl::optional<std::string> target_name_override_;
206 };
207
fake_check_peer(grpc_security_connector *,tsi_peer peer,grpc_core::RefCountedPtr<grpc_auth_context> * auth_context,grpc_closure * on_peer_checked)208 void fake_check_peer(grpc_security_connector* /*sc*/, tsi_peer peer,
209 grpc_core::RefCountedPtr<grpc_auth_context>* auth_context,
210 grpc_closure* on_peer_checked) {
211 const char* prop_name;
212 grpc_error_handle error;
213 *auth_context = nullptr;
214 if (peer.property_count != 2) {
215 error = GRPC_ERROR_CREATE("Fake peers should only have 2 properties.");
216 goto end;
217 }
218 prop_name = peer.properties[0].name;
219 if (prop_name == nullptr ||
220 strcmp(prop_name, TSI_CERTIFICATE_TYPE_PEER_PROPERTY) != 0) {
221 error = GRPC_ERROR_CREATE(
222 absl::StrCat("Unexpected property in fake peer: ",
223 prop_name == nullptr ? "<EMPTY>" : prop_name));
224 goto end;
225 }
226 if (strncmp(peer.properties[0].value.data, TSI_FAKE_CERTIFICATE_TYPE,
227 peer.properties[0].value.length) != 0) {
228 error = GRPC_ERROR_CREATE("Invalid value for cert type property.");
229 goto end;
230 }
231 prop_name = peer.properties[1].name;
232 if (prop_name == nullptr ||
233 strcmp(prop_name, TSI_SECURITY_LEVEL_PEER_PROPERTY) != 0) {
234 error = GRPC_ERROR_CREATE(
235 absl::StrCat("Unexpected property in fake peer: ",
236 prop_name == nullptr ? "<EMPTY>" : prop_name));
237 goto end;
238 }
239 if (strncmp(peer.properties[1].value.data, TSI_FAKE_SECURITY_LEVEL,
240 peer.properties[1].value.length) != 0) {
241 error = GRPC_ERROR_CREATE("Invalid value for security level property.");
242 goto end;
243 }
244
245 *auth_context = grpc_core::MakeRefCounted<grpc_auth_context>(nullptr);
246 grpc_auth_context_add_cstring_property(
247 auth_context->get(), GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME,
248 GRPC_FAKE_TRANSPORT_SECURITY_TYPE);
249 grpc_auth_context_add_cstring_property(
250 auth_context->get(), GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME,
251 TSI_FAKE_SECURITY_LEVEL);
252 end:
253 grpc_core::ExecCtx::Run(DEBUG_LOCATION, on_peer_checked, error);
254 tsi_peer_destruct(&peer);
255 }
256
check_peer(tsi_peer peer,grpc_endpoint *,const grpc_core::ChannelArgs &,grpc_core::RefCountedPtr<grpc_auth_context> * auth_context,grpc_closure * on_peer_checked)257 void grpc_fake_channel_security_connector::check_peer(
258 tsi_peer peer, grpc_endpoint* /*ep*/,
259 const grpc_core::ChannelArgs& /*args*/,
260 grpc_core::RefCountedPtr<grpc_auth_context>* auth_context,
261 grpc_closure* on_peer_checked) {
262 fake_check_peer(this, peer, auth_context, on_peer_checked);
263 fake_secure_name_check();
264 }
265
266 class grpc_fake_server_security_connector
267 : public grpc_server_security_connector {
268 public:
grpc_fake_server_security_connector(grpc_core::RefCountedPtr<grpc_server_credentials> server_creds)269 explicit grpc_fake_server_security_connector(
270 grpc_core::RefCountedPtr<grpc_server_credentials> server_creds)
271 : grpc_server_security_connector(GRPC_FAKE_SECURITY_URL_SCHEME,
272 std::move(server_creds)) {}
273 ~grpc_fake_server_security_connector() override = default;
274
check_peer(tsi_peer peer,grpc_endpoint *,const grpc_core::ChannelArgs &,grpc_core::RefCountedPtr<grpc_auth_context> * auth_context,grpc_closure * on_peer_checked)275 void check_peer(tsi_peer peer, grpc_endpoint* /*ep*/,
276 const grpc_core::ChannelArgs& /*args*/,
277 grpc_core::RefCountedPtr<grpc_auth_context>* auth_context,
278 grpc_closure* on_peer_checked) override {
279 fake_check_peer(this, peer, auth_context, on_peer_checked);
280 }
281
cancel_check_peer(grpc_closure *,grpc_error_handle)282 void cancel_check_peer(grpc_closure* /*on_peer_checked*/,
283 grpc_error_handle /*error*/) override {}
284
add_handshakers(const grpc_core::ChannelArgs & args,grpc_pollset_set *,grpc_core::HandshakeManager * handshake_mgr)285 void add_handshakers(const grpc_core::ChannelArgs& args,
286 grpc_pollset_set* /*interested_parties*/,
287 grpc_core::HandshakeManager* handshake_mgr) override {
288 handshake_mgr->Add(grpc_core::SecurityHandshakerCreate(
289 tsi_create_fake_handshaker(/*=is_client*/ false), this, args));
290 }
291
cmp(const grpc_security_connector * other) const292 int cmp(const grpc_security_connector* other) const override {
293 return server_security_connector_cmp(
294 static_cast<const grpc_server_security_connector*>(other));
295 }
296 };
297 } // namespace
298
299 grpc_core::RefCountedPtr<grpc_channel_security_connector>
grpc_fake_channel_security_connector_create(grpc_core::RefCountedPtr<grpc_channel_credentials> channel_creds,grpc_core::RefCountedPtr<grpc_call_credentials> request_metadata_creds,const char * target,const grpc_core::ChannelArgs & args)300 grpc_fake_channel_security_connector_create(
301 grpc_core::RefCountedPtr<grpc_channel_credentials> channel_creds,
302 grpc_core::RefCountedPtr<grpc_call_credentials> request_metadata_creds,
303 const char* target, const grpc_core::ChannelArgs& args) {
304 return grpc_core::MakeRefCounted<grpc_fake_channel_security_connector>(
305 std::move(channel_creds), std::move(request_metadata_creds), target,
306 args);
307 }
308
309 grpc_core::RefCountedPtr<grpc_server_security_connector>
grpc_fake_server_security_connector_create(grpc_core::RefCountedPtr<grpc_server_credentials> server_creds)310 grpc_fake_server_security_connector_create(
311 grpc_core::RefCountedPtr<grpc_server_credentials> server_creds) {
312 return grpc_core::MakeRefCounted<grpc_fake_server_security_connector>(
313 std::move(server_creds));
314 }
315