aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc
diff options
context:
space:
mode:
authorIngela Anderton Andin <[email protected]>2018-07-02 12:25:08 +0200
committerIngela Anderton Andin <[email protected]>2018-07-04 11:02:46 +0200
commit26ed7aa618b4860340d646f8f2b545857cee1289 (patch)
tree21869348d7a99cf5bc0ab639fd09a8283fdee4c6 /lib/ssl/doc
parente6d9c7eb9e62e220bfb6a5e1b5c1b991c7b9c121 (diff)
downloadotp-26ed7aa618b4860340d646f8f2b545857cee1289.tar.gz
otp-26ed7aa618b4860340d646f8f2b545857cee1289.tar.bz2
otp-26ed7aa618b4860340d646f8f2b545857cee1289.zip
ssl: Add connection information on new cipher_suite format
Diffstat (limited to 'lib/ssl/doc')
-rw-r--r--lib/ssl/doc/src/ssl.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index e3deb1c8a4..6e124c3513 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -1066,7 +1066,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
</fsummary>
<type>
<v>SslSocket = sslsocket()</v>
- <v>Item = protocol | cipher_suite | sni_hostname | ecc | session_id | atom()</v>
+ <v>Item = protocol | selected_cipher_suite | sni_hostname | ecc | session_id | atom()</v>
<d>Meaningful atoms, not specified above, are the ssl option names.</d>
<v>Result = [{Item::atom(), Value::term()}]</v>
<v>Reason = term()</v>
@@ -1074,6 +1074,9 @@ fun(srp, Username :: string(), UserState :: term()) ->
<desc><p>Returns the most relevant information about the connection, ssl options that
are undefined will be filtered out. Note that values that affect the security of the
connection will only be returned if explicitly requested by connection_information/2.</p>
+ <note><p>The legacy <c>Item = cipher_suite</c> is still supported
+ and returns the cipher suite on its (undocumented) legacy format.
+ It should be replaced by <c>selected_cipher_suite</c>.</p></note>
</desc>
</func>