diff options
| author | Ingela Anderton Andin <[email protected]> | 2015-09-16 10:48:12 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2015-09-16 10:48:12 +0200 |
| commit | a12b70fa98eee10650c9de78d7d91516a2989999 (patch) | |
| tree | 016d7910e943c7a98710589063e116596da53545 /lib/ssl/doc | |
| parent | e802c5d8152440cc59003f04271f7f1934453db4 (diff) | |
| parent | 82aafa295a4004bcbd549c5bb888907e3ffc0c97 (diff) | |
| download | otp-a12b70fa98eee10650c9de78d7d91516a2989999.tar.gz otp-a12b70fa98eee10650c9de78d7d91516a2989999.tar.bz2 otp-a12b70fa98eee10650c9de78d7d91516a2989999.zip | |
Merge branch 'ia/ssl/downgrade/alert_timout/OTP-11397/OTP-12832' into maint
* ia/ssl/downgrade/alert_timout/OTP-11397/OTP-12832:
ssl: Better timeout gaurds
ssl: Improve shutdown logic
Diffstat (limited to 'lib/ssl/doc')
| -rw-r--r-- | lib/ssl/doc/src/ssl.xml | 15 | ||||
| -rw-r--r-- | lib/ssl/doc/src/ssl_app.xml | 11 |
2 files changed, 26 insertions, 0 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 6c977bdb74..22ac98c24e 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -766,6 +766,21 @@ fun(srp, Username :: string(), UserState :: term()) -> </func> <func> + <name>close(SslSocket, How) -> ok | {ok, port()} | {error, Reason}</name> + <fsummary>Closes an SSL connection.</fsummary> + <type> + <v>SslSocket = sslsocket()</v> + <v>How = timeout() | {NewController::pid(), timeout()} </v> + <v>Reason = term()</v> + </type> + <desc><p>Closes or downgrades an SSL connection, in the later case the transport + connection will be handed over to the <c>NewController</c> process after reciving + the TLS close alert from the peer. The retuned transport socket will have + the following options set [{active, false}, {packet, 0}, {mode, binary}].</p> + </desc> + </func> + + <func> <name>connection_info(SslSocket) -> {ok, {ProtocolVersion, CipherSuite}} | {error, Reason}</name> <fsummary>Returns the Negotiated Protocol version and cipher suite. diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml index 2b6dc7e8be..51ce0cedf1 100644 --- a/lib/ssl/doc/src/ssl_app.xml +++ b/lib/ssl/doc/src/ssl_app.xml @@ -87,6 +87,17 @@ marker="ssl#clear_pem_cache-0">ssl:clear_pem_cache/0</seealso> </item> + <tag><c><![CDATA[alert_timeout = integer() <optional>]]></c></tag> + <item> + <p> + Number of milliseconds between sending of a fatal alert and + closing the connection. Waiting a little while improves the + peers chances to properly receiving the alert so it may + shutdown gracefully. Defaults to 5000 milliseconds. + </p> + </item> + + </taglist> </section> |