]> git.ipfire.org Git - thirdparty/openssl.git/commit
Clarify/fix encoder/decoder context docs and code
authorViktor Dukhovni <openssl-users@dukhovni.org>
Wed, 3 Dec 2025 04:24:46 +0000 (15:24 +1100)
committerPauli <paul.dale@oracle.com>
Thu, 4 Dec 2025 23:07:51 +0000 (10:07 +1100)
commitbf236e07afbd235d609f057eb50c92d1d2ee5008
tree3305a1ee504801b647dd6875334ee64531db8cf9
parent3720c946f095d4f35f04f61cf6efa8b84e26fc7c
Clarify/fix encoder/decoder context docs and code

In was premature to make OSSL_(EN|DE)CODER_CTX_[sg]et_finalized() be
public interfaces.  Forunately, these have not yet appeared outside the
"master" branch, so we can still retract them.

Also, in the case of decoders, the implementation failed to take into
account that the context was duplicated before it was returned to the
user, and the duplicated copy failed to copy the "finalized" field.

This commit also renames "finalized" to "frozen", because
finalisation is a misleading term in this context, it suggests
resource reclamation during garbage collection or deallocation,
not marking a structure partly immutable.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/29206)
15 files changed:
CHANGES.md
crypto/encode_decode/decoder_lib.c
crypto/encode_decode/decoder_pkey.c
crypto/encode_decode/encoder_lib.c
crypto/encode_decode/encoder_local.h
crypto/encode_decode/encoder_pkey.c
doc/man3/OSSL_DECODER_CTX.pod
doc/man3/OSSL_DECODER_CTX_new_for_pkey.pod
doc/man3/OSSL_ENCODER_CTX.pod
doc/man3/OSSL_ENCODER_CTX_new_for_pkey.pod
include/openssl/decoder.h
include/openssl/encoder.h
test/endecode_test.c
test/evp_extra_test.c
util/libcrypto.num