Added NTLM authentication

Author: Daniel Barker

.gitignore

@@ -2,6 +2,9 @@
 .idea/
 build/
 osisoft.pidevclub.piwebapi.egg-info/
+credentials.py
+test/dcb_tests.py
+
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

osisoft/pidevclub/piwebapi/api_client.py

@@ -1,6 +1,7 @@
 # coding: utf-8
 from requests.auth import HTTPBasicAuth
 from requests_kerberos import HTTPKerberosAuth, OPTIONAL
+from requests_ntlm import HttpNtlmAuth
 """
 	Copyright 2017 OSIsoft, LLC
 	Licensed under the Apache License, Version 2.0 (the "License");
@@ -82,16 +83,15 @@ def user_agent(self, value):
         self.default_headers['User-Agent'] = value
 
 
-
     def set_kerberos_auth(self):
         self.rest_client.auth = HTTPKerberosAuth(force_preemptive=True, mutual_authentication=OPTIONAL, delegate=True)
 
-
+    def set_ntlm_auth(self, username, password):
+        self.rest_client.auth = HttpNtlmAuth(username, password)
 
     def set_basic_auth(self, username, password):
         self.rest_client.auth = HTTPBasicAuth(username, password)
 
-
     def set_default_header(self, header_name, header_value):
         self.default_headers[header_name] = header_value
 

osisoft/pidevclub/piwebapi/pi_web_api_client.py

@@ -62,22 +62,26 @@
 class PIWebApiClient(object):
     __baseUrl = None
     __useKerberos = True
+    __useNtlm = False
     __username = None
     __password = None
     __verifySsl = True
     __config = None
-    def __init__(self, baseUrl, useKerberos = True, username = None, password = None, verifySsl = True):
+
+    def __init__(self, baseUrl, useKerberos=True, username=None, password=None, verifySsl=True, useNtlm=False):
         self.__baseUrl = baseUrl
         self.__useKerberos = useKerberos
+        self.__useNtlm = useNtlm
         self.__username = username
         self.__password = password
         self.__verifySsl = verifySsl
         self.__api_client = api_client.ApiClient(self.__baseUrl, self.__verifySsl)
-        if (self.__useKerberos == True):
+        if self.__useKerberos is True:
             self.__api_client.set_kerberos_auth()
+        elif self.__useNtlm is True:
+            self.__api_client.set_ntlm_auth(username, password)
         else:
             self.__api_client.set_basic_auth(self.__username, self.__password)
-
         self.__homeApi = HomeApi(self.__api_client)
         self.__analysisApi = AnalysisApi(self.__api_client)
         self.__analysisCategoryApi = AnalysisCategoryApi(self.__api_client)

requirements.txt

@@ -3,4 +3,19 @@ six == 1.8.0
 setuptools >= 21.0.0
 requests >= 2.18.4
 requests-kerberos >= 0.12.0
-
+asn1crypto==0.24.0
+certifi==2018.4.16
+cffi==1.11.5
+chardet==3.0.4
+cryptography==2.2.2
+idna==2.6
+ntlm-auth==1.1.0
+numpy==1.14.3
+pycparser==2.18
+python-dateutil==2.7.3
+pytz==2018.4
+requests-ntlm==1.1.0
+six==1.8.0
+urllib3==1.22
+wincertstore==0.2
+winkerberos==0.7.0

test/test_main.py

@@ -30,7 +30,8 @@
 class TestMain(unittest.TestCase):
 
     def getPIWebApiClient(self):
-        return PIWebApiClient("https://devdata.osisoft.com/piwebapi", useKerberos=False, username="webapiuser", password="!try3.14webapi!", verifySsl=False)
+        return PIWebApiClient("https://devdata.osisoft.com/piwebapi", useKerberos=False, username="webapiuser",
+                              password="!try3.14webapi!", verifySsl=False)
 
 
     def test_getHome(self):
@@ -111,7 +112,8 @@ def test_getExceptionError(self):
         pass
 
     def test_getBatch(self):
-        client = PIWebApiClient("https://marc-rras.osisoft.int/piwebapi", useKerberos=False, username="marc.adm", password="kk", verifySsl=False)
+        client = PIWebApiClient("https://marc-rras.osisoft.int/piwebapi", useKerberos=False, username="marc.adm",
+                                password="kk", verifySsl=False)
         landing = client.home.get();
         req1 = PIRequest()
         req2 = PIRequest()