From 0bfdc60ca42b278d83b2642fc910b3c8e21a5bbb Mon Sep 17 00:00:00 2001 From: Rene Meusel Date: Wed, 10 Jan 2024 11:12:36 +0100 Subject: [PATCH] Document the erroneous removal of pk_ops.h --- doc/migration_guide.rst | 8 ++++++++ src/lib/pubkey/pk_ops.h | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/doc/migration_guide.rst b/doc/migration_guide.rst index ce742a738da..c2a4c75dfda 100644 --- a/doc/migration_guide.rst +++ b/doc/migration_guide.rst @@ -26,6 +26,14 @@ algorithm headers (such as ``aes.h``) have been removed. Instead you should create objects via the factory methods (in the case of AES, ``BlockCipher::create``) which works in both 2.x and 3.0 +Errata: ``pk_ops.h`` +^^^^^^^^^^^^^^^^^^^^ + +Between Botan 3.0 and 3.2 the public header ``pk_ops.h`` was removed +accidentally. This header is typically required for specialized applications +that interface with dedicated crypto hardware. If you are migrating such an +application, please make sure to use Botan 3.3 or newer. + Build Artifacts --------------- diff --git a/src/lib/pubkey/pk_ops.h b/src/lib/pubkey/pk_ops.h index 8af657ec759..97d9949315a 100644 --- a/src/lib/pubkey/pk_ops.h +++ b/src/lib/pubkey/pk_ops.h @@ -16,6 +16,11 @@ * Unless you're doing something like that, you don't need anything * here. Instead use pubkey.h which wraps these types safely and * provides a stable application-oriented API. +* +* Note: This header was accidentally pulled from the public API between +* Botan 3.0.0 and 3.2.0, and then restored in 3.3.0. If you are +* maintaining an application which used this header in Botan 2.x, +* you should make sure to use Botan 3.3.0 or later when migrating. */ #include