omnata-plugin-devkit 0.3.7__tar.gz → 0.3.8__tar.gz

{omnata_plugin_devkit-0.3.7 → omnata_plugin_devkit-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-devkit
-Version: 0.3.7
+Version: 0.3.8
 Summary: 
 Author: James Weakley
 Author-email: james.weakley@omnata.com
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Requires-Dist: behave (>=1.2,<2.0)
 Requires-Dist: behave_pandas (>=0.5.0,<0.6.0)
 Requires-Dist: jinja2 (>=3,<4)
-Requires-Dist: omnata-plugin-runtime (>=0.2.92,<0.3.0)
+Requires-Dist: omnata-plugin-runtime (>=0.3.3)
 Requires-Dist: omnata_cli (>=0.2.0,<0.3.0)
 Requires-Dist: pandas (==2.1.4)
 Requires-Dist: pydantic (>=1,<2)

{omnata_plugin_devkit-0.3.7 → omnata_plugin_devkit-0.3.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-devkit"
-version = "0.3.7"
+version = "0.3.8"
 description = ""
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"
@@ -9,7 +9,7 @@ packages = [{ include = "omnata_plugin_devkit", from = "src" }]
 [tool.poetry.dependencies]
 python = "~3.10"
 omnata_cli = "^0.2.0"
-omnata-plugin-runtime = "^0.2.92"
+omnata-plugin-runtime = ">=0.3.3"
 pandas = "2.1.4"
 jinja2 = "^3"
 pydantic = "^1"

{omnata_plugin_devkit-0.3.7 → omnata_plugin_devkit-0.3.8}/src/omnata_plugin_devkit/jinja_templates/CONFIGURE_APIS.sql.jinja

@@ -141,6 +141,8 @@ try{
                         VARCHAR)`,
         `RETRIEVE_SECRETS(VARCHAR,
                         VARCHAR)`,
+        `TUNNEL_TEST(VARCHAR,
+                        VARCHAR)`,
         `UPDATE_GENERIC_SECRET_OBJECT(VARCHAR,
                                     VARCHAR,
                                     VARCHAR)`,

{omnata_plugin_devkit-0.3.7 → omnata_plugin_devkit-0.3.8}/src/omnata_plugin_devkit/jinja_templates/NGROK_POST_TUNNEL_FIELDS.sql.jinja

@@ -22,13 +22,18 @@ logger = getLogger(__name__)
 def run(session,connection_method,connection_parameters,oauth_secret_name,other_secrets_name,function_name):
    try:
       logger.info('plugin entrypoint wrapper')
-      from omnata_plugin_runtime.plugin_entrypoints import PluginEntrypoint
+      from omnata_plugin_runtime.plugin_entrypoints import PluginEntrypoint, normalise_nulls
       logger.info('importing plugin {{plugin_class_name}} from module {{plugin_class_module}}')
       entrypoint = PluginEntrypoint(session=session,
          plugin_fqn='{{plugin_fqn}}',
          module_name='{{plugin_class_module}}',
          class_name='{{plugin_class_name}}'
       )
+      oauth_secret_name = normalise_nulls(oauth_secret_name)
+      other_secrets_name = normalise_nulls(other_secrets_name)
+      # no idea why this sometimes happens, I blame some versions of the snowflake python connector
+      if oauth_secret_name=='None':
+         oauth_secret_name=None
       result = entrypoint.ngrok_post_tunnel_fields(connection_method,connection_parameters,oauth_secret_name,other_secrets_name,function_name)
       logger.debug(f'result from plugin: {result}')
       return {

omnata_plugin_devkit-0.3.8/src/omnata_plugin_devkit/jinja_templates/TUNNEL_TEST.sql.jinja

@@ -0,0 +1,107 @@
+create or replace procedure PLUGIN.TUNNEL_TEST(TUNNEL_TYPE VARCHAR,
+                                                OTHER_SECRETS_NAME VARCHAR)
+returns object
+language python
+RUNTIME_VERSION = '3.10'
+EXTERNAL_ACCESS_INTEGRATIONS = ()
+PACKAGES = ({{packages}})
+SECRETS = ()
+IMPORTS = ('/app.zip')
+HANDLER = 'run'
+execute as owner
+as
+$$
+from logging import getLogger
+from omnata_plugin_runtime.logging import log_exception
+import json
+from urllib3.contrib.pyopenssl import PyOpenSSLContext
+import OpenSSL.crypto
+import urllib3
+import ssl
+import certifi
+logger = getLogger(__name__)
+def run(session,tunnel_type:str,other_secrets_name:str):
+   try:
+      logger.info('plugin entrypoint wrapper')
+      if tunnel_type!='ngrok':
+         raise ValueError('Only ngrok tunnels are supported')
+      from omnata_plugin_runtime.plugin_entrypoints import PluginEntrypoint
+      logger.info('importing plugin {{plugin_class_name}} from module {{plugin_class_module}}')
+      entrypoint = PluginEntrypoint(session=session,
+         plugin_fqn='{{plugin_fqn}}',
+         module_name='{{plugin_class_module}}',
+         class_name='{{plugin_class_name}}'
+      )
+      secrets = entrypoint.get_secrets(None,other_secrets_name)
+      if "ngrok_endpoint_host" not in secrets:
+         raise ValueError("No endpoint host available for tunnel test")
+      if "ngrok_endpoint_port" not in secrets:
+         raise ValueError("No endpoint port available for tunnel test")
+      if "ngrok_client_certificate" not in secrets:
+         raise ValueError("No client certificate available for tunnel test")
+      if "ngrok_client_key" not in secrets:
+         raise ValueError("No client key available for tunnel test")
+      ngrok_endpoint_host = secrets['ngrok_endpoint_host'].value
+      ngrok_endpoint_port = int(secrets['ngrok_endpoint_port'].value)
+      if ngrok_endpoint_port != 443:
+         raise ValueError('Currently we always expect port 443')
+      ngrok_client_certificate = secrets['ngrok_client_certificate'].value
+      ngrok_client_key = secrets['ngrok_client_key'].value
+      return_data = {}
+      ssl_context = create_ssl_context(ngrok_client_certificate, ngrok_client_key)
+      http = urllib3.PoolManager(ssl_context=ssl_context)
+      url = f'https://{ngrok_endpoint_host}/'
+      try:
+         response=http.request('GET',url)
+      except urllib3.exceptions.MaxRetryError as max_retry_error:
+         if isinstance(max_retry_error.reason, urllib3.exceptions.SSLError):
+            ssl_error:urllib3.exceptions.SSLError = max_retry_error.reason
+            if 'sslv3 alert bad certificate' in str(ssl_error):
+                  logger.exception("Client certificate was not valid")
+                  return_data['mtls_success'] = False
+                  return_data['mtls_failure_reason'] = "Client certificate was not valid. Contact Omnata Support for assistance."
+            elif 'certificate verify failed' in str(ssl_error):
+                  logger.exception("Server certificate was not trusted")
+                  return_data['mtls_success'] = False
+                  return_data['mtls_failure_reason'] = "Server certificate was not trusted. Contact Omnata Support for assistance."
+            else:
+                  raise
+         elif isinstance(max_retry_error.reason, urllib3.exceptions.ProtocolError):
+            return_data['mtls_success'] = True
+         else:
+            raise
+
+      logger.info(f'result from tunnel test : {return_data}')
+      return {
+         "success": True,
+         "data": return_data
+      }
+   except Exception as exception:
+      log_exception(exception,logger)
+      return {
+         "success": False,
+         "error": f"TUNNEL_TEST: {str(exception)}"
+      }
+
+def create_ssl_context(cert_str, key_str):
+    # Load client certificate and key
+    certificate = OpenSSL.crypto.load_certificate(OpenSSL.crypto.FILETYPE_PEM, cert_str)
+    private_key = OpenSSL.crypto.load_privatekey(OpenSSL.crypto.FILETYPE_PEM, key_str)
+
+    # Create a PyOpenSSL Context
+    ssl_context = PyOpenSSLContext(ssl.PROTOCOL_TLSv1_2)
+    
+    # Use the certificate and key in the context
+    ssl_context._ctx.use_certificate(certificate)
+    ssl_context._ctx.use_privatekey(private_key)
+    ssl_context.verify_mode = ssl.VerifyMode.CERT_REQUIRED
+    ssl_context.load_verify_locations(cafile=certifi.where())
+
+    return ssl_context
+
+$$
+;
+   
+grant usage on procedure PLUGIN.TUNNEL_TEST(VARCHAR, 
+                                    VARCHAR)
+to application role OMNATA_MANAGEMENT;

{omnata_plugin_devkit-0.3.7 → omnata_plugin_devkit-0.3.8}/src/omnata_plugin_devkit/plugin_uploader.py

@@ -425,6 +425,7 @@ class PluginUploader:
                 "RETRIEVE_SECRETS",
                 "SYNC",
                 "TEST_OAUTH_TOKEN_EXISTS",
+                "TUNNEL_TEST",
                 "UPDATE_GENERIC_SECRET_OBJECT"
             ]:
                 template = environment.get_template(f"{proc_template}.sql.jinja")