Deprecate the low level DSA functions.
[openssl.git] / doc / man3 / RSA_print.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_print, RSA_print_fp,
6 DSAparams_print, DSAparams_print_fp, DSA_print, DSA_print_fp,
7 DHparams_print, DHparams_print_fp - print cryptographic parameters
8
9 =head1 SYNOPSIS
10
11  #include <openssl/rsa.h>
12
13 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
14 B<OPENSSL_API_COMPAT> with a suitable version value, see
15 L<openssl_user_macros(7)>:
16
17  int RSA_print(BIO *bp, RSA *x, int offset);
18  int RSA_print_fp(FILE *fp, RSA *x, int offset);
19
20  #include <openssl/dsa.h>
21
22 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
23 B<OPENSSL_API_COMPAT> with a suitable version value, see
24 L<openssl_user_macros(7)>:
25
26  int DSAparams_print(BIO *bp, DSA *x);
27  int DSAparams_print_fp(FILE *fp, DSA *x);
28  int DSA_print(BIO *bp, DSA *x, int offset);
29  int DSA_print_fp(FILE *fp, DSA *x, int offset);
30
31  #include <openssl/dh.h>
32
33 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
34 B<OPENSSL_API_COMPAT> with a suitable version value, see
35 L<openssl_user_macros(7)>:
36
37  int DHparams_print(BIO *bp, DH *x);
38  int DHparams_print_fp(FILE *fp, DH *x);
39
40 =head1 DESCRIPTION
41
42 All of the functions described on this page are deprecated.
43 Applications should instead use L<EVP_PKEY_print_params(3)> and
44 L<EVP_PKEY_print_private(3)>.
45
46 A human-readable hexadecimal output of the components of the RSA
47 key, DSA parameters or key or DH parameters is printed to B<bp> or B<fp>.
48
49 The output lines are indented by B<offset> spaces.
50
51 =head1 RETURN VALUES
52
53 These functions return 1 on success, 0 on error.
54
55 =head1 SEE ALSO
56
57  L<EVP_PKEY_print_params(3)>,
58  L<EVP_PKEY_print_private(3)>,
59  L<BN_bn2bin(3)>
60
61 =head1 HISTORY
62
63 All of these functions were deprecated in OpenSSL 3.0.
64
65 =head1 COPYRIGHT
66
67 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
68
69 Licensed under the Apache License 2.0 (the "License").  You may not use
70 this file except in compliance with the License.  You can obtain a copy
71 in the file LICENSE in the source distribution or at
72 L<https://www.openssl.org/source/license.html>.
73
74 =cut