aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <hans@erlang.org>2017-10-13 12:29:13 +0200
committerHans Nilsson <hans@erlang.org>2017-10-16 12:05:56 +0200
commit25aae346f1f74105268cb616d2b56a00c869a923 (patch)
tree010d429e764f6f0de5459be6611a3a390484c43c
parent21fd1710a483fd6f0438feb89c6790b0fcf800bd (diff)
downloadotp-25aae346f1f74105268cb616d2b56a00c869a923.tar.gz
otp-25aae346f1f74105268cb616d2b56a00c869a923.tar.bz2
otp-25aae346f1f74105268cb616d2b56a00c869a923.zip
public_key: Polish verify_hostname doc
-rw-r--r--lib/public_key/doc/src/public_key.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 3040f2db0d..5230cef496 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -883,8 +883,8 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
</type>
<desc>
<p>This function checks that the <i>Presented Identifier</i> (e.g hostname) in a peer certificate
- conforms with the Expected Identifier that the client wants to connect to.
- This functions is intended to be added as an extra client check to the peer certificate when performing
+ is in agreement with the <i>Reference Identifier</i> that the client expects to be connected to.
+ The function is intended to be added as an extra client check of the peer certificate when performing
<seealso marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_validation/3</seealso>
</p>
<p>See <url href="https://tools.ietf.org/html/rfc6125">RFC 6125</url>
@@ -897,7 +897,8 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
<p>The <c>{OtherRefId,term()}</c> is defined by the user and is passed to the <c>match_fun</c>, if defined.
If that term is a binary, it will be converted to a string.
</p>
- <p>The <c>ip</c> takes a 4-tuple or a
+ <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>
</desc>
</func>