aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAli Sabil <[email protected]>2012-03-23 07:32:44 +0100
committerAli Sabil <[email protected]>2012-03-23 07:32:44 +0100
commit0c2cb207b9065bf73d3cb9e062b668143f4e105b (patch)
tree4d6f0908be5869e89d848211f3a33d829ad95b78
parent9ac784df3b41bf31df4e77a65ccf90cb67aa0014 (diff)
downloadcowboy-0c2cb207b9065bf73d3cb9e062b668143f4e105b.tar.gz
cowboy-0c2cb207b9065bf73d3cb9e062b668143f4e105b.tar.bz2
cowboy-0c2cb207b9065bf73d3cb9e062b668143f4e105b.zip
Update the edoc for cowboy_ssl_transport:listen/1
-rw-r--r--src/cowboy_ssl_transport.erl9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/cowboy_ssl_transport.erl b/src/cowboy_ssl_transport.erl
index efe3dba..8074209 100644
--- a/src/cowboy_ssl_transport.erl
+++ b/src/cowboy_ssl_transport.erl
@@ -48,13 +48,16 @@ messages() -> {ssl, ssl_closed, ssl_error}.
%% by default.</dd>
%% <dt>certfile</dt><dd>Mandatory. Path to a file containing the user's
%% certificate.</dd>
-%% <dt>keyfile</dt><dd>Mandatory. Path to the file containing the user's
+%% <dt>keyfile</dt><dd>Optional. Path to the file containing the user's
%% private PEM encoded key.</dd>
%% <dt>cacertfile</dt><dd>Optional. Path to file containing PEM encoded
%% CA certificates (trusted certificates used for verifying a peer
%% certificate).</dd>
-%% <dt>password</dt><dd>Mandatory. String containing the user's password.
+%% <dt>password</dt><dd>Optional. String containing the user's password.
%% All private keyfiles must be password protected currently.</dd>
+%% <dt>ciphers</dt><dd>Optional. The cipher suites that should be supported.
+%% The function ssl:cipher_suites/0 can be used to find all available
+%% ciphers.</dd>
%% </dl>
%%
%% @see ssl:listen/2
@@ -74,8 +77,8 @@ listen(Opts) ->
ListenOpts = lists:foldl(fun
({ip, _} = Ip, Acc) -> [Ip | Acc];
({keyfile, _} = KeyFile, Acc) -> [KeyFile | Acc];
- ({password, _} = Password, Acc) -> [Password | Acc];
({cacertfile, _} = CACertFile, Acc) -> [CACertFile | Acc];
+ ({password, _} = Password, Acc) -> [Password | Acc];
({ciphers, _} = Ciphers, Acc) -> [Ciphers | Acc];
(_, Acc) -> Acc
end, ListenOpts0, Opts),