2
0

ssl.pod 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. =pod
  2. =head1 NAME
  3. ssl - OpenSSL SSL/TLS library
  4. =head1 SYNOPSIS
  5. See the individual manual pages for details.
  6. =head1 DESCRIPTION
  7. The OpenSSL B<ssl> library implements several versions of the
  8. Secure Sockets Layer, Transport Layer Security, and Datagram Transport Layer
  9. Security protocols.
  10. This page gives a brief overview of the extensive API and data types
  11. provided by the library.
  12. An B<SSL_CTX> object is created as a framework to establish
  13. TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
  14. Various options regarding certificates, algorithms etc. can be set
  15. in this object.
  16. When a network connection has been created, it can be assigned to an
  17. B<SSL> object. After the B<SSL> object has been created using
  18. L<SSL_new(3)>, L<SSL_set_fd(3)> or
  19. L<SSL_set_bio(3)> can be used to associate the network
  20. connection with the object.
  21. When the TLS/SSL handshake is performed using
  22. L<SSL_accept(3)> or L<SSL_connect(3)>
  23. respectively.
  24. L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> and L<SSL_write(3)> are
  25. used to read and write data on the TLS/SSL connection.
  26. L<SSL_shutdown(3)> can be used to shut down the
  27. TLS/SSL connection.
  28. =head1 DATA STRUCTURES
  29. Here are some of the main data structures in the library.
  30. =over 4
  31. =item B<SSL_METHOD> (SSL Method)
  32. This is a dispatch structure describing the internal B<ssl> library
  33. methods/functions which implement the various protocol versions (SSLv3
  34. TLSv1, ...). It's needed to create an B<SSL_CTX>.
  35. =item B<SSL_CIPHER> (SSL Cipher)
  36. This structure holds the algorithm information for a particular cipher which
  37. are a core part of the SSL/TLS protocol. The available ciphers are configured
  38. on a B<SSL_CTX> basis and the actual ones used are then part of the
  39. B<SSL_SESSION>.
  40. =item B<SSL_CTX> (SSL Context)
  41. This is the global context structure which is created by a server or client
  42. once per program life-time and which holds mainly default values for the
  43. B<SSL> structures which are later created for the connections.
  44. =item B<SSL_SESSION> (SSL Session)
  45. This is a structure containing the current TLS/SSL session details for a
  46. connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
  47. =item B<SSL> (SSL Connection)
  48. This is the main SSL/TLS structure which is created by a server or client per
  49. established connection. This actually is the core structure in the SSL API.
  50. At run-time the application usually deals with this structure which has
  51. links to mostly all other structures.
  52. =back
  53. =head1 HEADER FILES
  54. Currently the OpenSSL B<ssl> library provides the following C header files
  55. containing the prototypes for the data structures and functions:
  56. =over 4
  57. =item F<< <openssl/ssl.h> >>
  58. This is the common header file for the SSL/TLS API. Include it into your
  59. program to make the API of the B<ssl> library available. It internally
  60. includes both more private SSL headers and headers from the B<crypto> library.
  61. Whenever you need hard-core details on the internals of the SSL API, look
  62. inside this header file.
  63. This file also includes the others listed below.
  64. =item F<< <openssl/ssl2.h> >>
  65. Unused. Present for backwards compatibility only.
  66. =item F<< <openssl/ssl3.h> >>
  67. This is the sub header file dealing with the SSLv3 protocol only.
  68. =item F<< <openssl/tls1.h> >>
  69. This is the sub header file dealing with the TLSv1 protocol only.
  70. =back
  71. =head1 COPYRIGHT
  72. Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
  73. Licensed under the Apache License 2.0 (the "License"). You may not use
  74. this file except in compliance with the License. You can obtain a copy
  75. in the file LICENSE in the source distribution or at
  76. L<https://www.openssl.org/source/license.html>.
  77. =cut