aboutsummaryrefslogtreecommitdiff
path: root/openssl-1.1.0h/doc/ssl/SSL_get_version.pod
blob: 23b6497d4f3ba6c18f00fadccd2c1f6fb6fc4969 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
=pod

=head1 NAME

SSL_get_version, SSL_is_dtls - get the protocol information of a connection

=head1 SYNOPSIS

 #include <openssl/ssl.h>

 const char *SSL_get_version(const SSL *ssl);

 int SSL_is_dtls(const SSL *ssl);

=head1 DESCRIPTION

SSL_get_version() returns the name of the protocol used for the
connection B<ssl>.

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

=head1 RETURN VALUES

SSL_get_version() returns one of the following strings:

=over 4

=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 that no version has been set (no connection established).

=back

=head1 SEE ALSO

L<ssl(3)>

=head1 HISTORY

SSL_is_dtls() was added in OpenSSL 1.1.0.

=head1 COPYRIGHT

Copyright 2001-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