Skip to content
Open
Show file tree
Hide file tree
Changes from 7 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
3 changes: 2 additions & 1 deletion libcaf_openssl/caf/openssl/session.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class CAF_OPENSSL_EXPORT session {
rw_state read_some(size_t& result, native_socket fd, void* buf, size_t len);
rw_state
write_some(size_t& result, native_socket fd, const void* buf, size_t len);
bool try_connect(native_socket fd);
bool try_connect(native_socket fd, const std::string& sni_servername);
bool try_accept(native_socket fd);

bool must_read_more(native_socket, size_t threshold);
Expand All @@ -68,6 +68,7 @@ using session_ptr = std::unique_ptr<session>;

/// @relates session
CAF_OPENSSL_EXPORT session_ptr make_session(actor_system& sys, native_socket fd,
const std::string& servername,
bool from_accepted_socket);

} // namespace caf::openssl
4 changes: 2 additions & 2 deletions libcaf_openssl/src/openssl/middleman_actor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ class doorman_impl : public io::network::doorman_impl {
auto fd = acceptor_.accepted_socket();
detail::socket_guard sguard{fd};
io::network::nonblocking(fd, true);
auto sssn = make_session(parent()->system(), fd, true);
auto sssn = make_session(parent()->system(), fd, "", true);
if (sssn == nullptr) {
CAF_LOG_ERROR("Unable to create SSL session for accepted socket");
return false;
Expand Down Expand Up @@ -245,7 +245,7 @@ class middleman_actor_impl : public io::middleman_actor_impl {
if (!fd)
return std::move(fd.error());
io::network::nonblocking(*fd, true);
auto sssn = make_session(system(), *fd, false);
auto sssn = make_session(system(), *fd, host, false);
if (!sssn) {
CAF_LOG_ERROR("Unable to create SSL session for connection");
return sec::cannot_connect_to_node;
Expand Down
99 changes: 91 additions & 8 deletions libcaf_openssl/src/openssl/session.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#include "caf/openssl/session.hpp"

#include <optional>

CAF_PUSH_WARNINGS
#include <openssl/err.h>
CAF_POP_WARNINGS
Expand Down Expand Up @@ -56,6 +58,54 @@ int pem_passwd_cb(char* buf, int size, int, void* ptr) {
return static_cast<int>(strlen(buf));
}

std::optional<std::string> contents_from_direct_envvar(const std::string& str) {
return str;
}

// If the input is a string like `env:SOME_VARIABLE` and the environment variable
// `SOME_VARIABLE` exists, returns a string with the value of `SOME_VARIABLE`.
// Otherwise, returns `std::nullopt`.
std::optional<std::string> contents_from_indirect_envvar(const std::string& str) {
if (str.find("env:") != 0)
return std::nullopt;
auto var = str.substr(4);
auto const* contents = ::getenv(var.c_str());
if (contents == nullptr)
return std::nullopt;
return std::string{contents};
}

// If the input is a string like `env:SOME_VARIABLE` and the environment variable
// `SOME_VARIABLE` exists, returns a string with the value of `SOME_VARIABLE`.
std::optional<std::string> tmpfile_from_string(const std::string& content) {
auto filename = std::string{"/tmp/caf-openssl.XXXXXX"};
::mkstemp(&filename[0]);
std::ofstream ofs(filename);
ofs << content;
ofs.close();
return filename;
}
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I just realized that this approach will only work for docker-compose, there's no good way to inject environment variables when the user uses his own vast and a vast.yaml.

However adding the value without the indirection has the disadvantage that the secrets will appear everywhere the VAST config is printed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we make it possible to pass the file path in the env variable for the second case?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

A file path is how it already works, before our patches.

I think the cleanest solution is to not pass this via config at all but to provide a /get-client-certificates endpoint where we can download everything before starting CAF. (and to only use this mechanism for the manager nodes) But for the short term I just added support for putting the PEM directly into the option.


// Returns
std::optional<std::string> pem_string_from_envvar(const std::string& str) {
if (str.find("env:") == 0)
return contents_from_indirect_envvar(str);
// The PEM format isn't very strictly defined, some implementations
// write the header as `---- BEGIN`. However, we probably don't want to
// keep supporting this in the long run anyways, so we're fine with just
// detecting exactly those certificates that we create ourselves.
if (str.find("-----BEGIN") == 0)
return contents_from_direct_envvar(str);
return std::nullopt;
}

std::optional<std::string> pem_file_from_envvar(const std::string& str) {
if (auto contents = pem_string_from_envvar(str))
return tmpfile_from_string(*contents);
return std::nullopt;
}


} // namespace

session::session(actor_system& sys)
Expand Down Expand Up @@ -154,11 +204,20 @@ rw_state session::write_some(size_t& result, native_socket, const void* buf,
return do_some(wr_fun, result, const_cast<void*>(buf), len, "write_some");
}

bool session::try_connect(native_socket fd) {
bool session::try_connect(native_socket fd, const std::string& sni_servername) {
CAF_LOG_TRACE(CAF_ARG(fd));
CAF_BLOCK_SIGPIPE();
SSL_set_fd(ssl_, fd);
SSL_set_connect_state(ssl_);
#if OPENSSL_VERSION_NUMBER >= 0x10100000L
// FIXME: Re-enable this.
// Enable hostname validation.
// SSL_set_hostflags(ssl_, X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
// if (SSL_set1_host(ssl_, sni_servername.c_str()) != 1)
// return false;
Comment thread
tobim marked this conversation as resolved.
Outdated
#endif
// Send SNI when connecting.
SSL_set_tlsext_host_name(ssl_, sni_servername.c_str());
auto ret = SSL_connect(ssl_);
if (ret == 1)
return true;
Expand Down Expand Up @@ -198,25 +257,48 @@ SSL_CTX* session::create_ssl_context() {
if (sys_.openssl_manager().authentication_enabled()) {
// Require valid certificates on both sides.
auto& cfg = sys_.config();
if (!cfg.openssl_certificate.empty()
// OpenSSL doesn't expose an API to read a certificate chain PEM from
// memory and the implementation of `SSL_CTX_use_certificate_chain_file`
// is huge, so we write into a temporary file.
if (auto filename = pem_file_from_envvar(cfg.openssl_certificate)) {
if (SSL_CTX_use_certificate_chain_file(ctx, filename->c_str())
!= 1)
CAF_RAISE_ERROR("cannot load certificate from environment variable");
} else if (!cfg.openssl_certificate.empty()
&& SSL_CTX_use_certificate_chain_file(ctx,
cfg.openssl_certificate.c_str())
!= 1)
!= 1) {
CAF_RAISE_ERROR("cannot load certificate");
}
if (!cfg.openssl_passphrase.empty()) {
openssl_passphrase_ = cfg.openssl_passphrase;
SSL_CTX_set_default_passwd_cb(ctx, pem_passwd_cb);
SSL_CTX_set_default_passwd_cb_userdata(ctx, this);
}
if (!cfg.openssl_key.empty()
&& SSL_CTX_use_PrivateKey_file(ctx, cfg.openssl_key.c_str(),
SSL_FILETYPE_PEM)
!= 1)
if (auto var = pem_string_from_envvar(cfg.openssl_key)) {
// BIO_new_mem_buf just creates a read-only view, so we don't need
// to free it afterwards.
auto* kbio = BIO_new_mem_buf(var->data(), -1);
if (kbio == nullptr)
CAF_RAISE_ERROR("failed to construct OpenSSL BIO");
// Starting from OpenSSL 3.0, the OSSL_DECODER API is the suggested
// alternative for this.
// TODO: Pass the pem_passwd_cb here if a passphrase was configured.
auto* pkey = PEM_read_bio_PrivateKey(kbio, nullptr, nullptr, nullptr);
if (pkey == nullptr)
CAF_RAISE_ERROR("invalid private key");
SSL_CTX_use_PrivateKey(ctx, pkey);
} else if (!cfg.openssl_key.empty()
&& SSL_CTX_use_PrivateKey_file(ctx, cfg.openssl_key.c_str(),
SSL_FILETYPE_PEM) != 1)
CAF_RAISE_ERROR("cannot load private key");
auto cafile = (!cfg.openssl_cafile.empty() ? cfg.openssl_cafile.c_str()
: nullptr);
auto capath = (!cfg.openssl_capath.empty() ? cfg.openssl_capath.c_str()
: nullptr);
auto tmpfile = pem_file_from_envvar(cafile);
if (tmpfile)
cafile = tmpfile->c_str();
if (cafile || capath) {
if (SSL_CTX_load_verify_locations(ctx, cafile, capath) != 1)
CAF_RAISE_ERROR("cannot load trusted CA certificates");
Expand Down Expand Up @@ -285,6 +367,7 @@ bool session::handle_ssl_result(int ret) {
}

session_ptr make_session(actor_system& sys, native_socket fd,
const std::string& servername,
bool from_accepted_socket) {
session_ptr ptr{new session(sys)};
if (!ptr->init())
Expand All @@ -293,7 +376,7 @@ session_ptr make_session(actor_system& sys, native_socket fd,
if (!ptr->try_accept(fd))
return nullptr;
} else {
if (!ptr->try_connect(fd))
if (!ptr->try_connect(fd, servername))
return nullptr;
}
return ptr;
Expand Down