diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-24 16:40:11 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2020-01-22 18:06:49 +0100 |
commit | fadb57e554cb0b9b7678902a3572740f31bcc279 (patch) | |
tree | 9f46c05cf0fd4f5fa18c8204c0a9607eb4314b5a /doc | |
parent | 2280685883f7c19a07a55bcc3ddcd11b6cd82056 (diff) |
Fix some missing doc links.
Replace "=for openssl foreign manuals" with simpler syntax, it looks
like the "=for openssl ifdef" construct.
Fix some broken L<> links; add some missing foreign references and fixed
some typo's.
The WARNINGS in dhparam referred to non-existant commands so reword it.
Fixes #10109
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10256)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/internal/man3/ossl_cmp_statusinfo_new.pod | 2 | ||||
-rw-r--r-- | doc/man1/openssl-ca.pod.in | 2 | ||||
-rw-r--r-- | doc/man1/openssl-cmds.pod | 4 | ||||
-rw-r--r-- | doc/man1/openssl-dgst.pod.in | 2 | ||||
-rw-r--r-- | doc/man1/openssl-dhparam.pod.in | 12 | ||||
-rw-r--r-- | doc/man1/openssl-ts.pod.in | 4 | ||||
-rw-r--r-- | doc/man1/tsget.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_CTX_ctrl.pod | 6 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_derive.pod | 7 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_sign.pod | 1 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_verify.pod | 3 | ||||
-rw-r--r-- | doc/man3/OSSL_trace_set_channel.pod | 2 | ||||
-rw-r--r-- | doc/man3/PKCS12_SAFEBAG_get0_attrs.pod | 1 | ||||
-rw-r--r-- | doc/man3/SMIME_read_CMS.pod | 2 | ||||
-rw-r--r-- | doc/man3/X509_LOOKUP_hash_dir.pod | 6 | ||||
-rw-r--r-- | doc/man7/EVP_KDF-KRB5KDF.pod | 1 | ||||
-rw-r--r-- | doc/man7/OSSL_PROVIDER-FIPS.pod | 4 | ||||
-rw-r--r-- | doc/man7/openssl-env.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-asym_cipher.pod | 8 | ||||
-rw-r--r-- | doc/man7/provider-keyexch.pod | 4 | ||||
-rw-r--r-- | doc/man7/provider-signature.pod | 6 | ||||
-rw-r--r-- | doc/man7/provider.pod | 4 |
23 files changed, 40 insertions, 47 deletions
diff --git a/doc/internal/man3/ossl_cmp_statusinfo_new.pod b/doc/internal/man3/ossl_cmp_statusinfo_new.pod index 6a72056455..ee7dd35cf5 100644 --- a/doc/internal/man3/ossl_cmp_statusinfo_new.pod +++ b/doc/internal/man3/ossl_cmp_statusinfo_new.pod @@ -89,7 +89,7 @@ See the individual functions above. =head1 SEE ALSO -L<OSSL_CMP_CTX_new(3)>, L<ossl_cmp_certreq_new(3)> +L<OSSL_CMP_CTX_new(3)>, L<ossl_cmp_certReq_new(3)> =head1 HISTORY diff --git a/doc/man1/openssl-ca.pod.in b/doc/man1/openssl-ca.pod.in index 44e581e0d9..6d351ae1cc 100644 --- a/doc/man1/openssl-ca.pod.in +++ b/doc/man1/openssl-ca.pod.in @@ -149,6 +149,8 @@ Names and values of these options are algorithm-specific. =item B<-key> I<password> +=for openssl foreign manual ps(1) + The password used to encrypt the private key. Since on some systems the command line arguments are visible (e.g. Unix with the L<ps(1)> utility) this option should be used with caution. diff --git a/doc/man1/openssl-cmds.pod b/doc/man1/openssl-cmds.pod index 8a649ca343..d44d40cfec 100644 --- a/doc/man1/openssl-cmds.pod +++ b/doc/man1/openssl-cmds.pod @@ -55,7 +55,7 @@ version, x509 - OpenSSL application commands -=for comment foreign manuals: apropos(1) +=for openssl foreign manual apropos(1) =head1 SYNOPSIS @@ -136,6 +136,8 @@ L<openssl-x509(1)>, =head1 HISTORY +=for openssl foreign manual apropos(1) + Initially, the manual page entry for the C<openssl I<cmd>> command used to be available at I<cmd>(1). Later, the alias B<openssl-I<cmd>>(1) was introduced, which made it easier to group the openssl commands using diff --git a/doc/man1/openssl-dgst.pod.in b/doc/man1/openssl-dgst.pod.in index 4563ad1d5e..a954b8b253 100644 --- a/doc/man1/openssl-dgst.pod.in +++ b/doc/man1/openssl-dgst.pod.in @@ -81,6 +81,8 @@ Output the digest or signature in binary form. =item B<-r> +=for openssl foreign manual sha1sum(1) + Output the digest in the "coreutils" format, including newlines. Used by programs like L<sha1sum(1)>. diff --git a/doc/man1/openssl-dhparam.pod.in b/doc/man1/openssl-dhparam.pod.in index e125330b36..9da15f7ad2 100644 --- a/doc/man1/openssl-dhparam.pod.in +++ b/doc/man1/openssl-dhparam.pod.in @@ -108,19 +108,15 @@ be loaded by calling the get_dhNNNN() function. =back -=head1 WARNINGS - -This command combines the functionality of the L<openssl-dh(1)> and the -L<openssl-gendh(1)> commands in previous OpenSSL versions. -The L<openssl-dh(1)> and L<openssl-gendh(1)> commands are retained for now but -may have different purposes in future versions of OpenSSL. - =head1 NOTES +This command replaces the B<dh> and B<gendh> commands of previous +releases. + OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42 DH. -This program manipulates DH parameters not keys. +This command manipulates DH parameters not keys. =head1 BUGS diff --git a/doc/man1/openssl-ts.pod.in b/doc/man1/openssl-ts.pod.in index 0eb4f8031a..53781126fa 100644 --- a/doc/man1/openssl-ts.pod.in +++ b/doc/man1/openssl-ts.pod.in @@ -608,7 +608,7 @@ You could also look at the 'test' directory for more examples. =head1 BUGS -=for openssl foreign manuals: procmail(1), perl(1) +=for openssl foreign manual procmail(1) perl(1) =over 2 @@ -653,7 +653,7 @@ retained mainly for compatibility reasons. =head1 SEE ALSO L<openssl(1)>, -L<openssl-tsget(1)>, +L<tsget(1)>, L<openssl-req(1)>, L<openssl-x509(1)>, L<openssl-ca(1)>, diff --git a/doc/man1/tsget.pod b/doc/man1/tsget.pod index 0287bc94be..201c24fc2a 100644 --- a/doc/man1/tsget.pod +++ b/doc/man1/tsget.pod @@ -183,7 +183,7 @@ example: =head1 SEE ALSO -=for openssl foreign manuals: WWW::Curl::Easy +=for openssl foreign manual WWW::Curl::Easy L<openssl(1)>, L<openssl-ts(1)>, diff --git a/doc/man3/EVP_PKEY_CTX_ctrl.pod b/doc/man3/EVP_PKEY_CTX_ctrl.pod index 4d52af9d4c..41f8d919d4 100644 --- a/doc/man3/EVP_PKEY_CTX_ctrl.pod +++ b/doc/man3/EVP_PKEY_CTX_ctrl.pod @@ -168,8 +168,7 @@ Not all parameters may be supported by all providers. See L<OSSL_PROVIDER(3)> for more information on providers. See L<OSSL_PARAM(3)> for more information on parameters. These functions must only be called after the EVP_PKEY_CTX has been initialised -for use in an operation (for example by L<EVP_PKEY_sign_init_ex(3)>, -L<EVP_PKEY_derive_init_ex(3)> or other similar functions). +for use in an operation. The parameters currently supported by the default provider are: @@ -204,8 +203,7 @@ that can be used with EVP_PKEY_CTX_get_params() and EVP_PKEY_CTX_set_params() respectively. See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. These functions must only be called after the EVP_PKEY_CTX has been initialised -for use in an operation (for example by L<EVP_PKEY_sign_init_ex(3)>, -L<EVP_PKEY_derive_init_ex(3)> or other similar functions). +for use in an operation. The function EVP_PKEY_CTX_ctrl() sends a control operation to the context B<ctx>. The key type used must match B<keytype> if it is not -1. The parameter diff --git a/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod b/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod index dfde4ff8bc..7dbf5fa9c9 100644 --- a/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod +++ b/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod @@ -29,7 +29,7 @@ EVP_PKEY_CTX_set_scrypt_maxmem_bytes These functions are used to set up the necessary data to use the scrypt KDF. -For more information on scrypt, see L<EVP_KDF_SCRYPT(7)>. +For more information on scrypt, see L<EVP_KDF-SCRYPT(7)>. EVP_PKEY_CTX_set1_scrypt_salt() sets the B<saltlen> bytes long salt value. diff --git a/doc/man3/EVP_PKEY_derive.pod b/doc/man3/EVP_PKEY_derive.pod index 954a3501e8..30d301a150 100644 --- a/doc/man3/EVP_PKEY_derive.pod +++ b/doc/man3/EVP_PKEY_derive.pod @@ -33,7 +33,7 @@ written to I<keylen>. =head1 NOTES -After the call to EVP_PKEY_derive_init() or EVP_PKEY_derive_init_ex() algorithm +After the call to EVP_PKEY_derive_init(), algorithm specific control operations can be performed to set any appropriate parameters for the operation. @@ -42,7 +42,7 @@ context if several operations are performed using the same parameters. =head1 RETURN VALUES -EVP_PKEY_derive_init_ex(), EVP_PKEY_derive_init() and EVP_PKEY_derive() return 1 +EVP_PKEY_derive_init() and EVP_PKEY_derive() return 1 for success and 0 or a negative value for failure. In particular a return value of -2 indicates the operation is not supported by the public key algorithm. @@ -95,8 +95,7 @@ L<EVP_KEYEXCH_fetch(3)> =head1 HISTORY -These functions were added in OpenSSL 1.0.0. The EVP_PKEY_derive_init_ex() -function was added in OpenSSL 3.0. +These functions were added in OpenSSL 1.0.0. =head1 COPYRIGHT diff --git a/doc/man3/EVP_PKEY_sign.pod b/doc/man3/EVP_PKEY_sign.pod index 68788921da..78288781b8 100644 --- a/doc/man3/EVP_PKEY_sign.pod +++ b/doc/man3/EVP_PKEY_sign.pod @@ -105,7 +105,6 @@ L<EVP_PKEY_derive(3)> =head1 HISTORY -EVP_PKEY_sign_init_ex() was added in OpenSSL 3.0. These functions were added in OpenSSL 1.0.0. =head1 COPYRIGHT diff --git a/doc/man3/EVP_PKEY_verify.pod b/doc/man3/EVP_PKEY_verify.pod index ed63cdae84..878e4878c7 100644 --- a/doc/man3/EVP_PKEY_verify.pod +++ b/doc/man3/EVP_PKEY_verify.pod @@ -93,8 +93,7 @@ L<EVP_PKEY_derive(3)> =head1 HISTORY -EVP_PKEY_verify_init_ex() was added in OpenSSL 3.0. -All other functions were added in OpenSSL 1.0.0. +These functions were added in OpenSSL 1.0.0. =head1 COPYRIGHT diff --git a/doc/man3/OSSL_trace_set_channel.pod b/doc/man3/OSSL_trace_set_channel.pod index 7df484ca95..a4b1d094d1 100644 --- a/doc/man3/OSSL_trace_set_channel.pod +++ b/doc/man3/OSSL_trace_set_channel.pod @@ -1,6 +1,6 @@ =pod -=for openssl foreign manuals: atexit(3) +=for openssl foreign manual atexit(3) =head1 NAME diff --git a/doc/man3/PKCS12_SAFEBAG_get0_attrs.pod b/doc/man3/PKCS12_SAFEBAG_get0_attrs.pod index 9fd3b78699..f95e537b45 100644 --- a/doc/man3/PKCS12_SAFEBAG_get0_attrs.pod +++ b/doc/man3/PKCS12_SAFEBAG_get0_attrs.pod @@ -35,7 +35,6 @@ is still owned by the B<PKCS12_SAFEBAG> in which it resides. =head1 SEE ALSO L<PKCS12_get_friendlyname(3)>, -L<PKCS12_get_localkeyid(3)>, L<PKCS12_add_friendlyname_asc(3)> =head1 COPYRIGHT diff --git a/doc/man3/SMIME_read_CMS.pod b/doc/man3/SMIME_read_CMS.pod index 41d6fd454b..eab8347d3e 100644 --- a/doc/man3/SMIME_read_CMS.pod +++ b/doc/man3/SMIME_read_CMS.pod @@ -58,7 +58,7 @@ if an error occurred. The error can be obtained from ERR_get_error(3). =head1 SEE ALSO -L<ERR_get_error(3)>, L<CMS_type(3)>, +L<ERR_get_error(3)>, L<SMIME_read_CMS(3)>, L<CMS_sign(3)>, L<CMS_verify(3)>, L<CMS_encrypt(3)>, L<CMS_decrypt(3)> diff --git a/doc/man3/X509_LOOKUP_hash_dir.pod b/doc/man3/X509_LOOKUP_hash_dir.pod index b2f0a6a361..41d24018a5 100644 --- a/doc/man3/X509_LOOKUP_hash_dir.pod +++ b/doc/man3/X509_LOOKUP_hash_dir.pod @@ -116,14 +116,14 @@ hashed names for all files with F<.pem> suffix in a given directory. B<X509_LOOKUP_store> is a method that allows access to any store of certificates and CRLs through any loader supported by -L<OSSL_STORE(3)>. +L<ossl_store(7)>. It works with the help of URIs, which can be direct references to certificates or CRLs, but can also be references to catalogues of such objects (that behave like directories). This method overlaps the L</File Method> and L</Hashed Directory Method> because of the 'file:' scheme loader. -It does no caching of its own, but can use a caching L<OSSL_STORE(3)> +It does no caching of its own, but can use a caching L<ossl_store(7)> loader, and therefore depends on the loader's capability. =head1 RETURN VALUES @@ -141,7 +141,7 @@ L<X509_STORE_load_locations(3)>, L<X509_store_add_lookup(3)>, L<SSL_CTX_load_verify_locations(3)>, L<X509_LOOKUP_meth_new(3)>, -L<OSSL_STORE(3)> +L<ossl_store(7)> =head1 HISTORY diff --git a/doc/man7/EVP_KDF-KRB5KDF.pod b/doc/man7/EVP_KDF-KRB5KDF.pod index 1ac06c493e..9d3f27bb4b 100644 --- a/doc/man7/EVP_KDF-KRB5KDF.pod +++ b/doc/man7/EVP_KDF-KRB5KDF.pod @@ -96,7 +96,6 @@ RFC 3961 =head1 SEE ALSO L<EVP_KDF(3)>, -L<EVP_KDF_CTX_new_id(3)>, L<EVP_KDF_CTX_free(3)>, L<EVP_KDF_ctrl(3)>, L<EVP_KDF_size(3)>, diff --git a/doc/man7/OSSL_PROVIDER-FIPS.pod b/doc/man7/OSSL_PROVIDER-FIPS.pod index a04ce4d6f2..c3768da7bc 100644 --- a/doc/man7/OSSL_PROVIDER-FIPS.pod +++ b/doc/man7/OSSL_PROVIDER-FIPS.pod @@ -15,7 +15,7 @@ accredited testing laboratory. One of the requirements for the FIPS module is self testing. An optional callback mechanism is available to return information to the user using -L<OSSL_SELF_TEST_set_callback(7)>. +L<OSSL_SELF_TEST_set_callback(3)>. The OPENSSL FIPS module uses the following mechanism to provide information about the self tests as they run. @@ -240,7 +240,7 @@ A simple self test callback is shown below for illustrative purposes. L<openssl-fipsinstall(1)>, L<fips_config(5)>, -L<OSSL_SELF_TEST_set_callback(7)>, +L<OSSL_SELF_TEST_set_callback(3)>, L<OSSL_PARAM(3)>, L<openssl-core.h(7)> diff --git a/doc/man7/openssl-env.pod b/doc/man7/openssl-env.pod index ee341a92d1..be89f85172 100644 --- a/doc/man7/openssl-env.pod +++ b/doc/man7/openssl-env.pod @@ -37,7 +37,7 @@ See L<openssl-engine(1)>. =item B<OPENSSL_MALLOC_FD>, B<OPENSSL_MALLOC_FAILURES> If built with debugging, this allows memory allocation to fail. -See L<OPENSSSL_malloc(3)>. +See L<OPENSSL_malloc(3)>. =item B<OPENSSL_MODULES> diff --git a/doc/man7/provider-asym_cipher.pod b/doc/man7/provider-asym_cipher.pod index de615c463f..b442cd5a50 100644 --- a/doc/man7/provider-asym_cipher.pod +++ b/doc/man7/provider-asym_cipher.pod @@ -47,9 +47,9 @@ for further information. The asymmetric cipher (OSSL_OP_ASYM_CIPHER) operation enables providers to implement asymmetric cipher algorithms and make them available to applications -via the API functions L<EVP_PKEY_encrypt_init_ex(3)>, L<EVP_PKEY_encrypt(3)>, -L<EVP_PKEY_decrypt_init_ex(3)>, L<EVP_PKEY_decrypt(3)> (as well -as other related functions). +via the API functions L<EVP_PKEY_encrypt(3)>, +L<EVP_PKEY_decrypt(3)> and +other related functions). All "functions" mentioned here are passed as function pointers between F<libcrypto> and the provider in B<OSSL_DISPATCH> arrays via @@ -108,7 +108,7 @@ structure for holding context information during an asymmetric cipher operation. A pointer to this context will be passed back in a number of the other asymmetric cipher operation function calls. The parameter I<provctx> is the provider context generated during provider -initialisation (see L<provider(3)>). +initialisation (see L<provider(7)>). OP_asym_cipher_freectx() is passed a pointer to the provider side asymmetric cipher context in the I<ctx> parameter. diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod index aa010daa81..ceb03ec2f0 100644 --- a/doc/man7/provider-keyexch.pod +++ b/doc/man7/provider-keyexch.pod @@ -38,8 +38,8 @@ This documentation is primarily aimed at provider authors. See L<provider(7)> for further information. The key exchange (OSSL_OP_KEYEXCH) operation enables providers to implement key -exchange algorithms and make them available to applications via the API -functions L<EVP_PKEY_derive_init_ex(3)>, and L<EVP_PKEY_derive(3)> (as well as +exchange algorithms and make them available to applications via +L<EVP_PKEY_derive(3)> and other related functions). All "functions" mentioned here are passed as function pointers between diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod index ea98c95ae2..d5f0c396c1 100644 --- a/doc/man7/provider-signature.pod +++ b/doc/man7/provider-signature.pod @@ -51,9 +51,9 @@ for further information. The signature (OSSL_OP_SIGNATURE) operation enables providers to implement signature algorithms and make them available to applications via the API -functions L<EVP_PKEY_sign_init_ex(3)>, L<EVP_PKEY_sign(3)>, -L<EVP_PKEY_verify_init_ex(3)>, L<EVP_PKEY_verify(3)>, -L<EVP_PKEY_verify_recover_init_ex(3)> and L<EVP_PKEY_verify_recover(3)> (as well +functions L<EVP_PKEY_sign(3)>, +L<EVP_PKEY_verify(3)>, +and L<EVP_PKEY_verify_recover(3)> (as well as other related functions). All "functions" mentioned here are passed as function pointers between diff --git a/doc/man7/provider.pod b/doc/man7/provider.pod index 0e9019960d..d2fef9beee 100644 --- a/doc/man7/provider.pod +++ b/doc/man7/provider.pod @@ -217,8 +217,7 @@ When they are used with functions like L<EVP_DigestInit_ex(3)> or L<EVP_CipherInit_ex(3)>, the actual implementation to be used is fetched implicitly using default search criteria. -Implicit fetching can also occur with functions such as -L<EVP_PKEY_derive_init_ex(3)> where a NULL algorithm parameter is +Implicit fetching can also occur when a NULL algorithm parameter is supplied. In this case an algorithm implementation is implicitly fetched using default search criteria and an algorithm name that is consistent with @@ -349,7 +348,6 @@ other providers: =head1 SEE ALSO L<EVP_DigestInit_ex(3)>, L<EVP_EncryptInit_ex(3)>, -L<EVP_PKEY_derive_init_ex(3)>, L<OPENSSL_CTX(3)>, L<EVP_set_default_properties(3)>, L<EVP_MD_fetch(3)>, |