Unifies ssl and plain connections.

Author: mzimbres

CMakeLists.txt

@@ -84,7 +84,7 @@ endif()
 #=======================================================================
 
 add_executable(cpp20_intro examples/cpp20_intro.cpp)
-target_link_libraries(cpp20_intro common)
+target_link_libraries(cpp20_intro PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 target_compile_features(cpp20_intro PUBLIC cxx_std_20)
 add_test(cpp20_intro cpp20_intro)
 if (MSVC)
@@ -93,14 +93,15 @@ if (MSVC)
 endif()
 
 add_executable(cpp20_streams examples/cpp20_streams.cpp)
-target_link_libraries(cpp20_streams common)
+target_link_libraries(cpp20_streams PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 target_compile_features(cpp20_streams PUBLIC cxx_std_20)
 if (MSVC)
     target_compile_options(cpp20_streams PRIVATE /bigobj)
     target_compile_definitions(cpp20_streams PRIVATE _WIN32_WINNT=0x0601)
 endif()
 
 add_executable(cpp17_intro examples/cpp17_intro.cpp)
+target_link_libraries(cpp17_intro PRIVATE OpenSSL::Crypto OpenSSL::SSL)
 target_compile_features(cpp17_intro PUBLIC cxx_std_17)
 add_test(cpp17_intro cpp17_intro)
 if (MSVC)
@@ -111,18 +112,19 @@ endif()
 if (NOT MSVC)
 add_executable(cpp17_intro_sync examples/cpp17_intro_sync.cpp)
 target_compile_features(cpp17_intro_sync PUBLIC cxx_std_17)
+target_link_libraries(cpp17_intro_sync PRIVATE OpenSSL::Crypto OpenSSL::SSL)
 add_test(cpp17_intro_sync cpp17_intro_sync)
 endif()
 
 if (NOT MSVC)
 add_executable(cpp20_chat_room examples/cpp20_chat_room.cpp)
 target_compile_features(cpp20_chat_room PUBLIC cxx_std_20)
-target_link_libraries(cpp20_chat_room common)
+target_link_libraries(cpp20_chat_room PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 endif()
 
 add_executable(cpp20_containers examples/cpp20_containers.cpp)
 target_compile_features(cpp20_containers PUBLIC cxx_std_20)
-target_link_libraries(cpp20_containers common)
+target_link_libraries(cpp20_containers PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 add_test(cpp20_containers cpp20_containers)
 if (MSVC)
     target_compile_options(cpp20_containers PRIVATE /bigobj)
@@ -132,12 +134,12 @@ endif()
 if (NOT MSVC)
 add_executable(cpp20_echo_server examples/cpp20_echo_server.cpp)
 target_compile_features(cpp20_echo_server PUBLIC cxx_std_20)
-target_link_libraries(cpp20_echo_server common)
+target_link_libraries(cpp20_echo_server PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 endif()
 
 add_executable(cpp20_resolve_with_sentinel examples/cpp20_resolve_with_sentinel.cpp)
 target_compile_features(cpp20_resolve_with_sentinel PUBLIC cxx_std_20)
-target_link_libraries(cpp20_resolve_with_sentinel common)
+target_link_libraries(cpp20_resolve_with_sentinel PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 #add_test(cpp20_resolve_with_sentinel cpp20_resolve_with_sentinel)
 if (MSVC)
     target_compile_options(cpp20_resolve_with_sentinel PRIVATE /bigobj)
@@ -146,7 +148,7 @@ endif()
 
 add_executable(cpp20_json examples/cpp20_json.cpp)
 target_compile_features(cpp20_json PUBLIC cxx_std_20)
-target_link_libraries(cpp20_json common)
+target_link_libraries(cpp20_json PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 add_test(cpp20_json cpp20_json)
 if (MSVC)
     target_compile_options(cpp20_json PRIVATE /bigobj)
@@ -157,7 +159,7 @@ if (Protobuf_FOUND)
    protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS examples/person.proto)
    add_executable(cpp20_protobuf examples/cpp20_protobuf.cpp ${PROTO_SRCS} ${PROTO_HDRS})
    target_compile_features(cpp20_protobuf PUBLIC cxx_std_20)
-   target_link_libraries(cpp20_protobuf common ${Protobuf_LIBRARIES})
+   target_link_libraries(cpp20_protobuf PRIVATE OpenSSL::Crypto OpenSSL::SSL common ${Protobuf_LIBRARIES})
    target_include_directories(cpp20_protobuf PUBLIC ${Protobuf_INCLUDE_DIRS} ${CMAKE_CURRENT_BINARY_DIR})
    add_test(cpp20_protobuf cpp20_protobuf)
    if (MSVC)
@@ -168,7 +170,7 @@ endif()
 
 add_executable(cpp20_subscriber examples/cpp20_subscriber.cpp)
 target_compile_features(cpp20_subscriber PUBLIC cxx_std_20)
-target_link_libraries(cpp20_subscriber common)
+target_link_libraries(cpp20_subscriber PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 if (MSVC)
     target_compile_options(cpp20_subscriber PRIVATE /bigobj)
     target_compile_definitions(cpp20_subscriber PRIVATE _WIN32_WINNT=0x0601)
@@ -177,8 +179,7 @@ endif()
 add_executable(cpp20_intro_tls examples/cpp20_intro_tls.cpp)
 target_compile_features(cpp20_intro_tls PUBLIC cxx_std_20)
 add_test(cpp20_intro_tls cpp20_intro_tls)
-target_link_libraries(cpp20_intro_tls OpenSSL::Crypto OpenSSL::SSL)
-target_link_libraries(cpp20_intro_tls common)
+target_link_libraries(cpp20_intro_tls PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 if (MSVC)
     target_compile_options(cpp20_intro_tls PRIVATE /bigobj)
     target_compile_definitions(cpp20_intro_tls PRIVATE _WIN32_WINNT=0x0601)
@@ -187,7 +188,7 @@ endif()
 add_executable(cpp20_low_level_async tests/cpp20_low_level_async.cpp)
 target_compile_features(cpp20_low_level_async PUBLIC cxx_std_20)
 add_test(cpp20_low_level_async cpp20_low_level_async)
-target_link_libraries(cpp20_low_level_async common)
+target_link_libraries(cpp20_low_level_async PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 if (MSVC)
     target_compile_options(cpp20_low_level_async PRIVATE /bigobj)
     target_compile_definitions(cpp20_low_level_async PRIVATE _WIN32_WINNT=0x0601)
@@ -217,7 +218,7 @@ endif()
 
 add_executable(test_conn_exec tests/conn_exec.cpp)
 target_compile_features(test_conn_exec PUBLIC cxx_std_20)
-target_link_libraries(test_conn_exec test_common)
+target_link_libraries(test_conn_exec PRIVATE OpenSSL::Crypto OpenSSL::SSL test_common)
 add_test(test_conn_exec test_conn_exec)
 if (MSVC)
     target_compile_options(test_conn_exec PRIVATE /bigobj)
@@ -226,7 +227,7 @@ endif()
 
 add_executable(test_conn_exec_retry tests/conn_exec_retry.cpp)
 target_compile_features(test_conn_exec_retry PUBLIC cxx_std_20)
-target_link_libraries(test_conn_exec_retry test_common)
+target_link_libraries(test_conn_exec_retry PRIVATE OpenSSL::Crypto OpenSSL::SSL test_common)
 add_test(test_conn_exec_retry test_conn_exec_retry)
 if (MSVC)
     target_compile_options(test_conn_exec_retry PRIVATE /bigobj)
@@ -235,7 +236,7 @@ endif()
 
 add_executable(test_conn_push tests/conn_push.cpp)
 target_compile_features(test_conn_push PUBLIC cxx_std_20)
-target_link_libraries(test_conn_push test_common)
+target_link_libraries(test_conn_push PRIVATE OpenSSL::Crypto OpenSSL::SSL test_common)
 add_test(test_conn_push test_conn_push)
 if (MSVC)
     target_compile_options(test_conn_push PRIVATE /bigobj)
@@ -244,6 +245,7 @@ endif()
 
 add_executable(test_conn_quit tests/conn_quit.cpp)
 target_compile_features(test_conn_quit PUBLIC cxx_std_17)
+target_link_libraries(test_conn_quit PRIVATE OpenSSL::Crypto OpenSSL::SSL test_common)
 add_test(test_conn_quit test_conn_quit)
 if (MSVC)
     target_compile_options(test_conn_quit PRIVATE /bigobj)
@@ -252,7 +254,7 @@ endif()
 
 add_executable(test_conn_reconnect tests/conn_reconnect.cpp)
 target_compile_features(test_conn_reconnect PUBLIC cxx_std_20)
-target_link_libraries(test_conn_reconnect common test_common)
+target_link_libraries(test_conn_reconnect PRIVATE OpenSSL::Crypto OpenSSL::SSL common test_common)
 add_test(test_conn_reconnect test_conn_reconnect)
 if (MSVC)
     target_compile_options(test_conn_reconnect PRIVATE /bigobj)
@@ -262,7 +264,7 @@ endif()
 add_executable(test_conn_tls tests/conn_tls.cpp)
 add_test(test_conn_tls test_conn_tls)
 target_compile_features(test_conn_tls PUBLIC cxx_std_17)
-target_link_libraries(test_conn_tls OpenSSL::Crypto OpenSSL::SSL)
+target_link_libraries(test_conn_tls PRIVATE OpenSSL::Crypto OpenSSL::SSL)
 if (MSVC)
     target_compile_options(test_conn_tls PRIVATE /bigobj)
     target_compile_definitions(test_conn_tls PRIVATE _WIN32_WINNT=0x0601)
@@ -279,14 +281,15 @@ endif()
 add_executable(test_conn_run_cancel tests/conn_run_cancel.cpp)
 target_compile_features(test_conn_run_cancel PUBLIC cxx_std_20)
 add_test(test_conn_run_cancel test_conn_run_cancel)
+target_link_libraries(test_conn_run_cancel PRIVATE OpenSSL::Crypto OpenSSL::SSL)
 if (MSVC)
     target_compile_options(test_conn_run_cancel PRIVATE /bigobj)
     target_compile_definitions(test_conn_run_cancel PRIVATE _WIN32_WINNT=0x0601)
 endif()
 
 add_executable(test_conn_exec_cancel tests/conn_exec_cancel.cpp)
 target_compile_features(test_conn_exec_cancel PUBLIC cxx_std_20)
-target_link_libraries(test_conn_exec_cancel common test_common)
+target_link_libraries(test_conn_exec_cancel PRIVATE OpenSSL::Crypto OpenSSL::SSL common test_common)
 add_test(test_conn_exec_cancel test_conn_exec_cancel)
 if (MSVC)
     target_compile_options(test_conn_exec_cancel PRIVATE /bigobj)
@@ -295,7 +298,7 @@ endif()
 
 add_executable(test_conn_exec_cancel2 tests/conn_exec_cancel2.cpp)
 target_compile_features(test_conn_exec_cancel2 PUBLIC cxx_std_20)
-target_link_libraries(test_conn_exec_cancel2 common test_common)
+target_link_libraries(test_conn_exec_cancel2 PRIVATE OpenSSL::Crypto OpenSSL::SSL common test_common)
 add_test(test_conn_exec_cancel2 test_conn_exec_cancel2)
 if (MSVC)
     target_compile_options(test_conn_exec_cancel2 PRIVATE /bigobj)
@@ -304,7 +307,7 @@ endif()
 
 add_executable(test_conn_exec_error tests/conn_exec_error.cpp)
 target_compile_features(test_conn_exec_error PUBLIC cxx_std_17)
-target_link_libraries(test_conn_exec_error common test_common)
+target_link_libraries(test_conn_exec_error PRIVATE OpenSSL::Crypto OpenSSL::SSL common test_common)
 add_test(test_conn_exec_error test_conn_exec_error)
 if (MSVC)
     target_compile_options(test_conn_exec_error PRIVATE /bigobj)
@@ -313,7 +316,7 @@ endif()
 
 add_executable(test_conn_echo_stress tests/conn_echo_stress.cpp)
 target_compile_features(test_conn_echo_stress PUBLIC cxx_std_20)
-target_link_libraries(test_conn_echo_stress common test_common)
+target_link_libraries(test_conn_echo_stress PRIVATE OpenSSL::Crypto OpenSSL::SSL common test_common)
 add_test(test_conn_echo_stress test_conn_echo_stress)
 if (MSVC)
     target_compile_options(test_conn_echo_stress PRIVATE /bigobj)
@@ -330,7 +333,7 @@ endif()
 
 add_executable(test_issue_50 tests/issue_50.cpp)
 target_compile_features(test_issue_50 PUBLIC cxx_std_20)
-target_link_libraries(test_issue_50 common)
+target_link_libraries(test_issue_50 PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 add_test(test_issue_50 test_issue_50)
 if (MSVC)
     target_compile_options(test_issue_50 PRIVATE /bigobj)
@@ -339,7 +342,7 @@ endif()
 
 add_executable(test_conn_check_health tests/conn_check_health.cpp)
 target_compile_features(test_conn_check_health PUBLIC cxx_std_17)
-target_link_libraries(test_conn_check_health common)
+target_link_libraries(test_conn_check_health PRIVATE OpenSSL::Crypto OpenSSL::SSL common)
 add_test(test_conn_check_health test_conn_check_health)
 if (MSVC)
     target_compile_options(test_conn_check_health PRIVATE /bigobj)
@@ -348,7 +351,7 @@ endif()
 
 add_executable(test_run tests/run.cpp)
 target_compile_features(test_run PUBLIC cxx_std_17)
-target_link_libraries(test_run test_common)
+target_link_libraries(test_run PRIVATE OpenSSL::Crypto OpenSSL::SSL test_common)
 add_test(test_run test_run)
 if (MSVC)
     target_compile_options(test_run PRIVATE /bigobj)

README.md

@@ -678,7 +678,7 @@ Acknowledgement to people that helped shape Boost.Redis
 * Mohammad Nejati ([ashtum](https://github.com/ashtum)): For pointing out scenarios where calls to `async_exec` should fail when the connection is lost.
 * Klemens Morgenstern ([klemens-morgenstern](https://github.com/klemens-morgenstern)): For useful discussion about timeouts, cancellation, synchronous interfaces and general help with Asio.
 * Vinnie Falco ([vinniefalco](https://github.com/vinniefalco)): For general suggestions about how to improve the code and the documentation.
-* Bram Veldhoen ([bveldhoen](https://github.com/bveldhoen)): For contributing a Redis streams example.
+* Bram Veldhoen ([bveldhoen](https://github.com/bveldhoen)): For contributing a Redis-streams example.
 
 Also many thanks to all individuals that participated in the Boost
 review

examples/cpp17_intro.cpp

@@ -32,7 +32,8 @@ auto main(int argc, char * argv[]) -> int
       response<std::string> resp;
 
       net::io_context ioc;
-      connection conn{ioc};
+      net::ssl::context ctx{net::ssl::context::tls_client};
+      connection conn{ioc, ctx};
 
       conn.async_run(cfg, {}, net::detached);
 

examples/cpp17_intro_sync.cpp

@@ -12,6 +12,7 @@
 // Include this in no more than one .cpp file.
 #include <boost/redis/src.hpp>
 
+namespace net = boost::asio;
 using boost::redis::sync_connection;
 using boost::redis::request;
 using boost::redis::response;
@@ -27,7 +28,8 @@ auto main(int argc, char * argv[]) -> int
          cfg.addr.port = argv[2];
       }
 
-      sync_connection conn;
+      net::ssl::context ctx{net::ssl::context::tls_client};
+      sync_connection conn{ctx};
       conn.run(cfg);
 
       request req;

examples/cpp20_chat_room.cpp

@@ -38,7 +38,7 @@ receiver(std::shared_ptr<connection> conn) -> net::awaitable<void>
    request req;
    req.push("SUBSCRIBE", "channel");
 
-   while (!conn->is_cancelled()) {
+   while (conn->will_reconnect()) {
 
       // Subscribe to channels.
       co_await conn->async_exec(req);
@@ -75,12 +75,13 @@ auto publisher(std::shared_ptr<stream_descriptor> in, std::shared_ptr<connection
 auto co_main(config cfg) -> net::awaitable<void>
 {
    auto ex = co_await net::this_coro::executor;
-   auto conn = std::make_shared<connection>(ex);
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(ex, *ctx);
    auto stream = std::make_shared<stream_descriptor>(ex, ::dup(STDIN_FILENO));
 
    net::co_spawn(ex, receiver(conn), net::detached);
    net::co_spawn(ex, publisher(stream, conn), net::detached);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    signal_set sig_set{ex, SIGINT, SIGTERM};
    co_await sig_set.async_wait();

examples/cpp20_containers.cpp

@@ -91,8 +91,9 @@ auto transaction(std::shared_ptr<connection> conn) -> net::awaitable<void>
 // Called from the main function (see main.cpp)
 net::awaitable<void> co_main(config cfg)
 {
-   auto conn = std::make_shared<connection>(co_await net::this_coro::executor);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(co_await net::this_coro::executor, *ctx);
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    co_await store(conn);
    co_await transaction(conn);

examples/cpp20_echo_server.cpp

@@ -58,9 +58,10 @@ auto listener(std::shared_ptr<connection> conn) -> net::awaitable<void>
 auto co_main(config cfg) -> net::awaitable<void>
 {
    auto ex = co_await net::this_coro::executor;
-   auto conn = std::make_shared<connection>(ex);
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(ex, *ctx);
    net::co_spawn(ex, listener(conn), net::detached);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    signal_set sig_set(ex, SIGINT, SIGTERM);
    co_await sig_set.async_wait();

examples/cpp20_intro.cpp

@@ -23,8 +23,9 @@ using connection = net::deferred_t::as_default_on_t<boost::redis::connection>;
 // Called from the main function (see main.cpp)
 auto co_main(config cfg) -> net::awaitable<void>
 {
-   auto conn = std::make_shared<connection>(co_await net::this_coro::executor);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(co_await net::this_coro::executor, *ctx);
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    // A request containing only a ping command.
    request req;

examples/cpp20_intro_tls.cpp

@@ -4,7 +4,7 @@
  * accompanying file LICENSE.txt)
  */
 
-#include <boost/redis/ssl/connection.hpp>
+#include <boost/redis/connection.hpp>
 #include <boost/asio/deferred.hpp>
 #include <boost/asio/use_awaitable.hpp>
 #include <boost/asio/detached.hpp>
@@ -18,7 +18,7 @@ using boost::redis::request;
 using boost::redis::response;
 using boost::redis::config;
 using boost::redis::logger;
-using connection = net::deferred_t::as_default_on_t<boost::redis::ssl::connection>;
+using connection = net::deferred_t::as_default_on_t<boost::redis::connection>;
 
 auto verify_certificate(bool, net::ssl::verify_context&) -> bool
 {
@@ -28,14 +28,15 @@ auto verify_certificate(bool, net::ssl::verify_context&) -> bool
 
 auto co_main(config cfg) -> net::awaitable<void>
 {
+   cfg.use_ssl = true;
    cfg.username = "aedis";
    cfg.password = "aedis";
    cfg.addr.host = "db.occase.de";
    cfg.addr.port = "6380";
 
-   net::ssl::context ctx{net::ssl::context::sslv23};
-   auto conn = std::make_shared<connection>(co_await net::this_coro::executor, ctx);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(co_await net::this_coro::executor, *ctx);
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    request req;
    req.push("PING");

examples/cpp20_json.cpp

@@ -48,8 +48,9 @@ void boost_redis_from_bulk(user& u, std::string_view sv, boost::system::error_co
 auto co_main(config cfg) -> net::awaitable<void>
 {
    auto ex = co_await net::this_coro::executor;
-   auto conn = std::make_shared<connection>(ex);
-   conn->async_run(cfg, {}, net::consign(net::detached, conn));
+   auto ctx = std::make_shared<net::ssl::context>(net::ssl::context::tls_client);
+   auto conn = std::make_shared<connection>(ex, *ctx);
+   conn->async_run(cfg, {}, net::consign(net::detached, conn, ctx));
 
    // user object that will be stored in Redis in json format.
    user const u{"Joao", "58", "Brazil"};