Skip to content

Commit

Permalink
Merge branch 'ingela/ssl/master/fix-doc-verify-def'
Browse files Browse the repository at this point in the history
* ingela/ssl/master/fix-doc-verify-def:
  ssl: Correct documentation
  • Loading branch information
IngelaAndin committed Feb 5, 2024
2 parents a0df1d8 + 986c0d1 commit 2b6b40c
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions lib/ssl/src/ssl.erl
Original file line number Diff line number Diff line change
Expand Up @@ -1309,11 +1309,9 @@ receiver and cannot be changed.
{stapling, stapling()}.

-doc """
Defaults to `verify_none` as additional options are needed to be able to perform
the certificate verification. A warning will be emitted unless `verify_none` is
explicitly configured. Usually the applications will want to configure
`verify_peer` together with an appropriate `cacert` or `cacertfile` option. For
example an `HTTPS` client would normally use the option
Defaults to `verify_peer`, 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 `HTTPS` client would normally use the option
`{cacerts, public_key:cacerts_get()}` (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
Expand Down

0 comments on commit 2b6b40c

Please sign in to comment.