Merge pull request #68 from Worvast/master

## [3.1.0] - 2019-09-25

Author: Worvast

CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## [3.1.0] - 2019-10-21
+#### Fixed
+ * Documentation with examples of version 2.0
+ 
+#### Added
+ * level flag to handlers in logging and updated documentation
+ * flag/capacity of Sender to use pfx certificates
+#### Deprecated
+ * level for global logging when get_log. We maintain general level until version 4
+
 ## [3.0.3] - 2019-09-25
 #### Fixed
  * Fixed reconnection to socket in every send instruction of Sender

README.md

@@ -1,7 +1,7 @@
 
 [![master Build Status](https://travis-ci.com/DevoInc/python-sdk.svg?branch=master)](https://travis-ci.com/DevoInc/python-sdk) [![LICENSE](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/DevoInc/python-sdk/blob/master/LICENSE)
 
-[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-3.0.3-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-blue.svg)](https://pypi.org/project/devo-sdk/)
+[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-3.1.0-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-blue.svg)](https://pypi.org/project/devo-sdk/)
 
 
 # Devo Python SDK

devo/__version__.py

@@ -1,6 +1,6 @@
 __description__ = 'Devo Python Library.'
 __url__ = 'http://www.devo.com'
-__version__ = "3.0.3"
+__version__ = "3.1.0"
 __author__ = 'Devo'
 __author_email__ = 'support@devo.com'
 __license__ = 'MIT'

devo/api/client.py

@@ -129,7 +129,6 @@ def __init__(self, address=None, auth=None, config=None,
         Initialize the API with this params, all optionals
         :param address: endpoint
         :param auth: object with auth params (key, secret, token, jwt)
-        :param options: options class for Client and queries
         :param retries: number of retries for a query
         :param timeout: timeout of socket
         """
@@ -293,7 +292,6 @@ def _call(self, payload):
         """
         Make the call, select correct item to return
         :param payload: item with headers for request
-        :param stream: boolean, indicate if one call is a streaming call
         :return: Response from API
         """
         if self.config.stream:

devo/common/logging/log.py

@@ -6,14 +6,27 @@
 from logging.handlers import RotatingFileHandler
 
 
-def get_log(name="log", level=logging.DEBUG, handler=None):
-    """Initialize logger for self process log
+def get_log(name="log", level=None, handler=None):
+    """Initialize logger for self process
+    :TODO v4.0.0: In version 4.0 delete level option for get_log
     :return: Log object
     """
     logger = logging.getLogger(name)
-    logger.addHandler(get_rotating_file_handler()
-                      if not handler else handler)
-    logger.setLevel(level)
+    if handler is None:
+        handler = get_rotating_file_handler(level=None if level is None
+                                            else level)
+        logger.addHandler(handler)
+    elif isinstance(handler, list):
+        for simple_handler in handler:
+            if level is not None:
+                simple_handler.setLevel(level)
+            logger.addHandler(simple_handler)
+    else:
+        logger.addHandler(handler)
+
+    if level is not None:
+        logger.setLevel(level)
+
     return logger
 
 
@@ -29,7 +42,8 @@ def get_rotating_file_handler(path="./",
                               file_name="history.log",
                               msg_format='%(asctime)s|%(levelname)s|%(message)s',
                               max_size=2097152,
-                              backup_count=5):
+                              backup_count=5,
+                              level=logging.INFO):
     """Initialize rotating file handler for logger
 
     :return: RotatingFileHandler object
@@ -41,14 +55,19 @@ def get_rotating_file_handler(path="./",
     handler = RotatingFileHandler(full_path, maxBytes=max_size,
                                   backupCount=backup_count)
     handler.setFormatter(set_formatter(msg_format))
+    if level is not None:
+        handler.setLevel(level)
     return handler
 
 
 def get_stream_handler(dest=sys.stdout,
-                       msg_format='%(asctime)s|%(levelname)s|%(message)s'):
+                       msg_format='%(asctime)s|%(levelname)s|%(message)s',
+                       level=logging.INFO):
     """Initialize stream handlerhandler for logger
     :return: StreamHandler object
     """
     handler = logging.StreamHandler(dest)
     handler.setFormatter(set_formatter(msg_format))
+    if level is not None:
+        handler.setLevel(level)
     return handler

devo/sender/data.py

@@ -34,6 +34,7 @@ class SenderConfigSSL:
     :param key: (str) key src file
     :param cert:  (str) cert src file
     :param chain:  (str) chain src file
+    :param pkcs:  (dict) (path: pfx src file, password: of cert)
 
     >>>sender_config = SenderConfigSSL(address=(SERVER, int(PORT)), key=KEY,
     ...                                cert=CERT, chain=CHAIN)
@@ -42,7 +43,8 @@ class SenderConfigSSL:
         Sender
 
     """
-    def __init__(self, address=None, key=None, cert=None, chain=None):
+    def __init__(self, address=None, key=None, cert=None, chain=None,
+                 pkcs=None):
         if not isinstance(address, tuple):
             raise DevoSenderException(
                 "Devo-SenderConfigSSL| address must be a tuple "
@@ -52,6 +54,7 @@ def __init__(self, address=None, key=None, cert=None, chain=None):
             self.key = key
             self.cert = cert
             self.chain = chain
+            self.pkcs = pkcs
             self.hostname = socket.gethostname()
         except Exception as error:
             raise DevoSenderException(
@@ -164,6 +167,22 @@ def __connect_ssl(self):
         self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         self.socket.settimeout(self.socket_timeout)
 
+        try:
+            if self._sender_config.pkcs is not None:
+                from .pfx_to_pem import pfx_to_pem
+                pkcs = self._sender_config.pkcs
+                key, cert, chain = pfx_to_pem(path=pkcs.get("path", None),
+                                              password=pkcs.get("password",
+                                                                None))
+
+                self._sender_config.key = key.name
+                self._sender_config.cert = cert.name
+                self._sender_config.chain = chain.name
+        except Exception as error:
+            self.close()
+            raise DevoSenderException(
+                "PFX Certificate read failed: %s" %
+                str(error))
         try:
             try:
                 if self._sender_config.key is not None \
@@ -436,7 +455,7 @@ def for_logging(config=None, con_type=None, tag=None, level=None):
         elif isinstance(config, dict):
             con.logging['level'] = config.get("verbose_level", 10)
         else:
-            con.logging['level'] = 10
+            con.logging['level'] = logging.INFO
 
         return con
 
@@ -465,9 +484,10 @@ def _from_dict(config=None, con_type=None):
 
         if connection_type == "SSL":
             return SenderConfigSSL(address=address,
-                                   key=config.get("key"),
-                                   cert=config.get("cert"),
-                                   chain=config.get("chain"))
+                                   key=config.get("key", None),
+                                   cert=config.get("cert", None),
+                                   chain=config.get("chain", None),
+                                   pkcs=config.get("pkcs", None))
 
         return SenderConfigTCP(address=address)
 

devo/sender/pfx_to_pem.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+""" Util function to convert .pfx and .pkcs12 certs to key+cert+chain for
+use in Python sockets"""
+import tempfile
+import OpenSSL.crypto
+
+
+def pfx_to_pem(path=None, password=None):
+    """
+    Decrypts the .pfx file to be used with requests.
+    :param path: path to .pfx/.pkcs12 file
+    :param password: password of certificate
+    :return: NamedTemporaryFile temp_key, temp_cert, temp_ca paths
+    """
+    temp_key = tempfile.NamedTemporaryFile(suffix='.key')
+    temp_cert = tempfile.NamedTemporaryFile(suffix='.crt')
+    temp_ca = tempfile.NamedTemporaryFile(suffix='.crt')
+
+    f_key = open(temp_key.name, 'wb')
+    f_cert = open(temp_cert.name, 'wb')
+    f_ca = open(temp_ca.name, 'wb')
+
+    pfx = open(path, 'rb').read()
+    p12 = OpenSSL.crypto.load_pkcs12(pfx, password)
+
+    f_key.write(OpenSSL.crypto.dump_privatekey(
+        OpenSSL.crypto.FILETYPE_PEM, p12.get_privatekey()))
+    f_cert.write(OpenSSL.crypto.dump_certificate(
+        OpenSSL.crypto.FILETYPE_PEM, p12.get_certificate()))
+    ca = p12.get_ca_certificates()
+    if ca is not None:
+        for cert in ca:
+            f_ca.write(OpenSSL.crypto.dump_certificate(
+                OpenSSL.crypto.FILETYPE_PEM, cert))
+    f_key.close()
+    f_cert.close()
+    f_ca.close()
+    return temp_key, temp_cert, temp_ca

docs/api/api.md

@@ -70,8 +70,6 @@ config = ClientConfig(response="json/compact", stream=False,
 api = Client(auth= {"key":"myapikey", "secret":"myapisecret"}, 
              address="https://apiv2-eu.devo.com/search/query",
              config=config)
-
-
 ```  
 
 #### query() params

docs/common.md

@@ -32,16 +32,20 @@ This library add utilities for other packages.
 Devo commons gives you a function, with enough parameters for your personalization, to get a logging object:
 
 ```python
-def get_log(name="log", level=logging.DEBUG, handler=None)
+def get_log(name="log", level=None, handler=None)
 ```
 By default, handler will be a RotatingFileHandler, named history.log, 5 files, in work folder.
-You can use other Handler, by you own or using one of the common package
+You can use other Handler, by you own or using one of the common package.
+
+If you set level, all handlers has the same level, if you want different levels, pass level to handlers, 
+and not to logger.
 
 ##### StreamHandler
 
 ```python
 def get_stream_handler(dest=sys.stdout,
-                       msg_format='%(asctime)s|%(levelname)s|%(message)s')
+                       msg_format='%(asctime)s|%(levelname)s|%(message)s',
+                       level=logging.DEBUG)
 ```
 With this function you will obtain a StreamHandler, by default the whole log will be to stdout.
 
@@ -60,7 +64,8 @@ def get_rotating_file_handler(path="./",
                               file_name="history.log",
                               msg_format='%(asctime)s|%(levelname)s|%(message)s',
                               max_size=2097152,
-                              backup_count=5):
+                              backup_count=5, 
+                              level=logging.DEBUG):
 ```
 
 You can use this handler like in the StreamHandler example

docs/sender.md

@@ -47,6 +47,17 @@ Variable descriptions
 + logger **(_string_)**: logger. Default sys.console
 
 
+Class SenderConfigSSL accept various types of certificates, you has:
+
++ address **(_tuple_)**: (Server address, port)
++ key **(_str_)**: key src file
++ cert **(_str_)**: cert src file
++ chain **(_str_)**: chain src file
++ pkcs **(_dict_)**: (path: pfx src file, password: of cert)
+
+
+You can use the collector in some ways:
+
 - With certificates:
 
 ```python
@@ -55,6 +66,16 @@ engine_config = SenderConfigSSL(address=(SERVER, PORT),
                                 key=KEY, cert=CERT,chain=CHAIN)
 con = Sender(engine_config)
 ```
+
+or 
+
+```python
+from devo.sender import SenderConfigSSL, Sender
+engine_config = SenderConfigSSL(address=(SERVER, PORT), 
+                                pkcs={"path": "tmp/mycert.pfx",
+                                      "password": "certpassword"})
+con = Sender(engine_config)
+```
 
 - Without certificates SSL
 
@@ -125,7 +146,7 @@ from devo.common import Configuration
 from devo.sender import Sender
 
 conf = Configuration("./config.json.example", 'sender')
-con = Sender.from_dict(conf)
+con = Sender(config=conf)
 ```
 
 #### Sending data 
@@ -400,7 +421,7 @@ from devo.sender import Sender, Lookup
 conf = Configuration()
 conf.load_config("./config.json.example", 'sender')
 conf.load_config("./config.json.example", 'lookup')
-con = Sender.from_dict(conf.get("sender"))
+con = Sender(config=conf.get("sender"))
 lookup = Lookup(name=conf.get('name', "default"), historic_tag=None, con=con)
 
 lookup.send_headers(headers=['KEY', 'HEX', 'COLOR'], key='KEY', event='START')