SSL_accept.pod (76866) | SSL_accept.pod (89837) |
---|---|
1=pod 2 3=head1 NAME 4 5SSL_accept - wait for a TLS/SSL client to initiate a TLS/SSL handshake 6 7=head1 SYNOPSIS 8 9 #include <openssl/ssl.h> 10 11 int SSL_accept(SSL *ssl); 12 13=head1 DESCRIPTION 14 15SSL_accept() waits for a TLS/SSL client to initiate the TLS/SSL handshake. 16The communication channel must already have been set and assigned to the 17B<ssl> by setting an underlying B<BIO>. 18 19=head1 NOTES 20 21The behaviour of SSL_accept() depends on the underlying BIO. 22 23If the underlying BIO is B<blocking>, SSL_accept() will only return once the 24handshake has been finished or an error occurred, except for SGC (Server 25Gated Cryptography). For SGC, SSL_accept() may return with -1, but 26SSL_get_error() will yield B<SSL_ERROR_WANT_READ/WRITE> and SSL_accept() 27should be called again. 28 29If the underlying BIO is B<non-blocking>, SSL_accept() will also return 30when the underlying BIO could not satisfy the needs of SSL_accept() 31to continue the handshake. In this case a call to SSL_get_error() with the 32return value of SSL_accept() will yield B<SSL_ERROR_WANT_READ> or 33B<SSL_ERROR_WANT_WRITE>. The calling process then must repeat the call after 34taking appropriate action to satisfy the needs of SSL_accept(). 35The action depends on the underlying BIO. When using a non-blocking socket, 36nothing is to be done, but select() can be used to check for the required 37condition. When using a buffering BIO, like a BIO pair, data must be written 38into or retrieved out of the BIO before being able to continue. 39 | 1=pod 2 3=head1 NAME 4 5SSL_accept - wait for a TLS/SSL client to initiate a TLS/SSL handshake 6 7=head1 SYNOPSIS 8 9 #include <openssl/ssl.h> 10 11 int SSL_accept(SSL *ssl); 12 13=head1 DESCRIPTION 14 15SSL_accept() waits for a TLS/SSL client to initiate the TLS/SSL handshake. 16The communication channel must already have been set and assigned to the 17B<ssl> by setting an underlying B<BIO>. 18 19=head1 NOTES 20 21The behaviour of SSL_accept() depends on the underlying BIO. 22 23If the underlying BIO is B<blocking>, SSL_accept() will only return once the 24handshake has been finished or an error occurred, except for SGC (Server 25Gated Cryptography). For SGC, SSL_accept() may return with -1, but 26SSL_get_error() will yield B<SSL_ERROR_WANT_READ/WRITE> and SSL_accept() 27should be called again. 28 29If the underlying BIO is B<non-blocking>, SSL_accept() will also return 30when the underlying BIO could not satisfy the needs of SSL_accept() 31to continue the handshake. In this case a call to SSL_get_error() with the 32return value of SSL_accept() will yield B<SSL_ERROR_WANT_READ> or 33B<SSL_ERROR_WANT_WRITE>. The calling process then must repeat the call after 34taking appropriate action to satisfy the needs of SSL_accept(). 35The action depends on the underlying BIO. When using a non-blocking socket, 36nothing is to be done, but select() can be used to check for the required 37condition. When using a buffering BIO, like a BIO pair, data must be written 38into or retrieved out of the BIO before being able to continue. 39 |
40When using a generic method (see L<SSL_CTX_new(3)|SSL_CTX_new(3)>), it 41is necessary to call SSL_set_accept_state() 42before calling SSL_accept() to explicitly switch the B<ssl> to server 43mode. 44 | |
45=head1 RETURN VALUES 46 47The following return values can occur: 48 49=over 4 50 51=item 1 52 53The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been 54established. 55 56=item 0 57 58The TLS/SSL handshake was not successful but was shut down controlled and 59by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the 60return value B<ret> to find out the reason. 61 62=item E<lt>0 63 64The TLS/SSL handshake was not successful because a fatal error occurred either 65at the protocol level or a connection failure occurred. The shutdown was 66not clean. It can also occur of action is need to continue the operation 67for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> 68to find out the reason. 69 70=back 71 72=head1 SEE ALSO 73 74L<SSL_get_error(3)|SSL_get_error(3)>, L<SSL_connect(3)|SSL_connect(3)>, 75L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>, 76L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>, 77L<SSL_CTX_new(3)|SSL_CTX_new(3)> 78 79=cut | 40=head1 RETURN VALUES 41 42The following return values can occur: 43 44=over 4 45 46=item 1 47 48The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been 49established. 50 51=item 0 52 53The TLS/SSL handshake was not successful but was shut down controlled and 54by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the 55return value B<ret> to find out the reason. 56 57=item E<lt>0 58 59The TLS/SSL handshake was not successful because a fatal error occurred either 60at the protocol level or a connection failure occurred. The shutdown was 61not clean. It can also occur of action is need to continue the operation 62for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> 63to find out the reason. 64 65=back 66 67=head1 SEE ALSO 68 69L<SSL_get_error(3)|SSL_get_error(3)>, L<SSL_connect(3)|SSL_connect(3)>, 70L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>, 71L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>, 72L<SSL_CTX_new(3)|SSL_CTX_new(3)> 73 74=cut |