Provide documentation for i2d_ECPrivateKey and d2i_ECPrivateKey
[openssl.git] / doc / crypto / 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  int RSA_print(BIO *bp, RSA *x, int offset);
14  int RSA_print_fp(FILE *fp, RSA *x, int offset);
15
16  #include <openssl/dsa.h>
17
18  int DSAparams_print(BIO *bp, DSA *x);
19  int DSAparams_print_fp(FILE *fp, DSA *x);
20  int DSA_print(BIO *bp, DSA *x, int offset);
21  int DSA_print_fp(FILE *fp, DSA *x, int offset);
22
23  #include <openssl/dh.h>
24
25  int DHparams_print(BIO *bp, DH *x);
26  int DHparams_print_fp(FILE *fp, DH *x);
27
28 =head1 DESCRIPTION
29
30 A human-readable hexadecimal output of the components of the RSA
31 key, DSA parameters or key or DH parameters is printed to B<bp> or B<fp>.
32
33 The output lines are indented by B<offset> spaces.
34
35 =head1 RETURN VALUES
36
37 These functions return 1 on success, 0 on error.
38
39 =head1 SEE ALSO
40
41 L<dh(3)|dh(3)>, L<dsa(3)|dsa(3)>, L<rsa(3)|rsa(3)>, L<BN_bn2bin(3)|BN_bn2bin(3)>
42
43 =head1 HISTORY
44
45 RSA_print(), RSA_print_fp(), DSA_print(), DSA_print_fp(), DH_print(),
46 DH_print_fp() are available in all versions of SSLeay and OpenSSL.
47 DSAparams_print() and DSAparams_print_fp() were added in SSLeay 0.8.
48
49 =cut