Codebase list openssl / 31b7f23
Add documentation of the old names kept as alias macros Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15405) Tomas Mraz 2 years ago
6 changed file(s) with 139 addition(s) and 8 deletion(s). Raw diff Collapse all Expand all
+7
-0
CHANGES.md less more
102102 * A public key check is now performed during EVP_PKEY_derive_set_peer().
103103
104104 *Shane Lontis*
105
106 * Many functions in the EVP_ namespace that are getters of values from
107 implementations or contexts were renamed to include get or get0 in their
108 names. Old names are provided as macro aliases for compatibility and
109 are not deprecated.
110
111 *Tomáš Mráz*
105112
106113 * The EVP_PKEY_CTRL_PKCS7_ENCRYPT, EVP_PKEY_CTRL_PKCS7_DECRYPT,
107114 EVP_PKEY_CTRL_PKCS7_SIGN, EVP_PKEY_CTRL_CMS_ENCRYPT,
+27
-5
doc/man3/EVP_DigestInit.pod less more
1212 EVP_Q_digest, EVP_Digest, EVP_DigestInit_ex2, EVP_DigestInit_ex, EVP_DigestInit,
1313 EVP_DigestUpdate, EVP_DigestFinal_ex, EVP_DigestFinalXOF, EVP_DigestFinal,
1414 EVP_MD_is_a, EVP_MD_get0_name, EVP_MD_get0_description, EVP_MD_get_number,
15 EVP_MD_names_do_all, EVP_MD_get0_provider,
16 EVP_MD_get_type, EVP_MD_get_pkey_type, EVP_MD_get_size, EVP_MD_get_block_size, EVP_MD_get_flags,
17 EVP_MD_CTX_get0_name,
18 EVP_MD_CTX_md, EVP_MD_CTX_get0_md, EVP_MD_CTX_get1_md,
15 EVP_MD_names_do_all, EVP_MD_get0_provider, EVP_MD_get_type,
16 EVP_MD_get_pkey_type, EVP_MD_get_size, EVP_MD_get_block_size, EVP_MD_get_flags,
17 EVP_MD_CTX_get0_name, EVP_MD_CTX_md, EVP_MD_CTX_get0_md, EVP_MD_CTX_get1_md,
1918 EVP_MD_CTX_get_type, EVP_MD_CTX_get_size, EVP_MD_CTX_get_block_size,
2019 EVP_MD_CTX_get0_md_data, EVP_MD_CTX_update_fn, EVP_MD_CTX_set_update_fn,
2120 EVP_md_null,
2221 EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj,
2322 EVP_MD_CTX_get_pkey_ctx, EVP_MD_CTX_set_pkey_ctx,
24 EVP_MD_do_all_provided
23 EVP_MD_do_all_provided,
24 EVP_MD_type, EVP_MD_nid, EVP_MD_name, EVP_MD_pkey_type, EVP_MD_size,
25 EVP_MD_block_size, EVP_MD_flags, EVP_MD_CTX_size, EVP_MD_CTX_block_size,
26 EVP_MD_CTX_type, EVP_MD_CTX_pkey_ctx, EVP_MD_CTX_md_data
2527 - EVP digest routines
2628
2729 =head1 SYNOPSIS
102104 void (*fn)(EVP_MD *mac, void *arg),
103105 void *arg);
104106
107 #define EVP_MD_type EVP_MD_get_type
108 #define EVP_MD_nid EVP_MD_get_type
109 #define EVP_MD_name EVP_MD_get0_name
110 #define EVP_MD_pkey_type EVP_MD_get_pkey_type
111 #define EVP_MD_size EVP_MD_get_size
112 #define EVP_MD_block_size EVP_MD_get_block_size
113 #define EVP_MD_flags EVP_MD_get_flags
114 #define EVP_MD_CTX_size EVP_MD_CTX_get_size
115 #define EVP_MD_CTX_block_size EVP_MD_CTX_get_block_size
116 #define EVP_MD_CTX_type EVP_MD_CTX_get_type
117 #define EVP_MD_CTX_pkey_ctx EVP_MD_CTX_get_pkey_ctx
118 #define EVP_MD_CTX_md_data EVP_MD_CTX_get0_md_data
119
105120 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
106121 B<OPENSSL_API_COMPAT> with a suitable version value, see
107122 L<openssl_user_macros(7)>:
717732 EVP_MD_settable_ctx_params(), EVP_MD_CTX_settable_params() and
718733 EVP_MD_CTX_gettable_params() functions were added in OpenSSL 3.0.
719734
735 The EVP_MD_type(), EVP_MD_nid(), EVP_MD_name(), EVP_MD_pkey_type(),
736 EVP_MD_size(), EVP_MD_block_size(), EVP_MD_flags(), EVP_MD_CTX_size(),
737 EVP_MD_CTX_block_size(), EVP_MD_CTX_type(), and EVP_MD_CTX_md_data()
738 functions were renamed to include C<get> or C<get0> in their names in
739 OpenSSL 3.0, respectively. The old names are kept as non-deprecated
740 alias macros.
741
720742 The EVP_MD_CTX_md() function was deprecated in OpenSSL 3.0; use
721743 EVP_MD_CTX_get0_md() instead.
722744 EVP_MD_CTX_update_fn() and EVP_MD_CTX_set_update_fn() were deprecated
+50
-1
doc/man3/EVP_EncryptInit.pod less more
7676 EVP_CIPHER_asn1_to_param,
7777 EVP_CIPHER_CTX_set_padding,
7878 EVP_enc_null,
79 EVP_CIPHER_do_all_provided
79 EVP_CIPHER_do_all_provided,
80 EVP_CIPHER_nid,
81 EVP_CIPHER_name,
82 EVP_CIPHER_block_size,
83 EVP_CIPHER_key_length,
84 EVP_CIPHER_iv_length,
85 EVP_CIPHER_flags,
86 EVP_CIPHER_mode,
87 EVP_CIPHER_type,
88 EVP_CIPHER_CTX_encrypting,
89 EVP_CIPHER_CTX_nid,
90 EVP_CIPHER_CTX_block_size,
91 EVP_CIPHER_CTX_key_length,
92 EVP_CIPHER_CTX_iv_length,
93 EVP_CIPHER_CTX_tag_length,
94 EVP_CIPHER_CTX_num,
95 EVP_CIPHER_CTX_type,
96 EVP_CIPHER_CTX_mode
8097 - EVP cipher routines
8198
8299 =head1 SYNOPSIS
194211 void EVP_CIPHER_do_all_provided(OSSL_LIB_CTX *libctx,
195212 void (*fn)(EVP_CIPHER *cipher, void *arg),
196213 void *arg);
214
215 #define EVP_CIPHER_nid EVP_CIPHER_get_nid
216 #define EVP_CIPHER_name EVP_CIPHER_get0_name
217 #define EVP_CIPHER_block_size EVP_CIPHER_get_block_size
218 #define EVP_CIPHER_key_length EVP_CIPHER_get_key_length
219 #define EVP_CIPHER_iv_length EVP_CIPHER_get_iv_length
220 #define EVP_CIPHER_flags EVP_CIPHER_get_flags
221 #define EVP_CIPHER_mode EVP_CIPHER_get_mode
222 #define EVP_CIPHER_type EVP_CIPHER_get_type
223 #define EVP_CIPHER_CTX_encrypting EVP_CIPHER_CTX_is_encrypting
224 #define EVP_CIPHER_CTX_nid EVP_CIPHER_CTX_get_nid
225 #define EVP_CIPHER_CTX_block_size EVP_CIPHER_CTX_get_block_size
226 #define EVP_CIPHER_CTX_key_length EVP_CIPHER_CTX_get_key_length
227 #define EVP_CIPHER_CTX_iv_length EVP_CIPHER_CTX_get_iv_length
228 #define EVP_CIPHER_CTX_tag_length EVP_CIPHER_CTX_get_tag_length
229 #define EVP_CIPHER_CTX_num EVP_CIPHER_CTX_get_num
230 #define EVP_CIPHER_CTX_type EVP_CIPHER_CTX_get_type
231 #define EVP_CIPHER_CTX_mode EVP_CIPHER_CTX_get_mode
197232
198233 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
199234 B<OPENSSL_API_COMPAT> with a suitable version value, see
16141649 EVP_CIPHER_CTX_settable_params() and EVP_CIPHER_CTX_gettable_params()
16151650 functions were added in 3.0.
16161651
1652 The EVP_CIPHER_nid(), EVP_CIPHER_name(), EVP_CIPHER_block_size(),
1653 EVP_CIPHER_key_length(), EVP_CIPHER_iv_length(), EVP_CIPHER_flags(),
1654 EVP_CIPHER_mode(), EVP_CIPHER_type(), EVP_CIPHER_CTX_nid(),
1655 EVP_CIPHER_CTX_block_size(), EVP_CIPHER_CTX_key_length(),
1656 EVP_CIPHER_CTX_iv_length(), EVP_CIPHER_CTX_tag_length(),
1657 EVP_CIPHER_CTX_num(), EVP_CIPHER_CTX_type(), and EVP_CIPHER_CTX_mode()
1658 functions were renamed to include C<get> or C<get0> in their names in
1659 OpenSSL 3.0, respectively. The old names are kept as non-deprecated
1660 alias macros.
1661
1662 The EVP_CIPHER_CTX_encrypting() function was renamed to
1663 EVP_CIPHER_CTX_is_encrypting() in OpenSSL 3.0. The old name is kept as
1664 non-deprecated alias macro.
1665
16171666 The EVP_CIPHER_CTX_flags() macro was deprecated in OpenSSL 1.1.0.
16181667
16191668 =head1 COPYRIGHT
+12
-1
doc/man3/EVP_PKEY_get_size.pod less more
11
22 =head1 NAME
33
4 EVP_PKEY_get_size, EVP_PKEY_get_bits, EVP_PKEY_get_security_bits
4 EVP_PKEY_get_size, EVP_PKEY_get_bits, EVP_PKEY_get_security_bits,
5 EVP_PKEY_bits, EVP_PKEY_security_bits, EVP_PKEY_size
56 - EVP_PKEY information functions
67
78 =head1 SYNOPSIS
1112 int EVP_PKEY_get_size(const EVP_PKEY *pkey);
1213 int EVP_PKEY_get_bits(const EVP_PKEY *pkey);
1314 int EVP_PKEY_get_security_bits(const EVP_PKEY *pkey);
15
16 #define EVP_PKEY_bits EVP_PKEY_get_bits
17 #define EVP_PKEY_security_bits EVP_PKEY_get_security_bits
18 #define EVP_PKEY_size EVP_PKEY_get_size
1419
1520 =head1 DESCRIPTION
1621
6772 L<EVP_PKEY_decrypt(3)>,
6873 L<EVP_PKEY_derive(3)>
6974
75 =head1 HISTORY
76
77 The EVP_PKEY_bits(), EVP_PKEY_security_bits(), and EVP_PKEY_size() functions
78 were renamed to include C<get> in their names in OpenSSL 3.0, respectively.
79 The old names are kept as non-deprecated alias macros.
80
7081 =head1 COPYRIGHT
7182
7283 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
+9
-1
doc/man3/EVP_PKEY_set1_RSA.pod less more
88 EVP_PKEY_assign_EC_KEY, EVP_PKEY_assign_POLY1305, EVP_PKEY_assign_SIPHASH,
99 EVP_PKEY_get0_hmac, EVP_PKEY_get0_poly1305, EVP_PKEY_get0_siphash,
1010 EVP_PKEY_get0, EVP_PKEY_type, EVP_PKEY_get_id, EVP_PKEY_get_base_id,
11 EVP_PKEY_set1_engine, EVP_PKEY_get0_engine -
11 EVP_PKEY_set1_engine, EVP_PKEY_get0_engine,
12 EVP_PKEY_id, EVP_PKEY_base_id -
1213 EVP_PKEY assignment functions
1314
1415 =head1 SYNOPSIS
1819 int EVP_PKEY_get_id(const EVP_PKEY *pkey);
1920 int EVP_PKEY_get_base_id(const EVP_PKEY *pkey);
2021 int EVP_PKEY_type(int type);
22
23 #define EVP_PKEY_id EVP_PKEY_get_id
24 #define EVP_PKEY_base_id EVP_PKEY_get_base_id
2125
2226 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
2327 B<OPENSSL_API_COMPAT> with a suitable version value, see
197201
198202 =head1 HISTORY
199203
204 The EVP_PKEY_id() and EVP_PKEY_base_id() functions were renamed to
205 include C<get> in their names in OpenSSL 3.0, respectively. The old names
206 are kept as non-deprecated alias macros.
207
200208 EVP_PKEY_set1_RSA, EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH, EVP_PKEY_set1_EC_KEY,
201209 EVP_PKEY_get1_RSA, EVP_PKEY_get1_DSA, EVP_PKEY_get1_DH, EVP_PKEY_get1_EC_KEY,
202210 EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH, EVP_PKEY_get0_EC_KEY,
+34
-0
util/other.syms less more
625625 TS_VERIFY_CTS_set_certs define deprecated 3.0.0
626626 EVP_PKEY_get1_tls_encodedpoint define deprecated 3.0.0
627627 EVP_PKEY_set1_tls_encodedpoint define deprecated 3.0.0
628 EVP_MD_type define
629 EVP_MD_nid define
630 EVP_MD_name define
631 EVP_MD_pkey_type define
632 EVP_MD_size define
633 EVP_MD_block_size define
634 EVP_MD_flags define
635 EVP_MD_CTX_size define
636 EVP_MD_CTX_block_size define
637 EVP_MD_CTX_type define
638 EVP_MD_CTX_pkey_ctx define
639 EVP_MD_CTX_md_data define
640 EVP_CIPHER_nid define
641 EVP_CIPHER_name define
642 EVP_CIPHER_block_size define
643 EVP_CIPHER_key_length define
644 EVP_CIPHER_iv_length define
645 EVP_CIPHER_flags define
646 EVP_CIPHER_mode define
647 EVP_CIPHER_type define
648 EVP_CIPHER_CTX_encrypting define
649 EVP_CIPHER_CTX_nid define
650 EVP_CIPHER_CTX_block_size define
651 EVP_CIPHER_CTX_key_length define
652 EVP_CIPHER_CTX_iv_length define
653 EVP_CIPHER_CTX_tag_length define
654 EVP_CIPHER_CTX_num define
655 EVP_CIPHER_CTX_type define
656 EVP_CIPHER_CTX_mode define
657 EVP_PKEY_bits define
658 EVP_PKEY_security_bits define
659 EVP_PKEY_size define
660 EVP_PKEY_id define
661 EVP_PKEY_base_id define