From: Rich Salz Date: Thu, 22 Aug 2019 05:21:25 +0000 (+0530) Subject: Fix some broken doc links X-Git-Tag: openssl-3.0.0-alpha1~942 X-Git-Url: https://git.librecmc.org/?p=oweals%2Fopenssl.git;a=commitdiff_plain;h=d7cea0b8f50ee9cc698211f4fbf8ad5fca5812ad Fix some broken doc links Replace L<> link to header-file with a C<> reference. Change some broken L links to L. For consistency, rename four cipher pages to have a specific mode. Fix up all references to any "generic" names to point to specific names. Reviewed-by: Richard Levitte Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10100) --- diff --git a/doc/man1/openssl-mac.pod b/doc/man1/openssl-mac.pod index ce2af2d934..f5be58bcb2 100644 --- a/doc/man1/openssl-mac.pod +++ b/doc/man1/openssl-mac.pod @@ -147,8 +147,8 @@ L, L, L, L, -L, -L +L, +L =head1 COPYRIGHT diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 46e6a42a28..1ca3e7478e 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -794,20 +794,20 @@ L Supported ciphers are listed in: -L, -L, -L, -L, -L, +L, +L, +L, +L, +L, L, -L, -L, -L, -L, +L, +L, +L, +L, L, -L, -L, -L +L, +L, +L =head1 HISTORY diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 1081314879..e737d45310 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -370,13 +370,13 @@ F<./foo>) L L, -L, -L, -L, -L, -L, -L, -L +L, +L, +L, +L, +L, +L, +L =head1 HISTORY diff --git a/doc/man3/EVP_aes.pod b/doc/man3/EVP_aes.pod deleted file mode 100644 index 1ca893a738..0000000000 --- a/doc/man3/EVP_aes.pod +++ /dev/null @@ -1,187 +0,0 @@ -=pod - -=head1 NAME - -EVP_aes_128_cbc, -EVP_aes_192_cbc, -EVP_aes_256_cbc, -EVP_aes_128_cfb, -EVP_aes_192_cfb, -EVP_aes_256_cfb, -EVP_aes_128_cfb1, -EVP_aes_192_cfb1, -EVP_aes_256_cfb1, -EVP_aes_128_cfb8, -EVP_aes_192_cfb8, -EVP_aes_256_cfb8, -EVP_aes_128_cfb128, -EVP_aes_192_cfb128, -EVP_aes_256_cfb128, -EVP_aes_128_ctr, -EVP_aes_192_ctr, -EVP_aes_256_ctr, -EVP_aes_128_ecb, -EVP_aes_192_ecb, -EVP_aes_256_ecb, -EVP_aes_128_ofb, -EVP_aes_192_ofb, -EVP_aes_256_ofb, -EVP_aes_128_cbc_hmac_sha1, -EVP_aes_256_cbc_hmac_sha1, -EVP_aes_128_cbc_hmac_sha256, -EVP_aes_256_cbc_hmac_sha256, -EVP_aes_128_ccm, -EVP_aes_192_ccm, -EVP_aes_256_ccm, -EVP_aes_128_gcm, -EVP_aes_192_gcm, -EVP_aes_256_gcm, -EVP_aes_128_ocb, -EVP_aes_192_ocb, -EVP_aes_256_ocb, -EVP_aes_128_wrap, -EVP_aes_192_wrap, -EVP_aes_256_wrap, -EVP_aes_128_wrap_pad, -EVP_aes_192_wrap_pad, -EVP_aes_256_wrap_pad, -EVP_aes_128_xts, -EVP_aes_256_xts -- EVP AES cipher - -=head1 SYNOPSIS - -=for openssl generic - - #include - - const EVP_CIPHER *EVP_ciphername(void) - -I is used a placeholder for any of the described cipher -functions, such as I. - -=head1 DESCRIPTION - -The AES encryption algorithm for EVP. - -=over 4 - -=item EVP_aes_128_cbc(), -EVP_aes_192_cbc(), -EVP_aes_256_cbc(), -EVP_aes_128_cfb(), -EVP_aes_192_cfb(), -EVP_aes_256_cfb(), -EVP_aes_128_cfb1(), -EVP_aes_192_cfb1(), -EVP_aes_256_cfb1(), -EVP_aes_128_cfb8(), -EVP_aes_192_cfb8(), -EVP_aes_256_cfb8(), -EVP_aes_128_cfb128(), -EVP_aes_192_cfb128(), -EVP_aes_256_cfb128(), -EVP_aes_128_ctr(), -EVP_aes_192_ctr(), -EVP_aes_256_ctr(), -EVP_aes_128_ecb(), -EVP_aes_192_ecb(), -EVP_aes_256_ecb(), -EVP_aes_128_ofb(), -EVP_aes_192_ofb(), -EVP_aes_256_ofb() - -AES for 128, 192 and 256 bit keys in the following modes: CBC, CFB with 128-bit -shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB, and OFB. - -=item EVP_aes_128_cbc_hmac_sha1(), -EVP_aes_256_cbc_hmac_sha1() - -Authenticated encryption with AES in CBC mode using SHA-1 as HMAC, with keys of -128 and 256 bits length respectively. The authentication tag is 160 bits long. - -WARNING: this is not intended for usage outside of TLS and requires calling of -some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD -interface. - -=item EVP_aes_128_cbc_hmac_sha256(), -EVP_aes_256_cbc_hmac_sha256() - -Authenticated encryption with AES in CBC mode using SHA256 (SHA-2, 256-bits) as -HMAC, with keys of 128 and 256 bits length respectively. The authentication tag -is 256 bits long. - -WARNING: this is not intended for usage outside of TLS and requires calling of -some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD -interface. - -=item EVP_aes_128_ccm(), -EVP_aes_192_ccm(), -EVP_aes_256_ccm(), -EVP_aes_128_gcm(), -EVP_aes_192_gcm(), -EVP_aes_256_gcm(), -EVP_aes_128_ocb(), -EVP_aes_192_ocb(), -EVP_aes_256_ocb() - -AES for 128, 192 and 256 bit keys in CBC-MAC Mode (CCM), Galois Counter Mode -(GCM) and OCB Mode respectively. These ciphers require additional control -operations to function correctly, see the L -section for details. - -=item EVP_aes_128_wrap(), -EVP_aes_192_wrap(), -EVP_aes_256_wrap(), -EVP_aes_128_wrap_pad(), -EVP_aes_128_wrap(), -EVP_aes_192_wrap(), -EVP_aes_256_wrap(), -EVP_aes_192_wrap_pad(), -EVP_aes_128_wrap(), -EVP_aes_192_wrap(), -EVP_aes_256_wrap(), -EVP_aes_256_wrap_pad() - -AES key wrap with 128, 192 and 256 bit keys, as according to RFC 3394 section -2.2.1 ("wrap") and RFC 5649 section 4.1 ("wrap with padding") respectively. - -=item EVP_aes_128_xts(), -EVP_aes_256_xts() - -AES XTS mode (XTS-AES) is standardized in IEEE Std. 1619-2007 and described in NIST -SP 800-38E. The XTS (XEX-based tweaked-codebook mode with ciphertext stealing) -mode was designed by Prof. Phillip Rogaway of University of California, Davis, -intended for encrypting data on a storage device. - -XTS-AES provides confidentiality but not authentication of data. It also -requires a key of double-length for protection of a certain key size. -In particular, XTS-AES-128 (B) takes input of a 256-bit key to -achieve AES 128-bit security, and XTS-AES-256 (B) takes input -of a 512-bit key to achieve AES 256-bit security. - -=back - -=head1 RETURN VALUES - -These functions return an B structure that contains the -implementation of the symmetric cipher. See L for -details of the B structure. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut - diff --git a/doc/man3/EVP_aes_128_gcm.pod b/doc/man3/EVP_aes_128_gcm.pod new file mode 100644 index 0000000000..1ca893a738 --- /dev/null +++ b/doc/man3/EVP_aes_128_gcm.pod @@ -0,0 +1,187 @@ +=pod + +=head1 NAME + +EVP_aes_128_cbc, +EVP_aes_192_cbc, +EVP_aes_256_cbc, +EVP_aes_128_cfb, +EVP_aes_192_cfb, +EVP_aes_256_cfb, +EVP_aes_128_cfb1, +EVP_aes_192_cfb1, +EVP_aes_256_cfb1, +EVP_aes_128_cfb8, +EVP_aes_192_cfb8, +EVP_aes_256_cfb8, +EVP_aes_128_cfb128, +EVP_aes_192_cfb128, +EVP_aes_256_cfb128, +EVP_aes_128_ctr, +EVP_aes_192_ctr, +EVP_aes_256_ctr, +EVP_aes_128_ecb, +EVP_aes_192_ecb, +EVP_aes_256_ecb, +EVP_aes_128_ofb, +EVP_aes_192_ofb, +EVP_aes_256_ofb, +EVP_aes_128_cbc_hmac_sha1, +EVP_aes_256_cbc_hmac_sha1, +EVP_aes_128_cbc_hmac_sha256, +EVP_aes_256_cbc_hmac_sha256, +EVP_aes_128_ccm, +EVP_aes_192_ccm, +EVP_aes_256_ccm, +EVP_aes_128_gcm, +EVP_aes_192_gcm, +EVP_aes_256_gcm, +EVP_aes_128_ocb, +EVP_aes_192_ocb, +EVP_aes_256_ocb, +EVP_aes_128_wrap, +EVP_aes_192_wrap, +EVP_aes_256_wrap, +EVP_aes_128_wrap_pad, +EVP_aes_192_wrap_pad, +EVP_aes_256_wrap_pad, +EVP_aes_128_xts, +EVP_aes_256_xts +- EVP AES cipher + +=head1 SYNOPSIS + +=for openssl generic + + #include + + const EVP_CIPHER *EVP_ciphername(void) + +I is used a placeholder for any of the described cipher +functions, such as I. + +=head1 DESCRIPTION + +The AES encryption algorithm for EVP. + +=over 4 + +=item EVP_aes_128_cbc(), +EVP_aes_192_cbc(), +EVP_aes_256_cbc(), +EVP_aes_128_cfb(), +EVP_aes_192_cfb(), +EVP_aes_256_cfb(), +EVP_aes_128_cfb1(), +EVP_aes_192_cfb1(), +EVP_aes_256_cfb1(), +EVP_aes_128_cfb8(), +EVP_aes_192_cfb8(), +EVP_aes_256_cfb8(), +EVP_aes_128_cfb128(), +EVP_aes_192_cfb128(), +EVP_aes_256_cfb128(), +EVP_aes_128_ctr(), +EVP_aes_192_ctr(), +EVP_aes_256_ctr(), +EVP_aes_128_ecb(), +EVP_aes_192_ecb(), +EVP_aes_256_ecb(), +EVP_aes_128_ofb(), +EVP_aes_192_ofb(), +EVP_aes_256_ofb() + +AES for 128, 192 and 256 bit keys in the following modes: CBC, CFB with 128-bit +shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB, and OFB. + +=item EVP_aes_128_cbc_hmac_sha1(), +EVP_aes_256_cbc_hmac_sha1() + +Authenticated encryption with AES in CBC mode using SHA-1 as HMAC, with keys of +128 and 256 bits length respectively. The authentication tag is 160 bits long. + +WARNING: this is not intended for usage outside of TLS and requires calling of +some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD +interface. + +=item EVP_aes_128_cbc_hmac_sha256(), +EVP_aes_256_cbc_hmac_sha256() + +Authenticated encryption with AES in CBC mode using SHA256 (SHA-2, 256-bits) as +HMAC, with keys of 128 and 256 bits length respectively. The authentication tag +is 256 bits long. + +WARNING: this is not intended for usage outside of TLS and requires calling of +some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD +interface. + +=item EVP_aes_128_ccm(), +EVP_aes_192_ccm(), +EVP_aes_256_ccm(), +EVP_aes_128_gcm(), +EVP_aes_192_gcm(), +EVP_aes_256_gcm(), +EVP_aes_128_ocb(), +EVP_aes_192_ocb(), +EVP_aes_256_ocb() + +AES for 128, 192 and 256 bit keys in CBC-MAC Mode (CCM), Galois Counter Mode +(GCM) and OCB Mode respectively. These ciphers require additional control +operations to function correctly, see the L +section for details. + +=item EVP_aes_128_wrap(), +EVP_aes_192_wrap(), +EVP_aes_256_wrap(), +EVP_aes_128_wrap_pad(), +EVP_aes_128_wrap(), +EVP_aes_192_wrap(), +EVP_aes_256_wrap(), +EVP_aes_192_wrap_pad(), +EVP_aes_128_wrap(), +EVP_aes_192_wrap(), +EVP_aes_256_wrap(), +EVP_aes_256_wrap_pad() + +AES key wrap with 128, 192 and 256 bit keys, as according to RFC 3394 section +2.2.1 ("wrap") and RFC 5649 section 4.1 ("wrap with padding") respectively. + +=item EVP_aes_128_xts(), +EVP_aes_256_xts() + +AES XTS mode (XTS-AES) is standardized in IEEE Std. 1619-2007 and described in NIST +SP 800-38E. The XTS (XEX-based tweaked-codebook mode with ciphertext stealing) +mode was designed by Prof. Phillip Rogaway of University of California, Davis, +intended for encrypting data on a storage device. + +XTS-AES provides confidentiality but not authentication of data. It also +requires a key of double-length for protection of a certain key size. +In particular, XTS-AES-128 (B) takes input of a 256-bit key to +achieve AES 128-bit security, and XTS-AES-256 (B) takes input +of a 512-bit key to achieve AES 256-bit security. + +=back + +=head1 RETURN VALUES + +These functions return an B structure that contains the +implementation of the symmetric cipher. See L for +details of the B structure. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut + diff --git a/doc/man3/EVP_aria.pod b/doc/man3/EVP_aria.pod deleted file mode 100644 index 6471acb249..0000000000 --- a/doc/man3/EVP_aria.pod +++ /dev/null @@ -1,117 +0,0 @@ -=pod - -=head1 NAME - -EVP_aria_128_cbc, -EVP_aria_192_cbc, -EVP_aria_256_cbc, -EVP_aria_128_cfb, -EVP_aria_192_cfb, -EVP_aria_256_cfb, -EVP_aria_128_cfb1, -EVP_aria_192_cfb1, -EVP_aria_256_cfb1, -EVP_aria_128_cfb8, -EVP_aria_192_cfb8, -EVP_aria_256_cfb8, -EVP_aria_128_cfb128, -EVP_aria_192_cfb128, -EVP_aria_256_cfb128, -EVP_aria_128_ctr, -EVP_aria_192_ctr, -EVP_aria_256_ctr, -EVP_aria_128_ecb, -EVP_aria_192_ecb, -EVP_aria_256_ecb, -EVP_aria_128_ofb, -EVP_aria_192_ofb, -EVP_aria_256_ofb, -EVP_aria_128_ccm, -EVP_aria_192_ccm, -EVP_aria_256_ccm, -EVP_aria_128_gcm, -EVP_aria_192_gcm, -EVP_aria_256_gcm, -- EVP ARIA cipher - -=head1 SYNOPSIS - -=for openssl generic - - #include - - const EVP_CIPHER *EVP_ciphername(void) - -I is used a placeholder for any of the described cipher -functions, such as I. - -=head1 DESCRIPTION - -The ARIA encryption algorithm for EVP. - -=over 4 - -=item EVP_aria_128_cbc(), -EVP_aria_192_cbc(), -EVP_aria_256_cbc(), -EVP_aria_128_cfb(), -EVP_aria_192_cfb(), -EVP_aria_256_cfb(), -EVP_aria_128_cfb1(), -EVP_aria_192_cfb1(), -EVP_aria_256_cfb1(), -EVP_aria_128_cfb8(), -EVP_aria_192_cfb8(), -EVP_aria_256_cfb8(), -EVP_aria_128_cfb128(), -EVP_aria_192_cfb128(), -EVP_aria_256_cfb128(), -EVP_aria_128_ctr(), -EVP_aria_192_ctr(), -EVP_aria_256_ctr(), -EVP_aria_128_ecb(), -EVP_aria_192_ecb(), -EVP_aria_256_ecb(), -EVP_aria_128_ofb(), -EVP_aria_192_ofb(), -EVP_aria_256_ofb() - -ARIA for 128, 192 and 256 bit keys in the following modes: CBC, CFB with -128-bit shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB and OFB. - -=item EVP_aria_128_ccm(), -EVP_aria_192_ccm(), -EVP_aria_256_ccm(), -EVP_aria_128_gcm(), -EVP_aria_192_gcm(), -EVP_aria_256_gcm(), - -ARIA for 128, 192 and 256 bit keys in CBC-MAC Mode (CCM) and Galois Counter -Mode (GCM). These ciphers require additional control operations to function -correctly, see the L section for details. - -=back - -=head1 RETURN VALUES - -These functions return an B structure that contains the -implementation of the symmetric cipher. See L for -details of the B structure. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut - diff --git a/doc/man3/EVP_aria_128_gcm.pod b/doc/man3/EVP_aria_128_gcm.pod new file mode 100644 index 0000000000..6471acb249 --- /dev/null +++ b/doc/man3/EVP_aria_128_gcm.pod @@ -0,0 +1,117 @@ +=pod + +=head1 NAME + +EVP_aria_128_cbc, +EVP_aria_192_cbc, +EVP_aria_256_cbc, +EVP_aria_128_cfb, +EVP_aria_192_cfb, +EVP_aria_256_cfb, +EVP_aria_128_cfb1, +EVP_aria_192_cfb1, +EVP_aria_256_cfb1, +EVP_aria_128_cfb8, +EVP_aria_192_cfb8, +EVP_aria_256_cfb8, +EVP_aria_128_cfb128, +EVP_aria_192_cfb128, +EVP_aria_256_cfb128, +EVP_aria_128_ctr, +EVP_aria_192_ctr, +EVP_aria_256_ctr, +EVP_aria_128_ecb, +EVP_aria_192_ecb, +EVP_aria_256_ecb, +EVP_aria_128_ofb, +EVP_aria_192_ofb, +EVP_aria_256_ofb, +EVP_aria_128_ccm, +EVP_aria_192_ccm, +EVP_aria_256_ccm, +EVP_aria_128_gcm, +EVP_aria_192_gcm, +EVP_aria_256_gcm, +- EVP ARIA cipher + +=head1 SYNOPSIS + +=for openssl generic + + #include + + const EVP_CIPHER *EVP_ciphername(void) + +I is used a placeholder for any of the described cipher +functions, such as I. + +=head1 DESCRIPTION + +The ARIA encryption algorithm for EVP. + +=over 4 + +=item EVP_aria_128_cbc(), +EVP_aria_192_cbc(), +EVP_aria_256_cbc(), +EVP_aria_128_cfb(), +EVP_aria_192_cfb(), +EVP_aria_256_cfb(), +EVP_aria_128_cfb1(), +EVP_aria_192_cfb1(), +EVP_aria_256_cfb1(), +EVP_aria_128_cfb8(), +EVP_aria_192_cfb8(), +EVP_aria_256_cfb8(), +EVP_aria_128_cfb128(), +EVP_aria_192_cfb128(), +EVP_aria_256_cfb128(), +EVP_aria_128_ctr(), +EVP_aria_192_ctr(), +EVP_aria_256_ctr(), +EVP_aria_128_ecb(), +EVP_aria_192_ecb(), +EVP_aria_256_ecb(), +EVP_aria_128_ofb(), +EVP_aria_192_ofb(), +EVP_aria_256_ofb() + +ARIA for 128, 192 and 256 bit keys in the following modes: CBC, CFB with +128-bit shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB and OFB. + +=item EVP_aria_128_ccm(), +EVP_aria_192_ccm(), +EVP_aria_256_ccm(), +EVP_aria_128_gcm(), +EVP_aria_192_gcm(), +EVP_aria_256_gcm(), + +ARIA for 128, 192 and 256 bit keys in CBC-MAC Mode (CCM) and Galois Counter +Mode (GCM). These ciphers require additional control operations to function +correctly, see the L section for details. + +=back + +=head1 RETURN VALUES + +These functions return an B structure that contains the +implementation of the symmetric cipher. See L for +details of the B structure. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut + diff --git a/doc/man3/EVP_camellia.pod b/doc/man3/EVP_camellia.pod deleted file mode 100644 index 4a57f79512..0000000000 --- a/doc/man3/EVP_camellia.pod +++ /dev/null @@ -1,100 +0,0 @@ -=pod - -=head1 NAME - -EVP_camellia_128_cbc, -EVP_camellia_192_cbc, -EVP_camellia_256_cbc, -EVP_camellia_128_cfb, -EVP_camellia_192_cfb, -EVP_camellia_256_cfb, -EVP_camellia_128_cfb1, -EVP_camellia_192_cfb1, -EVP_camellia_256_cfb1, -EVP_camellia_128_cfb8, -EVP_camellia_192_cfb8, -EVP_camellia_256_cfb8, -EVP_camellia_128_cfb128, -EVP_camellia_192_cfb128, -EVP_camellia_256_cfb128, -EVP_camellia_128_ctr, -EVP_camellia_192_ctr, -EVP_camellia_256_ctr, -EVP_camellia_128_ecb, -EVP_camellia_192_ecb, -EVP_camellia_256_ecb, -EVP_camellia_128_ofb, -EVP_camellia_192_ofb, -EVP_camellia_256_ofb -- EVP Camellia cipher - -=head1 SYNOPSIS - -=for openssl generic - - #include - - const EVP_CIPHER *EVP_ciphername(void) - -I is used a placeholder for any of the described cipher -functions, such as I. - -=head1 DESCRIPTION - -The Camellia encryption algorithm for EVP. - -=over 4 - -=item EVP_camellia_128_cbc(), -EVP_camellia_192_cbc(), -EVP_camellia_256_cbc(), -EVP_camellia_128_cfb(), -EVP_camellia_192_cfb(), -EVP_camellia_256_cfb(), -EVP_camellia_128_cfb1(), -EVP_camellia_192_cfb1(), -EVP_camellia_256_cfb1(), -EVP_camellia_128_cfb8(), -EVP_camellia_192_cfb8(), -EVP_camellia_256_cfb8(), -EVP_camellia_128_cfb128(), -EVP_camellia_192_cfb128(), -EVP_camellia_256_cfb128(), -EVP_camellia_128_ctr(), -EVP_camellia_192_ctr(), -EVP_camellia_256_ctr(), -EVP_camellia_128_ecb(), -EVP_camellia_192_ecb(), -EVP_camellia_256_ecb(), -EVP_camellia_128_ofb(), -EVP_camellia_192_ofb(), -EVP_camellia_256_ofb() - -Camellia for 128, 192 and 256 bit keys in the following modes: CBC, CFB with -128-bit shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB and OFB. - -=back - -=head1 RETURN VALUES - -These functions return an B structure that contains the -implementation of the symmetric cipher. See L for -details of the B structure. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut - diff --git a/doc/man3/EVP_camellia_128_ecb.pod b/doc/man3/EVP_camellia_128_ecb.pod new file mode 100644 index 0000000000..4a57f79512 --- /dev/null +++ b/doc/man3/EVP_camellia_128_ecb.pod @@ -0,0 +1,100 @@ +=pod + +=head1 NAME + +EVP_camellia_128_cbc, +EVP_camellia_192_cbc, +EVP_camellia_256_cbc, +EVP_camellia_128_cfb, +EVP_camellia_192_cfb, +EVP_camellia_256_cfb, +EVP_camellia_128_cfb1, +EVP_camellia_192_cfb1, +EVP_camellia_256_cfb1, +EVP_camellia_128_cfb8, +EVP_camellia_192_cfb8, +EVP_camellia_256_cfb8, +EVP_camellia_128_cfb128, +EVP_camellia_192_cfb128, +EVP_camellia_256_cfb128, +EVP_camellia_128_ctr, +EVP_camellia_192_ctr, +EVP_camellia_256_ctr, +EVP_camellia_128_ecb, +EVP_camellia_192_ecb, +EVP_camellia_256_ecb, +EVP_camellia_128_ofb, +EVP_camellia_192_ofb, +EVP_camellia_256_ofb +- EVP Camellia cipher + +=head1 SYNOPSIS + +=for openssl generic + + #include + + const EVP_CIPHER *EVP_ciphername(void) + +I is used a placeholder for any of the described cipher +functions, such as I. + +=head1 DESCRIPTION + +The Camellia encryption algorithm for EVP. + +=over 4 + +=item EVP_camellia_128_cbc(), +EVP_camellia_192_cbc(), +EVP_camellia_256_cbc(), +EVP_camellia_128_cfb(), +EVP_camellia_192_cfb(), +EVP_camellia_256_cfb(), +EVP_camellia_128_cfb1(), +EVP_camellia_192_cfb1(), +EVP_camellia_256_cfb1(), +EVP_camellia_128_cfb8(), +EVP_camellia_192_cfb8(), +EVP_camellia_256_cfb8(), +EVP_camellia_128_cfb128(), +EVP_camellia_192_cfb128(), +EVP_camellia_256_cfb128(), +EVP_camellia_128_ctr(), +EVP_camellia_192_ctr(), +EVP_camellia_256_ctr(), +EVP_camellia_128_ecb(), +EVP_camellia_192_ecb(), +EVP_camellia_256_ecb(), +EVP_camellia_128_ofb(), +EVP_camellia_192_ofb(), +EVP_camellia_256_ofb() + +Camellia for 128, 192 and 256 bit keys in the following modes: CBC, CFB with +128-bit shift, CFB with 1-bit shift, CFB with 8-bit shift, CTR, ECB and OFB. + +=back + +=head1 RETURN VALUES + +These functions return an B structure that contains the +implementation of the symmetric cipher. See L for +details of the B structure. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut + diff --git a/doc/man3/EVP_des.pod b/doc/man3/EVP_des.pod deleted file mode 100644 index d00179eacb..0000000000 --- a/doc/man3/EVP_des.pod +++ /dev/null @@ -1,106 +0,0 @@ -=pod - -=head1 NAME - -EVP_des_cbc, -EVP_des_cfb, -EVP_des_cfb1, -EVP_des_cfb8, -EVP_des_cfb64, -EVP_des_ecb, -EVP_des_ofb, -EVP_des_ede, -EVP_des_ede_cbc, -EVP_des_ede_cfb, -EVP_des_ede_cfb64, -EVP_des_ede_ecb, -EVP_des_ede_ofb, -EVP_des_ede3, -EVP_des_ede3_cbc, -EVP_des_ede3_cfb, -EVP_des_ede3_cfb1, -EVP_des_ede3_cfb8, -EVP_des_ede3_cfb64, -EVP_des_ede3_ecb, -EVP_des_ede3_ofb, -EVP_des_ede3_wrap -- EVP DES cipher - -=head1 SYNOPSIS - -=for openssl generic - - #include - - const EVP_CIPHER *EVP_ciphername(void) - -I is used a placeholder for any of the described cipher -functions, such as I. - -=head1 DESCRIPTION - -The DES encryption algorithm for EVP. - -=over 4 - -=item EVP_des_cbc(), -EVP_des_ecb(), -EVP_des_cfb(), -EVP_des_cfb1(), -EVP_des_cfb8(), -EVP_des_cfb64(), -EVP_des_ofb() - -DES in CBC, ECB, CFB with 64-bit shift, CFB with 1-bit shift, CFB with 8-bit -shift and OFB modes. - -=item EVP_des_ede(), -EVP_des_ede_cbc(), -EVP_des_ede_cfb(), -EVP_des_ede_cfb64(), -EVP_des_ede_ecb(), -EVP_des_ede_ofb() - -Two key triple DES in ECB, CBC, CFB with 64-bit shift and OFB modes. - -=item EVP_des_ede3(), -EVP_des_ede3_cbc(), -EVP_des_ede3_cfb(), -EVP_des_ede3_cfb1(), -EVP_des_ede3_cfb8(), -EVP_des_ede3_cfb64(), -EVP_des_ede3_ecb(), -EVP_des_ede3_ofb() - -Three-key triple DES in ECB, CBC, CFB with 64-bit shift, CFB with 1-bit shift, -CFB with 8-bit shift and OFB modes. - -=item EVP_des_ede3_wrap() - -Triple-DES key wrap according to RFC 3217 Section 3. - -=back - -=head1 RETURN VALUES - -These functions return an B structure that contains the -implementation of the symmetric cipher. See L for -details of the B structure. - -=head1 SEE ALSO - -L, -L, -L - -=head1 COPYRIGHT - -Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut - diff --git a/doc/man3/EVP_des_cbc.pod b/doc/man3/EVP_des_cbc.pod new file mode 100644 index 0000000000..d00179eacb --- /dev/null +++ b/doc/man3/EVP_des_cbc.pod @@ -0,0 +1,106 @@ +=pod + +=head1 NAME + +EVP_des_cbc, +EVP_des_cfb, +EVP_des_cfb1, +EVP_des_cfb8, +EVP_des_cfb64, +EVP_des_ecb, +EVP_des_ofb, +EVP_des_ede, +EVP_des_ede_cbc, +EVP_des_ede_cfb, +EVP_des_ede_cfb64, +EVP_des_ede_ecb, +EVP_des_ede_ofb, +EVP_des_ede3, +EVP_des_ede3_cbc, +EVP_des_ede3_cfb, +EVP_des_ede3_cfb1, +EVP_des_ede3_cfb8, +EVP_des_ede3_cfb64, +EVP_des_ede3_ecb, +EVP_des_ede3_ofb, +EVP_des_ede3_wrap +- EVP DES cipher + +=head1 SYNOPSIS + +=for openssl generic + + #include + + const EVP_CIPHER *EVP_ciphername(void) + +I is used a placeholder for any of the described cipher +functions, such as I. + +=head1 DESCRIPTION + +The DES encryption algorithm for EVP. + +=over 4 + +=item EVP_des_cbc(), +EVP_des_ecb(), +EVP_des_cfb(), +EVP_des_cfb1(), +EVP_des_cfb8(), +EVP_des_cfb64(), +EVP_des_ofb() + +DES in CBC, ECB, CFB with 64-bit shift, CFB with 1-bit shift, CFB with 8-bit +shift and OFB modes. + +=item EVP_des_ede(), +EVP_des_ede_cbc(), +EVP_des_ede_cfb(), +EVP_des_ede_cfb64(), +EVP_des_ede_ecb(), +EVP_des_ede_ofb() + +Two key triple DES in ECB, CBC, CFB with 64-bit shift and OFB modes. + +=item EVP_des_ede3(), +EVP_des_ede3_cbc(), +EVP_des_ede3_cfb(), +EVP_des_ede3_cfb1(), +EVP_des_ede3_cfb8(), +EVP_des_ede3_cfb64(), +EVP_des_ede3_ecb(), +EVP_des_ede3_ofb() + +Three-key triple DES in ECB, CBC, CFB with 64-bit shift, CFB with 1-bit shift, +CFB with 8-bit shift and OFB modes. + +=item EVP_des_ede3_wrap() + +Triple-DES key wrap according to RFC 3217 Section 3. + +=back + +=head1 RETURN VALUES + +These functions return an B structure that contains the +implementation of the symmetric cipher. See L for +details of the B structure. + +=head1 SEE ALSO + +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut + diff --git a/doc/man7/EVP_MAC-KMAC.pod b/doc/man7/EVP_MAC-KMAC.pod index ac94f6b5f7..0801a19781 100644 --- a/doc/man7/EVP_MAC-KMAC.pod +++ b/doc/man7/EVP_MAC-KMAC.pod @@ -2,7 +2,7 @@ =head1 NAME -EVP_MAC-KMAC, EVP_MAC-KMAC256, EVP_MAC-KMAC256 +EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256 - The KMAC EVP_MAC implementations =head1 DESCRIPTION diff --git a/doc/man7/openssl-core.h.pod b/doc/man7/openssl-core.h.pod index 55d53fe262..b5323e9d21 100644 --- a/doc/man7/openssl-core.h.pod +++ b/doc/man7/openssl-core.h.pod @@ -10,7 +10,7 @@ openssl/core.h - OpenSSL Core types =head1 DESCRIPTION -The header file defines a number of public types that +The F<< >> header defines a number of public types that are used to communicate between the OpenSSL libraries and implementation providers. These types are designed to minimise the need for intimate knowledge @@ -30,7 +30,7 @@ Arrays of this type must be terminated with a tuple having function identity zero and function pointer NULL. The available function identities and corresponding function -signatures are defined by L. +signatures are defined in L. Any function identity not recognised by the recipient of this type will be ignored. diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod index c5415a5441..cd999f880e 100644 --- a/doc/man7/provider-cipher.pod +++ b/doc/man7/provider-cipher.pod @@ -112,7 +112,7 @@ structure for holding context information during a cipher operation. A pointer to this context will be passed back in a number of the other cipher operation function calls. The parameter I is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_cipher_freectx() is passed a pointer to the provider side cipher context in the I parameter. diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod index 159a0e0b76..576ea581b4 100644 --- a/doc/man7/provider-digest.pod +++ b/doc/man7/provider-digest.pod @@ -100,7 +100,7 @@ structure for holding context information during a digest operation. A pointer to this context will be passed back in a number of the other digest operation function calls. The parameter I is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_digest_freectx() is passed a pointer to the provider side digest context in the I parameter. @@ -132,7 +132,7 @@ The digest should not exceed I bytes. OP_digest_digest() is a "oneshot" digest function. No provider side digest context is used. Instead the provider context that was created during provider initialisation is -passed in the I parameter (see L). +passed in the I parameter (see L). I bytes at I should be digested and the result should be stored at I. The length of the digest should be stored in I<*outl> which should not exceed I bytes. diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod index 0f7752cf8f..dc5bdfc005 100644 --- a/doc/man7/provider-keyexch.pod +++ b/doc/man7/provider-keyexch.pod @@ -88,7 +88,7 @@ structure for holding context information during a key exchange operation. A pointer to this context will be passed back in a number of the other key exchange operation function calls. The paramater I is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_keyexch_freectx() is passed a pointer to the provider side key exchange context in the I parameter. diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index 1a2e43130b..f11ca42d76 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -94,7 +94,7 @@ structure for holding context information during a mac operation. A pointer to this context will be passed back in a number of the other mac operation function calls. The paramater I is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_mac_freectx() is passed a pointer to the provider side mac context in the I parameter. diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod index fa446737bb..48fbe2ce04 100644 --- a/doc/man7/provider-signature.pod +++ b/doc/man7/provider-signature.pod @@ -112,7 +112,7 @@ structure for holding context information during a signature operation. A pointer to this context will be passed back in a number of the other signature operation function calls. The parameter I is the provider context generated during provider -initialisation (see L). +initialisation (see L). OP_signature_freectx() is passed a pointer to the provider side signature context in the I parameter.