Add OpenSSL compat: BIO_get_new_index, i2d_PUBKEY_bio, OpenSSL_version by julek-wolfssl · Pull Request #11020 · wolfSSL/wolfssl

julek-wolfssl · 2026-07-30T18:00:11Z

Description

As part of the continuous integration of OpenSSL to wolfSSL, this adds a few missing functions needed for OpenSSL-compat APIs: BIO_get_new_index() (unique custom BIO type IDs, 128–255), i2d_PUBKEY_bio() (write public-key DER to a BIO), and OpenSSL_version(type) handling for the six standard OPENSSL_* selector constants (plus unknown → version string). Headers/macros updated under OPENSSL_EXTRA / !NO_BIO as appropriate.

Originally authored by @Roy-Carter in #10294, which was closed. Re-opening from julek-wolfssl with the same branch and follow-up fixes applied.

Testing

Ran ./tests/unit.test with -~BIO_get_new_index, -~OpenSSL_version, and -~i2d_PUBKEY_bio (substring filters). All passed.

Checklist

added tests
updated/added doxygen
updated appropriate READMEs
Updated manual and documentation

wolfSSL_OpenSSL_version() was declared with either an int or a void parameter list depending on OPENSSL_VERSION_NUMBER. That macro does not evaluate the same way in the library and in the application: with OPENSSL_COEXIST the library additionally pulls in the real OpenSSL headers and gets their version number, while an application that turns coexist off gets wolfSSL's default. The two builds then disagreed on the argument list and the selector read garbage, so OpenSSL_version() always hit the default case. Give the function a single unconditional signature. Also match the test guards for wolfSSL_i2d_PUBKEY_bio and wolfSSL_OpenSSL_version to the guards on their implementations.

The Linux kernel build compiles with -Werror=date-time, so OPENSSL_BUILT_ON broke libwolfssl.ko.

Copilot

Pull request overview

This PR extends wolfSSL’s OpenSSL-compat layer by adding missing APIs used by OpenSSL-compatible applications: BIO_get_new_index(), i2d_PUBKEY_bio(), and fuller OpenSSL_version(type) selector handling.

Changes:

Add wolfSSL_BIO_get_new_index() plus BIO_TYPE_START mapping for allocating custom BIO method type IDs.
Add wolfSSL_i2d_PUBKEY_bio() to write DER-encoded public keys to a BIO, plus unit test coverage.
Standardize wolfSSL_OpenSSL_version(int type) and implement selector-based strings for OPENSSL_* constants, with tests.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
wolfssl/ssl.h	Adds BIO type range macros, declares `wolfSSL_BIO_get_new_index`, adds `wolfSSL_i2d_PUBKEY_bio`, and standardizes `wolfSSL_OpenSSL_version(int)`.
wolfssl/openssl/ssl.h	Maps `i2d_PUBKEY_bio` and simplifies `OpenSSL_version(x)` mapping to always pass the selector.
wolfssl/openssl/opensslv.h	Defines `OPENSSL_*` selector constants (0–5) when missing.
wolfssl/openssl/bio.h	Exposes `BIO_TYPE_START` and maps `BIO_get_new_index` to wolfSSL.
wolfcrypt/src/evp_pk.c	Implements `wolfSSL_i2d_PUBKEY_bio()` for writing DER public keys to a BIO.
src/ssl.c	Implements selector-based `wolfSSL_OpenSSL_version(int type)` and avoids signature dependence on `OPENSSL_VERSION_NUMBER`.
src/bio.c	Implements `wolfSSL_BIO_get_new_index()` using a static counter (needs thread-safety fix per review comment).
tests/api/test_ossl_bio.h	Adds declaration and registration for the new BIO index test.
tests/api/test_ossl_bio.c	Adds `BIO_get_new_index()` API test for uniqueness and range.
tests/api.c	Adds `i2d_PUBKEY_bio` round-trip tests and expands `OpenSSL_version(type)` selector tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2026-07-30T18:09:10Z

MemBrowse Memory Report

gcc-arm-cortex-m0plus

FLASH: .text +48 B (+0.1%, 64,255 B / 262,144 B, total: 25% used)

gcc-arm-cortex-m3

FLASH: .text +332 B (+0.3%, 122,943 B / 262,144 B, total: 47% used)

gcc-arm-cortex-m4

FLASH: .text +256 B (+0.1%, 201,109 B / 262,144 B, total: 77% used)

gcc-arm-cortex-m4-baremetal

FLASH: .text +64 B (+0.1%, 66,891 B / 262,144 B, total: 26% used)

gcc-arm-cortex-m4-crypto-only

FLASH: .text +128 B (+0.1%, 175,120 B / 262,144 B, total: 67% used)

gcc-arm-cortex-m4-dtls13

FLASH: .text +832 B (+0.5%, 181,924 B / 1,048,576 B, total: 17% used)

gcc-arm-cortex-m4-min-ecc

FLASH: .text +64 B (+0.1%, 61,805 B / 262,144 B, total: 24% used)

gcc-arm-cortex-m4-openssl-compat

FLASH: .rodata +184 B, .text +1,600 B (+0.2%, 773,132 B / 1,048,576 B, total: 74% used)
RAM: .data +8 B (+0.0%, 136,944 B / 262,144 B, total: 52% used)

gcc-arm-cortex-m4-pkcs7

FLASH: .text +64 B (+0.0%, 213,908 B / 262,144 B, total: 82% used)

gcc-arm-cortex-m4-pq

FLASH: .text +1,088 B (+0.4%, 281,088 B / 1,048,576 B, total: 27% used)

gcc-arm-cortex-m4-rsa-only

FLASH: .text +1,024 B (+0.3%, 327,192 B / 1,048,576 B, total: 31% used)

gcc-arm-cortex-m4-sp-math

FLASH: .text +64 B (+0.1%, 61,805 B / 262,144 B, total: 24% used)

gcc-arm-cortex-m4-tls12

FLASH: .text +384 B (+0.3%, 123,739 B / 262,144 B, total: 47% used)

gcc-arm-cortex-m4-tls13

FLASH: .text +576 B (+0.2%, 237,255 B / 262,144 B, total: 91% used)

gcc-arm-cortex-m7

FLASH: .text +256 B (+0.1%, 201,109 B / 262,144 B, total: 77% used)

gcc-arm-cortex-m7-pq

FLASH: .text +1,088 B (+0.4%, 281,664 B / 1,048,576 B, total: 27% used)

gcc-arm-cortex-m7-tls13

FLASH: .text +576 B (+0.2%, 237,319 B / 262,144 B, total: 91% used)

linuxkm-pie

Data: __patchable_function_entries +184 B (+0.7%, 26,440 B)

linuxkm-standard

Data: __patchable_function_entries +240 B (+0.5%, 49,240 B)
No memory changes detected for:
stm32-sim-stm32h753

julek-wolfssl · 2026-07-31T08:44:00Z

retest this please

dgarske · 2026-08-05T01:02:56Z

+            return "compiler: information not available";
+        case OPENSSL_BUILT_ON:
+        /* Kernel module builds compile with -Werror=date-time. */
+#if defined(HAVE_REPRODUCIBLE_BUILD) || defined(WOLFSSL_LINUXKM)


This is nice, but perhaps we should have another new gate like WOLFSSL_OPENSSL_BUILT_ON_DATE or a way to disable it beside the reproducible build option?

dgarske · 2026-08-05T01:03:16Z

+        WOLFSSL_MSG("BIO type index space exhausted");
+        return -1;
+    }
+    bio_type_idx++;


This is not thread safe. Should it use the atomic?

dgarske · 2026-08-05T01:03:57Z

+        return WOLFSSL_FAILURE;
+    }
+
+    der = (byte*)XMALLOC((size_t)derSz, NULL, DYNAMIC_TYPE_TMP_BUFFER);


Consider passing bio->heap as the hint since we have it? Don't forgot the free too

dgarske · 2026-08-05T01:05:02Z

+ * @return  WOLFSSL_SUCCESS on success.
+ * @return  WOLFSSL_FAILURE on failure.
+ */
+int wolfSSL_i2d_PUBKEY_bio(WOLFSSL_BIO* bio, WOLFSSL_EVP_PKEY* key)


Should the "key" be const? const WOLFSSL_EVP_PKEY* key

dgarske · 2026-08-05T01:08:30Z

+    idx = bio_type_idx;
+    if (idx > WOLFSSL_BIO_TYPE_MAX) {
+        WOLFSSL_MSG("BIO type index space exhausted");
+        return -1;


Should this be WOLFSSL_FATAL_ERROR?

dgarske · 2026-08-05T01:10:55Z

+    idx3 = BIO_get_new_index();
+
+    ExpectIntGE(idx1, BIO_TYPE_START);
+    ExpectIntLE(idx1, WOLFSSL_BIO_TYPE_MAX);


Should this be BIO_TYPE_MASK? Should we add a helper WOLFSSL_BIO_TYPE_MASK add a BIO_TYPE_MASK compat alias in wolfssl/openssl/bio.h?

- wolfSSL_BIO_get_new_index: claim the index atomically when atomics are available (zero-initialized count), with a plain-increment fallback; return WOLFSSL_FATAL_ERROR on exhaustion. - wolfSSL_i2d_PUBKEY_bio: make key const and use bio->heap for the temp buffer alloc/free. - OpenSSL_version: add WOLFSSL_OPENSSL_NO_BUILD_DATE to drop the build date without the full reproducible-build option. - Add BIO_TYPE_MASK compat alias and use it in the test.

Roy-Carter and others added 9 commits July 30, 2026 15:02

Initial commit to add some more openssl compatibility layer functions

9ad52e9

Refactor : fix some buggy logic + cleaned code

901b75c

Fix: Handle build errors with .deb package + date build time

842f1a7

Fix note regarding unitest handling

42a750d

Refactor - Implement PR fix for better behavior

fce9764

Fix - change test string default case

68393e2

Remove old comment

416e34d

Don't use __DATE__/__TIME__ in kernel module builds

8297038

The Linux kernel build compiles with -Werror=date-time, so OPENSSL_BUILT_ON broke libwolfssl.ko.

Copilot AI review requested due to automatic review settings July 30, 2026 18:00

julek-wolfssl self-assigned this Jul 30, 2026

Copilot started reviewing on behalf of julek-wolfssl July 30, 2026 18:00 View session

julek-wolfssl mentioned this pull request Jul 30, 2026

Add OpenSSL compat: BIO_get_new_index, i2d_PUBKEY_bio, OpenSSL_version #10294

Closed

3 tasks

Copilot AI reviewed Jul 30, 2026

View reviewed changes

Comment thread src/bio.c

julek-wolfssl assigned wolfSSL-Bot and unassigned julek-wolfssl Jul 31, 2026

dgarske requested changes Aug 5, 2026

View reviewed changes

dgarske assigned julek-wolfssl Aug 5, 2026

Navigation Menu

Uh oh!

Add OpenSSL compat: BIO_get_new_index, i2d_PUBKEY_bio, OpenSSL_version - #11020

Add OpenSSL compat: BIO_get_new_index, i2d_PUBKEY_bio, OpenSSL_version#11020
julek-wolfssl wants to merge 10 commits into
wolfSSL:masterfrom
julek-wolfssl:feature/extra_enhancement_to_compatibility_layer

julek-wolfssl commented Jul 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

github-actions Bot commented Jul 30, 2026 •

edited

Loading

Uh oh!

julek-wolfssl commented Jul 31, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

dgarske Aug 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

julek-wolfssl commented Jul 30, 2026

Description

Testing

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

github-actions Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

MemBrowse Memory Report

Uh oh!

julek-wolfssl commented Jul 31, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Jul 30, 2026 •

edited

Loading