Debian Codegraph @

upstream/debian-unstable/man3/OPENSSL_fork_prepare.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 "OPENSSL_FORK_PREPARE 3SSL"
58 .TH OPENSSL_FORK_PREPARE 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 OPENSSL_fork_prepare,
65 OPENSSL_fork_parent,
66 OPENSSL_fork_child
67 \&\- OpenSSL fork handlers
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& #include <openssl/crypto.h>
72 .Ve
73 .PP
74 The following functions have been deprecated since OpenSSL 3.0, and can be
75 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
76 see \fBopenssl_user_macros\fR\|(7):
77 .PP
78 .Vb 3
79 \& void OPENSSL_fork_prepare(void);
80 \& void OPENSSL_fork_parent(void);
81 \& void OPENSSL_fork_child(void);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 These methods are currently unused, and as such, no replacement methods are
86 required or planned.
87 .PP
88 OpenSSL has state that should be reset when a process forks. For example,
89 the entropy pool used to generate random numbers (and therefore encryption
90 keys) should not be shared across multiple programs.
91 The \fBOPENSSL_fork_prepare()\fR, \fBOPENSSL_fork_parent()\fR, and \fBOPENSSL_fork_child()\fR
92 functions are used to reset this internal state.
93 .PP
94 Platforms without \fBfork\fR\|(2) will probably not need to use these functions.
95 Platforms with \fBfork\fR\|(2) but without \fBpthread_atfork\fR\|(3) will probably need
96 to call them manually, as described in the following paragraph. Platforms
97 such as Linux that have both functions will normally not need to call these
98 functions as the OpenSSL library will do so automatically.
99 .PP
100 \&\fBOPENSSL_init_crypto\fR\|(3) will register these functions with the appropriate
101 handler, when the \fBOPENSSL_INIT_ATFORK\fR flag is used. For other
102 applications, these functions can be called directly. They should be used
103 according to the calling sequence described by the \fBpthread_atfork\fR\|(3)
104 documentation, which is summarized here. \fBOPENSSL_fork_prepare()\fR should
105 be called before a \fBfork()\fR is done. After the \fBfork()\fR returns, the parent
106 process should call \fBOPENSSL_fork_parent()\fR and the child process should
107 call \fBOPENSSL_fork_child()\fR.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 \&\fBOPENSSL_fork_prepare()\fR, \fBOPENSSL_fork_parent()\fR and \fBOPENSSL_fork_child()\fR do not
111 return values.
112 .SH "SEE ALSO"
113 .IX Header "SEE ALSO"
114 \&\fBOPENSSL_init_crypto\fR\|(3)
115 .SH HISTORY
116 .IX Header "HISTORY"
117 These functions were added in OpenSSL 1.1.1.
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2017\-2020 The OpenSSL Project Authors. All Rights Reserved.
121 .PP
122 Licensed under the Apache License 2.0 (the "License"). You may not use
123 this file except in compliance with the License. You can obtain a copy
124 in the file LICENSE in the source distribution or at
125 <https://www.openssl.org/source/license.html>.