xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_set_connect_state.3 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL_SET_CONNECT_STATE 3"
SSL_SET_CONNECT_STATE 3 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #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); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBSSL_set_connect_state() sets ssl to work in client mode.

\fBSSL_set_accept_state() sets ssl to work in server mode.

\fBSSL_is_server() checks if ssl is working in server mode.

"NOTES"
Header "NOTES" When the \s-1SSL_CTX\s0 object was created with 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 \fBSSL_CTX_set_ssl_version\|(3) or \fBSSL_set_ssl_method\|(3).)

When beginning a new handshake, the \s-1SSL\s0 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 SSL_connect\|(3) or \fBSSL_accept\|(3) routines, the correct handshake routines are automatically set. When performing a transparent negotiation using SSL_write_ex\|(3), SSL_write\|(3), SSL_read_ex\|(3), or SSL_read\|(3), the handshake routines must be explicitly set in advance using either \fBSSL_set_connect_state() or SSL_set_accept_state().

If SSL_is_server() is called before SSL_set_connect_state() or \fBSSL_set_accept_state() is called (either automatically or explicitly), the result depends on what method was used when \s-1SSL_CTX\s0 was created with \fBSSL_CTX_new\|(3). If a generic method or a dedicated server method was passed to SSL_CTX_new\|(3), SSL_is_server() returns 1; otherwise, it returns 0.

"RETURN VALUES"
Header "RETURN VALUES" \fBSSL_set_connect_state() and SSL_set_accept_state() do not return diagnostic information.

\fBSSL_is_server() returns 1 if ssl is working in server mode or 0 for client mode.

"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), SSL_new\|(3), SSL_CTX_new\|(3), \fBSSL_connect\|(3), SSL_accept\|(3), \fBSSL_write_ex\|(3), SSL_write\|(3), SSL_read_ex\|(3), SSL_read\|(3), \fBSSL_do_handshake\|(3), \fBSSL_CTX_set_ssl_version\|(3)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2001-2017 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.