Merge pull request #13 from platinummonkey/custom_ssl_options

add custom config options for global ssl verification and certs

Author: platinummonkey

docs/changelog.rst

@@ -5,6 +5,11 @@ ChangeLog
 
 Changes to the library are recorded here.
 
+v1.2.0
+------
+  * Add custom cert/verification options to be passed normally through the singleton config
+  * Upgrades minimum requests version to 2.20.0 for known CVE-2018-18074
+
 v1.1.5
 ------
   * Looser requirements everywhere, run free!

docs/quickstart.py

@@ -2,6 +2,10 @@
 from wiremock.client import *
 
 Config.base_url = 'https://mockserver.example.com/__admin/'
+# Optionally set a custom cert path:
+# Config.requests_cert = ... (See requests documentation)
+# Optionally disable cert verification
+# Config.requests_verify = False
 
 mapping = Mapping(
     priority=100,

setup.py

@@ -14,7 +14,7 @@
     'nose~=1.3.7',
     'python-coveralls~=2.9.0',
     'responses~=0.5.1',
-    'requests~=2.13.0',
+    'requests>=2.20.0',
     'six>=1.10.0',
     'sphinx-rtd-theme~=0.2.4',
     'tox~=2.6.0',
@@ -54,7 +54,7 @@
     install_requires=[
         'setuptools>=35.0.1',
         'six>=1.10.0',
-        'requests~=2.13.0'
+        'requests>=2.20.0'
     ],
     extras_require={
         'develop': develop_requires,

wiremock/VERSION

@@ -1 +1 @@
-1.1.5
+1.2.0

wiremock/base/base_resource.py

@@ -12,16 +12,24 @@
 
 class RestClient(object):
 
-    def __init__(self, timeout=None, base_url=None):
+    def __init__(self, timeout=None, base_url=None, requests_verify=None, requests_cert=None):
         self.timeout = timeout
         self.base_url = base_url
+        self.requests_verify = requests_verify
+        self.requests_cert = requests_cert
 
     def _base_url(self):
         return self.base_url or Config.base_url
 
     def _timeout(self):
         return self.timeout or Config.timeout
 
+    def _requests_verify(self):
+        return self.requests_verify or Config.requests_verify
+
+    def _requests_cert(self):
+        return self.requests_cert or Config.requests_cert
+
     def _log(self, action, url, **kwargs):
         ctx = {'timeout': kwargs.get('timeout')}
         logger.debug(
@@ -32,6 +40,10 @@ def _log(self, action, url, **kwargs):
     def post(self, uri, **kwargs):
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("POST", url, **kwargs)
@@ -44,6 +56,10 @@ def post(self, uri, **kwargs):
     def get(self, uri, **kwargs):
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("GET", url, **kwargs)
@@ -56,6 +72,10 @@ def get(self, uri, **kwargs):
     def put(self, uri, **kwargs):
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("PUT", url, **kwargs)
@@ -68,6 +88,10 @@ def put(self, uri, **kwargs):
     def patch(self, uri, **kwargs):  # pragma: no cover
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("PATCH", url, **kwargs)
@@ -80,6 +104,10 @@ def patch(self, uri, **kwargs):  # pragma: no cover
     def delete(self, uri, **kwargs):
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("DELETE", url, **kwargs)
@@ -92,6 +120,10 @@ def delete(self, uri, **kwargs):
     def options(self, uri, **kwargs):  # pragma: no cover
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("OPTIONS", url, **kwargs)
@@ -104,6 +136,10 @@ def options(self, uri, **kwargs):  # pragma: no cover
     def head(self, uri, **kwargs):  # pragma: no cover
         if 'timeout' not in kwargs:
             kwargs['timeout'] = self._timeout()
+        if 'requests_verify' not in kwargs:
+            kwargs['verify'] = self._requests_verify()
+        if 'requests_cert' not in kwargs:
+            kwargs['cert'] = self._requests_cert()
         try:
             url = self._base_url() + uri
             self._log("HEAD", url, **kwargs)

wiremock/constants.py

@@ -23,6 +23,8 @@ def __call__(cls, *args, **kwargs):
 DEFAULT_BASE_URL = 'http://localhost/__admin'
 USER_AGENT = 'python_wiremock/%s'.format(__version__)
 DEFAULT_HEADERS = {'Accept': 'application/json', 'Content-Type': 'application/json', 'user-agent': USER_AGENT}
+DEFAULT_REQUESTS_VERIFY = True
+DEFAULT_REQUESTS_CERT = None
 
 
 @add_metaclass(Singleton)
@@ -31,6 +33,9 @@ class Config(object):
     base_url = DEFAULT_BASE_URL
     user_agent = USER_AGENT
     headers = DEFAULT_HEADERS
+    requests_verify = DEFAULT_REQUESTS_VERIFY
+    requests_cert = DEFAULT_REQUESTS_CERT
+
 
 Config()  # pre-call once