User's Guide
Reference Manual
Release Notes
PDF
Top

Secure Socket Layer
Reference Manual
Version 5.1

Expand All
Contract All

Table of Contents

- ssl (App)
- ssl
  - Top of manual page
  - cipher_suites/0
  - cipher_suites/1
  - connect/2
  - connect/3
  - connect/3
  - connect/4
  - close/1
  - controlling_process/2
  - connection_info/1
  - format_error/1
  - getopts/2
  - listen/2
  - peercert/1
  - peername/1
  - recv/2
  - recv/3
  - prf/5
  - renegotiate/1
  - send/2
  - setopts/2
  - shutdown/2
  - ssl_accept/1
  - ssl_accept/2
  - ssl_accept/2
  - ssl_accept/3
  - sockname/1
  - start/0
  - start/1
  - stop/0
  - transport_accept/1
  - transport_accept/2
  - versions/0
- ssl_session_cache_api
  - Top of manual page
  - delete/2
  - foldl/3
  - init/0
  - lookup/2
  - select_session/2
  - terminate/1
  - update/3

# ssl

### APPLICATION

ssl

### APPLICATION SUMMARY

The SSL application provides secure communication over sockets.

### Environment

The following application environment configuration parameters are defined for the SSL application. Refer to application(3) for more information about configuration parameters.

Note that the environment parameters can be set on the command line, for instance,

erl ... -ssl protocol_version '[sslv3, tlsv1]' ....

protocol_version = [sslv3|tlsv1] <optional>.

  Protocol that will be supported by started clients and servers. If this option is not set it will default to all protocols currently supported by the erlang ssl application. Note that this option may be overridden by the version option to ssl:connect/[2,3] and ssl:listen/2.

session_lifetime = integer() <optional>

  The lifetime of session data in seconds.

session_cb = atom() <optional>

  Name of session cache callback module that implements the ssl_session_cache_api behavior, defaults to ssl_session_cache.erl.

session_cb_init_args = list() <optional>

  List of arguments to the init function in session cache callback module, defaults to [].

### SEE ALSO

application(3)