Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config security using enclave ROS argument #412

Draft
wants to merge 4 commits into
base: rolling
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions rmw_zenoh_cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ find_package(rcutils REQUIRED)
find_package(rosidl_typesupport_fastrtps_c REQUIRED)
find_package(rosidl_typesupport_fastrtps_cpp REQUIRED)
find_package(rmw REQUIRED)
find_package(rmw_dds_common REQUIRED)
find_package(tracetools REQUIRED)
find_package(zenoh_cpp_vendor REQUIRED)

if(SECURITY)
find_package(OpenSSL REQUIRED)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see OpenSSL being linked anywhere? Does this happen transitively via rmw_dds_common::rmw_dds_common_library?

set(HAVE_SECURITY 1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not have any special build flags for security. We will overwrite the Zenoh config with auth params if security_options is present in rmw_context_impl_s.

endif()

add_library(rmw_zenoh_cpp SHARED
src/detail/attachment_helpers.cpp
src/detail/cdr.cpp
Expand Down Expand Up @@ -68,6 +74,7 @@ target_link_libraries(rmw_zenoh_cpp
rosidl_typesupport_fastrtps_c::rosidl_typesupport_fastrtps_c
rosidl_typesupport_fastrtps_cpp::rosidl_typesupport_fastrtps_cpp
rmw::rmw
rmw_dds_common::rmw_dds_common_library
tracetools::tracetools
zenohcxx::zenohc
)
Expand All @@ -79,6 +86,7 @@ target_compile_definitions(rmw_zenoh_cpp
RMW_VERSION_MAJOR=${rmw_VERSION_MAJOR}
RMW_VERSION_MINOR=${rmw_VERSION_MINOR}
RMW_VERSION_PATCH=${rmw_VERSION_PATCH}
HAVE_SECURITY=${HAVE_SECURITY}
)

ament_export_targets(export_rmw_zenoh_cpp)
Expand Down
1 change: 1 addition & 0 deletions rmw_zenoh_cpp/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<depend>rosidl_typesupport_fastrtps_c</depend>
<depend>rosidl_typesupport_fastrtps_cpp</depend>
<depend>rmw</depend>
<depend>rmw_dds_common</depend>
<depend>tracetools</depend>

<test_depend>ament_lint_auto</test_depend>
Expand Down
41 changes: 37 additions & 4 deletions rmw_zenoh_cpp/src/detail/rmw_context_impl_s.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

#include "rcpputils/scope_exit.hpp"
#include "rmw/error_handling.h"
#include "rmw_dds_common/security.hpp"
#include "zenoh_utils.hpp"

// Megabytes of SHM to reserve.
Expand All @@ -52,7 +53,8 @@ class rmw_context_impl_s::Data final : public std::enable_shared_from_this<Data>
// Constructor.
Data(
std::size_t domain_id,
const std::string & enclave)
const std::string & enclave,
const rmw_security_options_t * security_options)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const rmw_security_options_t * security_options)
const rmw_security_options_t & security_options)

: domain_id_(std::move(domain_id)),
enclave_(std::move(enclave)),
is_shutdown_(false),
Expand All @@ -67,7 +69,37 @@ class rmw_context_impl_s::Data final : public std::enable_shared_from_this<Data>
if (!config.has_value()) {
throw std::runtime_error("Error configuring Zenoh session.");
}

#ifdef HAVE_SECURITY
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this flag? My understanding is that rmw_dds_common::get_security_files will return false if the enclave ROS arg is not passed or is invalid so we can have this codeblock that modifies for all situations. Let me know if I misunderstood something.

std::unordered_map<std::string, std::string> security_files_paths;
if (rmw_dds_common::get_security_files(
true, "", security_options->security_root_path, security_files_paths))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
true, "", security_options->security_root_path, security_files_paths))
true, "", security_options.security_root_path, security_files_paths))

{
config.value().insert_json5("connect/endpoints", "[\"tls/localhost:7447\"]");
config.value().insert_json5("listen/endpoints", "[\"tls/localhost:0\"]");

std::string tls_config = "{\"link\": \n"
"\t\t{ \n"
"\t\t\t\"protocols\": [ \n"
"\t\t\t\t\"tls\" \n"
"\t\t\t], \n"
"\t\t\t\"tls\": { \n"
"\t\t\t\t\"enable_mtls\": true, \n"
"\t\t\t\t\"verify_name_on_connect\": false, \n"
"\t\t\t\t\"root_ca_certificate\": \"" + security_files_paths["IDENTITY_CA"] + "\",\n" +
"\t\t\t\t\"listen_private_key\": \"" + security_files_paths["PRIVATE_KEY"] + "\",\n" +
"\t\t\t\t\"listen_certificate\": \"" + security_files_paths["CERTIFICATE"] + "\",\n" +
"\t\t\t\t\"connect_private_key\": \"" + security_files_paths["PRIVATE_KEY"] + "\",\n" +
"\t\t\t\t\"connect_certificate\": \"" + security_files_paths["CERTIFICATE"] + "\",\n" +
Comment on lines +88 to +92
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's check that these keys exist in security_files_paths before accessing their values. If not present, return an error.

"\t\t\t}, \n"
"\t\t}, \n"
"\t}\n";
config.value().insert_json5(
"transport",
tls_config);
} else {
std::cout << "Error getting secutiry data" << std::endl;
}
#endif
zenoh::ZResult result;

#ifndef _MSC_VER
Expand Down Expand Up @@ -432,9 +464,10 @@ class rmw_context_impl_s::Data final : public std::enable_shared_from_this<Data>
///=============================================================================
rmw_context_impl_s::rmw_context_impl_s(
const std::size_t domain_id,
const std::string & enclave)
const std::string & enclave,
const rmw_security_options_t * security_options)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const rmw_security_options_t * security_options)
const rmw_security_options_t & security_options)

{
data_ = std::make_shared<Data>(domain_id, std::move(enclave));
data_ = std::make_shared<Data>(domain_id, std::move(enclave), security_options);
data_->init();
}

Expand Down
3 changes: 2 additions & 1 deletion rmw_zenoh_cpp/src/detail/rmw_context_impl_s.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ struct rmw_context_impl_s final
// check has not succeeded.
rmw_context_impl_s(
const std::size_t domain_id,
const std::string & enclave);
const std::string & enclave,
const rmw_security_options_t * security_options);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const rmw_security_options_t * security_options);
const rmw_security_options_t & security_options);


~rmw_context_impl_s();

Expand Down
3 changes: 2 additions & 1 deletion rmw_zenoh_cpp/src/rmw_init.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,8 @@ rmw_init(const rmw_init_options_t * options, rmw_context_t * context)
return RMW_RET_BAD_ALLOC,
rmw_context_impl_t,
context->actual_domain_id,
std::string(options->enclave)
std::string(options->enclave),
&context->options.security_options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
&context->options.security_options
context->options.security_options

);

free_options.cancel();
Expand Down