doc_ssltls.h 1.3 KB

1234567891011121314151617181920212223242526272829303132
  1. /**
  2. * @file
  3. * SSL/TLS communication module documentation file.
  4. */
  5. /**
  6. * @addtogroup ssltls_communication_module SSL/TLS communication module
  7. *
  8. * The SSL/TLS communication module provides the means to create an SSL/TLS
  9. * communication channel.
  10. * The basic provisions are:
  11. * - initialise an SSL/TLS context (see \c ssl_init()).
  12. * - perform an SSL/TLS handshake (see \c ssl_handshake()).
  13. * - read/write (see \c ssl_read() and \c ssl_write()).
  14. * - notify a peer that conection is being closed (see \c ssl_close_notify()).
  15. *
  16. *
  17. * Many aspects of such a channel are set through parameters and callback
  18. * functions:
  19. * - the endpoint role: client or server.
  20. * - the authentication mode. Should verification take place.
  21. * - the Host-to-host communication channel. A TCP/IP module is provided.
  22. * - the random number generator (RNG).
  23. * - the ciphers to use for encryption/decryption.
  24. * - session control functions.
  25. * - X.509 parameters for certificate-handling and key exchange.
  26. *
  27. *
  28. * This module can be used to create an SSL/TLS server and client and to provide a basic
  29. * framework to setup and communicate through an SSL/TLS communication channel.\n
  30. * Note that you need to provide for several aspects yourself as mentioned above.
  31. */