Skip to content

Commit f149dc7

Browse files
jblebrunjblebrun
committed
C++ OakSessionClient/OakSessionServer implementations
OakServer provides initialized channels using an underlying OakServerSession. OakClient provides initialized channels using an underlying OakClientSession. Both implementations use an underlying OakChannel implementation. The channel implementation is templatized on send/receive types, so the same implementation can be used for both by switching the send/receive message types, and changing the underlying session type. I wanted to add error contexts in many places, so I created a simple absl::Status annotater to help as part of this CR. Fixed: b/382733114 Fixed: b/356398548 Fixed: b/382481589 Change-Id: I0da73930e9dd9005be2c5803c875f7bb0092196b
1 parent 9f44ffa commit f149dc7

13 files changed

+796
-0
lines changed

‎cc/client/BUILD

+29
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,32 @@ cc_binary(
7979
"@com_google_absl//absl/log",
8080
],
8181
)
82+
83+
cc_library(
84+
name = "session_client",
85+
srcs = ["session_client.cc"],
86+
hdrs = ["session_client.h"],
87+
deps = [
88+
"//cc/oak_session:client_session",
89+
"//cc/oak_session/channel",
90+
"//cc/utils/status",
91+
"//proto/session:session_cc_proto",
92+
"@com_google_absl//absl/status",
93+
"@com_google_absl//absl/status:statusor",
94+
"@com_google_absl//absl/strings",
95+
],
96+
)
97+
98+
cc_test(
99+
name = "session_client_test",
100+
srcs = ["session_client_test.cc"],
101+
deps = [
102+
":session_client",
103+
"//cc/oak_session:client_session",
104+
"//cc/oak_session:server_session",
105+
"@com_google_absl//absl/status",
106+
"@com_google_absl//absl/status:status_matchers",
107+
"@com_google_absl//absl/status:statusor",
108+
"@com_google_googletest//:gtest_main",
109+
],
110+
)

‎cc/client/session_client.cc

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* Copyright 2024 The Project Oak Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
#include "cc/client/session_client.h"
18+
19+
#include "absl/status/status.h"
20+
#include "absl/status/statusor.h"
21+
#include "cc/oak_session/client_session.h"
22+
#include "cc/utils/status/status.h"
23+
#include "proto/session/session.pb.h"
24+
25+
namespace oak::client {
26+
27+
absl::StatusOr<std::unique_ptr<OakSessionClient::Channel>>
28+
OakSessionClient::NewChannel(std::unique_ptr<Channel::Transport> transport) {
29+
absl::StatusOr<std::unique_ptr<session::ClientSession>> session =
30+
session::ClientSession::Create();
31+
32+
while (!(*session)->IsOpen()) {
33+
absl::StatusOr<std::optional<session::v1::SessionRequest>> init_request =
34+
(*session)->GetOutgoingMessage();
35+
if (!init_request.ok()) {
36+
return util::status::Annotate(
37+
init_request.status(),
38+
"Failed to get outgoing message from state machine");
39+
}
40+
41+
if (*init_request == std::nullopt) {
42+
return absl::InternalError("No outgoing message but session not open");
43+
}
44+
45+
absl::Status send_result = transport->Send(**init_request);
46+
if (!send_result.ok()) {
47+
return util::status::Annotate(send_result,
48+
"Failed to send outgoing message");
49+
}
50+
51+
// Some initialization seqeuences may end with the client sending a final
52+
// request but not expecting any response from the server.
53+
if ((*session)->IsOpen()) {
54+
break;
55+
}
56+
57+
absl::StatusOr<session::v1::SessionResponse> init_response =
58+
transport->Receive();
59+
if (!init_response.ok()) {
60+
return util::status::Annotate(
61+
init_request.status(),
62+
"Failed to get next init response from server");
63+
}
64+
65+
absl::Status put_result = (*session)->PutIncomingMessage(*init_response);
66+
if (!put_result.ok()) {
67+
return util::status::Annotate(
68+
put_result,
69+
"Failed to put next init response in session state machine");
70+
}
71+
}
72+
73+
// Need to call private constructor, so WrapUnique instead of make_unique.
74+
return absl::WrapUnique(
75+
new Channel(std::move(*session), std::move(transport)));
76+
}
77+
78+
} // namespace oak::client

‎cc/client/session_client.h

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
/*
2+
* Copyright 2024 The Project Oak Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
#ifndef CC_CLIENT_SESSION_CLIENT_H_
18+
#define CC_CLIENT_SESSION_CLIENT_H_
19+
20+
#include "absl/status/status.h"
21+
#include "absl/status/statusor.h"
22+
#include "cc/oak_session/channel/oak_session_channel.h"
23+
#include "cc/oak_session/client_session.h"
24+
#include "proto/session/session.pb.h"
25+
26+
namespace oak::client {
27+
28+
class OakSessionClient {
29+
public:
30+
// OakClientChannel manages an established connection between a client and
31+
// server that communicate using the Noise Protocol via an Oak Session.
32+
using Channel =
33+
session::channel::OakSessionChannel<session::v1::SessionRequest,
34+
session::v1::SessionResponse,
35+
session::ClientSession>;
36+
37+
OakSessionClient() = default;
38+
39+
// Create a new OakClientChannel instance with the provided session and
40+
// transport.
41+
//
42+
// client_session should be a newly created ClientSession instance with a
43+
// configuration that matches the configuration of the target server.
44+
//
45+
// The call will block during the initialization sequence, and return an open
46+
// channel that is ready to use, or return an error if the handshake didn't
47+
// succeed.
48+
absl::StatusOr<std::unique_ptr<OakSessionClient::Channel>> NewChannel(
49+
std::unique_ptr<OakSessionClient::Channel::Transport> transport);
50+
};
51+
52+
} // namespace oak::client
53+
54+
#endif // CC_CLIENT_SESSION_CLIENT_H_

‎cc/client/session_client_test.cc

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
* Copyright 2024 The Project Oak Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
#include "cc/client/session_client.h"
18+
19+
#include "absl/status/status_matchers.h"
20+
#include "cc/oak_session/client_session.h"
21+
#include "cc/oak_session/server_session.h"
22+
#include "gmock/gmock.h"
23+
#include "gtest/gtest.h"
24+
25+
namespace oak::client {
26+
namespace {
27+
28+
using ::absl_testing::IsOk;
29+
using ::testing::Eq;
30+
using ::testing::Ne;
31+
using ::testing::Optional;
32+
33+
class TestTransport : public OakSessionClient::Channel::Transport {
34+
public:
35+
TestTransport(std::unique_ptr<session::ServerSession> server_session)
36+
: server_session_(std::move(server_session)) {}
37+
absl::Status Send(const session::v1::SessionRequest& request) override {
38+
return server_session_->PutIncomingMessage(request);
39+
}
40+
absl::StatusOr<session::v1::SessionResponse> Receive() override {
41+
absl::StatusOr<std::optional<session::v1::SessionResponse>> msg =
42+
server_session_->GetOutgoingMessage();
43+
if (!msg.ok()) {
44+
return msg.status();
45+
}
46+
if (*msg == std::nullopt) {
47+
return absl::FailedPreconditionError("expected outgoing server message");
48+
}
49+
return **msg;
50+
}
51+
52+
private:
53+
std::unique_ptr<session::ServerSession> server_session_;
54+
};
55+
56+
TEST(OakSessionClientTest, CreateSuccessFullyHandshakes) {
57+
auto server_session = session::ServerSession::Create();
58+
ASSERT_THAT(server_session, IsOk());
59+
auto client_session = session::ClientSession::Create();
60+
ASSERT_THAT(client_session, IsOk());
61+
auto _ = OakSessionClient().NewChannel(
62+
std::make_unique<TestTransport>(std::move(*server_session)));
63+
}
64+
65+
TEST(OakSessionClientTest, CreatedSessionCanSend) {
66+
auto server_session = session::ServerSession::Create();
67+
// Hold a pointer for testing behavior below.
68+
session::ServerSession* server_session_ptr = server_session->get();
69+
ASSERT_THAT(server_session, IsOk());
70+
auto client_session = session::ClientSession::Create();
71+
ASSERT_THAT(client_session, IsOk());
72+
auto channel = OakSessionClient().NewChannel(
73+
std::make_unique<TestTransport>(std::move(*server_session)));
74+
75+
std::string test_send_msg = "Testing Send";
76+
ASSERT_THAT((*channel)->Send(test_send_msg), IsOk());
77+
absl::StatusOr<std::optional<std::string>> test_send_read_back =
78+
server_session_ptr->Read();
79+
EXPECT_THAT(test_send_read_back, IsOk());
80+
EXPECT_THAT(*test_send_read_back, Optional(Eq(test_send_msg)));
81+
}
82+
83+
TEST(OakSessionClientTest, CreatedSessionCanReceive) {
84+
auto server_session = session::ServerSession::Create();
85+
// Hold a pointer for testing behavior below.
86+
session::ServerSession* server_session_ptr = server_session->get();
87+
ASSERT_THAT(server_session, IsOk());
88+
auto client_session = session::ClientSession::Create();
89+
ASSERT_THAT(client_session, IsOk());
90+
auto channel = OakSessionClient().NewChannel(
91+
std::make_unique<TestTransport>(std::move(*server_session)));
92+
93+
std::string test_recv_msg = "Testing Receive";
94+
ASSERT_THAT(server_session_ptr->Write(test_recv_msg), IsOk());
95+
96+
absl::StatusOr<std::string> server_read = (*channel)->Receive();
97+
EXPECT_THAT(server_read, IsOk());
98+
EXPECT_THAT(*server_read, Eq(test_recv_msg));
99+
}
100+
} // namespace
101+
} // namespace oak::client

‎cc/oak_session/channel/BUILD

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#
2+
# Copyright 2022 The Project Oak Authors
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
17+
package(
18+
default_visibility = ["//:default_visibility"],
19+
licenses = ["notice"],
20+
)
21+
22+
cc_library(
23+
name = "channel",
24+
hdrs = ["oak_session_channel.h"],
25+
deps = [
26+
"//cc/utils/status",
27+
"@com_google_absl//absl/status",
28+
"@com_google_absl//absl/status:statusor",
29+
"@com_google_absl//absl/strings",
30+
],
31+
)

0 commit comments

Comments
 (0)