]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
document provider dependency handling
authorMichael Baentsch <57787676+baentsch@users.noreply.github.com>
Mon, 15 Jul 2024 04:54:48 +0000 (06:54 +0200)
committerTomas Mraz <tomas@openssl.org>
Wed, 11 Sep 2024 07:34:05 +0000 (09:34 +0200)
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/24884)

(cherry picked from commit e8498dc6455fc36f70dc3a0ca1ef82b34c088a90)

doc/man7/provider.pod

index a061fc4709d0bb1287d284b29e18abc75fee8dcf..08ac1d02907ff598e06306bcb1230bf87eaee019 100644 (file)
@@ -227,6 +227,18 @@ MODE is only present where applicable.
 Other aliases may exist for example where standards bodies or common practice
 use alternative names or names that OpenSSL has used historically.
 
+=head3 Provider dependencies
+
+Providers may depend for their proper operation on the availability of
+(functionality implemented in) other providers. As there is no mechanism to
+express such dependencies towards the OpenSSL core, provider authors must
+take care that such dependencies are either completely avoided or made visible
+to users, e.g., by documentation and/or defensive programming, e.g.,
+outputting error messages if required external dependencies are not available,
+e.g., when no provider implementing the required functionality has been
+activated. In particular, provider initialization should not depend on other
+providers already having been initialized.
+
 =head1 OPENSSL PROVIDERS
 
 OpenSSL provides a number of its own providers. These are the default, base,