otdf-python 0.0.10__py3-none-any.whl → 0.0.12__py3-none-any.whl

otdf_python/build.py

@@ -149,6 +149,11 @@ mod.add_function('Slice_uint8_elem', retval('uint8_t'), [param('int64_t', 'handl
 mod.add_function('Slice_uint8_subslice', retval('int64_t'), [param('int64_t', 'handle'), param('int', 'st'), param('int', 'ed')])
 mod.add_function('Slice_uint8_set', None, [param('int64_t', 'handle'), param('int', 'idx'), param('uint8_t', 'value')])
 mod.add_function('Slice_uint8_append', None, [param('int64_t', 'handle'), param('uint8_t', 'value')])
+mod.add_function('gotdf_python_TokenAuth_CTor', retval('int64_t'), [])
+mod.add_function('gotdf_python_TokenAuth_AccessToken_Get', retval('char*'), [param('int64_t', 'handle')])
+mod.add_function('gotdf_python_TokenAuth_AccessToken_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
+mod.add_function('gotdf_python_TokenAuth_NpeClientId_Get', retval('char*'), [param('int64_t', 'handle')])
+mod.add_function('gotdf_python_TokenAuth_NpeClientId_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
 mod.add_function('gotdf_python_DecryptionConfig_CTor', retval('int64_t'), [])
 mod.add_function('gotdf_python_DecryptionConfig_ClientId_Get', retval('char*'), [param('int64_t', 'handle')])
 mod.add_function('gotdf_python_DecryptionConfig_ClientId_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
@@ -173,18 +178,13 @@ mod.add_function('gotdf_python_EncryptionConfig_KasUrl_Get', retval('char*'), [p
 mod.add_function('gotdf_python_EncryptionConfig_KasUrl_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
 mod.add_function('gotdf_python_EncryptionConfig_DataAttributes_Get', retval('int64_t'), [param('int64_t', 'handle')])
 mod.add_function('gotdf_python_EncryptionConfig_DataAttributes_Set', None, [param('int64_t', 'handle'), param('int64_t', 'val')])
-mod.add_function('gotdf_python_TokenAuth_CTor', retval('int64_t'), [])
-mod.add_function('gotdf_python_TokenAuth_AccessToken_Get', retval('char*'), [param('int64_t', 'handle')])
-mod.add_function('gotdf_python_TokenAuth_AccessToken_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
-mod.add_function('gotdf_python_TokenAuth_NpeClientId_Get', retval('char*'), [param('int64_t', 'handle')])
-mod.add_function('gotdf_python_TokenAuth_NpeClientId_Set', None, [param('int64_t', 'handle'), param('char*', 'val')])
+add_checked_string_function(mod, 'gotdf_python_DecryptFile', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config')])
+add_checked_string_function(mod, 'gotdf_python_DecryptFilePE', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config'), param('int64_t', 'token')])
+add_checked_string_function(mod, 'gotdf_python_DecryptStringPE', retval('char*'), [param('char*', 'inputText'), param('int64_t', 'config'), param('int64_t', 'token')])
 add_checked_string_function(mod, 'gotdf_python_EncryptFile', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config')])
 add_checked_string_function(mod, 'gotdf_python_EncryptFilePE', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config'), param('int64_t', 'token')])
 add_checked_string_function(mod, 'gotdf_python_EncryptString', retval('char*'), [param('char*', 'inputText'), param('int64_t', 'config')])
 add_checked_string_function(mod, 'gotdf_python_Hello', retval('char*'), [])
-add_checked_string_function(mod, 'gotdf_python_DecryptFile', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config')])
-add_checked_string_function(mod, 'gotdf_python_DecryptFilePE', retval('char*'), [param('char*', 'inputFilePath'), param('char*', 'outputFilePath'), param('int64_t', 'config'), param('int64_t', 'token')])
-add_checked_string_function(mod, 'gotdf_python_DecryptStringPE', retval('char*'), [param('char*', 'inputText'), param('int64_t', 'config'), param('int64_t', 'token')])
 
 mod.generate(open('gotdf_python.c', 'w'))
 

otdf_python/gotdf_python.py

@@ -44,6 +44,73 @@ os.chdir(cwd)
 
 # ---- Structs ---
 
+# Python type for struct gotdf_python.TokenAuth
+class TokenAuth(go.GoClass):
+	""""""
+	def __init__(self, *args, **kwargs):
+		"""
+		handle=A Go-side object is always initialized with an explicit handle=arg
+		otherwise parameters can be unnamed in order of field names or named fields
+		in which case a new Go object is constructed first
+		"""
+		if len(kwargs) == 1 and 'handle' in kwargs:
+			self.handle = kwargs['handle']
+			_gotdf_python.IncRef(self.handle)
+		elif len(args) == 1 and isinstance(args[0], go.GoClass):
+			self.handle = args[0].handle
+			_gotdf_python.IncRef(self.handle)
+		else:
+			self.handle = _gotdf_python.gotdf_python_TokenAuth_CTor()
+			_gotdf_python.IncRef(self.handle)
+			if  0 < len(args):
+				self.AccessToken = args[0]
+			if "AccessToken" in kwargs:
+				self.AccessToken = kwargs["AccessToken"]
+			if  1 < len(args):
+				self.NpeClientId = args[1]
+			if "NpeClientId" in kwargs:
+				self.NpeClientId = kwargs["NpeClientId"]
+	def __del__(self):
+		_gotdf_python.DecRef(self.handle)
+	def __str__(self):
+		pr = [(p, getattr(self, p)) for p in dir(self) if not p.startswith('__')]
+		sv = 'gotdf_python.TokenAuth{'
+		first = True
+		for v in pr:
+			if callable(v[1]):
+				continue
+			if first:
+				first = False
+			else:
+				sv += ', '
+			sv += v[0] + '=' + str(v[1])
+		return sv + '}'
+	def __repr__(self):
+		pr = [(p, getattr(self, p)) for p in dir(self) if not p.startswith('__')]
+		sv = 'gotdf_python.TokenAuth ( '
+		for v in pr:
+			if not callable(v[1]):
+				sv += v[0] + '=' + str(v[1]) + ', '
+		return sv + ')'
+	@property
+	def AccessToken(self):
+		return _gotdf_python.gotdf_python_TokenAuth_AccessToken_Get(self.handle)
+	@AccessToken.setter
+	def AccessToken(self, value):
+		if isinstance(value, go.GoClass):
+			_gotdf_python.gotdf_python_TokenAuth_AccessToken_Set(self.handle, value.handle)
+		else:
+			_gotdf_python.gotdf_python_TokenAuth_AccessToken_Set(self.handle, value)
+	@property
+	def NpeClientId(self):
+		return _gotdf_python.gotdf_python_TokenAuth_NpeClientId_Get(self.handle)
+	@NpeClientId.setter
+	def NpeClientId(self, value):
+		if isinstance(value, go.GoClass):
+			_gotdf_python.gotdf_python_TokenAuth_NpeClientId_Set(self.handle, value.handle)
+		else:
+			_gotdf_python.gotdf_python_TokenAuth_NpeClientId_Set(self.handle, value)
+
 # Python type for struct gotdf_python.DecryptionConfig
 class DecryptionConfig(go.GoClass):
 	""""""
@@ -269,73 +336,6 @@ class EncryptionConfig(go.GoClass):
 		else:
 			raise TypeError("supplied argument type {t} is not a go.GoClass".format(t=type(value)))
 
-# Python type for struct gotdf_python.TokenAuth
-class TokenAuth(go.GoClass):
-	""""""
-	def __init__(self, *args, **kwargs):
-		"""
-		handle=A Go-side object is always initialized with an explicit handle=arg
-		otherwise parameters can be unnamed in order of field names or named fields
-		in which case a new Go object is constructed first
-		"""
-		if len(kwargs) == 1 and 'handle' in kwargs:
-			self.handle = kwargs['handle']
-			_gotdf_python.IncRef(self.handle)
-		elif len(args) == 1 and isinstance(args[0], go.GoClass):
-			self.handle = args[0].handle
-			_gotdf_python.IncRef(self.handle)
-		else:
-			self.handle = _gotdf_python.gotdf_python_TokenAuth_CTor()
-			_gotdf_python.IncRef(self.handle)
-			if  0 < len(args):
-				self.AccessToken = args[0]
-			if "AccessToken" in kwargs:
-				self.AccessToken = kwargs["AccessToken"]
-			if  1 < len(args):
-				self.NpeClientId = args[1]
-			if "NpeClientId" in kwargs:
-				self.NpeClientId = kwargs["NpeClientId"]
-	def __del__(self):
-		_gotdf_python.DecRef(self.handle)
-	def __str__(self):
-		pr = [(p, getattr(self, p)) for p in dir(self) if not p.startswith('__')]
-		sv = 'gotdf_python.TokenAuth{'
-		first = True
-		for v in pr:
-			if callable(v[1]):
-				continue
-			if first:
-				first = False
-			else:
-				sv += ', '
-			sv += v[0] + '=' + str(v[1])
-		return sv + '}'
-	def __repr__(self):
-		pr = [(p, getattr(self, p)) for p in dir(self) if not p.startswith('__')]
-		sv = 'gotdf_python.TokenAuth ( '
-		for v in pr:
-			if not callable(v[1]):
-				sv += v[0] + '=' + str(v[1]) + ', '
-		return sv + ')'
-	@property
-	def AccessToken(self):
-		return _gotdf_python.gotdf_python_TokenAuth_AccessToken_Get(self.handle)
-	@AccessToken.setter
-	def AccessToken(self, value):
-		if isinstance(value, go.GoClass):
-			_gotdf_python.gotdf_python_TokenAuth_AccessToken_Set(self.handle, value.handle)
-		else:
-			_gotdf_python.gotdf_python_TokenAuth_AccessToken_Set(self.handle, value)
-	@property
-	def NpeClientId(self):
-		return _gotdf_python.gotdf_python_TokenAuth_NpeClientId_Get(self.handle)
-	@NpeClientId.setter
-	def NpeClientId(self, value):
-		if isinstance(value, go.GoClass):
-			_gotdf_python.gotdf_python_TokenAuth_NpeClientId_Set(self.handle, value.handle)
-		else:
-			_gotdf_python.gotdf_python_TokenAuth_NpeClientId_Set(self.handle, value)
-
 
 # ---- Slices ---
 
@@ -347,6 +347,15 @@ class TokenAuth(go.GoClass):
 
 
 # ---- Functions ---
+def DecryptFile(inputFilePath, outputFilePath, config):
+	"""DecryptFile(str inputFilePath, str outputFilePath, object config) str, str"""
+	return _gotdf_python.gotdf_python_DecryptFile(inputFilePath, outputFilePath, config.handle)
+def DecryptFilePE(inputFilePath, outputFilePath, config, token):
+	"""DecryptFilePE(str inputFilePath, str outputFilePath, object config, object token) str, str"""
+	return _gotdf_python.gotdf_python_DecryptFilePE(inputFilePath, outputFilePath, config.handle, token.handle)
+def DecryptStringPE(inputText, config, token):
+	"""DecryptStringPE(str inputText, object config, object token) str, str"""
+	return _gotdf_python.gotdf_python_DecryptStringPE(inputText, config.handle, token.handle)
 def EncryptFile(inputFilePath, outputFilePath, config):
 	"""EncryptFile(str inputFilePath, str outputFilePath, object config) str, str"""
 	return _gotdf_python.gotdf_python_EncryptFile(inputFilePath, outputFilePath, config.handle)
@@ -370,14 +379,5 @@ def Hello():
 	conventional & useful function like GetVersion()
 	"""
 	return _gotdf_python.gotdf_python_Hello()
-def DecryptFile(inputFilePath, outputFilePath, config):
-	"""DecryptFile(str inputFilePath, str outputFilePath, object config) str, str"""
-	return _gotdf_python.gotdf_python_DecryptFile(inputFilePath, outputFilePath, config.handle)
-def DecryptFilePE(inputFilePath, outputFilePath, config, token):
-	"""DecryptFilePE(str inputFilePath, str outputFilePath, object config, object token) str, str"""
-	return _gotdf_python.gotdf_python_DecryptFilePE(inputFilePath, outputFilePath, config.handle, token.handle)
-def DecryptStringPE(inputText, config, token):
-	"""DecryptStringPE(str inputText, object config, object token) str, str"""
-	return _gotdf_python.gotdf_python_DecryptStringPE(inputText, config.handle, token.handle)
 
 

otdf_python-0.0.12.dist-info/METADATA

@@ -0,0 +1,149 @@
+Metadata-Version: 2.1
+Name: otdf_python
+Version: 0.0.12
+Home-page: https://github.com/b-long/opentdf-python-sdk
+Author-email: b-long@users.noreply.github.com
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# opentdf-python-sdk
+
+Unofficial OpenTDF SDK for Python
+
+[![Tests](https://github.com/b-long/opentdf-python-sdk/workflows/PyPIBuild/badge.svg)](https://github.com/b-long/opentdf-python-sdk/actions?query=workflow%3APyPIBuild)
+
+This project is powered by gopy, which generates (and compiles) a CPython extension module from a go package.  The `gopy`
+tool unlocks performance, flexibility, and excellent Developer Experience to Python end-users.  Read more about
+[`gopy` on Github](https://github.com/go-python/gopy).
+
+## Adding features
+
+If you wish to expand the functionality of `otdf-python`:
+
+1. Create a fork/branch
+1. Add new capabilities (e.g. in `main.go`)
+1. Add a test (e.g. in `otdf_python_test.go`)
+1. Commit your changes, push, and open a Pull Request via
+the Github project: https://github.com/b-long/opentdf-python-sdk
+
+## Installation
+
+Install from the [Python Package Index (PyPI)](https://pypi.org):
+
+```bash
+# Install the latest from pypi.org
+pip install otdf_python
+
+# Install a pinned version
+pip install otdf-python==0.0.9
+
+# Install a pinned version, from test.pypi.org
+pip install -i https://test.pypi.org/simple/ otdf-python==0.0.9
+```
+
+## Usage
+
+Simple usage examples are given below.  In addition, we recommend you also:
+
+1. See the contents of [`main.go` on Github](https://github.com/b-long/opentdf-python-sdk/blob/main/main.go).  ✨ Note that all Upper-case functions are available in Python.
+1. See the contents of [`validate_otdf_python.py` on Github](https://github.com/b-long/opentdf-python-sdk/blob/main/validate_otdf_python.py).
+
+### Example: Configuration
+
+Creating a helper function may simplify the usage of `otdf-python`.
+
+For example:
+
+```python
+def get_encrypt_config(data_attributes: list | None = None):
+    """
+    The config object returned here can only be used for encryption.
+
+    While 'otdf_python.gotdf_python' internally can use golang interfaces,
+     to normalize config objects, that pattern causes a panic
+     when used from Python.
+
+    """
+    print("Preparing 'EncryptionConfig' object")
+    from otdf_python.gotdf_python import EncryptionConfig
+    from otdf_python.go import Slice_string
+
+    if isinstance(data_attributes, list):
+        # Create config using the attributes from the caller
+        da = Slice_string(data_attributes)
+        config: EncryptionConfig = EncryptionConfig(
+            ClientId="opentdf-sdk",
+            ClientSecret="secret",
+            PlatformEndpoint=platformEndpoint,
+            TokenEndpoint="http://localhost:8888/auth/realms/opentdf/protocol/openid-connect/token",
+            KasUrl=f"http://{platformEndpoint}/kas",
+            # FIXME: Be careful with binding the 'DataAttributes' field on this struct.
+            #
+            # In golang, this is initialized as []string , but passing
+            # DataAttributes=None, or DataAttributes=[] from Python will fail.
+            DataAttributes=da,
+        )
+    else:
+        # Create config without attributes
+        config: EncryptionConfig = EncryptionConfig(
+            ClientId=testing_credentials.TDF_NPE_CLIENT,
+            ClientSecret=testing_credentials.TDF_NPE_CLIENT_SECRET,
+            PlatformEndpoint=testing_credentials.PLATFORM_ENDPOINT,
+            TokenEndpoint=testing_credentials.OIDC_AUTH_URL,
+            KasUrl=testing_credentials.KAS_URL,
+        )
+
+    # NOTE: Structs from golang can be printed, like below
+    # print(config)
+    print("Returning 'EncryptionConfig'")
+
+    return config
+```
+
+
+### Example: Encrypt a string
+
+```python
+from otdf_python.gotdf_python import EncryptString
+
+# Depends on the 'get_encrypt_config()' given
+# in the README above
+config: EncryptionConfig = get_encrypt_config()
+
+tdf_manifest_json = EncryptString(inputText="Hello from Python", config=config)
+```
+
+### Example: Encrypt a file
+
+```python
+from otdf_python.gotdf_python import EncryptFile
+from otdf_python.go import Slice_string
+
+# Depends on the 'get_encrypt_config()' given
+# in the README above
+config: EncryptionConfig = get_encrypt_config()
+
+with tempfile.TemporaryDirectory() as tmpDir:
+    print("Created temporary directory", tmpDir)
+
+    da = Slice_string(["https://example.com/attr/attr1/value/value1", "https://example.com/attr/attr1/value/value2"])
+
+    encrypted_file = Path(tmpDir) / "some-file.tdf"
+
+    if encrypted_file.exists():
+        encrypted_file.unlink()
+
+    if encrypted_file.exists():
+        raise ValueError(
+            "The output path should not exist before calling 'EncryptFile()'."
+        )
+
+    outputFilePath = EncryptFile(
+        inputFilePath=str(SOME_PLAINTEXT_FILE),
+        outputFilePath=str(encrypted_file),
+        config=config,
+    )
+
+    print(f"The output file was written to destination path: {outputFilePath}")
+
+```

otdf_python-0.0.12.dist-info/RECORD

@@ -0,0 +1,10 @@
+otdf_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otdf_python/_gotdf_python.cpython-311-darwin.so,sha256=WaiZ__LO-HDPQBKuWhBNR3gFvNbvzhwapCGDGnC86Mg,15204536
+otdf_python/build.py,sha256=n992UQdwhJukysD1zgty1LrOnNTPEGAAG9MOWGlaJqs,16756
+otdf_python/go.py,sha256=7kz0kwEbEJZp9ZJIvdcUryZmhahLRb5RrkhGBN2BDBY,49317
+otdf_python/gotdf_python.py,sha256=1-Agpw4XFW01MudVbpiuf59ZRKSzvARXv-ojOlbeKsE,13880
+otdf_python-0.0.12.dist-info/LICENSE,sha256=51wzGxR-Rns8XaiGmDLq2OqPN3qWMpoQKV-fERpVzyM,1063
+otdf_python-0.0.12.dist-info/METADATA,sha256=udqnlCw0jdvLs_aDGRWPfBjCn4HXYxeAocYh3wv0NYA,4964
+otdf_python-0.0.12.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+otdf_python-0.0.12.dist-info/top_level.txt,sha256=A2vK95iTIxdu4pm8kDZlvHorBKCvSN5dvlMdFbIVXrA,12
+otdf_python-0.0.12.dist-info/RECORD,,

{otdf_python-0.0.10.dist-info → otdf_python-0.0.12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

otdf_python-0.0.10.dist-info/METADATA

@@ -1,26 +0,0 @@
-Metadata-Version: 2.1
-Name: otdf_python
-Version: 0.0.10
-Home-page: https://github.com/b-long/opentdf-python-sdk
-Author-email: b-long@users.noreply.github.com
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# opentdf-python-sdk
-
-Unofficial OpenTDF SDK for Python
-
-[![Tests](https://github.com/b-long/opentdf-python-sdk/workflows/PyPIBuild/badge.svg)](https://github.com/b-long/opentdf-python-sdk/actions?query=workflow%3APyPIBuild)
-
-
-## Installation
-
-Install from PyPI.org:
-
-```bash
-pip install otdf_python
-```
-
-## Usage
-
-See `validate_otdf_python.py` for usage examples.

otdf_python-0.0.10.dist-info/RECORD

@@ -1,10 +0,0 @@
-otdf_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-otdf_python/_gotdf_python.cpython-311-darwin.so,sha256=fKnB15EsCuBIYojneErkAwjE0uyrlhscu5blp224YDs,15112432
-otdf_python/build.py,sha256=1rFsosV3JfeaySm5QT14CY0x51go6XbdiL3UgreyIek,16756
-otdf_python/go.py,sha256=7kz0kwEbEJZp9ZJIvdcUryZmhahLRb5RrkhGBN2BDBY,49317
-otdf_python/gotdf_python.py,sha256=PcXrL4WNGcK-peWHhO1Xt72KYgE3US2Q0y33OlcHGtQ,13880
-otdf_python-0.0.10.dist-info/LICENSE,sha256=51wzGxR-Rns8XaiGmDLq2OqPN3qWMpoQKV-fERpVzyM,1063
-otdf_python-0.0.10.dist-info/METADATA,sha256=5WhOylKFnYmehQtp8g7kTKe1GsxJ5mJmaCIyQ6IzW2k,586
-otdf_python-0.0.10.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-otdf_python-0.0.10.dist-info/top_level.txt,sha256=A2vK95iTIxdu4pm8kDZlvHorBKCvSN5dvlMdFbIVXrA,12
-otdf_python-0.0.10.dist-info/RECORD,,