Commit ddba302a authored by Matt Caswell's avatar Matt Caswell
Browse files

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: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6013)
parent ff25dd1a

doc/man3/SSL_get_version.pod

+6 −7
Original line number Original line Diff line number Diff line
@@ -20,15 +20,14 @@ protocol information of a connection 
=head1 DESCRIPTION

=head1 DESCRIPTION





SSL_client_version() returns the protocol version used by the client when

SSL_client_version() returns the protocol version used by the client when

initiating the connection.

initiating the connection. SSL_get_version() returns the name of the protocol



used for the connection. SSL_version() returns the protocol version used for the

SSL_get_version() returns the name of the protocol used for the

connection. They should only be called after the initial handshake has been

connection.

completed. Prior to that the results returned from these functions may be

unreliable.





SSL_is_dtls() returns one if the connection is using DTLS, zero if not.

SSL_is_dtls() returns one if the connection is using DTLS, zero if not.





SSL_version() returns the protocol version used for the connection.



=head1 RETURN VALUES

=head1 RETURN VALUES





SSL_get_version() returns one of the following strings:

SSL_get_version() returns one of the following strings:
@@ -57,7 +56,7 @@ The connection uses the TLSv1.3 protocol. 




=item unknown

=item unknown





This indicates that no version has been set (no connection established).

This indicates an unknown protocol version.





=back

=back