Improve help on middlebox/decrypt tool.

Author: dgarske

examples/etsi_test/etsi_test.c

@@ -26,14 +26,6 @@
 #define WOLFKM_ETST_CLIENT_DEF_REQUESTS     1       /* per thread */
 #define WOLFKM_ETST_CLIENT_DEF_TIMEOUT_SEC 10
 
-#ifndef EX_USAGE
-#define EX_USAGE 2
-#endif
-
-#ifndef EXIT_FAILURE
-#define EXIT_FAILURE 1
-#endif
-
 #define REQ_TYPE_GET  1
 #define REQ_TYPE_PUSH 2
 #define REQ_TYPE_FIND 3

examples/https/server.c

@@ -26,14 +26,6 @@
 
 #include <signal.h>        /* signal */
 
-#ifndef EX_USAGE
-#define EX_USAGE 2
-#endif
-
-#ifndef EXIT_FAILURE
-#define EXIT_FAILURE 1
-#endif
-
 static volatile int mStop = 0;
 static WKM_SOCKET_T listenFd = WKM_SOCKET_INVALID;
 
@@ -62,8 +54,9 @@ static void Usage(void)
     printf("-?          Help, print this usage\n");
     printf("-d          Disable ETSI Key Manager loading\n");
     printf("-p <num>    Port to listen, default %d\n", HTTPS_TEST_PORT);
-    printf("-l <num>    Log Level (1=Error to 4=Debug), default %d\n", WOLFKM_DEFAULT_LOG_LEVEL);
-    printf("-h <keymgr> Key Manager URL (default %s)\n", "https://" ETSI_TEST_HOST ":" ETSI_TEST_PORT_STR);
+    printf("-l <num>    Log Level (1=Error to 4=Debug), default %d\n",
+        WOLFKM_DEFAULT_LOG_LEVEL);
+    printf("-h <keymgr> Key Manager URL (default %s)\n", ETSI_TEST_URL);
 }
 
 int https_server_test(int argc, char** argv)
@@ -79,7 +72,7 @@ int https_server_test(int argc, char** argv)
     SOCKADDR_IN_T clientAddr;
     int port = HTTPS_TEST_PORT;
     enum log_level_t logLevel = WOLFKM_DEFAULT_LOG_LEVEL;
-    const char* etsiServer = "https://" ETSI_TEST_HOST ":" ETSI_TEST_PORT_STR;
+    const char* etsiServer = ETSI_TEST_URL;
     int ch, useKeyMgr = 1;
 
     signal(SIGINT, sig_handler);

examples/middlebox/decrypt.c

@@ -48,6 +48,7 @@
     #include <netinet/in.h>
 #endif
 
+#define DEFAULT_SERVER_ADDR_FILTER "127.0.0.1"
 
 typedef unsigned char byte;
 
@@ -326,6 +327,22 @@ static void TrimNewLine(char* str)
         str[strSz-1] = '\0';
 }
 
+static void Usage(void)
+{
+    printf("%s %s\n",  "decrypt", PACKAGE_VERSION);
+    printf( "usage: ./decrypt or ./decrypt pcapFile keyServerURL"
+                " [server] [port] [password]\n");
+    printf("-?           Help, print this usage\n");
+    printf("pcapFile     A previously saved pcap file\n");
+    printf("keyServerURL Key Manager URL or private key as PEM (default %s)\n",
+        ETSI_TEST_URL);
+    printf("server       The server’s IP address (v4 or v6) (default %s)\n",
+        DEFAULT_SERVER_ADDR_FILTER);
+    printf("port         The server port to sniff (default %d)\n",
+        HTTPS_TEST_PORT);
+    printf("password     Private Key Password if required\n");
+}
+
 int middlebox_decrypt_test(int argc, char** argv)
 {
     int          ret = 0;
@@ -336,7 +353,7 @@ int middlebox_decrypt_test(int argc, char** argv)
     int          frame = ETHER_IF_FRAME_LEN;
     char         err[PCAP_ERRBUF_SIZE];
     char         filter[32];
-    const char  *keyFilesSrc = "https://" ETSI_TEST_HOST ":" ETSI_TEST_PORT_STR;
+    const char  *keyFilesSrc = ETSI_TEST_URL;
     char         keyFilesBuf[MAX_FILENAME_SZ];
     char         keyFilesUser[MAX_FILENAME_SZ];
     const char  *server = NULL;
@@ -347,6 +364,16 @@ int middlebox_decrypt_test(int argc, char** argv)
 
     signal(SIGINT, sig_handler);
 
+    if (argc == 2 && 
+           (XSTRNCMP(argv[1], "-?", 2) == 0 ||
+            XSTRNCMP(argv[1], "-h", 2) == 0 ||
+            XSTRNCMP(argv[1], "--help", 6) == 0))
+    {
+        /* show usage */
+        Usage();
+        exit(EX_USAGE);
+    }
+
 #ifndef _WIN32
     ssl_InitSniffer();   /* dll load on Windows */
 #endif
@@ -524,7 +551,7 @@ int middlebox_decrypt_test(int argc, char** argv)
 
             /* defaults for server and port */
             port = portDef;
-            server = "127.0.0.1";
+            server = DEFAULT_SERVER_ADDR_FILTER;
 
             if (argc >= 3)
                 keyFilesSrc = argv[2];
@@ -554,12 +581,6 @@ int middlebox_decrypt_test(int argc, char** argv)
             }
         }
     }
-    else {
-        /* usage error */
-        printf( "usage: ./decrypt or ./decrypt dumpFile keyServerURL"
-                " [server] [port] [password]\n");
-        exit(EXIT_FAILURE);
-    }
 
     if (ret != 0)
         err_sys(err);

examples/test_config.h

@@ -34,6 +34,7 @@ extern "C" {
 #define ETSI_TEST_PORT_STR        "8119"
 #define ETSI_TEST_TIMEOUT_MS      2
 #define ETSI_TEST_KEY_TYPE        ETSI_KEY_TYPE_SECP256R1
+#define ETSI_TEST_URL             "https://" ETSI_TEST_HOST ":" ETSI_TEST_PORT_STR
 
 /* Example certificate and key for mutual authentication to key manager.
  * See ./certs/test-cert.sh for generation and signing. */
@@ -67,6 +68,15 @@ int  etsi_client_find(const char* urlStr, EtsiKey* key, int namedGroup, const by
 void etsi_client_cleanup(void);
 
 
+#ifndef EX_USAGE
+#define EX_USAGE 2
+#endif
+
+#ifndef EXIT_FAILURE
+#define EXIT_FAILURE 1
+#endif
+
+
 #ifdef __cplusplus
 }
 #endif