df75c2bfcd
While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
50 lines
1.4 KiB
Text
50 lines
1.4 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL_SESSION_get_id,
|
|
SSL_SESSION_set1_id
|
|
- get and set the SSL session ID
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#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);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
SSL_SESSION_get_id() returns a pointer to the internal session id value for the
|
|
session B<s>. The length of the id in bytes is stored in B<*len>. The length may
|
|
be 0. The caller should not free the returned pointer directly.
|
|
|
|
SSL_SESSION_set1_id() sets the session ID for the B<ssl> SSL/TLS session
|
|
to B<sid> of length B<sid_len>.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
SSL_SESSION_get_id() returns a pointer to the session id value.
|
|
SSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example
|
|
if the supplied session ID length exceeds B<SSL_MAX_SSL_SESSION_ID_LENGTH>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ssl(7)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The SSL_SESSION_set1_id() function was added in OpenSSL 1.1.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|