add callbacks for debug messages
authorFelix Fietkau <nbd@nbd.name>
Sun, 7 Apr 2024 14:15:34 +0000 (16:15 +0200)
committerFelix Fietkau <nbd@nbd.name>
Sun, 7 Apr 2024 16:46:09 +0000 (18:46 +0200)
This is useful for tracking down connection issues

Signed-off-by: Felix Fietkau <nbd@nbd.name>
ustream-internal.h
ustream-mbedtls.c
ustream-mbedtls.h
ustream-openssl.c
ustream-openssl.h
ustream-ssl.c
ustream-ssl.h

index e80abf827515fde4d2c7dea0605a0ddae85e5b6e..f8f28e1ab9a3f0e2bd707e47c93cb7100faad1fc 100644 (file)
@@ -40,6 +40,7 @@ int __ustream_ssl_set_crt_file(struct ustream_ssl_ctx *ctx, const char *file);
 int __ustream_ssl_set_key_file(struct ustream_ssl_ctx *ctx, const char *file);
 int __ustream_ssl_set_ciphers(struct ustream_ssl_ctx *ctx, const char *ciphers);
 int __ustream_ssl_set_require_validation(struct ustream_ssl_ctx *ctx, bool require);
+void __ustream_ssl_set_debug(struct ustream_ssl_ctx *ctx, int level, ustream_ssl_debug_cb cb, void *cb_priv);
 void __ustream_ssl_context_free(struct ustream_ssl_ctx *ctx);
 enum ssl_conn_status __ustream_ssl_connect(struct ustream_ssl *us);
 int __ustream_ssl_read(struct ustream_ssl *us, char *buf, int len);
index 13785ce6e587dd1be9d400ad7ab37bfc4299cf41..b733ea1d79613adb07e86555d5e1e2cc4ef44e75 100644 (file)
 #include "ustream-ssl.h"
 #include "ustream-internal.h"
 #include <psa/crypto.h>
+#include <mbedtls/debug.h>
+
+static void debug_cb(void *ctx_p, int level,
+                     const char *file, int line,
+                     const char *str)
+{
+       struct ustream_ssl_ctx *ctx = ctx_p;
+       const char *fstr;
+       char buf[512];
+       int len;
+
+       if (!ctx->debug_cb)
+               return;
+
+       while ((fstr = strstr(file + 1, "library/")) != NULL)
+               file = fstr;
+
+       len = snprintf(buf, sizeof(buf), "%s:%04d: %s", file, line, str);
+       if (len >= (int)sizeof(buf))
+               len = (int)sizeof(buf) - 1;
+       if (buf[len - 1] == '\n')
+               buf[len - 1] = 0;
+       ctx->debug_cb(ctx->debug_cb_priv, level, buf);
+}
 
 static int s_ustream_read(void *ctx, unsigned char *buf, size_t len)
 {
@@ -433,6 +457,15 @@ __hidden int __ustream_ssl_read(struct ustream_ssl *us, char *buf, int len)
        return ret;
 }
 
+__hidden void __ustream_ssl_set_debug(struct ustream_ssl_ctx *ctx, int level,
+                                     ustream_ssl_debug_cb cb, void *cb_priv)
+{
+       ctx->debug_cb = cb;
+       ctx->debug_cb_priv = cb_priv;
+       mbedtls_ssl_conf_dbg(&ctx->conf, debug_cb, ctx);
+       mbedtls_debug_set_threshold(level);
+}
+
 __hidden void *__ustream_ssl_session_new(struct ustream_ssl_ctx *ctx)
 {
        mbedtls_ssl_context *ssl;
index 7e7c699398e78db1a07e4671115206903a27a7ff..ff907f6d5bc1708d618c5384f0cd094406f68ccc 100644 (file)
@@ -39,6 +39,8 @@ struct ustream_ssl_ctx {
 #if defined(MBEDTLS_SSL_CACHE_C)
        mbedtls_ssl_cache_context cache;
 #endif
+       ustream_ssl_debug_cb debug_cb;
+       void *debug_cb_priv;
        bool server;
        int *ciphersuites;
 };
index 7a991e9d54d1d6e3c572dd9e5b54f4b00442d302..3d576be1cf9397adf812bc03f1c87fa4096f9678 100644 (file)
 __hidden struct ustream_ssl_ctx *
 __ustream_ssl_context_new(bool server)
 {
+       struct ustream_ssl_ctx *ctx;
        const void *m;
        SSL_CTX *c;
 
@@ -134,6 +135,9 @@ __ustream_ssl_context_new(bool server)
        if (!c)
                return NULL;
 
+       ctx = calloc(1, sizeof(*ctx));
+       ctx->ssl = c;
+
 #if defined(HAVE_WOLFSSL)
        if (server)
                SSL_CTX_set_verify(c, SSL_VERIFY_NONE, NULL);
@@ -169,14 +173,14 @@ __ustream_ssl_context_new(bool server)
        }
        SSL_CTX_set_quiet_shutdown(c, 1);
 
-       return (void *) c;
+       return ctx;
 }
 
 __hidden int __ustream_ssl_add_ca_crt_file(struct ustream_ssl_ctx *ctx, const char *file)
 {
        int ret;
 
-       ret = SSL_CTX_load_verify_locations((void *) ctx, file, NULL);
+       ret = SSL_CTX_load_verify_locations(ctx->ssl, file, NULL);
        if (ret < 1)
                return -1;
 
@@ -187,9 +191,9 @@ __hidden int __ustream_ssl_set_crt_file(struct ustream_ssl_ctx *ctx, const char
 {
        int ret;
 
-       ret = SSL_CTX_use_certificate_chain_file((void *) ctx, file);
+       ret = SSL_CTX_use_certificate_chain_file(ctx->ssl, file);
        if (ret < 1)
-               ret = SSL_CTX_use_certificate_file((void *) ctx, file, SSL_FILETYPE_ASN1);
+               ret = SSL_CTX_use_certificate_file(ctx->ssl, file, SSL_FILETYPE_ASN1);
 
        if (ret < 1)
                return -1;
@@ -201,9 +205,9 @@ __hidden int __ustream_ssl_set_key_file(struct ustream_ssl_ctx *ctx, const char
 {
        int ret;
 
-       ret = SSL_CTX_use_PrivateKey_file((void *) ctx, file, SSL_FILETYPE_PEM);
+       ret = SSL_CTX_use_PrivateKey_file(ctx->ssl, file, SSL_FILETYPE_PEM);
        if (ret < 1)
-               ret = SSL_CTX_use_PrivateKey_file((void *) ctx, file, SSL_FILETYPE_ASN1);
+               ret = SSL_CTX_use_PrivateKey_file(ctx->ssl, file, SSL_FILETYPE_ASN1);
 
        if (ret < 1)
                return -1;
@@ -213,7 +217,7 @@ __hidden int __ustream_ssl_set_key_file(struct ustream_ssl_ctx *ctx, const char
 
 __hidden int __ustream_ssl_set_ciphers(struct ustream_ssl_ctx *ctx, const char *ciphers)
 {
-       int ret = SSL_CTX_set_cipher_list((void *) ctx, ciphers);
+       int ret = SSL_CTX_set_cipher_list(ctx->ssl, ciphers);
 
        if (ret == 0)
                return -1;
@@ -228,14 +232,17 @@ __hidden int __ustream_ssl_set_require_validation(struct ustream_ssl_ctx *ctx, b
        if (!require)
                mode = SSL_VERIFY_NONE;
 
-       SSL_CTX_set_verify((void *) ctx, mode, NULL);
+       SSL_CTX_set_verify(ctx->ssl, mode, NULL);
 
        return 0;
 }
 
 __hidden void __ustream_ssl_context_free(struct ustream_ssl_ctx *ctx)
 {
-       SSL_CTX_free((void *) ctx);
+       SSL_CTX_free(ctx->ssl);
+       if (ctx->debug_bio)
+               BIO_free(ctx->debug_bio);
+       free(ctx);
 }
 
 void __ustream_ssl_session_free(void *ssl)
@@ -420,3 +427,61 @@ __hidden int __ustream_ssl_read(struct ustream_ssl *us, char *buf, int len)
 
        return ret;
 }
+
+#ifndef WOLFSSL_SSL_H
+static long
+debug_cb(BIO *bio, int cmd, const char *argp, size_t len, int argi, long argl,
+        int ret, size_t *processed)
+{
+       struct ustream_ssl_ctx *ctx = (void *)BIO_get_callback_arg(bio);
+       char buf[256];
+       char *str, *sep;
+       ssize_t cur_len;
+
+       if (cmd != (BIO_CB_WRITE|BIO_CB_RETURN))
+           goto out;
+
+       while (1) {
+               cur_len = BIO_get_mem_data(bio, (void *)&str);
+               if (!cur_len)
+                       break;
+
+               sep = memchr(str, '\n', cur_len);
+               if (!sep)
+                       break;
+
+               cur_len = sep + 1 - str;
+               if (cur_len >= (ssize_t)sizeof(buf))
+                       cur_len = sizeof(buf) - 1;
+
+               cur_len = BIO_read(bio, buf, cur_len);
+               if (cur_len <= 1)
+                       break;
+
+               cur_len--;
+               buf[cur_len] = 0;
+               if (ctx->debug_cb)
+                       ctx->debug_cb(ctx->debug_cb_priv, 1, buf);
+       }
+
+out:
+       return ret;
+}
+#endif
+
+__hidden void __ustream_ssl_set_debug(struct ustream_ssl_ctx *ctx, int level,
+                                     ustream_ssl_debug_cb cb, void *cb_priv)
+{
+#ifndef WOLFSSL_SSL_H
+       if (!ctx->debug_bio)
+               ctx->debug_bio = BIO_new(BIO_s_mem());
+
+       ctx->debug_cb = cb;
+       ctx->debug_cb_priv = cb_priv;
+       SSL_CTX_set_msg_callback(ctx->ssl, SSL_trace);
+       SSL_CTX_set_msg_callback_arg(ctx->ssl, ctx->debug_bio);
+
+       BIO_set_callback_ex(ctx->debug_bio, debug_cb);
+       BIO_set_callback_arg(ctx->debug_bio, (void *)ctx);
+#endif
+}
index 90acc864ddfac72f37a3d2eb84edadf2e0b49193..f547aa663f98f6f93602d47b12ede05f0cc790a6 100644 (file)
 
 #include <stdbool.h>
 
+struct ustream_ssl_ctx {
+       SSL_CTX *ssl;
+       BIO *debug_bio;
+       ustream_ssl_debug_cb debug_cb;
+       void *debug_cb_priv;
+};
+
 void __ustream_ssl_session_free(void *ssl);
 
 struct bio_ctx {
@@ -36,9 +43,9 @@ struct bio_ctx {
        struct ustream *stream;
 };
 
-static inline void *__ustream_ssl_session_new(void *ctx)
+static inline void *__ustream_ssl_session_new(struct ustream_ssl_ctx *ctx)
 {
-       return SSL_new(ctx);
+       return SSL_new(ctx->ssl);
 }
 
 static inline char *__ustream_ssl_strerror(int error, char *buffer, int len)
index cd69f9e97449435ee407f81b36ae49930cbef5fc..c4e79710998e0caeaa2b0af553809f09cf84b10b 100644 (file)
@@ -230,6 +230,7 @@ const struct ustream_ssl_ops ustream_ssl_ops = {
        .context_add_ca_crt_file = __ustream_ssl_add_ca_crt_file,
        .context_set_ciphers = __ustream_ssl_set_ciphers,
        .context_set_require_validation = __ustream_ssl_set_require_validation,
+       .context_set_debug = __ustream_ssl_set_debug,
        .context_free = __ustream_ssl_context_free,
        .init = _ustream_ssl_init,
        .set_peer_cn = _ustream_ssl_set_peer_cn,
index 87c0ae6da59564d03acbb030335a8a6326c58616..b1115c6451a8e1a6e5f6dcc958027d561786f9dc 100644 (file)
@@ -47,8 +47,9 @@ struct ustream_ssl {
 
 struct ustream_ssl_ctx;
 
-struct ustream_ssl_ops {
+typedef void (*ustream_ssl_debug_cb)(void *priv, int level, const char *msg);
 
+struct ustream_ssl_ops {
        struct ustream_ssl_ctx *(*context_new)(bool server);
        int (*context_set_crt_file)(struct ustream_ssl_ctx *ctx, const char *file);
        int (*context_set_key_file)(struct ustream_ssl_ctx *ctx, const char *file);
@@ -59,6 +60,7 @@ struct ustream_ssl_ops {
        int (*set_peer_cn)(struct ustream_ssl *conn, const char *name);
 
        int (*context_set_ciphers)(struct ustream_ssl_ctx *ctx, const char *ciphers);
+       void (*context_set_debug)(struct ustream_ssl_ctx *ctx, int level, ustream_ssl_debug_cb cb, void *cb_priv);
        int (*context_set_require_validation)(struct ustream_ssl_ctx *ctx, bool require);
 };
 
@@ -69,6 +71,7 @@ extern const struct ustream_ssl_ops ustream_ssl_ops;
 #define ustream_ssl_context_set_key_file               ustream_ssl_ops.context_set_key_file
 #define ustream_ssl_context_add_ca_crt_file            ustream_ssl_ops.context_add_ca_crt_file
 #define ustream_ssl_context_set_ciphers                        ustream_ssl_ops.context_set_ciphers
+#define ustream_ssl_context_set_debug                  ustream_ssl_ops.context_set_debug
 #define ustream_ssl_context_set_require_validation     ustream_ssl_ops.context_set_require_validation
 #define ustream_ssl_context_free                       ustream_ssl_ops.context_free
 #define ustream_ssl_init                               ustream_ssl_ops.init