jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve httpClient docs on SSL cert verification (#15201)

Browse source 
* Improve httpClient docs on SSL cert verification

Cert verification is enabled by default after CVE-2021-29495

* Update httpclient.nim

Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>
This commit is contained in:
Federico Ceratto 2021-06-13 16:50:04 +01:00 • committed by GitHub
commit a266c54921
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lib/pure/httpclient.nim
View file

@ -115,7 +115,7 @@
## ##
## SSL/TLS support ## SSL/TLS support
## =============== ## ===============
## This requires the OpenSSL library, fortunately it's widely used and installed ## This requires the OpenSSL library. Fortunately it's widely used and installed
## on many operating systems. httpclient will use SSL automatically if you give ## on many operating systems. httpclient will use SSL automatically if you give
## any of the functions a url with the `https` schema, for example: ## any of the functions a url with the `https` schema, for example:
## `https://github.com/`. ## `https://github.com/`.
@ -123,12 +123,25 @@
## You will also have to compile with `ssl` defined like so: ## You will also have to compile with `ssl` defined like so:
## `nim c -d:ssl ...`. ## `nim c -d:ssl ...`.
## ##
## Certificate validation is NOT performed by default. ## Certificate validation is performed by default.
## This will change in the future.
## ##
## A set of directories and files from the `ssl_certs <ssl_certs.html>`_ ## A set of directories and files from the `ssl_certs <ssl_certs.html>`_
## module are scanned to locate CA certificates. ## module are scanned to locate CA certificates.
## ##
## Example of setting SSL verification parameters in a new client:
##
## .. code-block:: Nim
## import httpclient
## var client = newHttpClient(sslContext=newContext(verifyMode=CVerifyPeer))
##
## There are three options for verify mode:
##
## * ``CVerifyNone``: certificates are not verified;
## * ``CVerifyPeer``: certificates are verified;
## * ``CVerifyPeerUseEnvVars``: certificates are verified and the optional
## environment variables SSL_CERT_FILE and SSL_CERT_DIR are also used to
## locate certificates
##
## See `newContext <net.html#newContext.string,string,string,string>`_ to tweak or disable certificate validation. ## See `newContext <net.html#newContext.string,string,string,string>`_ to tweak or disable certificate validation.
## ##
## Timeouts ## Timeouts