summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJames Muir <james@openssl.org>2023-10-26 17:50:45 -0400
committerHugo Landau <hlandau@openssl.org>2023-11-01 15:39:12 +0000
commit0d4a8667e25406b39785c6d4a25b34a825eb798a (patch)
treebe6e190df980332d493a62d878ba63342479f3f5 /doc
parent97750ca0b2c2fe7fd94e82ae841fec92f7173a35 (diff)
quic ddd demos: update makefile and demo sources
Update makefile and fix some signedness issues in the demo sources. Drop stray "\n" in the host-port format string that prevented ddd-01 from working (this was also noticed by Neil H). Also, determine the length of the message we are sending and send that many bytes (rather than send sizeof the buffer storing the message). These changes are part of https://github.com/openssl/project/issues/253 Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22542) (cherry picked from commit d1338fcf12672ef4a3d417f5dd03e342710ee5b3)
Diffstat (limited to 'doc')
-rw-r--r--doc/designs/ddd/Makefile44
-rw-r--r--doc/designs/ddd/ddd-01-conn-blocking.c13
-rw-r--r--doc/designs/ddd/ddd-02-conn-nonblocking-threads.c8
-rw-r--r--doc/designs/ddd/ddd-02-conn-nonblocking.c8
-rw-r--r--doc/designs/ddd/ddd-03-fd-blocking.c9
-rw-r--r--doc/designs/ddd/ddd-04-fd-nonblocking.c8
-rw-r--r--doc/designs/ddd/ddd-05-mem-nonblocking.c8
-rw-r--r--doc/designs/ddd/ddd-06-mem-uv.c11
8 files changed, 63 insertions, 46 deletions
diff --git a/doc/designs/ddd/Makefile b/doc/designs/ddd/Makefile
index 505830ea5d..5762159b0b 100644
--- a/doc/designs/ddd/Makefile
+++ b/doc/designs/ddd/Makefile
@@ -1,29 +1,43 @@
#
-# To run the demos when linked with a shared library (default):
+# To run the demos when linked with a shared library (default) ensure that
+# libcrypto and libssl are on the library path. For example to run the
+# ddd-01-conn-blocking-tls demo:
#
-# LD_LIBRARY_PATH=../.. make test
+# LD_LIBRARY_PATH=../../.. ./ddd-01-conn-blocking-tls
+#
+# Building ddd-06-mem-uv-tls and ddd-06-mem-uv-quic requires the
+# library libuv and header file. On Ubuntu, they are provided by the
+# package "libuv1-dev".
+
+TESTS_BASE = ddd-01-conn-blocking \
+ ddd-02-conn-nonblocking \
+ ddd-02-conn-nonblocking-threads \
+ ddd-03-fd-blocking \
+ ddd-04-fd-nonblocking \
+ ddd-05-mem-nonblocking \
+ ddd-06-mem-uv
-TESTS_BASE=ddd-01-conn-blocking ddd-02-conn-nonblocking ddd-02-conn-nonblocking-threads \
- ddd-03-fd-blocking ddd-04-fd-nonblocking ddd-05-mem-nonblocking ddd-06-mem-uv
-TESTS=$(foreach x,$(TESTS_BASE),$(x)-tls $(x)-quic)
+TESTS = $(foreach x,$(TESTS_BASE),$(x)-tls $(x)-quic)
-CFLAGS = -I../../../include -O3 -g -Wall
+CFLAGS = -I../../../include -g -Wall -Wsign-compare
LDFLAGS = -L../../..
-LDLIBS = -lcrypto -lssl
+LDLIBS = -lcrypto -lssl
+
+CC_CMD = $(CC) $(CFLAGS) $(LDFLAGS) -o "$@" "$<" $(LDLIBS)
all: $(TESTS)
clean:
rm -f $(TESTS) *.o
-ddd-06-mem-uv-tls: ddd-06-mem-uv.c
- $(CC) $(CFLAGS) $(LDFLAGS) -o "$@" "$<" $(LDLIBS) -luv
-
-ddd-06-mem-uv-quic: ddd-06-mem-uv.c
- $(CC) $(CFLAGS) $(LDFLAGS) -DUSE_QUIC -o "$@" "$<" $(LDLIBS) -luv
+ddd-%-tls: ddd-%.c
+ $(CC_CMD)
ddd-%-quic: ddd-%.c
- $(CC) $(CFLAGS) $(LDFLAGS) -DUSE_QUIC -o "$@" "$<" $(LDLIBS)
+ $(CC_CMD) -DUSE_QUIC
-ddd-%-tls: ddd-%.c
- $(CC) $(CFLAGS) $(LDFLAGS) -o "$@" "$<" $(LDLIBS)
+ddd-%-uv-tls: ddd-%-uv.c
+ $(CC_CMD) -luv
+
+ddd-%-uv-quic: ddd-%-uv.c
+ $(CC_CMD) -luv -DUSE_QUIC
diff --git a/doc/designs/ddd/ddd-01-conn-blocking.c b/doc/designs/ddd/ddd-01-conn-blocking.c
index ab5cbf673d..d2df84d854 100644
--- a/doc/designs/ddd/ddd-01-conn-blocking.c
+++ b/doc/designs/ddd/ddd-01-conn-blocking.c
@@ -141,16 +141,16 @@ int main(int argc, char **argv)
SSL_CTX *ctx = NULL;
BIO *b = NULL;
char buf[2048];
- int l, res = 1;
+ int l, mlen, res = 1;
if (argc < 3) {
fprintf(stderr, "usage: %s host port\n", argv[0]);
goto fail;
}
- snprintf(host_port, sizeof(host_port), "%s:%s\n", argv[1], argv[2]);
- snprintf(msg, sizeof(msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ snprintf(host_port, sizeof(host_port), "%s:%s", argv[1], argv[2]);
+ mlen = snprintf(msg, sizeof(msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
@@ -160,11 +160,12 @@ int main(int argc, char **argv)
b = new_conn(ctx, host_port);
if (b == NULL) {
- fprintf(stderr, "could not create conn\n");
+ fprintf(stderr, "could not create connection\n");
goto fail;
}
- if (tx(b, msg, sizeof(msg)) < sizeof(msg)) {
+ l = tx(b, msg, mlen);
+ if (l < mlen) {
fprintf(stderr, "tx error\n");
goto fail;
}
diff --git a/doc/designs/ddd/ddd-02-conn-nonblocking-threads.c b/doc/designs/ddd/ddd-02-conn-nonblocking-threads.c
index 892c36f1ce..dd981c3e66 100644
--- a/doc/designs/ddd/ddd-02-conn-nonblocking-threads.c
+++ b/doc/designs/ddd/ddd-02-conn-nonblocking-threads.c
@@ -2,7 +2,7 @@
#include <openssl/ssl.h>
/*
- * Demo 2: Client — Managed Connection — Asynchronous Nonblocking
+ * Demo 2: Client — Managed Connection — Nonblocking
* ==============================================================
*
* This is an example of (part of) an application which uses libssl in an
@@ -260,7 +260,7 @@ int main(int argc, char **argv)
static char tx_msg[384], host_port[300];
const char *tx_p = tx_msg;
char rx_buf[2048];
- int res = 1, l, tx_len = sizeof(tx_msg)-1;
+ int res = 1, l, tx_len;
int timeout = 2000 /* ms */;
APP_CONN *conn = NULL;
SSL_CTX *ctx = NULL;
@@ -271,8 +271,8 @@ int main(int argc, char **argv)
}
snprintf(host_port, sizeof(host_port), "%s:%s", argv[1], argv[2]);
- snprintf(tx_msg, sizeof(tx_msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ tx_len = snprintf(tx_msg, sizeof(tx_msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
diff --git a/doc/designs/ddd/ddd-02-conn-nonblocking.c b/doc/designs/ddd/ddd-02-conn-nonblocking.c
index 9b45781fdf..a92892f6e1 100644
--- a/doc/designs/ddd/ddd-02-conn-nonblocking.c
+++ b/doc/designs/ddd/ddd-02-conn-nonblocking.c
@@ -2,7 +2,7 @@
#include <openssl/ssl.h>
/*
- * Demo 2: Client — Managed Connection — Asynchronous Nonblocking
+ * Demo 2: Client — Managed Connection — Nonblocking
* ==============================================================
*
* This is an example of (part of) an application which uses libssl in an
@@ -316,7 +316,7 @@ int main(int argc, char **argv)
static char tx_msg[384], host_port[300];
const char *tx_p = tx_msg;
char rx_buf[2048];
- int res = 1, l, tx_len = sizeof(tx_msg)-1;
+ int res = 1, l, tx_len;
#ifdef USE_QUIC
struct timeval timeout;
#else
@@ -335,8 +335,8 @@ int main(int argc, char **argv)
}
snprintf(host_port, sizeof(host_port), "%s:%s", argv[1], argv[2]);
- snprintf(tx_msg, sizeof(tx_msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ tx_len = snprintf(tx_msg, sizeof(tx_msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
diff --git a/doc/designs/ddd/ddd-03-fd-blocking.c b/doc/designs/ddd/ddd-03-fd-blocking.c
index 1388839cec..c545714c3c 100644
--- a/doc/designs/ddd/ddd-03-fd-blocking.c
+++ b/doc/designs/ddd/ddd-03-fd-blocking.c
@@ -136,7 +136,7 @@ void teardown_ctx(SSL_CTX *ctx)
int main(int argc, char **argv)
{
- int rc, fd = -1, l, res = 1;
+ int rc, fd = -1, l, mlen, res = 1;
static char msg[300];
struct addrinfo hints = {0}, *result = NULL;
SSL *ssl = NULL;
@@ -148,8 +148,8 @@ int main(int argc, char **argv)
goto fail;
}
- snprintf(msg, sizeof(msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ mlen = snprintf(msg, sizeof(msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
@@ -190,7 +190,8 @@ int main(int argc, char **argv)
goto fail;
}
- if (tx(ssl, msg, sizeof(msg)-1) < sizeof(msg)-1) {
+ l = tx(ssl, msg, mlen);
+ if (l < mlen) {
fprintf(stderr, "tx error\n");
goto fail;
}
diff --git a/doc/designs/ddd/ddd-04-fd-nonblocking.c b/doc/designs/ddd/ddd-04-fd-nonblocking.c
index 009ba571fe..d39827adf6 100644
--- a/doc/designs/ddd/ddd-04-fd-nonblocking.c
+++ b/doc/designs/ddd/ddd-04-fd-nonblocking.c
@@ -8,7 +8,7 @@
* This is an example of (part of) an application which uses libssl in an
* asynchronous, nonblocking fashion. The client is responsible for creating the
* socket and passing it to libssl. The functions show all interactions with
- * libssl the application makes, and wouldn hypothetically be linked into a
+ * libssl the application makes, and would hypothetically be linked into a
* larger application.
*/
typedef struct app_conn_st {
@@ -297,7 +297,7 @@ int main(int argc, char **argv)
static char tx_msg[300];
const char *tx_p = tx_msg;
char rx_buf[2048];
- int l, tx_len = sizeof(tx_msg)-1;
+ int l, tx_len;
#ifdef USE_QUIC
struct timeval timeout;
#else
@@ -316,8 +316,8 @@ int main(int argc, char **argv)
goto fail;
}
- snprintf(tx_msg, sizeof(tx_msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ tx_len = snprintf(tx_msg, sizeof(tx_msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
diff --git a/doc/designs/ddd/ddd-05-mem-nonblocking.c b/doc/designs/ddd/ddd-05-mem-nonblocking.c
index abf6c3c496..8e30016bb1 100644
--- a/doc/designs/ddd/ddd-05-mem-nonblocking.c
+++ b/doc/designs/ddd/ddd-05-mem-nonblocking.c
@@ -356,7 +356,7 @@ int main(int argc, char **argv)
static char tx_msg[300];
const char *tx_p = tx_msg;
char rx_buf[2048];
- int l, tx_len = sizeof(tx_msg)-1;
+ int l, tx_len;
int timeout = 2000 /* ms */;
APP_CONN *conn = NULL;
struct addrinfo hints = {0}, *result = NULL;
@@ -367,9 +367,9 @@ int main(int argc, char **argv)
goto fail;
}
- snprintf(tx_msg, sizeof(tx_msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n",
- argv[1]);
+ tx_len = snprintf(tx_msg, sizeof(tx_msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n",
+ argv[1]);
ctx = create_ssl_ctx();
if (ctx == NULL) {
diff --git a/doc/designs/ddd/ddd-06-mem-uv.c b/doc/designs/ddd/ddd-06-mem-uv.c
index 20699501c8..b4e2164e91 100644
--- a/doc/designs/ddd/ddd-06-mem-uv.c
+++ b/doc/designs/ddd/ddd-06-mem-uv.c
@@ -294,7 +294,7 @@ static void net_read_alloc(uv_handle_t *handle,
static void on_rx_push(APP_CONN *conn)
{
int srd, rc;
- size_t buf_len = 4096;
+ int buf_len = 4096;
do {
if (!conn->app_read_cb)
@@ -696,6 +696,7 @@ static void post_write_get(APP_CONN *conn, int status, void *arg)
}
char tx_msg[300];
+int mlen;
static void post_connect(APP_CONN *conn, int status, void *arg)
{
@@ -707,8 +708,8 @@ static void post_connect(APP_CONN *conn, int status, void *arg)
return;
}
- wr = app_write(conn, tx_msg, sizeof(tx_msg)-1, post_write_get, NULL);
- if (wr < sizeof(tx_msg)-1) {
+ wr = app_write(conn, tx_msg, mlen, post_write_get, NULL);
+ if (wr < mlen) {
fprintf(stderr, "error writing request");
return;
}
@@ -726,8 +727,8 @@ int main(int argc, char **argv)
goto fail;
}
- snprintf(tx_msg, sizeof(tx_msg),
- "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
+ mlen = snprintf(tx_msg, sizeof(tx_msg),
+ "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[1]);
ctx = create_ssl_ctx();
if (!ctx)