diff options
Diffstat (limited to 'deps/openssl/openssl/doc/man3/SSL_set_connect_state.pod')
-rw-r--r-- | deps/openssl/openssl/doc/man3/SSL_set_connect_state.pod | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/deps/openssl/openssl/doc/man3/SSL_set_connect_state.pod b/deps/openssl/openssl/doc/man3/SSL_set_connect_state.pod new file mode 100644 index 0000000000..37bfa8fb54 --- /dev/null +++ b/deps/openssl/openssl/doc/man3/SSL_set_connect_state.pod @@ -0,0 +1,77 @@ +=pod + +=head1 NAME + +SSL_set_connect_state, SSL_set_accept_state, SSL_is_server +- functions for manipulating and examining the client or server mode of an SSL object + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + void SSL_set_connect_state(SSL *ssl); + + void SSL_set_accept_state(SSL *ssl); + + int SSL_is_server(const SSL *ssl); + +=head1 DESCRIPTION + +SSL_set_connect_state() sets B<ssl> to work in client mode. + +SSL_set_accept_state() sets B<ssl> to work in server mode. + +SSL_is_server() checks if B<ssl> is working in server mode. + +=head1 NOTES + +When the SSL_CTX object was created with L<SSL_CTX_new(3)>, +it was either assigned a dedicated client method, a dedicated server +method, or a generic method, that can be used for both client and +server connections. (The method might have been changed with +L<SSL_CTX_set_ssl_version(3)> or +L<SSL_set_ssl_method(3)>.) + +When beginning a new handshake, the SSL engine must know whether it must +call the connect (client) or accept (server) routines. Even though it may +be clear from the method chosen, whether client or server mode was +requested, the handshake routines must be explicitly set. + +When using the L<SSL_connect(3)> or +L<SSL_accept(3)> routines, the correct handshake +routines are automatically set. When performing a transparent negotiation +using L<SSL_write_ex(3)>, L<SSL_write(3)>, L<SSL_read_ex(3)>, or L<SSL_read(3)>, +the handshake routines must be explicitly set in advance using either +SSL_set_connect_state() or SSL_set_accept_state(). + +If SSL_is_server() is called before SSL_set_connect_state() or +SSL_set_accept_state() is called (either automatically or explicitly), +the result depends on what method was used when SSL_CTX was created with +L<SSL_CTX_new(3)>. If a generic method or a dedicated server method was +passed to L<SSL_CTX_new(3)>, SSL_is_server() returns 1; otherwise, it returns 0. + +=head1 RETURN VALUES + +SSL_set_connect_state() and SSL_set_accept_state() do not return diagnostic +information. + +SSL_is_server() returns 1 if B<ssl> is working in server mode or 0 for client mode. + +=head1 SEE ALSO + +L<ssl(7)>, L<SSL_new(3)>, L<SSL_CTX_new(3)>, +L<SSL_connect(3)>, L<SSL_accept(3)>, +L<SSL_write_ex(3)>, L<SSL_write(3)>, L<SSL_read_ex(3)>, L<SSL_read(3)>, +L<SSL_do_handshake(3)>, +L<SSL_CTX_set_ssl_version(3)> + +=head1 COPYRIGHT + +Copyright 2001-2017 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 |