openssl/doc/ssl/SSL_get_version.pod
Matt Caswell 85032506d6 Update version docs
Make it clear that you should not attempt to get the version before the
first handshake is complete.

Fixes #2893

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6015)
2018-04-27 10:14:05 +01:00

57 lines
879 B
Plaintext

=pod
=head1 NAME
SSL_get_version - get the protocol version of a connection.
=head1 SYNOPSIS
#include <openssl/ssl.h>
const char *SSL_get_version(const SSL *ssl);
=head1 DESCRIPTION
SSL_get_version() returns the name of the protocol used for the
connection B<ssl>. It should only be called after the initial handshake has been
completed. Prior to that the results returned from this function may be
unreliable.
=head1 RETURN VALUES
The following strings can be returned:
=over 4
=item SSLv2
The connection uses the SSLv2 protocol.
=item SSLv3
The connection uses the SSLv3 protocol.
=item TLSv1
The connection uses the TLSv1.0 protocol.
=item TLSv1.1
The connection uses the TLSv1.1 protocol.
=item TLSv1.2
The connection uses the TLSv1.2 protocol.
=item unknown
This indicates an unknown protocol version.
=back
=head1 SEE ALSO
L<ssl(3)|ssl(3)>
=cut