Debian Codegraph @

upstream/debian-unstable/man3/RSA_new.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_NEW 3SSL"
58 .TH RSA_NEW 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_new, RSA_free \- allocate and free RSA objects
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rsa.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 1
76 \& RSA *RSA_new(void);
77 \&
78 \& void RSA_free(RSA *rsa);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBRSA_new()\fR allocates and initializes an \fBRSA\fR structure. It is equivalent to
83 calling RSA_new_method(NULL).
84 .PP
85 \&\fBRSA_free()\fR frees the \fBRSA\fR structure and its components. The key is
86 erased before the memory is returned to the system.
87 If \fBrsa\fR is NULL nothing is done.
88 .SH "RETURN VALUES"
89 .IX Header "RETURN VALUES"
90 If the allocation fails, \fBRSA_new()\fR returns \fBNULL\fR and sets an error
91 code that can be obtained by \fBERR_get_error\fR\|(3). Otherwise it returns
92 a pointer to the newly allocated structure.
93 .PP
94 \&\fBRSA_free()\fR returns no value.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBERR_get_error\fR\|(3),
98 \&\fBRSA_generate_key\fR\|(3),
99 \&\fBRSA_new_method\fR\|(3)
100 .SH HISTORY
101 .IX Header "HISTORY"
102 All functions described here were deprecated in OpenSSL 3.0.
103 For replacement see \fBEVP_PKEY\-RSA\fR\|(7).
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.