From b3286ec182e6e1bd36e69d757c62a97485ba668b Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 17 May 2018 12:08:22 +0200
Subject: public_key: Doc

---
 lib/public_key/doc/src/public_key.xml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'lib/public_key/doc/src')

diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 7284da0499..5d57109140 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -986,9 +986,37 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
       <p>The <c>ip</c> Reference ID takes an <seealso marker="inet:inet#type-ip_address">inet:ip_address()</seealso>
       or an ip address in string format (E.g "10.0.1.1" or "1234::5678:9012") as second element.
       </p>
+      <p>See <seealso marker="#pkix_verify_hostname_match_fun-1">pkix_verify_hostname_match_fun/1</seealso> for a
+      function that return a fun suitable for this option.
+      </p>
     </desc>
   </func>
 
+  <func>
+    <name>pkix_verify_hostname_match_fun(Alg) ->  fun(RefId | FQDN::string(), PresentedID) -> boolean() | default</name>
+    <fsummary>Returns a fun that is intendended as argument to the match_fun option in pkix_verify_hostname/3.
+    </fsummary>
+    <type>
+      <v>Alg = https</v>
+      <d>The algorithm for wich the fun should implement the special matching rules</d>
+      <v>RefId</v>
+      <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d>
+      <v>FQDN</v>
+      <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d>
+      <v>PresentedID</v>
+      <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d>
+    </type>
+    <desc>
+      <p>The return value of calling this function is intended to be used in the <c>match_fun</c> option in
+      <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.
+      </p>
+      <p>The returned fun augments the verify hostname matching according to the specific rules for
+      the protocol in the argument.
+      </p>
+    </desc>
+  </func>
+  
+
   <func>
     <name>sign(Msg, DigestType, Key) -> binary()</name>
     <name>sign(Msg, DigestType, Key, Options) -> binary()</name>
-- 
cgit v1.2.3