diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2015-01-24 17:09:55 +0000 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2015-02-03 14:50:08 +0000 |
commit | 156a872233b56558c72561789b8f33ff71a88fa7 (patch) | |
tree | d3191cd09ec050b2f5adee82bfb8dc20b6250c14 /doc/ssl/SSL_get_extms_support.pod | |
parent | 6668b6b8b0c1bcb6c6168ab22159a12cac41ae79 (diff) |
Add SSL_get_extms_support documentation.
Document SSL_get_extms_support().
Modify behaviour of SSL_get_extms_support() so it returns -1 if the
master secret support of the peer is not known (e.g. handshake in progress).
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc/ssl/SSL_get_extms_support.pod')
-rw-r--r-- | doc/ssl/SSL_get_extms_support.pod | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/ssl/SSL_get_extms_support.pod b/doc/ssl/SSL_get_extms_support.pod new file mode 100644 index 0000000000..427819a5ab --- /dev/null +++ b/doc/ssl/SSL_get_extms_support.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +SSL_get_extms_support - extended master secret support + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_get_extms_support(SSL *ssl); + +=head1 DESCRIPTION + +SSL_get_extms_support() indicates whether the current session used extended +master secret. + +This function is implemented as a macro. + +=head1 RETURN VALUES + +SSL_get_extms_support() returns 1 if the current session used extended +master secret, 0 if it did not and -1 if a handshake is currently in +progress i.e. it is not possible to determine if extended master secret +was used. + +=back + +=head1 SEE ALSO + +L<ssl(3)|ssl(3)> + +=cut |