MTLS Client: Enabling mtls support in http_client
http_client currently does not uses mtls client certificates. This is
a good feature for both authentication and authorization purpose.
It will help external servers to trust the identity of bmc for better
security.This patch will add MTLS client certificate support for bmcweb
This is a needed feature to support secure redfish aggregation between
BMCs.
To support secure aggregation BMCs should be provisioned with CA signed
certificate with an authorized username as the subject name field of the
certificate.
With the support of strong MTLS authentication from Bmcweb server we can
use the MTLS path to enable secure redfish aggregation among BMCs. This
can avoid complexities and extra API calls needed for token based
approach.
Tested by:
Aggregation Test1:
1) Setup two instance of romulus qemu session at different ports.This
will act as two BMCs
2) Installed CA root certificates at /etc/ssl/certs/authority in both
BMCs
3) Installed server.pem and client.pem entity certificates signed by the
root CA at /etc/ssl/certs/https folder in both BMCs
4) Enable aggregation for Bmcweb.
5) Fired several redfish queries to BMC1
Result
Observed that the aggregation worked fine. User session created using
username mentined in the CN field of certificate.
Aggregation Test2:
Followed same steps from Aggregation Test1 with modification in step 3
In step3 installed only the server.pem.
Result
Bmcweb ran as usual. But aggregation failed to collect resources from
BMC2. No crash observed.
Redfish Event Test:
Subscribed for redfish events using test server.
Fired redfish test events from BMC.
Result:
Events reached server successfully.
Change-Id: Id8cccf9beec77da0f16adb72d52f3adf46347d06
Signed-off-by: Abhilash Raju <abhilash.kollam@gmail.com>
Signed-off-by: Ed Tanous <etanous@nvidia.com>
diff --git a/http/http_server.hpp b/http/http_server.hpp
index 6088ca1..6d725c9 100644
--- a/http/http_server.hpp
+++ b/http/http_server.hpp
@@ -79,37 +79,9 @@
{
return;
}
- namespace fs = std::filesystem;
- // Cleanup older certificate file existing in the system
- fs::path oldCert = "/home/root/server.pem";
- if (fs::exists(oldCert))
- {
- fs::remove("/home/root/server.pem");
- }
- fs::path certPath = "/etc/ssl/certs/https/";
- // if path does not exist create the path so that
- // self signed certificate can be created in the
- // path
- if (!fs::exists(certPath))
- {
- fs::create_directories(certPath);
- }
- fs::path certFile = certPath / "server.pem";
- BMCWEB_LOG_INFO("Building SSL Context file={}", certFile.string());
- std::string sslPemFile(certFile);
- std::string cert =
- ensuressl::ensureOpensslKeyPresentAndValid(sslPemFile);
- if (cert.empty())
- {
- throw std::runtime_error("Failed to load string");
- }
- std::shared_ptr<boost::asio::ssl::context> sslContext =
- ensuressl::getSslContext(cert);
- if (sslContext == nullptr)
- {
- throw std::runtime_error("Failed to load certificate");
- }
- BMCWEB_LOG_DEBUG("Replaced certificate");
+
+ auto sslContext = ensuressl::getSslServerContext();
+
adaptorCtx = sslContext;
handler->ssl(std::move(sslContext));
}
@@ -167,7 +139,7 @@
if (adaptorCtx == nullptr)
{
BMCWEB_LOG_CRITICAL(
- "Asked to lauch TLS socket but no context available");
+ "Asked to launch TLS socket but no context available");
return;
}
connection = std::make_shared<Connection<Adaptor, Handler>>(
diff --git a/include/ssl_key_handler.hpp b/include/ssl_key_handler.hpp
index 551d474..e3290b6 100644
--- a/include/ssl_key_handler.hpp
+++ b/include/ssl_key_handler.hpp
@@ -24,6 +24,8 @@
#include <boost/asio/ssl/context.hpp>
#include <boost/system/error_code.hpp>
+#include <filesystem>
+#include <memory>
#include <optional>
#include <random>
#include <string>
@@ -479,6 +481,30 @@
return cert;
}
+inline std::string ensureCertificate()
+{
+ namespace fs = std::filesystem;
+ // Cleanup older certificate file existing in the system
+ fs::path oldcertPath = fs::path("/home/root/server.pem");
+ std::error_code ec;
+ fs::remove(oldcertPath, ec);
+ // Ignore failure to remove; File might not exist.
+
+ fs::path certPath = "/etc/ssl/certs/https/";
+ // if path does not exist create the path so that
+ // self signed certificate can be created in the
+ // path
+ fs::path certFile = certPath / "server.pem";
+
+ if (!fs::exists(certPath, ec))
+ {
+ fs::create_directories(certFile, ec);
+ }
+ BMCWEB_LOG_INFO("Building SSL Context file= {}", certFile.string());
+ std::string sslPemFile(certFile);
+ return ensuressl::ensureOpensslKeyPresentAndValid(sslPemFile);
+}
+
inline int nextProtoCallback(SSL* /*unused*/, const unsigned char** data,
unsigned int* len, void* /*unused*/)
{
@@ -509,51 +535,37 @@
return SSL_TLSEXT_ERR_OK;
}
-inline std::shared_ptr<boost::asio::ssl::context>
- getSslContext(const std::string& sslPemFile)
+inline bool getSslContext(boost::asio::ssl::context& mSslContext,
+ const std::string& sslPemFile)
{
- std::shared_ptr<boost::asio::ssl::context> mSslContext =
- std::make_shared<boost::asio::ssl::context>(
- boost::asio::ssl::context::tls_server);
- mSslContext->set_options(boost::asio::ssl::context::default_workarounds |
- boost::asio::ssl::context::no_sslv2 |
- boost::asio::ssl::context::no_sslv3 |
- boost::asio::ssl::context::single_dh_use |
- boost::asio::ssl::context::no_tlsv1 |
- boost::asio::ssl::context::no_tlsv1_1);
-
- // BIG WARNING: This needs to stay disabled, as there will always be
- // unauthenticated endpoints
- // mSslContext->set_verify_mode(boost::asio::ssl::verify_peer);
-
- SSL_CTX_set_options(mSslContext->native_handle(), SSL_OP_NO_RENEGOTIATION);
+ mSslContext.set_options(boost::asio::ssl::context::default_workarounds |
+ boost::asio::ssl::context::no_sslv2 |
+ boost::asio::ssl::context::no_sslv3 |
+ boost::asio::ssl::context::single_dh_use |
+ boost::asio::ssl::context::no_tlsv1 |
+ boost::asio::ssl::context::no_tlsv1_1);
BMCWEB_LOG_DEBUG("Using default TrustStore location: {}", trustStorePath);
- mSslContext->add_verify_path(trustStorePath);
+ mSslContext.add_verify_path(trustStorePath);
- boost::system::error_code ec;
- boost::asio::const_buffer buf(sslPemFile.data(), sslPemFile.size());
- mSslContext->use_certificate(buf, boost::asio::ssl::context::pem, ec);
- if (ec)
+ if (!sslPemFile.empty())
{
- BMCWEB_LOG_CRITICAL("Failed to open ssl certificate");
- return nullptr;
- }
- mSslContext->use_private_key(buf, boost::asio::ssl::context::pem);
- if (ec)
- {
- BMCWEB_LOG_CRITICAL("Failed to open ssl pkey");
- return nullptr;
+ boost::system::error_code ec;
+
+ boost::asio::const_buffer buf(sslPemFile.data(), sslPemFile.size());
+ mSslContext.use_certificate(buf, boost::asio::ssl::context::pem, ec);
+ if (ec)
+ {
+ return false;
+ }
+ mSslContext.use_private_key(buf, boost::asio::ssl::context::pem, ec);
+ if (ec)
+ {
+ BMCWEB_LOG_CRITICAL("Failed to open ssl pkey");
+ return false;
+ }
}
- if constexpr (BMCWEB_EXPERIMENTAL_HTTP2)
- {
- SSL_CTX_set_next_protos_advertised_cb(mSslContext->native_handle(),
- nextProtoCallback, nullptr);
-
- SSL_CTX_set_alpn_select_cb(mSslContext->native_handle(),
- alpnSelectProtoCallback, nullptr);
- }
// Set up EC curves to auto (boost asio doesn't have a method for this)
// There is a pull request to add this. Once this is included in an asio
// drop, use the right way
@@ -573,36 +585,63 @@
"DHE-RSA-AES256-GCM-SHA384:"
"DHE-RSA-CHACHA20-POLY1305";
- if (SSL_CTX_set_cipher_list(mSslContext->native_handle(),
+ if (SSL_CTX_set_cipher_list(mSslContext.native_handle(),
mozillaIntermediate) != 1)
{
BMCWEB_LOG_ERROR("Error setting cipher list");
+ return false;
}
- return mSslContext;
+ return true;
+}
+
+inline std::shared_ptr<boost::asio::ssl::context> getSslServerContext()
+{
+ boost::asio::ssl::context sslCtx(boost::asio::ssl::context::tls_server);
+
+ auto certFile = ensureCertificate();
+ if (!getSslContext(sslCtx, certFile))
+ {
+ BMCWEB_LOG_CRITICAL("Couldn't get server context");
+ return nullptr;
+ }
+
+ // BIG WARNING: This needs to stay disabled, as there will always be
+ // unauthenticated endpoints
+ // mSslContext->set_verify_mode(boost::asio::ssl::verify_peer);
+
+ SSL_CTX_set_options(sslCtx.native_handle(), SSL_OP_NO_RENEGOTIATION);
+
+ if constexpr (BMCWEB_EXPERIMENTAL_HTTP2)
+ {
+ SSL_CTX_set_next_protos_advertised_cb(sslCtx.native_handle(),
+ nextProtoCallback, nullptr);
+
+ SSL_CTX_set_alpn_select_cb(sslCtx.native_handle(),
+ alpnSelectProtoCallback, nullptr);
+ }
+
+ return std::make_shared<boost::asio::ssl::context>(std::move(sslCtx));
}
inline std::optional<boost::asio::ssl::context> getSSLClientContext()
{
+ namespace fs = std::filesystem;
+
boost::asio::ssl::context sslCtx(boost::asio::ssl::context::tls_client);
- boost::system::error_code ec;
+ // NOTE, this path is temporary; In the future it will need to change to
+ // be set per subscription. Do not rely on this.
+ fs::path certPath = "/etc/ssl/certs/https/client.pem";
+ std::string cert = verifyOpensslKeyCert(certPath);
- // Support only TLS v1.2 & v1.3
- sslCtx.set_options(boost::asio::ssl::context::default_workarounds |
- boost::asio::ssl::context::no_sslv2 |
- boost::asio::ssl::context::no_sslv3 |
- boost::asio::ssl::context::single_dh_use |
- boost::asio::ssl::context::no_tlsv1 |
- boost::asio::ssl::context::no_tlsv1_1,
- ec);
- if (ec)
+ if (!getSslContext(sslCtx, cert))
{
- BMCWEB_LOG_ERROR("SSL context set_options failed");
return std::nullopt;
}
// Add a directory containing certificate authority files to be used
// for performing verification.
+ boost::system::error_code ec;
sslCtx.set_default_verify_paths(ec);
if (ec)
{
@@ -638,7 +677,7 @@
return std::nullopt;
}
- return sslCtx;
+ return {std::move(sslCtx)};
}
} // namespace ensuressl