Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_set1_id.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_SET1_ID 3SSL"
58 .TH SSL_SESSION_SET1_ID 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_get_id,
65 SSL_SESSION_set1_id
66 \&\- get and set the SSL session ID
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
73 \& unsigned int *len);
74 \& int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
75 \& unsigned int sid_len);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBSSL_SESSION_get_id()\fR returns a pointer to the internal session id value for the
80 session \fBs\fR. The length of the id in bytes is stored in \fB*len\fR. The length may
81 be 0. The caller should not free the returned pointer directly.
82 .PP
83 \&\fBSSL_SESSION_set1_id()\fR sets the session ID for the \fBssl\fR SSL/TLS session
84 to \fBsid\fR of length \fBsid_len\fR.
85 .SH "RETURN VALUES"
86 .IX Header "RETURN VALUES"
87 \&\fBSSL_SESSION_get_id()\fR returns a pointer to the session id value.
88 \&\fBSSL_SESSION_set1_id()\fR returns 1 for success and 0 for failure, for example
89 if the supplied session ID length exceeds \fBSSL_MAX_SSL_SESSION_ID_LENGTH\fR.
90 .SH "SEE ALSO"
91 .IX Header "SEE ALSO"
92 \&\fBssl\fR\|(7)
93 .SH HISTORY
94 .IX Header "HISTORY"
95 The \fBSSL_SESSION_set1_id()\fR function was added in OpenSSL 1.1.0.
96 .SH COPYRIGHT
97 .IX Header "COPYRIGHT"
98 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
99 .PP
100 Licensed under the Apache License 2.0 (the "License"). You may not use
101 this file except in compliance with the License. You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 <https://www.openssl.org/source/license.html>.