c2pa-python 0.22.0__tar.gz → 0.23.1__tar.gz

{c2pa_python-0.22.0/src/c2pa_python.egg-info → c2pa_python-0.23.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: c2pa-python
-Version: 0.22.0
+Version: 0.23.1
 Summary: Python bindings for the C2PA Content Authenticity Initiative (CAI) library
 Author-email: Gavin Peacock <gvnpeacock@adobe.com>, Tania Mathern <mathern@adobe.com>
 Maintainer-email: Gavin Peacock <gpeacock@adobe.com>
@@ -56,9 +56,14 @@ import c2pa
 ## Examples
 
 See the [`examples` directory](https://github.com/contentauth/c2pa-python/tree/main/examples) for some helpful examples:
+
 - `examples/sign.py` shows how to sign and verify an asset with a C2PA manifest.
 - `examples/training.py` demonstrates how to add a "Do Not Train" assertion to an asset and verify it.
 
+## API reference documentation
+
+See [the section in Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md#api-reference-documentation).
+
 ## Contributing
 
 Contributions are welcome!  For more information, see [Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md).

{c2pa_python-0.22.0 → c2pa_python-0.23.1}/README.md

@@ -33,9 +33,14 @@ import c2pa
 ## Examples
 
 See the [`examples` directory](https://github.com/contentauth/c2pa-python/tree/main/examples) for some helpful examples:
+
 - `examples/sign.py` shows how to sign and verify an asset with a C2PA manifest.
 - `examples/training.py` demonstrates how to add a "Do Not Train" assertion to an asset and verify it.
 
+## API reference documentation
+
+See [the section in Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md#api-reference-documentation).
+
 ## Contributing
 
 Contributions are welcome!  For more information, see [Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md).

{c2pa_python-0.22.0 → c2pa_python-0.23.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "c2pa-python"
-version = "0.22.0"
+version = "0.23.1"
 requires-python = ">=3.10"
 description = "Python bindings for the C2PA Content Authenticity Initiative (CAI) library"
 readme = { file = "README.md", content-type = "text/markdown" }

{c2pa_python-0.22.0 → c2pa_python-0.23.1}/src/c2pa/build.py

@@ -13,7 +13,7 @@
 
 import os
 import sys
-import requests
+import requests  # type: ignore
 from pathlib import Path
 import zipfile
 import io
@@ -53,8 +53,7 @@ def download_artifact(url: str, platform_name: str) -> None:
         # Extract all files to the platform directory
         zip_ref.extractall(platform_dir)
 
-    print(f"Successfully downloaded and extracted artifacts for {
-          platform_name}")
+    print(f"Successfully downloaded and extracted artifacts for {platform_name}")
 
 
 def download_artifacts() -> None:
@@ -95,7 +94,7 @@ def download_artifacts() -> None:
 def inject_version():
     """Inject the version from pyproject.toml
     into src/c2pa/__init__.py as __version__."""
-    import toml
+    import toml  # type: ignore
     pyproject_path = os.path.abspath(
         os.path.join(
             os.path.dirname(__file__),

{c2pa_python-0.22.0 → c2pa_python-0.23.1}/src/c2pa/c2pa.py

@@ -23,6 +23,7 @@ from typing import Optional, Union, Callable, Any, overload
 import io
 from .lib import dynamically_load_library
 import mimetypes
+from itertools import count
 
 # Create a module-specific logger
 logger = logging.getLogger("c2pa")
@@ -567,7 +568,7 @@ def _convert_to_py_string(value) -> str:
         # Only if we got a valid pointer with valid content
         if ptr and ptr.value is not None:
             try:
-                py_string = ptr.value.decode('utf-8', errors='replace')
+                py_string = ptr.value.decode('utf-8', errors='strict')
             except Exception:
                 py_string = ""
             finally:
@@ -706,24 +707,14 @@ def _get_mime_type_from_path(path: Union[str, Path]) -> str:
 
 def read_ingredient_file(
         path: Union[str, Path], data_dir: Union[str, Path]) -> str:
-    """Read a file as C2PA ingredient.
+    """Read a file as C2PA ingredient (deprecated).
     This creates the JSON string that would be used as the ingredient JSON.
 
     .. deprecated:: 0.11.0
         This function is deprecated and will be removed in a future version.
-        Please use the Reader class for reading C2PA metadata instead.
-        Example:
-            ```python
-            with Reader(path) as reader:
-                manifest_json = reader.json()
-            ```
-
-        To add ingredients to a manifest, please use the Builder class.
-        Example:
-            ```
-            with open(ingredient_file_path, 'rb') as f:
-                builder.add_ingredient(ingredient_json, "image/jpeg", f)
-            ```
+        To read C2PA metadata, use the :class:`c2pa.c2pa.Reader` class.
+        To add ingredients to a manifest,
+        use :meth:`c2pa.c2pa.Builder.add_ingredient` instead.
 
     Args:
         path: Path to the file to read
@@ -766,16 +757,11 @@ def read_ingredient_file(
 
 def read_file(path: Union[str, Path],
               data_dir: Union[str, Path]) -> str:
-    """Read a C2PA manifest from a file.
+    """Read a C2PA manifest from a file (deprecated).
 
     .. deprecated:: 0.10.0
         This function is deprecated and will be removed in a future version.
-        Please use the Reader class for reading C2PA metadata instead.
-        Example:
-            ```python
-            with Reader(path) as reader:
-                manifest_json = reader.json()
-            ```
+        To read C2PA metadata, use the :class:`c2pa.c2pa.Reader` class.
 
     Args:
         path: Path to the file to read
@@ -845,7 +831,7 @@ def sign_file(
     signer_or_info: Union[C2paSignerInfo, 'Signer'],
     return_manifest_as_bytes: bool = False
 ) -> Union[str, bytes]:
-    """Sign a file with a C2PA manifest.
+    """Sign a file with a C2PA manifest (deprecated).
     For now, this function is left here to provide a backwards-compatible API.
 
     .. deprecated:: 0.13.0
@@ -926,16 +912,11 @@ def sign_file(
 
 
 class Stream:
-    # Class-level counter for generating unique stream IDs
-    # (useful for tracing streams usage in debug)
-    _next_stream_id = 0
+    # Class-level somewhat atomic counter for generating
+    #  unique stream IDs (useful for tracing streams usage in debug)
+    _stream_id_counter = count(start=0, step=1)
+
     # Maximum value for a 32-bit signed integer (2^31 - 1)
-    # This prevents integer overflow which could cause:
-    # 1. Unexpected behavior in stream ID generation
-    # 2. Potential security issues if IDs wrap around
-    # 3. Memory issues if the number grows too large
-    # When this limit is reached, we reset to 0 since the timestamp component
-    # of the stream ID ensures uniqueness even after counter reset
     _MAX_STREAM_ID = 2**31 - 1
 
     # Class-level error messages to avoid multiple creation
@@ -973,10 +954,15 @@ class Stream:
         self._stream = None
 
         # Generate unique stream ID using object ID and counter
-        if Stream._next_stream_id >= Stream._MAX_STREAM_ID:  # pragma: no cover
-            Stream._next_stream_id = 0
-        self._stream_id = f"{id(self)}-{Stream._next_stream_id}"
-        Stream._next_stream_id += 1
+        stream_counter = next(Stream._stream_id_counter)
+
+        # Handle counter overflow by resetting the counter
+        if stream_counter >= Stream._MAX_STREAM_ID:  # pragma: no cover
+            # Reset the counter to 0 and get the next value
+            Stream._stream_id_counter = count(start=0, step=1)
+            stream_counter = next(Stream._stream_id_counter)
+
+        self._stream_id = f"{id(self)}-{stream_counter}"
 
         # Rest of the existing initialization code...
         required_methods = ['read', 'write', 'seek', 'tell', 'flush']
@@ -1125,7 +1111,7 @@ class Stream:
 
         # Create the stream
         self._stream = _lib.c2pa_create_stream(
-            None,  # context
+            None,
             self._read_cb,
             self._seek_cb,
             self._write_cb,
@@ -1242,7 +1228,15 @@ class Stream:
 
 
 class Reader:
-    """High-level wrapper for C2PA Reader operations."""
+    """High-level wrapper for C2PA Reader operations.
+
+    Example:
+        ```
+        with Reader("image/jpeg", output) as reader:
+            manifest_json = reader.json()
+        ```
+        Where `output` is either an in-memory stream or an opened file.
+    """
 
     # Supported mimetypes cache
     _supported_mime_types_cache = None
@@ -1374,34 +1368,32 @@ class Reader:
                         str(e)))
 
             try:
-                # Open the file and create a stream
-                file = open(path, 'rb')
-                self._own_stream = Stream(file)
-
-                self._reader = _lib.c2pa_reader_from_stream(
-                    mime_type_str,
-                    self._own_stream._stream
-                )
+                with open(path, 'rb') as file:
+                    self._own_stream = Stream(file)
 
-                if not self._reader:
-                    self._own_stream.close()
-                    file.close()
-                    error = _parse_operation_result_for_error(
-                        _lib.c2pa_error())
-                    if error:
-                        raise C2paError(error)
-                    raise C2paError(
-                        Reader._ERROR_MESSAGES['reader_error'].format(
-                            "Unknown error"
-                        )
+                    self._reader = _lib.c2pa_reader_from_stream(
+                        mime_type_str,
+                        self._own_stream._stream
                     )
 
-                # Store the file to close it later
-                self._backing_file = file
+                    if not self._reader:
+                        self._own_stream.close()
+                        error = _parse_operation_result_for_error(
+                            _lib.c2pa_error())
+                        if error:
+                            raise C2paError(error)
+                        raise C2paError(
+                            Reader._ERROR_MESSAGES['reader_error'].format(
+                                "Unknown error"
+                            )
+                        )
 
-                self._initialized = True
+                    # Store the file to close it later
+                    self._backing_file = file
+                    self._initialized = True
 
             except Exception as e:
+                # File automatically closed by context manager
                 if self._own_stream:
                     self._own_stream.close()
                 if hasattr(self, '_backing_file') and self._backing_file:
@@ -1420,50 +1412,49 @@ class Reader:
                     f"Reader does not support {format_or_path}")
 
             try:
-                file = open(stream, 'rb')
-                self._own_stream = Stream(file)
-
-                format_str = str(format_or_path)
-                format_bytes = format_str.encode('utf-8')
-
-                if manifest_data is None:
-                    self._reader = _lib.c2pa_reader_from_stream(
-                        format_bytes, self._own_stream._stream)
-                else:
-                    if not isinstance(manifest_data, bytes):
-                        raise TypeError(
-                            Reader._ERROR_MESSAGES['manifest_error'])
-                    manifest_array = (
-                        ctypes.c_ubyte *
-                        len(manifest_data))(
-                        *
-                        manifest_data)
-                    self._reader = (
-                        _lib.c2pa_reader_from_manifest_data_and_stream(
-                            format_bytes,
-                            self._own_stream._stream,
-                            manifest_array,
-                            len(manifest_data),
+                with open(stream, 'rb') as file:
+                    self._own_stream = Stream(file)
+
+                    format_str = str(format_or_path)
+                    format_bytes = format_str.encode('utf-8')
+
+                    if manifest_data is None:
+                        self._reader = _lib.c2pa_reader_from_stream(
+                            format_bytes, self._own_stream._stream)
+                    else:
+                        if not isinstance(manifest_data, bytes):
+                            raise TypeError(
+                                Reader._ERROR_MESSAGES['manifest_error'])
+                        manifest_array = (
+                            ctypes.c_ubyte *
+                            len(manifest_data))(
+                            *
+                            manifest_data)
+                        self._reader = (
+                            _lib.c2pa_reader_from_manifest_data_and_stream(
+                                format_bytes,
+                                self._own_stream._stream,
+                                manifest_array,
+                                len(manifest_data),
+                            )
                         )
-                    )
 
-                if not self._reader:
-                    self._own_stream.close()
-                    file.close()
-                    error = _parse_operation_result_for_error(
-                        _lib.c2pa_error())
-                    if error:
-                        raise C2paError(error)
-                    raise C2paError(
-                        Reader._ERROR_MESSAGES['reader_error'].format(
-                            "Unknown error"
+                    if not self._reader:
+                        self._own_stream.close()
+                        error = _parse_operation_result_for_error(
+                            _lib.c2pa_error())
+                        if error:
+                            raise C2paError(error)
+                        raise C2paError(
+                            Reader._ERROR_MESSAGES['reader_error'].format(
+                                "Unknown error"
+                            )
                         )
-                    )
 
-                self._backing_file = file
-
-                self._initialized = True
+                    self._backing_file = file
+                    self._initialized = True
             except Exception as e:
+                # File closed by context manager
                 if self._own_stream:
                     self._own_stream.close()
                 if hasattr(self, '_backing_file') and self._backing_file:
@@ -2309,6 +2300,12 @@ class Builder:
             C2paError: If there was an error adding the ingredient
             C2paError.Encoding: If the ingredient JSON contains
               invalid UTF-8 characters
+
+        Example:
+            ```
+            with open(ingredient_file_path, 'rb') as a_file:
+                builder.add_ingredient(ingredient_json, "image/jpeg", a_file)
+            ```
         """
         return self.add_ingredient_from_stream(ingredient_json, format, source)
 
@@ -2366,7 +2363,7 @@ class Builder:
             ingredient_json: str,
             format: str,
             filepath: Union[str, Path]):
-        """Add an ingredient from a file path to the builder.
+        """Add an ingredient from a file path to the builder (deprecated).
         This is a legacy method.
 
         .. deprecated:: 0.13.0
@@ -2635,7 +2632,7 @@ def create_signer(
     certs: str,
     tsa_url: Optional[str] = None
 ) -> Signer:
-    """Create a signer from a callback function.
+    """Create a signer from a callback function (deprecated).
 
     .. deprecated:: 0.11.0
         This function is deprecated and will be removed in a future version.
@@ -2670,7 +2667,7 @@ def create_signer(
 
 
 def create_signer_from_info(signer_info: C2paSignerInfo) -> Signer:
-    """Create a signer from signer information.
+    """Create a signer from signer information (deprecated).
 
     .. deprecated:: 0.11.0
         This function is deprecated and will be removed in a future version.
@@ -2713,28 +2710,53 @@ def ed25519_sign(data: bytes, private_key: str) -> bytes:
         C2paError: If there was an error signing the data
         C2paError.Encoding: If the private key contains invalid UTF-8 chars
     """
-    data_array = (ctypes.c_ubyte * len(data))(*data)
-    try:
-        key_str = private_key.encode('utf-8')
-    except UnicodeError as e:
-        raise C2paError.Encoding(
-            f"Invalid UTF-8 characters in private key: {str(e)}")
+    if not data:
+        raise C2paError("Data to sign cannot be empty")
 
-    signature_ptr = _lib.c2pa_ed25519_sign(data_array, len(data), key_str)
+    if not private_key or not isinstance(private_key, str):
+        raise C2paError("Private key must be a non-empty string")
 
-    if not signature_ptr:
-        error = _parse_operation_result_for_error(_lib.c2pa_error())
-        if error:
-            raise C2paError(error)
-        raise C2paError("Failed to sign data with Ed25519")
+    # Create secure memory buffer for data
+    data_array = None
+    key_bytes = None
 
     try:
-        # Ed25519 signatures are always 64 bytes
-        signature = bytes(signature_ptr[:64])
-    finally:
-        _lib.c2pa_signature_free(signature_ptr)
+        # Create data array with size validation
+        data_size = len(data)
+        data_array = (ctypes.c_ubyte * data_size)(*data)
 
-    return signature
+        # Encode private key to bytes
+        try:
+            key_bytes = private_key.encode('utf-8')
+        except UnicodeError as e:
+            raise C2paError.Encoding(
+                f"Invalid UTF-8 characters in private key: {str(e)}")
+
+        # Perform the signing operation
+        signature_ptr = _lib.c2pa_ed25519_sign(
+            data_array,
+            data_size,
+            key_bytes
+        )
+
+        if not signature_ptr:
+            error = _parse_operation_result_for_error(_lib.c2pa_error())
+            if error:
+                raise C2paError(error)
+            raise C2paError("Failed to sign data with Ed25519")
+
+        try:
+            # Ed25519 signatures are always 64 bytes
+            signature = bytes(signature_ptr[:64])
+        finally:
+            _lib.c2pa_signature_free(signature_ptr)
+
+        return signature
+
+    finally:
+        if key_bytes:
+            ctypes.memset(key_bytes, 0, len(key_bytes))
+            del key_bytes
 
 
 __all__ = [

{c2pa_python-0.22.0 → c2pa_python-0.23.1/src/c2pa_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: c2pa-python
-Version: 0.22.0
+Version: 0.23.1
 Summary: Python bindings for the C2PA Content Authenticity Initiative (CAI) library
 Author-email: Gavin Peacock <gvnpeacock@adobe.com>, Tania Mathern <mathern@adobe.com>
 Maintainer-email: Gavin Peacock <gpeacock@adobe.com>
@@ -56,9 +56,14 @@ import c2pa
 ## Examples
 
 See the [`examples` directory](https://github.com/contentauth/c2pa-python/tree/main/examples) for some helpful examples:
+
 - `examples/sign.py` shows how to sign and verify an asset with a C2PA manifest.
 - `examples/training.py` demonstrates how to add a "Do Not Train" assertion to an asset and verify it.
 
+## API reference documentation
+
+See [the section in Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md#api-reference-documentation).
+
 ## Contributing
 
 Contributions are welcome!  For more information, see [Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md).

{c2pa_python-0.22.0 → c2pa_python-0.23.1}/tests/test_unit_tests.py

@@ -40,7 +40,7 @@ ALTERNATIVE_INGREDIENT_TEST_FILE = os.path.join(FIXTURES_DIR, "cloud.jpg")
 
 class TestC2paSdk(unittest.TestCase):
     def test_sdk_version(self):
-        self.assertIn("0.64.0", sdk_version())
+        self.assertIn("0.65.1", sdk_version())
 
 
 class TestReader(unittest.TestCase):
@@ -1124,7 +1124,7 @@ class TestBuilderWithSigner(unittest.TestCase):
 
         builder.close()
 
-        # Settings are global, so we reset to the default "true" here
+        # Settings are thread-local, so we reset to the default "true" here
         load_settings('{"builder": { "thumbnail": {"enabled": true}}}')
 
     def test_builder_sign_with_duplicate_ingredient(self):