1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE appref SYSTEM "appref.dtd">
<appref>
<header>
<copyright>
<year>1999</year><year>2015</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
</legalnotice>
<title>ssl</title>
<prepared></prepared>
<docno></docno>
<date></date>
<rev></rev>
<file>ssl_app.sgml</file>
</header>
<app>ssl</app>
<appsummary>The ssl application provides secure communication over
sockets.</appsummary>
<description></description>
<section>
<title>DEPENDENCIES</title>
<p>The <c>ssl</c> application uses the <c>public_key</c> and
<c>crypto</c> application to handle public keys and encryption, hence
these applications must be loaded for the <c>ssl</c> application to work.
In an embedded environment this means they must be started with
<c>application:start/[1,2]</c> before the <c>ssl</c> application is
started.</p>
</section>
<section>
<title>CONFIGURATION</title>
<p>The application environment configuration parameters in this section
are defined for the <c>ssl</c> application. For more information
about configuration parameters, see the
<seealso marker="kernel:application">application(3)</seealso>
manual page in <c>kernel</c>.</p>
<p>The environment parameters can be set on the command line,
for example:</p>
<p><c>erl ... -ssl protocol_version '[sslv3, tlsv1]' ...</c>.</p>
<taglist>
<tag><c><![CDATA[protocol_version = [sslv3|tlsv1] <optional>]]></c>.</tag>
<item><p>Protocol supported by started clients and
servers. If this option is not set, it defaults to all
protocols currently supported by the <c>ssl</c> application.
This option can be overridden by the version option
to <c>ssl:connect/[2,3]</c> and <c>ssl:listen/2</c>.</p></item>
<tag><c><![CDATA[session_lifetime = integer() <optional>]]></c></tag>
<item><p>Lifetime of the session data in seconds.</p></item>
<tag><c><![CDATA[session_cb = atom() <optional>]]></c></tag>
<item><p>Name of the session cache callback module that implements
the <c>ssl_session_cache_api</c> behavior. Defaults to
<c>ssl_session_cache.erl</c>.</p></item>
<tag><c><![CDATA[session_cb_init_args = proplist:proplist() <optional>]]></c></tag>
<item><p>List of extra user-defined arguments to the <c>init</c> function
in the session cache callback module. Defaults to <c>[]</c>.</p></item>
<tag><c><![CDATA[ssl_pem_cache_clean = integer() <optional>]]></c></tag>
<item>
<p>
Number of milliseconds between PEM cache validations.
</p>
<seealso
marker="ssl#clear_pem_cache-0">ssl:clear_pem_cache/0</seealso>
</item>
</taglist>
</section>
<section>
<title>ERROR LOGGER AND EVENT HANDLERS</title>
<p>The <c>ssl</c> applications has no error logger or event handlers.</p>
</section>
<section>
<title>SEE ALSO</title>
<p><seealso marker="kernel:application">application(3)</seealso></p>
</section>
</appref>
|
