Make LHASH_OF() and STACK_OF() use opaque structs

This removes internals of these two special snowflakes and will allow
further simplifications. Unfortunately, there are some pieces of
software that actually use LHASH_OF() (looking at you, pound, Ruby, and
openssl(1)), so we get to keep exposing this garbage, at least for now.

Expose lh_error() as a symbol to replace a macro reaching into _LHASH.
lh_down_load() is no longer available. _LHASH and _STACK are now opaque,
LHASH_NODE becomes internal-only.

from jsing

3 files changed, 119 insertions, 45 deletions

diff --git a/src/lib/libcrypto/lhash/lhash.c b/src/lib/libcrypto/lhash/lhash.c
index 81660419c7..cd69f6fec1 100644
--- a/src/lib/libcrypto/lhash/lhash.c
+++ b/src/lib/libcrypto/lhash/lhash.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: lhash.c,v 1.21 2024/01/24 14:02:52 jsing Exp $ */
+/* $OpenBSD: lhash.c,v 1.22 2024/03/02 11:11:11 tb Exp $ */
 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
@@ -103,6 +103,8 @@
 #include <openssl/crypto.h>
 #include <openssl/lhash.h>
 
+#include "lhash_local.h"
+
 #undef MIN_NODES
 #define MIN_NODES       16
 #define UP_LOAD         (2*LH_LOAD_MULT) /* load times 256  (default 2) */
@@ -157,6 +159,13 @@ lh_free(_LHASH *lh)
 }
 LCRYPTO_ALIAS(lh_free);
 
+int
+lh_error(_LHASH *lh)
+{
+        return lh->error;
+}
+LCRYPTO_ALIAS(lh_error);
+
 void *
 lh_insert(_LHASH *lh, void *data)
 {
diff --git a/src/lib/libcrypto/lhash/lhash.h b/src/lib/libcrypto/lhash/lhash.h
index 8db0174a61..86d05544a0 100644
--- a/src/lib/libcrypto/lhash/lhash.h
+++ b/src/lib/libcrypto/lhash/lhash.h
@@ -1,4 +1,4 @@
-/* $OpenBSD: lhash.h,v 1.13 2024/03/02 11:04:51 tb Exp $ */
+/* $OpenBSD: lhash.h,v 1.14 2024/03/02 11:11:11 tb Exp $ */
 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
@@ -75,14 +75,6 @@
 extern "C" {
 #endif
 
-typedef struct lhash_node_st {
-        void *data;
-        struct lhash_node_st *next;
-#ifndef OPENSSL_NO_HASH_COMP
-        unsigned long hash;
-#endif
-} LHASH_NODE;
-
 typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *);
 typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *);
 typedef void (*LHASH_DOALL_FN_TYPE)(void *);
@@ -133,44 +125,13 @@ typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *);
                 name##_doall_arg(a, b); }
 #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
 
-typedef struct lhash_st {
-        LHASH_NODE **b;
-        LHASH_COMP_FN_TYPE comp;
-        LHASH_HASH_FN_TYPE hash;
-        unsigned int num_nodes;
-        unsigned int num_alloc_nodes;
-        unsigned int p;
-        unsigned int pmax;
-        unsigned long up_load; /* load times 256 */
-        unsigned long down_load; /* load times 256 */
-        unsigned long num_items;
-
-        unsigned long num_expands;
-        unsigned long num_expand_reallocs;
-        unsigned long num_contracts;
-        unsigned long num_contract_reallocs;
-        unsigned long num_hash_calls;
-        unsigned long num_comp_calls;
-        unsigned long num_insert;
-        unsigned long num_replace;
-        unsigned long num_delete;
-        unsigned long num_no_delete;
-        unsigned long num_retrieve;
-        unsigned long num_retrieve_miss;
-        unsigned long num_hash_comps;
-
-        int error;
-} _LHASH;       /* Do not use _LHASH directly, use LHASH_OF
-                 * and friends */
+typedef struct lhash_st _LHASH;
 
 #define LH_LOAD_MULT    256
 
-/* Indicates a malloc() error in the last call, this is only bad
- * in lh_insert(). */
-#define lh_error(lh)    ((lh)->error)
-
 _LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c);
 void lh_free(_LHASH *lh);
+int lh_error(_LHASH *lh);
 void *lh_insert(_LHASH *lh, void *data);
 void *lh_delete(_LHASH *lh, const void *data);
 void *lh_retrieve(_LHASH *lh, const void *data);
@@ -183,7 +144,7 @@ unsigned long lh_num_items(const _LHASH *lh);
 
 #define LHASH_OF(type) struct lhash_st_##type
 
-#define DECLARE_LHASH_OF(type) LHASH_OF(type) { int dummy; }
+#define DECLARE_LHASH_OF(type) LHASH_OF(type)
 
 #define CHECKED_LHASH_OF(type,lh) \
   ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh))
@@ -206,7 +167,6 @@ unsigned long lh_num_items(const _LHASH *lh);
 #define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \
   lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg))
 #define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh))
-#define LHM_lh_down_load(type, lh) (CHECKED_LHASH_OF(type, lh)->down_load)
 #define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh))
 
 DECLARE_LHASH_OF(OPENSSL_STRING);
diff --git a/src/lib/libcrypto/lhash/lhash_local.h b/src/lib/libcrypto/lhash/lhash_local.h
new file mode 100644
index 0000000000..5466e554e7
--- /dev/null
+++ b/src/lib/libcrypto/lhash/lhash_local.h
@@ -0,0 +1,105 @@
+/* $OpenBSD: lhash_local.h,v 1.1 2024/03/02 11:11:11 tb Exp $ */
+/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
+ * All rights reserved.
+ *
+ * This package is an SSL implementation written
+ * by Eric Young (eay@cryptsoft.com).
+ * The implementation was written so as to conform with Netscapes SSL.
+ *
+ * This library is free for commercial and non-commercial use as long as
+ * the following conditions are aheared to.  The following conditions
+ * apply to all code found in this distribution, be it the RC4, RSA,
+ * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
+ * included with this distribution is covered by the same copyright terms
+ * except that the holder is Tim Hudson (tjh@cryptsoft.com).
+ *
+ * Copyright remains Eric Young's, and as such any Copyright notices in
+ * the code are not to be removed.
+ * If this package is used in a product, Eric Young should be given attribution
+ * as the author of the parts of the library used.
+ * This can be in the form of a textual message at program startup or
+ * in documentation (online or textual) provided with the package.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *    "This product includes cryptographic software written by
+ *     Eric Young (eay@cryptsoft.com)"
+ *    The word 'cryptographic' can be left out if the rouines from the library
+ *    being used are not cryptographic related :-).
+ * 4. If you include any Windows specific code (or a derivative thereof) from
+ *    the apps directory (application code) you must include an acknowledgement:
+ *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * The licence and distribution terms for any publically available version or
+ * derivative of this code cannot be changed.  i.e. this code cannot simply be
+ * copied and put under another distribution licence
+ * [including the GNU Public Licence.]
+ */
+
+/* Header for dynamic hash table routines
+ * Author - Eric Young
+ */
+
+#include <openssl/opensslconf.h>
+
+#ifndef HEADER_LHASH_LOCAL_H
+#define HEADER_LHASH_LOCAL_H
+
+typedef struct lhash_node_st {
+        void *data;
+        struct lhash_node_st *next;
+#ifndef OPENSSL_NO_HASH_COMP
+        unsigned long hash;
+#endif
+} LHASH_NODE;
+
+struct lhash_st {
+        LHASH_NODE **b;
+        LHASH_COMP_FN_TYPE comp;
+        LHASH_HASH_FN_TYPE hash;
+        unsigned int num_nodes;
+        unsigned int num_alloc_nodes;
+        unsigned int p;
+        unsigned int pmax;
+        unsigned long up_load; /* load times 256 */
+        unsigned long down_load; /* load times 256 */
+        unsigned long num_items;
+
+        unsigned long num_expands;
+        unsigned long num_expand_reallocs;
+        unsigned long num_contracts;
+        unsigned long num_contract_reallocs;
+        unsigned long num_hash_calls;
+        unsigned long num_comp_calls;
+        unsigned long num_insert;
+        unsigned long num_replace;
+        unsigned long num_delete;
+        unsigned long num_no_delete;
+        unsigned long num_retrieve;
+        unsigned long num_retrieve_miss;
+        unsigned long num_hash_comps;
+
+        int error;
+} /* _LHASH */;
+
+#endif