xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/SSL_SESSION_set1_id.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: SSL_SESSION_set1_id.3,v 1.9 2024/09/08 13:08:34 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_SESSION_set1_id 3"
SSL_SESSION_set1_id 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
SSL_SESSION_get_id, SSL_SESSION_set1_id \- get and set the SSL session ID
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len); int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid, unsigned int sid_len); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_SESSION_get_id() returns a pointer to the internal session id value for the session s. The length of the id in bytes is stored in *len. The length may be 0. The caller should not free the returned pointer directly.

\fBSSL_SESSION_set1_id() sets the session ID for the ssl SSL/TLS session to sid of length sid_len.

"RETURN VALUES"
Header "RETURN VALUES" \fBSSL_SESSION_get_id() returns a pointer to the session id value. \fBSSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example if the supplied session ID length exceeds SSL_MAX_SSL_SESSION_ID_LENGTH.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7)
HISTORY
Header "HISTORY" The SSL_SESSION_set1_id() function was added in OpenSSL 1.1.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.