Debian Codegraph @

upstream/debian-unstable/man3/d2i_SSL_SESSION.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 "D2I_SSL_SESSION 3SSL"
58 .TH D2I_SSL_SESSION 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 d2i_SSL_SESSION, d2i_SSL_SESSION_ex, i2d_SSL_SESSION \- convert SSL_SESSION object from/to ASN1 representation
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
71 \& long length);
72 \& SSL_SESSION *d2i_SSL_SESSION_ex(SSL_SESSION **a, const unsigned char **pp,
73 \& long length, OSSL_LIB_CTX *libctx,
74 \& const char *propq);
75 \& int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 These functions decode and encode an SSL_SESSION object.
80 For encoding details see \fBd2i_X509\fR\|(3).
81 .PP
82 SSL_SESSION objects keep internal link information about the session cache
83 list, when being inserted into one SSL_CTX object's session cache.
84 One SSL_SESSION object, regardless of its reference count, must therefore
85 only be used with one SSL_CTX object (and the SSL objects created
86 from this SSL_CTX object).
87 .SH "RETURN VALUES"
88 .IX Header "RETURN VALUES"
89 \&\fBd2i_SSL_SESSION()\fR and \fBd2i_SSL_SESSION_ex()\fR return a pointer to the newly
90 allocated SSL_SESSION object.
91 In case of failure the NULL-pointer is returned and the error message
92 can be retrieved from the error stack.
93 .PP
94 \&\fBi2d_SSL_SESSION()\fR returns the size of the ASN1 representation in bytes.
95 When the session is not valid, \fB0\fR is returned and no operation is performed.
96 .SH "SEE ALSO"
97 .IX Header "SEE ALSO"
98 \&\fBssl\fR\|(7), \fBSSL_SESSION_free\fR\|(3),
99 \&\fBSSL_CTX_sess_set_get_cb\fR\|(3),
100 \&\fBd2i_X509\fR\|(3)
101 .SH HISTORY
102 .IX Header "HISTORY"
103 The function \fBd2i_SSL_SESSION_ex()\fR was added in OpenSSL 3.2.
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2001\-2024 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>.