From 906bced110c156f98e5e4725d7d6de5a8da93089 Mon Sep 17 00:00:00 2001 From: Matt Caswell Date: Thu, 25 Mar 2021 17:02:25 +0000 Subject: Update the algorithm fetching documentation links The documentation on algorithm fetching has moved. There were a lot of references to the old location so we update all of those locations. Reviewed-by: Paul Dale (Merged from https://github.com/openssl/openssl/pull/1487) --- doc/man3/EVP_ASYM_CIPHER_free.pod | 4 ++-- doc/man3/EVP_DigestInit.pod | 4 ++-- doc/man3/EVP_EncryptInit.pod | 2 +- doc/man3/EVP_KDF.pod | 2 +- doc/man3/EVP_KEM_free.pod | 4 ++-- doc/man3/EVP_KEYEXCH_free.pod | 4 ++-- doc/man3/EVP_MAC.pod | 2 +- doc/man3/EVP_RAND.pod | 2 +- doc/man3/EVP_SIGNATURE_free.pod | 4 ++-- doc/man3/OCSP_response_status.pod | 4 ++-- doc/man3/OSSL_CRMF_pbmp_new.pod | 2 +- doc/man3/SRP_Calc_B.pod | 2 +- doc/man3/SRP_create_verifier.pod | 2 +- doc/man3/SSL_CTX_new.pod | 2 +- 14 files changed, 20 insertions(+), 20 deletions(-) (limited to 'doc') diff --git a/doc/man3/EVP_ASYM_CIPHER_free.pod b/doc/man3/EVP_ASYM_CIPHER_free.pod index 2500109e45..dfe67d9993 100644 --- a/doc/man3/EVP_ASYM_CIPHER_free.pod +++ b/doc/man3/EVP_ASYM_CIPHER_free.pod @@ -38,7 +38,7 @@ B from any provider offering it, within the criteria given by the B and in the scope of the given library context B (see L). The algorithm will be one offering functions for performing asymmetric cipher related tasks such as asymmetric encryption and decryption. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_ASYM_CIPHER_free(). @@ -90,7 +90,7 @@ return a constant B array or NULL on error. =head1 SEE ALSO -L, L +L, L =head1 HISTORY diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod index 6299aa3d20..d01414e5e6 100644 --- a/doc/man3/EVP_DigestInit.pod +++ b/doc/man3/EVP_DigestInit.pod @@ -122,7 +122,7 @@ The B type is a structure for digest method implementation. Fetches the digest implementation for the given I from any provider offering it, within the criteria given by the I. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_MD_free(). @@ -677,7 +677,7 @@ L, L, L, L -L +L =head1 HISTORY diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 303e93fe06..b07c102e04 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -191,7 +191,7 @@ The B type is a structure for cipher method implementation. EVP_CIPHER_fetch() fetches the cipher implementation for the given B from any provider offering it, within the criteria given by the B. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_CIPHER_free(). diff --git a/doc/man3/EVP_KDF.pod b/doc/man3/EVP_KDF.pod index c3d0464d2e..08b15f08ab 100644 --- a/doc/man3/EVP_KDF.pod +++ b/doc/man3/EVP_KDF.pod @@ -73,7 +73,7 @@ B is a context type that holds the algorithm inputs. EVP_KDF_fetch() fetches an implementation of a KDF I, given a library context I and a set of I. -See L for further information. +See L for further information. See L for the lists of algorithms supported by the default provider. diff --git a/doc/man3/EVP_KEM_free.pod b/doc/man3/EVP_KEM_free.pod index 0551afcf8d..906f4eebed 100644 --- a/doc/man3/EVP_KEM_free.pod +++ b/doc/man3/EVP_KEM_free.pod @@ -34,7 +34,7 @@ provider offering it, within the criteria given by the B and in the scope of the given library context B (see L). The algorithm will be one offering functions for performing asymmetric kem related tasks such as key encapsulation and decapsulation. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_KEM_free(). @@ -83,7 +83,7 @@ a constant B array or NULL on error. =head1 SEE ALSO -L, L +L, L =head1 HISTORY diff --git a/doc/man3/EVP_KEYEXCH_free.pod b/doc/man3/EVP_KEYEXCH_free.pod index a040e7d604..1257dd2e5c 100644 --- a/doc/man3/EVP_KEYEXCH_free.pod +++ b/doc/man3/EVP_KEYEXCH_free.pod @@ -35,7 +35,7 @@ EVP_KEYEXCH_gettable_ctx_params, EVP_KEYEXCH_settable_ctx_params EVP_KEYEXCH_fetch() fetches the key exchange implementation for the given I from any provider offering it, within the criteria given by the I. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_KEYEXCH_free(). @@ -92,7 +92,7 @@ a constant B array or NULL on error. =head1 SEE ALSO -L, L +L, L =head1 HISTORY diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index a4da280ab4..2a8fb5332e 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -86,7 +86,7 @@ rely on an underlying computation algorithm. EVP_MAC_fetch() fetches an implementation of a MAC I, given a library context I and a set of I. -See L for further information. +See L for further information. See L for the list of algorithms supported by the default provider. diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod index ab0fdbcb48..23906da5ba 100644 --- a/doc/man3/EVP_RAND.pod +++ b/doc/man3/EVP_RAND.pod @@ -97,7 +97,7 @@ B structures are reference counted. EVP_RAND_fetch() fetches an implementation of a RAND I, given a library context I and a set of I. -See L for further information. +See L for further information. The returned value must eventually be freed with L. diff --git a/doc/man3/EVP_SIGNATURE_free.pod b/doc/man3/EVP_SIGNATURE_free.pod index de1b22f387..71f283fdc6 100644 --- a/doc/man3/EVP_SIGNATURE_free.pod +++ b/doc/man3/EVP_SIGNATURE_free.pod @@ -38,7 +38,7 @@ B from any provider offering it, within the criteria given by the B. The algorithm will be one offering functions for performing signature related tasks such as signing and verifying. -See L for further information. +See L for further information. The returned value must eventually be freed with EVP_SIGNATURE_free(). @@ -90,7 +90,7 @@ return a constant B array or NULL on error. =head1 SEE ALSO -L, L +L, L =head1 HISTORY diff --git a/doc/man3/OCSP_response_status.pod b/doc/man3/OCSP_response_status.pod index c97f22c4ed..9113af3836 100644 --- a/doc/man3/OCSP_response_status.pod +++ b/doc/man3/OCSP_response_status.pod @@ -54,7 +54,7 @@ OCSP_RESPID_set_by_key_ex() sets the key of the OCSP_RESPID to be the same as th key in the supplied X509 certificate I for the OCSP responder. The key is stored as a SHA1 hash. To calculate the hash the SHA1 algorithm is fetched using the library ctx I and the property query string I (see -L for further information). +L for further information). OCSP_RESPID_set_by_key() does the same as OCSP_RESPID_set_by_key_ex() except that the default library context is used with an empty property query string. @@ -66,7 +66,7 @@ setting. OCSP_RESPID_match_ex() tests whether the OCSP_RESPID given in I matches with the X509 certificate I based on the SHA1 hash. To calculate the hash the SHA1 algorithm is fetched using the library ctx I and the property -query string I (see L for further +query string I (see L for further information). OCSP_RESPID_match() does the same as OCSP_RESPID_match_ex() except that the diff --git a/doc/man3/OSSL_CRMF_pbmp_new.pod b/doc/man3/OSSL_CRMF_pbmp_new.pod index 25368401f1..ff8b3c327c 100644 --- a/doc/man3/OSSL_CRMF_pbmp_new.pod +++ b/doc/man3/OSSL_CRMF_pbmp_new.pod @@ -27,7 +27,7 @@ parameters I, message I, and secret I, along with the respective lengths I and I. The optional library context I and I parameters may be used to influence the selection of the MAC algorithm referenced in the I; -see L for further information. +see L for further information. On success writes the address of the newly allocated MAC via the I reference parameter and writes the length via the I reference parameter unless it its NULL. diff --git a/doc/man3/SRP_Calc_B.pod b/doc/man3/SRP_Calc_B.pod index 48eb018328..8fa25b0b56 100644 --- a/doc/man3/SRP_Calc_B.pod +++ b/doc/man3/SRP_Calc_B.pod @@ -63,7 +63,7 @@ BIGNUM parameters to these functions. Most of these functions come in two forms. Those that take a I and I parameter, and those that don't. Any cryptogrpahic functions that are fetched and used during the calculation use the provided I and -I. See L for more details. The variants +I. See L for more details. The variants that do not take a I and I parameter use the default library context and property query string. The SRP_Calc_server_key() and SRP_Calc_A() functions do not have a form that takes I or I parameters because diff --git a/doc/man3/SRP_create_verifier.pod b/doc/man3/SRP_create_verifier.pod index 74d520199d..37022b7dda 100644 --- a/doc/man3/SRP_create_verifier.pod +++ b/doc/man3/SRP_create_verifier.pod @@ -42,7 +42,7 @@ The SRP_create_verifier_BN_ex() function creates an SRP password verifier from the supplied parameters as defined in section 2.4 of RFC 5054 using the library context I and property query string I. Any cryptographic algorithms that need to be fetched will use the I and I. See -L. +L. SRP_create_verifier_BN() is the same as SRP_create_verifier_BN_ex() except the default library context and property query string is used. diff --git a/doc/man3/SSL_CTX_new.pod b/doc/man3/SSL_CTX_new.pod index 1c953098e2..6bab45631f 100644 --- a/doc/man3/SSL_CTX_new.pod +++ b/doc/man3/SSL_CTX_new.pod @@ -79,7 +79,7 @@ library context I (see L) is used to provide the cryptographic algorithms needed for the session. Any cryptographic algorithms that are used by any B objects created from this B will be fetched from the I using the property query string I (see -L. Either or both the I or I +L. Either or both the I or I parameters may be NULL. SSL_CTX_new() does the same as SSL_CTX_new_ex() except that the default -- cgit v1.2.3