Debian Codegraph @

upstream/debian-unstable/man3/BIO_s_core.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 "BIO_S_CORE 3SSL"
58 .TH BIO_S_CORE 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 BIO_s_core, BIO_new_from_core_bio \- OSSL_CORE_BIO functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bio.h>
69 \&
70 \& const BIO_METHOD *BIO_s_core(void);
71 \&
72 \& BIO *BIO_new_from_core_bio(OSSL_LIB_CTX *libctx, OSSL_CORE_BIO *corebio);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBBIO_s_core()\fR returns the core BIO method function.
77 .PP
78 A core BIO is treated as source/sink BIO which communicates to some external
79 BIO. This is primarily useful to provider authors. A number of calls from
80 libcrypto into a provider supply an OSSL_CORE_BIO parameter. This represents
81 a BIO within libcrypto, but cannot be used directly by a provider. Instead it
82 should be wrapped using a \fBBIO_s_core()\fR.
83 .PP
84 Once a BIO is constructed based on \fBBIO_s_core()\fR, the associated OSSL_CORE_BIO
85 object should be set on it using \fBBIO_set_data\fR\|(3). Note that the BIO will only
86 operate correctly if it is associated with a library context constructed using
87 \&\fBOSSL_LIB_CTX_new_from_dispatch\fR\|(3). To associate the BIO with a library context
88 construct it using \fBBIO_new_ex\fR\|(3).
89 .PP
90 \&\fBBIO_new_from_core_bio()\fR is a convenience function that constructs a new BIO
91 based on \fBBIO_s_core()\fR and that is associated with the given library context. It
92 then also sets the OSSL_CORE_BIO object on the BIO using \fBBIO_set_data\fR\|(3).
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 \&\fBBIO_s_core()\fR return a core BIO \fBBIO_METHOD\fR structure.
96 .PP
97 \&\fBBIO_new_from_core_bio()\fR returns a BIO structure on success or NULL on failure.
98 A failure will most commonly be because the library context was not constructed
99 using \fBOSSL_LIB_CTX_new_from_dispatch\fR\|(3).
100 .SH HISTORY
101 .IX Header "HISTORY"
102 \&\fBBIO_s_core()\fR and \fBBIO_new_from_core_bio()\fR were added in OpenSSL 3.0.
103 .SH EXAMPLES
104 .IX Header "EXAMPLES"
105 Create a core BIO and write some data to it:
106 .PP
107 .Vb 2
108 \& int some_function(OSSL_LIB_CTX *libctx, OSSL_CORE_BIO *corebio) {
109 \& BIO *cbio = BIO_new_from_core_bio(libctx, corebio);
110 \&
111 \& if (cbio == NULL)
112 \& return 0;
113 \&
114 \& BIO_puts(cbio, "Hello World\en");
115 \&
116 \& BIO_free(cbio);
117 \& return 1;
118 \& }
119 .Ve
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright 2021\-2022 The OpenSSL Project Authors. All Rights Reserved.
123 .PP
124 Licensed under the Apache License 2.0 (the "License"). You may not use
125 this file except in compliance with the License. You can obtain a copy
126 in the file LICENSE in the source distribution or at
127 <https://www.openssl.org/source/license.html>.