Rename secure -> config and change its focus (C++) (#277)

Author: bernardnormier

cpp/Ice/secure/CMakeLists.txt renamed to cpp/Ice/config/CMakeLists.txt

@@ -6,9 +6,10 @@
 #include <sstream>
 
 using namespace std;
+using namespace ConfigServer;
 
 string
-GreeterServer::Chatbot::greet(string name, const Ice::Current&)
+Chatbot::greet(string name, const Ice::Current&)
 {
     cout << "Dispatching greet request { name = '" << name << "' }" << endl;
 

cpp/Ice/secure/Chatbot.cpp renamed to cpp/Ice/config/Chatbot.cpp

@@ -5,7 +5,7 @@
 
 #include "Greeter.h"
 
-namespace GreeterServer
+namespace ConfigServer
 {
     /// A Chatbot is an Ice servant that implements Slice interface Greeter.
     class Chatbot : public VisitorCenter::Greeter

cpp/Ice/secure/Chatbot.h renamed to cpp/Ice/config/Chatbot.h

@@ -2,6 +2,7 @@
 
 #include "Greeter.h"
 
+#include <Ice/Ice.h>
 #include <cstdlib>
 #include <iostream>
 
@@ -18,22 +19,21 @@ main(int argc, char* argv[])
     }
     if (name == nullptr)
     {
-        name = "alice";
+        name = "masked user";
     }
 
-    // Create an Ice communicator to initialize the Ice runtime. The new communicator gets its properties from file
-    // "config.client".
+    // Create an Ice communicator to initialize the Ice runtime. The communicator gets its configuration properties from
+    // file "config.server". The communicator initialization also parses the command-line options to find and set
+    // additional properties.
     const Ice::CommunicatorHolder communicatorHolder{argc, argv, "config.client"};
     const Ice::CommunicatorPtr& communicator = communicatorHolder.communicator();
 
-    // GreeterPrx is a class generated by the Slice compiler. We create a proxy from a communicator and a "stringified
-    // proxy" with the address of the target object.
-    // If you run the server on a different computer, replace localhost in the string below with the server's hostname
-    // or IP address.
-    VisitorCenter::GreeterPrx greeter{communicator, "greeter:ssl -h localhost -p 4061"};
+    // We create a Greeter proxy using the value of the "Greeter.Proxy" property in config.client.
+    // It's nullopt if the property is not set.
+    std::optional<VisitorCenter::GreeterPrx> greeter =
+        communicator->propertyToProxy<VisitorCenter::GreeterPrx>("Greeter.Proxy");
 
-    // Send a request to the remote object and get the response. Both the -> and . syntax can be used to make
-    // invocations with the proxy.
+    // Send a request to the remote object and get the response.
     string greeting = greeter->greet(name);
 
     cout << greeting << endl;

cpp/Ice/secure/Client.cpp renamed to cpp/Ice/config/Client.cpp

@@ -0,0 +1,64 @@
+# Config
+
+This demo shows how to configure your client and server applications using Ice configuration
+files.
+
+To build the demo run:
+
+```shell
+cmake -B build
+cmake --build build --config Release
+```
+
+To run the demo, first start the server:
+
+**Linux/macOS:**
+
+```shell
+./build/server
+```
+
+**Windows:**
+
+```shell
+build\Release\server
+```
+
+In a separate window, start the client:
+
+**Linux/macOS:**
+
+```shell
+./build/client
+```
+
+**Windows:**
+
+```shell
+build\Release\client
+```
+
+You can pass `--Ice` command-line options to set additional properties or override the properties set in the
+configuration file.
+
+For example:
+
+**Linux/macOS:**
+
+```shell
+./build/server --Ice.Default.Protocol=ws
+```
+
+```shell
+./build/client --Ice.Default.Protocol=ws --Ice.Trace.Network=2
+```
+
+**Windows:**
+
+```shell
+build\Release\server --Ice.Default.Protocol=ws
+```
+
+```shell
+build\Release\client --Ice.Default.Protocol=ws --Ice.Trace.Network=2
+```

cpp/Ice/secure/Greeter.ice renamed to cpp/Ice/config/Greeter.ice

@@ -2,9 +2,11 @@
 
 #include "Chatbot.h"
 
+#include <Ice/Ice.h>
 #include <iostream>
 
 using namespace std;
+using namespace ConfigServer;
 
 int
 main(int argc, char* argv[])
@@ -13,21 +15,24 @@ main(int argc, char* argv[])
     // of the program, before creating an Ice communicator or starting any thread.
     Ice::CtrlCHandler ctrlCHandler;
 
-    // Create an Ice communicator to initialize the Ice runtime. The new communicator gets its properties from file
-    // "config.server".
+    // Create an Ice communicator to initialize the Ice runtime. The communicator gets its configuration properties from
+    // file "config.server". The communicator initialization also parses the command-line options to find and set
+    // additional properties.
     const Ice::CommunicatorHolder communicatorHolder{argc, argv, "config.server"};
     const Ice::CommunicatorPtr& communicator = communicatorHolder.communicator();
 
-    // Create an object adapter that listens for incoming requests and dispatches them to servants. We use the ssl
-    // transport for secure communications.
-    auto adapter = communicator->createObjectAdapterWithEndpoints("GreeterAdapter", "ssl -p 4061");
+    // Create an object adapter that listens for incoming requests and dispatches them to servants.
+    // This adapter is configured through the GreeterAdapter.* properties in config.server.
+    auto adapter = communicator->createObjectAdapter("GreeterAdapter");
 
     // Register the Chatbot servant with the adapter.
-    adapter->add(make_shared<GreeterServer::Chatbot>(), Ice::stringToIdentity("greeter"));
+    adapter->add(make_shared<Chatbot>(), Ice::stringToIdentity("greeter"));
 
     // Start dispatching requests.
     adapter->activate();
 
+    // Ice.Trace.Network=1 or greater shows on which interface(s) and port(s) the server is listening.
+
     // Wait until the user presses Ctrl+C.
     int signal = ctrlCHandler.wait();
     cout << "Caught signal " << signal << ", exiting..." << endl;

cpp/Ice/config/README.md

@@ -0,0 +1,38 @@
+#
+# Application-specific configuration
+#
+
+# The address of the target object. `default` is replaced by the value of Ice.Default.Protocol.
+Greeter.Proxy=greeter:default -h localhost -p 4061
+
+#
+# Ice configuration
+#
+
+# The transport protocol to use for Ice communications when `default` is specified.
+# You can set it to tcp, ssl, ws, or wss. Leaving it unset is equivalent to setting it to tcp.
+# Make sure you use the same value in config.client and config.server.
+Ice.Default.Protocol=ssl
+
+#
+# IceSSL configuration
+#
+
+# The directory where the application finds certificates and other files.
+IceSSL.DefaultDir=../../../certs
+
+# The certificate authority file.
+IceSSL.CAs=cacert.pem
+
+# The client's certificate file.
+IceSSL.CertFile=client.p12
+
+# The name of the keychain in which to import the client's certificate (SecureTransport only).
+IceSSL.Keychain=client.keychain
+
+# TODO: switch to password-less certificates
+IceSSL.Password=password
+IceSSL.KeychainPassword=password
+
+# Turn on security logging/tracing.
+# IceSSL.Trace.Security=1

cpp/Ice/secure/Server.cpp renamed to cpp/Ice/config/Server.cpp

@@ -0,0 +1,39 @@
+#
+# Object adapter configuration
+#
+
+# Configure the GreeterAdapter adapter to listen on port 4061, on all interfaces.
+# `default` is replaced by the value of Ice.Default.Protocol.
+GreeterAdapter.Endpoints=default -p 4061
+
+#
+# Ice configuration
+#
+
+# The transport protocol to use for Ice communications when `default` is specified.
+# You can set it to tcp, ssl, ws, or wss. Leaving it unset is equivalent to setting it to tcp.
+# Make sure you use the same value in config.client and config.server.
+Ice.Default.Protocol=ssl
+
+# Turn on Network and Dispatch logging/tracing.
+Ice.Trace.Network=1
+Ice.Trace.Dispatch=1
+
+# The directory where the application finds certificates and other files.
+IceSSL.DefaultDir=../../../certs
+
+# The certificate authority file.
+IceSSL.CAs=cacert.pem
+
+# The server's certificate file.
+IceSSL.CertFile=server.p12
+
+# The name of the keychain in which to import the server's certificate (SecureTransport only).
+IceSSL.Keychain=server.keychain
+
+# TODO: switch to password-less certificates
+IceSSL.Password=password
+IceSSL.KeychainPassword=password
+
+# Turn on security logging/tracing.
+IceSSL.Trace.Security=1