Added Delete Cert features

Author: rlabbeptc

kepconfig/ua_gateway/client.py

@@ -6,13 +6,14 @@
 
 r"""`client` exposes an API to allow modifications (add, delete, modify) to 
 UA Gateway plug-in client connection objects within the Kepware Configuration API. 
-Certificate read and trust functionality is also available for the client connections.
+Certificate store read, remove and trust functionality is also available for the 
+client connections.
 """
 
 from typing import Union
 from ..connection import server
 from ..error import KepError, KepHTTPError
-from ..ua_gateway.common import _INTER_TYPE, _change_cert_trust,  _create_url_cert, _create_url_client
+from ..ua_gateway.common import _INTER_TYPE, _change_cert_trust,  _create_url_cert, _create_url_client, _delete_cert_truststore
 
 def get_certificate(server: server, certificate: str) -> dict:
     '''Returns the properties of the UAG client connection certificate object in the UAG client connection 
@@ -75,6 +76,19 @@ def reject_certificate(server: server, certificate: str) -> bool:
 
     return _change_cert_trust(server, _INTER_TYPE.CLIENT, certificate, False)
 
+def delete_certificate(server: server, certificate: str) -> bool:
+    '''Deletes the certificate in the UAG client endpoint certificate store.
+
+    :param server: instance of the `server` class
+    :param certificate: name of certificate
+    
+    :return: True - If a "HTTP 200 - OK" is received from Kepware server
+
+    :raises KepHTTPError: If urllib provides an HTTPError
+    :raises KepURLError: If urllib provides an URLError
+    '''
+    return _delete_cert_truststore(server, _INTER_TYPE.CLIENT, certificate)
+
 def get_ua_client_connection(server: server, ua_client_connection: str) -> dict:
     '''Returns the properties of the UAG client connection object.
     

kepconfig/ua_gateway/common.py

@@ -26,6 +26,7 @@ class _INTER_TYPE(Enum):
     CLIENT = 1
     CERTS = 2
 
+INSTANCE_CERTIFICATE = "Instance Certificate"
 
 def _create_url_cert(interface, certificate = None):
     '''Creates url object for the "certificate" branch of Kepware's UA Gateway. Used 
@@ -59,6 +60,12 @@ def _change_cert_trust(server: server, inter_type, certificate: str, trust: bool
     if r.code == 200: return True 
     else: 
         raise KepHTTPError(r.url, r.code, r.msg, r.hdrs, r.payload)
+    
+def _delete_cert_truststore(server: server, inter_type, certificate: str):
+    r = server._config_del(server.url + _create_url_cert(inter_type, certificate))
+    if r.code == 200: return True 
+    else: 
+        raise KepHTTPError(r.url, r.code, r.msg, r.hdrs, r.payload)
 
 def _create_url_server(ua_server_endpoint = None):
     '''Creates url object for the "ua_server_endpoints" branch of Kepware's UA Gateway. Used 

kepconfig/ua_gateway/server.py

@@ -6,13 +6,14 @@
 
 r"""`server` exposes an API to allow modifications (add, delete, modify) to 
 UA Gateway plug-in server endpoint objects within the Kepware Configuration API. 
-Certificate read and trust functionality is also available for the server endpoints.
+Certificate store read, remove and trust functionality is also available for the 
+server endpoints.
 """
 
 from typing import Union
 from ..connection import server
 from ..error import KepError, KepHTTPError
-from ..ua_gateway.common import _INTER_TYPE, _change_cert_trust, _create_url_cert, _create_url_server
+from ..ua_gateway.common import _INTER_TYPE, _change_cert_trust, _create_url_cert, _create_url_server, _delete_cert_truststore
 
 
 def get_certificate(server: server, certificate: str) -> dict:
@@ -49,7 +50,7 @@ def get_all_certificates(server: server, *, options: dict = None) -> list:
     return r.payload
 
 def trust_certificate(server: server, certificate: str) -> bool:
-    '''Trusts the certificate in the UAG server endpoint certifcate store. This is updating the trust state of UA client instance 
+    '''Trusts the certificate in the UAG server endpoint certificate store. This is updating the trust state of UA client instance 
     certificates that are used by UAG server endpoints for trust purposes in the UA security model.
 
     :param server: instance of the `server` class
@@ -63,7 +64,7 @@ def trust_certificate(server: server, certificate: str) -> bool:
     return _change_cert_trust(server, _INTER_TYPE.SERVER, certificate, True)
 
 def reject_certificate(server: server, certificate: str) -> bool:
-    '''Rejects the certificate in the UAG server endpoint certifcate store.
+    '''Rejects the certificate in the UAG server endpoint certificate store.
 
     :param server: instance of the `server` class
     :param certificate: name of certificate
@@ -75,6 +76,19 @@ def reject_certificate(server: server, certificate: str) -> bool:
     '''
     return _change_cert_trust(server, _INTER_TYPE.SERVER, certificate, False)
 
+def delete_certificate(server: server, certificate: str) -> bool:
+    '''Deletes the certificate in the UAG server endpoint certificate store.
+
+    :param server: instance of the `server` class
+    :param certificate: name of certificate
+    
+    :return: True - If a "HTTP 200 - OK" is received from Kepware server
+
+    :raises KepHTTPError: If urllib provides an HTTPError
+    :raises KepURLError: If urllib provides an URLError
+    '''
+    return _delete_cert_truststore(server, _INTER_TYPE.SERVER, certificate)
+
 def get_ua_server_endpoint(server: server, ua_server_endpoint: str) -> dict:
     '''Returns the properties of the UAG server endpoint object.