c2pa::Signer Class Reference

Signer class for creating a Signer. More...

#include <c2pa.hpp>

Public Member Functions
	Signer (SignerFunc *callback, C2paSigningAlg alg, const std::string &sign_cert, const std::string &tsa_uri)
	Create a Signer from a callback function.
	Signer (C2paSigner *c_signer)
	Create a signer from a Signer pointer and take ownership of that pointer.
	Signer (const std::string &alg, const std::string &sign_cert, const std::string &private_key, const std::optional< std::string > &tsa_uri=std::nullopt)
	Create a Signer from signing credentials.
	Signer (const Signer &)=delete
Signer &	operator= (const Signer &)=delete
	Signer (Signer &&other) noexcept
	Move constructor.
Signer &	operator= (Signer &&other) noexcept
	~Signer ()
uintptr_t	reserve_size ()
	Get the size to reserve for a signature for this Signer.
C2paSigner *	c2pa_signer () const noexcept
	Get the underlying C2paSigner pointer.

Friends
class	Context::ContextBuilder

Detailed Description

Signer class for creating a Signer.

This class is used to create a signer from a signing algorithm, certificate, and TSA URI. Supports both callback-based and direct signing methods.

Constructor & Destructor Documentation

Signer() [1/5]

c2pa::Signer::Signer	(	SignerFunc *	callback,
		C2paSigningAlg	alg,
		const std::string &	sign_cert,
		const std::string &	tsa_uri
	)

Create a Signer from a callback function.

Parameters

callback	The callback function to use for signing.
alg	The signing algorithm to use (e.g., C2paSigningAlg::PS256).
sign_cert	The signing certificate in PEM format.
tsa_uri	The timestamp authority URI for time-stamping.

Exceptions

C2paException

if signer creation fails.

Signer() [2/5]

c2pa::Signer::Signer ( C2paSigner *  c_signer )

inline

Create a signer from a Signer pointer and take ownership of that pointer.

Parameters

c_signer

The C2paSigner pointer (must be non-null).

                                     : signer(c_signer) {
            if (!c_signer) {
                throw C2paException("Signer can not be null");
            }
        }

Signer() [3/5]

c2pa::Signer::Signer	(	const std::string &	alg,
		const std::string &	sign_cert,
		const std::string &	private_key,
		const std::optional< std::string > &	tsa_uri = std::nullopt
	)

Create a Signer from signing credentials.

Parameters

alg	Signing algorithm name (e.g., "ps256", "es256").
sign_cert	Signing certificate in PEM format.
private_key	Private key in PEM format.
tsa_uri	Optional timestamp authority URI.

Exceptions

C2paException

if signer creation fails.

Signer() [4/5]

c2pa::Signer::Signer ( const Signer &  )

delete

Signer() [5/5]

c2pa::Signer::Signer ( Signer &&  other )

inlinenoexcept

Move constructor.

Parameters

other

Signer to move from.

                                        : signer(std::exchange(other.signer, nullptr)) {
        }

~Signer()

c2pa::Signer::~Signer

(

)

Member Function Documentation

c2pa_signer()

C2paSigner * c2pa::Signer::c2pa_signer ( ) const

noexcept

Get the underlying C2paSigner pointer.

Returns

Pointer to the C2paSigner object.

operator=() [1/2]

Signer & c2pa::Signer::operator= ( const Signer &  )

delete

operator=() [2/2]

Signer & c2pa::Signer::operator= ( Signer &&  other )

inlinenoexcept

                                                   {
            if (this != &other) {
                c2pa_free(signer);
                signer = std::exchange(other.signer, nullptr);
            }
            return *this;
        }

reserve_size()

uintptr_t c2pa::Signer::reserve_size

(

)

Get the size to reserve for a signature for this Signer.

Returns

Reserved size for the signature in bytes.

Friends And Related Symbol Documentation

Context::ContextBuilder

friend class Context::ContextBuilder

friend

---

The documentation for this class was generated from the following file:

• c2pa.hpp