Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_get0_id_context.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 "SSL_SESSION_GET0_ID_CONTEXT 3SSL"
58 .TH SSL_SESSION_GET0_ID_CONTEXT 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 SSL_SESSION_get0_id_context,
65 SSL_SESSION_set1_id_context
66 \&\- get and set the SSL ID context associated with a session
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
73 \& unsigned int *len);
74 \& int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
75 \& unsigned int sid_ctx_len);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 See \fBSSL_CTX_set_session_id_context\fR\|(3) for further details on session ID
80 contexts.
81 .PP
82 \&\fBSSL_SESSION_get0_id_context()\fR returns the ID context associated with
83 the SSL/TLS session \fBs\fR. The length of the ID context is written to
84 \&\fB*len\fR if \fBlen\fR is not NULL.
85 .PP
86 The value returned is a pointer to an object maintained within \fBs\fR and
87 should not be released.
88 .PP
89 \&\fBSSL_SESSION_set1_id_context()\fR takes a copy of the provided ID context given in
90 \&\fBsid_ctx\fR and associates it with the session \fBs\fR. The length of the ID context
91 is given by \fBsid_ctx_len\fR which must not exceed SSL_MAX_SID_CTX_LENGTH bytes.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 \&\fBSSL_SESSION_set1_id_context()\fR returns 1 on success or 0 on error.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBssl\fR\|(7),
98 \&\fBSSL_set_session_id_context\fR\|(3)
99 .SH HISTORY
100 .IX Header "HISTORY"
101 The \fBSSL_SESSION_get0_id_context()\fR function was added in OpenSSL 1.1.0.
102 .SH COPYRIGHT
103 .IX Header "COPYRIGHT"
104 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
105 .PP
106 Licensed under the Apache License 2.0 (the "License"). You may not use
107 this file except in compliance with the License. You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 <https://www.openssl.org/source/license.html>.