ENH: Added pyproj.set_ca_bundle_path

Author: snowman2

docs/api/datadir.rst

@@ -1,7 +1,7 @@
-.. _data_directory:
+.. _data_and_ca_bundle_directory:
 
-Data Directory
-==============
+Data Directory & CA Bundle Path
+===============================
 
 pyproj.datadir.get_data_dir
 ---------------------------
@@ -25,3 +25,9 @@ pyproj.datadir.get_user_data_dir
 ---------------------------------
 
 .. autofunction:: pyproj.datadir.get_user_data_dir
+
+
+pyproj.set_ca_bundle_path
+--------------------------
+
+.. autofunction:: pyproj.set_ca_bundle_path

docs/history.rst

@@ -22,6 +22,7 @@ Change Log
 * ENH: Added ability to use global context (issue #661)
 * ENH: Add support for temporal CRS CF coordinate system (issue #672)
 * BUG: Fix handling of polygon holes when calculating area in Geod (pull #686)
+* ENH: Added :func:`pyproj.set_ca_bundle_path` (pull #691)
 
 2.6.1
 ~~~~~

docs/transformation_grids.rst

@@ -9,7 +9,7 @@ More information about the data available is located under the PROJ
 `resource files <https://proj.org/resource_files.html#transformation-grids>`__
 documentation.
 
-`pyproj` API for managing the :ref:`data_directory`
+`pyproj` API for managing the :ref:`data_and_ca_bundle_directory`
 
 .. warning:: pyproj 2 includes datumgrid 1.8 in the wheels. pyproj 3 will not include any datum grids.
 

pyproj/__init__.py

@@ -49,6 +49,7 @@
 from pyproj._datadir import (  # noqa: F401
     _pyproj_global_context_initialize,
     is_global_context_network_enabled,
+    set_ca_bundle_path,
     set_global_context_network,
     set_use_global_context,
 )
@@ -79,3 +80,5 @@
     _pyproj_global_context_initialize()
 except DataDirError as err:
     warnings.warn(str(err))
+
+set_ca_bundle_path()

pyproj/_datadir.pyi

@@ -1,7 +1,9 @@
-from typing import Optional
+from pathlib import Path
+from typing import Optional, Union
 
 def _pyproj_global_context_initialize() -> None: ...
 def get_user_data_dir(create: bool = False) -> str: ...
+def set_ca_bundle_path(ca_bundle_path: Union[Path, str, bool, None] = None) -> None: ...
 def _global_context_set_data_dir() -> None: ...
 def set_use_global_context(active: Optional[bool] = None) -> None: ...
 def set_global_context_network(active: Optional[bool] = None) -> None: ...

pyproj/_datadir.pyx

@@ -1,7 +1,9 @@
 import os
 import warnings
 from distutils.util import strtobool
+from pathlib import Path
 
+import certifi
 from libc.stdlib cimport free, malloc
 
 from pyproj.compat import cstrencode, pystrdecode
@@ -111,6 +113,47 @@ def get_user_data_dir(create=False):
     return pystrdecode(proj_context_get_user_writable_directory(NULL, bool(create)))
 
 
+def set_ca_bundle_path(ca_bundle_path=None):
+    """
+    .. versionadded:: 3.0.0
+
+    Sets the path to the CA Bundle used by the `curl`
+    built into PROJ.
+
+    Environment variables that can be used with PROJ 7.2+:
+    - PROJ_CURL_CA_BUNDLE
+    - CURL_CA_BUNDLE
+    - SSL_CERT_FILE
+
+    Parameters
+    ----------
+    ca_bundle_path: Union[Path, str, bool, None], optional
+        Default is None, which only uses the `certifi` package path as a fallback if
+        the environment variables are not set. If a path is passed in, then
+        that will be the path used. If it is set to True, then it will default
+        to using the path provied by the `certifi` package. If it is set to False,
+        then it will not set the path.
+    """
+    if ca_bundle_path is False:
+        return None
+
+    env_var_names = (
+        "PROJ_CURL_CA_BUNDLE",
+        "CURL_CA_BUNDLE",
+        "SSL_CERT_FILE",
+    )
+    if isinstance(ca_bundle_path, (str, Path)):
+        ca_bundle_path = str(ca_bundle_path)
+    elif (
+        (ca_bundle_path is True) or
+        not any(env_var_name in os.environ for env_var_name in env_var_names)
+    ):
+        ca_bundle_path = certifi.where()
+
+    if isinstance(ca_bundle_path, str):
+        proj_context_set_ca_bundle_path(NULL, cstrencode(ca_bundle_path))
+
+
 cdef void pyproj_log_function(void *user_data, int level, const char *error_msg):
     """
     Log function for catching PROJ errors.

pyproj/proj.pxi

@@ -9,6 +9,7 @@ cdef extern from "proj.h":
                                        const char *dbPath,
                                        const char *const *auxDbPaths,
                                        const char* const *options)
+    void proj_context_set_ca_bundle_path(PJ_CONTEXT *ctx, const char *path);
 
     # projCtx has been replaced by PJ_CONTEXT *.
     # projPJ  has been replaced by PJ *

setup.py

@@ -244,4 +244,5 @@ def get_long_description():
     ext_modules=get_extension_modules(),
     package_data=get_package_data(),
     zip_safe=False,  # https://mypy.readthedocs.io/en/stable/installed_packages.html
+    install_requires=["certifi"],
 )