skip book previous and next navigation links
go up to top of book: HP Open Source Security for OpenVMS Volume 2:... HP Open Source Security for OpenVMS Volume 2:...
go to beginning of reference: SSL Application Programming Interface (API) Reference SSL Application Programming Interface (API) Reference
go to previous page: SSL_set_session SSL_set_session
go to next page: SSL_set_verify_resultSSL_set_verify_result
end of book navigation links


SSL_set_shutdown
Description
Notes
Return Values
See Also
 

NAME

SSL_set_shutdown, SSL_get_shutdown - manipulate shutdown state of an SSL connection

Synopsis  

#include <openssl/ssl.h>
void SSL_set_shutdown(SSL *ssl, int mode);
int SSL_get_shutdown(SSL *ssl);


return to top DESCRIPTION  

SSL_set_shutdown() sets the shutdown state of ssl to mode.

SSL_get_shutdown() returns the shutdown mode of ssl.


return to top NOTES  

The shutdown state of an ssl connection is a bitmask of:

SSL_SENT_SHUTDOWN and SSL_RECEIVED_SHUTDOWN can be set at the same time.

The shutdown state of the connection is used to determine the state of the ssl session. If the session is still open, when SSL_clear(3) or SSL_free(3) is called, it is considered bad and removed according to RFC2246. The actual condition for a correctly closed session is SSL_SENT_SHUTDOWN (according to the TLS RFC, it is acceptable to only send the "close notify" alert but to not wait for the peer's answer, when the underlying connection is closed). SSL_set_shutdown() can be used to set this state without sending a close alert to the peer (see SSL_shutdown(3) ).

If a "close notify" was received, SSL_RECEIVED_SHUTDOWN will be set, for setting SSL_SENT_SHUTDOWN the application must however still call SSL_shutdown(3) or SSL_set_shutdown() itself.


return to top RETURN VALUES  

SSL_set_shutdown() does not return diagnostic information.

SSL_get_shutdown() returns the current setting.


return to top SEE ALSO  

ssl(3) , SSL_shutdown(3) , SSL_CTX_set_quiet_shutdown(3) , SSL_clear(3) , SSL_free(3)
go to previous page: SSL_set_session SSL_set_session
go to next page: SSL_set_verify_resultSSL_set_verify_result