Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 49 additions & 2 deletions src/c2pa/c2pa.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import weakref
from abc import ABC, abstractmethod
from pathlib import Path
from typing import Optional, Union, Callable, Any, overload
from typing import Optional, Union, Callable, Any, Dict, overload
import io
from .lib import dynamically_load_library, record_owner_pid, is_foreign_process
import mimetypes
Expand Down Expand Up @@ -1396,6 +1396,15 @@ def _setup_function(func, argtypes, restype=None):
ctypes.c_char_p,
ctypes.c_char_p],
ctypes.POINTER(C2paSigner))
# Optional: native libraries built from c2pa-rs releases before it was added
# do not export it (Signer.from_callback(tsa_headers=...) then raises).
_signer_with_tsa_header = getattr(_lib, "c2pa_signer_with_tsa_header", None)
if _signer_with_tsa_header is not None:
_setup_function(_signer_with_tsa_header,
[ctypes.POINTER(C2paSigner),
ctypes.c_char_p,
ctypes.c_char_p],
ctypes.POINTER(C2paSigner))
_setup_function(_lib.c2pa_signer_from_info,
[ctypes.POINTER(C2paSignerInfo)],
ctypes.POINTER(C2paSigner))
Expand Down Expand Up @@ -3689,13 +3698,44 @@ def from_info(cls, signer_info: C2paSignerInfo) -> 'Signer':
ManagedResource._free_native_ptr(signer_ptr)
raise

@staticmethod
def _with_tsa_headers(signer_ptr, tsa_headers: Dict[str, str]):
"""Wrap a native signer so it sends ``tsa_headers`` with its timestamp
requests. Each native call consumes the signer it gets on success; on
any failure the current signer is freed and the error raised."""
if _signer_with_tsa_header is None:
ManagedResource._free_native_ptr(signer_ptr)
raise C2paError(
"tsa_headers needs a c2pa native library that exports "
"c2pa_signer_with_tsa_header"
)
for name, value in tsa_headers.items():
try:
name_bytes = name.encode('utf-8')
value_bytes = value.encode('utf-8')
except (AttributeError, UnicodeError) as e:
ManagedResource._free_native_ptr(signer_ptr)
raise C2paError.Encoding(
f"Invalid TSA header {name!r}: {e}") from e
with _native_section():
wrapped = _signer_with_tsa_header(
signer_ptr, name_bytes, value_bytes)
if not wrapped:
# Not consumed on failure: still ours to free.
ManagedResource._free_native_ptr(signer_ptr)
_check_ffi_operation_result(
wrapped, "Failed to add TSA header: {}")
signer_ptr = wrapped
return signer_ptr

@classmethod
def from_callback(
cls,
callback: Callable[[bytes], bytes],
alg: C2paSigningAlg,
certs: str,
tsa_url: Optional[str] = None
tsa_url: Optional[str] = None,
tsa_headers: Optional[Dict[str, str]] = None,
) -> 'Signer':
"""Create a signer from a callback function.

Expand All @@ -3704,6 +3744,10 @@ def from_callback(
alg: The signing algorithm to use
certs: Certificate chain in PEM format
tsa_url: Optional RFC 3161 timestamp authority URL
tsa_headers: Optional headers sent with every timestamp request,
for timestamp authorities that authenticate clients (usually
an API key, e.g. ``{"X-API-Key": key}``). Needs a native
library that exports ``c2pa_signer_with_tsa_header``.

Returns:
A new Signer instance
Expand Down Expand Up @@ -3815,6 +3859,9 @@ def wrapped_callback(
_check_ffi_operation_result(signer_ptr,
"Failed to create signer")

if tsa_headers:
signer_ptr = cls._with_tsa_headers(signer_ptr, tsa_headers)

try:
# Create and return the signer instance with the callback
signer_instance = cls(signer_ptr)
Expand Down
61 changes: 61 additions & 0 deletions tests/test_unit_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -1825,6 +1825,67 @@ def test_signer_from_callback_error_wrong_url(self):
tsa_url="ftp://timestamp.digicert.com"
)

def test_signer_from_callback_tsa_headers_need_native_support(self):
with patch.object(c2pa_module, "_signer_with_tsa_header", None):
with self.assertRaises(Error):
Signer.from_callback(
callback=self.callback_signer_es256,
alg=SigningAlg.ES256,
certs=self.certs.decode('utf-8'),
tsa_url="http://timestamp.digicert.com",
tsa_headers={"X-API-Key": "secret"},
)

def test_signer_from_callback_sends_each_tsa_header_to_the_native_signer(self):
calls = []

def with_header(signer_ptr, name, value):
calls.append((name, value))
return signer_ptr # the native call returns the wrapping signer

with patch.object(c2pa_module, "_signer_with_tsa_header", with_header):
signer = Signer.from_callback(
callback=self.callback_signer_es256,
alg=SigningAlg.ES256,
certs=self.certs.decode('utf-8'),
tsa_url="http://timestamp.digicert.com",
tsa_headers={"X-API-Key": "secret", "X-Tenant": "t1"},
)
try:
self.assertEqual(
calls, [(b"X-API-Key", b"secret"), (b"X-Tenant", b"t1")])
finally:
signer.close()

def test_signer_from_callback_tsa_header_failure_raises(self):
freed = []
with patch.object(c2pa_module, "_signer_with_tsa_header",
lambda *_: None), \
patch.object(ManagedResource, "_free_native_ptr",
side_effect=freed.append):
with self.assertRaises(Error):
Signer.from_callback(
callback=self.callback_signer_es256,
alg=SigningAlg.ES256,
certs=self.certs.decode('utf-8'),
tsa_url="http://timestamp.digicert.com",
tsa_headers={"": "secret"},
)
self.assertEqual(len(freed), 1) # the signer that was not consumed

@unittest.skipUnless(
getattr(c2pa_module, "_signer_with_tsa_header", None) is not None,
"native library without c2pa_signer_with_tsa_header")
def test_signer_from_callback_tsa_headers_native(self):
signer = Signer.from_callback(
callback=self.callback_signer_es256,
alg=SigningAlg.ES256,
certs=self.certs.decode('utf-8'),
tsa_url="http://timestamp.digicert.com",
tsa_headers={"X-API-Key": "secret"},
)
signer.close()

def test_reserve_size_on_closed_signer(self):
signer_info = C2paSignerInfo(
alg=b"es256",
Expand Down