Skip to content

Commit

Permalink
Merge branch 'ingela/ssl/maint/fix-doc-verify-def' into maint
Browse files Browse the repository at this point in the history
* ingela/ssl/maint/fix-doc-verify-def:
  ssl: Correct OTP-26 documentation
  • Loading branch information
IngelaAndin committed Feb 5, 2024
2 parents 823ce81 + 6b0e1e2 commit 759e796
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/ssl/doc/src/ssl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1001,9 +1001,9 @@ fun(srp, Username :: binary(), UserState :: term()) ->
<datatype>
<name name="client_verify_type"/>
<desc>
<p>Defaults to <c>verify_none</c> as additional options are needed to be able to perform the certificate verification.
A warning will be emitted unless <c>verify_none</c> is explicitly configured. Usually the applications will want to configure
<c>verify_peer</c> together with an appropriate <c>cacert</c> or <c>cacertfile</c> option. For example an <c>HTTPS</c> client would normally
<p>Defaults to <c>verify_peer</c>, since OTP-26, which means the option cacerts or cacertfile is also required
to perform the certificate verification unless <c>verify_none</c> is explicitly configured.
For example an <c>HTTPS</c> client would normally
use the option <c>{cacerts, public_key:cacerts_get()}</c> (available since OTP-25) to access the CA certificates
provided by the OS. Using verify_none means that all x509-certificate path validation errors will be ignored.
See also option <seetype marker="#custom_verify">verify_fun</seetype>.</p>
Expand Down

0 comments on commit 759e796

Please sign in to comment.