From 3058ef6bb7a2a3f96cfde819976ee7a52be65364 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin
Date: Wed, 20 Feb 2019 15:51:21 +0100
Subject: ssl: Enhance documentation after "use-spec-rewrite"
---
lib/ssl/doc/src/ssl.xml | 66 +++++++++++++++++++++++++------------------------
1 file changed, 34 insertions(+), 32 deletions(-)
(limited to 'lib/ssl/doc')
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 21ea1be4b4..67ec93809f 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -55,7 +55,7 @@
- An opaque reference to the TLS/DTLS connection.
+ An opaque reference to the TLS/DTLS connection, may be used for equality matching.
@@ -86,14 +86,6 @@
-
-
-
-
-
-
-
-
@@ -119,11 +111,7 @@
-
-
-
-
-
+
@@ -147,12 +135,14 @@
-
-
-
+
+
+
+
+
@@ -190,7 +180,10 @@
-
+
+
+
+
@@ -200,7 +193,7 @@
-
+
@@ -231,6 +224,10 @@
+
+
+
+
@@ -366,8 +363,8 @@
The verification fun is to be defined as follows:
-fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom() | {revoked,
-atom()}} |
+fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom() |
+ {revoked, atom()}} |
{extension, #'Extension'{}}, InitialUserState :: term()) ->
{valid, UserState :: term()} | {valid_peer, UserState :: term()} |
{fail, Reason :: term()} | {unknown, UserState :: term()}.
@@ -580,7 +577,8 @@ fun(Chain::[public_key:der_encoded()]) ->
fun(psk, PSKIdentity ::string(), UserState :: term()) ->
{ok, SharedSecret :: binary()} | error;
fun(srp, Username :: string(), UserState :: term()) ->
- {ok, {SRPParams :: srp_param_type(), Salt :: binary(), DerivedKey :: binary()}} | error.
+ {ok, {SRPParams :: srp_param_type(), Salt :: binary(),
+ DerivedKey :: binary()}} | error.
For Pre-Shared Key (PSK) cipher suites, the lookup fun is
@@ -658,7 +656,11 @@ fun(srp, Username :: string(), UserState :: term()) ->
-
+
+
+ Deprecated since OTP-17, has no affect.
+
+
TLS/DTLS OPTION DESCRIPTIONS - CLIENT
@@ -1079,7 +1081,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
cipher_suites() ->
- cipher_suites(Type) -> old_ciphers()
+ cipher_suites(Type) -> [old_cipher_suite()]
Returns a list of supported cipher suites.
Type = erlang | openssl | all
@@ -1140,10 +1142,10 @@ fun(srp, Username :: string(), UserState :: term()) ->
equivalent, connected socket to an TLS socket.
Socket = socket()
- Options = [client_option()]
+ Options = [tls_client_option()]
Timeout = timeout()
SslSocket = sslsocket()
- Ext = hello_extensions()
+ Ext = protocol_extensions()
Reason = closed | timeout | error_alert()
Upgrades a gen_tcp, or equivalent,
@@ -1184,7 +1186,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
Host = host()
Port = inet:port_number()
- Options = [client_option()]
+ Options = [tls_client_option()]
Timeout = timeout()
SslSocket = sslsocket()
Reason = closed | timeout | error_alert()
@@ -1393,8 +1395,8 @@ fun(srp, Username :: string(), UserState :: term()) ->
Socket = socket() | socket()
SslSocket = sslsocket()
- Ext = hello_extensions()
- Options = [server_option()]
+ Ext = protocol_extensions()
+ Options = [server_option()]
Timeout = timeout()
Reason = closed | timeout | error_alert()
@@ -1464,7 +1466,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
Creates an SSL listen socket.
Port = inet:port_number()
- Options = [server_option()]
+ Options = [server_option()]
ListenSocket = sslsocket()
@@ -1539,7 +1541,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
Socket = sslsocket()
Secret = binary() | master_secret
Label = binary()
- Seed = [binary() | prf_random()]
+ Seed = [binary() | prf_random()]
WantedLength = non_neg_integer()
@@ -1658,7 +1660,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
Performs server-side SSL/TLS/DTLS handshake.
Socket = socket() | sslsocket()
- Options = [server_option()]
+ Options = [server_option()]
Timeout = timeout()
Reason = closed | timeout | error_alert()
--
cgit v1.2.3