Skip to content

Commit

Permalink
Explcitly mention LibreSSL and BoringSSL in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
p committed Jun 30, 2019
1 parent d13a48a commit a17b893
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
7 changes: 4 additions & 3 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ To fix this, you need to tell ``setup.py`` what SSL backend is used::
python setup.py --with-[openssl|gnutls|nss|mbedtls] install

Note: as of PycURL 7.21.5, setup.py accepts ``--with-openssl`` option to
indicate that libcurl is built against OpenSSL. ``--with-ssl`` is an alias
indicate that libcurl is built against OpenSSL/LibreSSL/BoringSSL.
``--with-ssl`` is an alias
for ``--with-openssl`` and continues to be accepted for backwards compatibility.

You can also ask ``setup.py`` to obtain SSL backend information from installed
Expand Down Expand Up @@ -216,8 +217,8 @@ Additional Windows setup.py options:
import library. The default is ``libcurl.lib`` which is appropriate for
static linking and is sometimes the correct choice for dynamic linking as
well. The other possibility for dynamic linking is ``libcurl_imp.lib``.
- ``--with-openssl``: use OpenSSL crypto locks when libcurl was built against
OpenSSL.
- ``--with-openssl``: use OpenSSL/LibreSSL/BoringSSL crypto locks when libcurl
was built against these SSL backends.
- ``--with-ssl``: legacy alias for ``--with-openssl``.
- ``--openssl-lib-name=""``: specify a different name for OpenSSL import
library containing CRYPTO_num_locks. For OpenSSL 1.1.0+ this should be set
Expand Down
3 changes: 2 additions & 1 deletion doc/thread-safety.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ For Python programs using PycURL, this means:
Python code *outside of a libcurl callback for the PycURL object in question*
is unsafe.

PycURL handles the necessary SSL locks for OpenSSL/LibreSSL, GnuTLS, NSS and mbedTLS.
PycURL handles the necessary SSL locks for OpenSSL/LibreSSL/BoringSSL,
GnuTLS, NSS and mbedTLS.

A special situation exists when libcurl uses the standard C library
name resolver (i.e., not threaded nor c-ares resolver). By default libcurl
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -896,8 +896,8 @@ def gen_docstrings_sources():
PycURL Unix options:
--curl-config=/path/to/curl-config use specified curl-config binary
--libcurl-dll=[/path/to/]libcurl.so obtain SSL library from libcurl.so
--openssl-dir=/path/to/openssl/dir path to OpenSSL headers and libraries
--with-openssl libcurl is linked against OpenSSL
--openssl-dir=/path/to/openssl/dir path to OpenSSL/LibreSSL/BoringSSL headers and libraries
--with-openssl libcurl is linked against OpenSSL/LibreSSL/BoringSSL
--with-ssl legacy alias for --with-openssl
--with-gnutls libcurl is linked against GnuTLS
--with-nss libcurl is linked against NSS
Expand All @@ -910,7 +910,7 @@ def gen_docstrings_sources():
--use-libcurl-dll link against libcurl DLL, if not given
link against libcurl statically
--libcurl-lib-name=libcurl_imp.lib override libcurl import library name
--with-openssl libcurl is linked against OpenSSL
--with-openssl libcurl is linked against OpenSSL/LibreSSL/BoringSSL
--with-ssl legacy alias for --with-openssl
--link-arg=foo.lib also link against specified library
'''
Expand Down

0 comments on commit a17b893

Please sign in to comment.