Debian Codegraph @

upstream/debian-unstable/man3/RSA_print.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "RSA_PRINT 3SSL"
58 .TH RSA_PRINT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 RSA_print, RSA_print_fp,
65 DSAparams_print, DSAparams_print_fp, DSA_print, DSA_print_fp,
66 DHparams_print, DHparams_print_fp \- print cryptographic parameters
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/rsa.h>
71 .Ve
72 .PP
73 The following functions have been deprecated since OpenSSL 3.0, and can be
74 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
75 see \fBopenssl_user_macros\fR\|(7):
76 .PP
77 .Vb 2
78 \& int RSA_print(BIO *bp, const RSA *x, int offset);
79 \& int RSA_print_fp(FILE *fp, const RSA *x, int offset);
80 \&
81 \& #include <openssl/dsa.h>
82 .Ve
83 .PP
84 The following functions have been deprecated since OpenSSL 3.0, and can be
85 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
86 see \fBopenssl_user_macros\fR\|(7):
87 .PP
88 .Vb 4
89 \& int DSAparams_print(BIO *bp, const DSA *x);
90 \& int DSAparams_print_fp(FILE *fp, const DSA *x);
91 \& int DSA_print(BIO *bp, const DSA *x, int offset);
92 \& int DSA_print_fp(FILE *fp, const DSA *x, int offset);
93 \&
94 \& #include <openssl/dh.h>
95 .Ve
96 .PP
97 The following functions have been deprecated since OpenSSL 3.0, and can be
98 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
99 see \fBopenssl_user_macros\fR\|(7):
100 .PP
101 .Vb 2
102 \& int DHparams_print(BIO *bp, DH *x);
103 \& int DHparams_print_fp(FILE *fp, const DH *x);
104 .Ve
105 .SH DESCRIPTION
106 .IX Header "DESCRIPTION"
107 All of the functions described on this page are deprecated.
108 Applications should instead use \fBEVP_PKEY_print_params\fR\|(3) and
109 \&\fBEVP_PKEY_print_private\fR\|(3).
110 .PP
111 A human-readable hexadecimal output of the components of the RSA
112 key, DSA parameters or key or DH parameters is printed to \fBbp\fR or \fBfp\fR.
113 .PP
114 The output lines are indented by \fBoffset\fR spaces.
115 .SH "RETURN VALUES"
116 .IX Header "RETURN VALUES"
117 \&\fBDSAparams_print()\fR, \fBDSAparams_print_fp()\fR, \fBDSA_print()\fR, and \fBDSA_print_fp()\fR
118 return 1 for success and 0 or a negative value for failure.
119 .PP
120 \&\fBDHparams_print()\fR and \fBDHparams_print_fp()\fR return 1 on success, 0 on error.
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 .Vb 3
124 \& L<EVP_PKEY_print_params(3)>,
125 \& L<EVP_PKEY_print_private(3)>,
126 \& L<BN_bn2bin(3)>
127 .Ve
128 .SH HISTORY
129 .IX Header "HISTORY"
130 All of these functions were deprecated in OpenSSL 3.0.
131 .SH COPYRIGHT
132 .IX Header "COPYRIGHT"
133 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
134 .PP
135 Licensed under the Apache License 2.0 (the "License"). You may not use
136 this file except in compliance with the License. You can obtain a copy
137 in the file LICENSE in the source distribution or at
138 <https://www.openssl.org/source/license.html>.