From 28e4dd20a4e2829293b540113f7d80facc7bddc2 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Thu, 2 May 2019 11:22:39 +0200
Subject: ssl: Add cipher suite convertion functions

---
 lib/ssl/doc/src/ssl.xml | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

(limited to 'lib/ssl/doc')

diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index d626748af6..3aa6e09c2c 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -1131,6 +1131,15 @@ fun(srp, Username :: string(), UserState :: term()) ->
     </desc>
     </func>
 
+    <func>
+      <name name="cipher_suites" arity="3" since="OTP 22.0"/>
+      <fsummary>Returns a list of RFC or OpenSSL names</fsummary>
+      <desc><p>Same as <seealso marker="#cipher_suites-2">cipher_suites/2</seealso>
+      but lists RFC or OpenSSL string names instead of <seealso marker="#type-erl_cipher_suite">erl_cipher_suite()</seealso>
+    </p>
+    </desc>
+    </func>
+    
     <func>
       <name name="eccs" arity="0" since="OTP 19.2"/>
       <name name="eccs" arity="1" since="OTP 19.2"/>
@@ -1563,12 +1572,36 @@ fun(srp, Username :: string(), UserState :: term()) ->
         <p>Stops the SSL application.</p>
       </desc>
     </func>
+  
+    <func>
+      <name since="OTP 22.0" name="str_to_suite" arity="1" />
+      <fsummary>Converts an RFC or OpenSSL name string to an erlang cipher suite format</fsummary>
+      <desc>
+        <p>Converts an RFC or OpenSSL name string to an
+	<seealso marker="#type-erl_cipher_suite">erl_cipher_suite()</seealso>
+	Returns an error if the cipher suite is not supported or the name is not a valid cipher suite name.</p>
+      </desc>
+    </func>
 
+    <func>
+      <name since="OTP 22.0" name="suite_to_openssl_str" arity="1" />
+      <fsummary>Converts erlang cipher suite format to an OpenSSL name string.
+      </fsummary>
+      <desc>
+        <p>Converts <seealso marker="#type-erl_cipher_suite">erl_cipher_suite()</seealso>
+	to OpenSSL name string. </p>
+	
+	<p>PRE TLS-1.3 these names differ for RFC names</p>
+	
+      </desc>
+    </func>
+    
     <func>
       <name since="OTP 21.0" name="suite_to_str" arity="1" clause_i="1" />
-      <fsummary>Returns the string representation of a cipher suite.</fsummary>
+      <fsummary>Converts an erlang cipher suite to an RFC name string.</fsummary>
       <desc>
-        <p>Returns the string representation of a cipher suite.</p>
+        <p>Converts <seealso marker="#type-erl_cipher_suite">erl_cipher_suite()</seealso>
+	to RFC name string.</p>
       </desc>
     </func>
 
-- 
cgit v1.2.3