Index for Section 3

Alphabetical listing for S

Bottom of page

SSL_set_shutdown(3)
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 );

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

  The SSL_get_shutdown() function returns the shutdown mode of ssl.

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

  0	  No shutdown setting, yet.

  SSL_SENT_SHUTDOWN
	  A close notify shutdown alert was sent to the peer, the connection
	  is being considered closed and the session is closed and correct.

  SSL_RECEIVED_SHUTDOWN
	  A shutdown alert was received form the peer, either a normal close
	  notify or a fatal error.

  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() or SSL_free() is
  called, it is considered bad and removed according to RFC2246. The actual
  condition for a correctly closed session is SSL_SENT_SHUTDOWN. Acording to
  the TLS RFC, it is acceptable to only send the "close notify" alert but not
  wait for the peer's answer, when the underlying connection is closed.

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

RETURN VALUES
  The SSL_set_shutdown() function does not return diagnostic information.

  The SSL_get_shutdown() function returns the current setting.

SEE ALSO
  Functions: ssl(3), SSL_shutdown(3), SSL_CTX_set_quiet_shutdown(3)
  SSL_clear(3), SSL_free(3)

Index for Section 3

Alphabetical listing for S

Top of page