C2PAVerifier Class

Properties   Methods   Events   Config Settings   Errors  

Extracts and validates the C2PA Manifests embedded in an asset.

Class Name

IPWorksLLM_C2PAVerifier

Procedural Interface

 ipworksllm_c2paverifier_open();
 ipworksllm_c2paverifier_close($res);
 ipworksllm_c2paverifier_register_callback($res, $id, $function);
 ipworksllm_c2paverifier_get_last_error($res);
 ipworksllm_c2paverifier_get_last_error_code($res);
 ipworksllm_c2paverifier_set($res, $id, $index, $value);
 ipworksllm_c2paverifier_get($res, $id, $index);
 ipworksllm_c2paverifier_do_config($res, $configurationstring);
 ipworksllm_c2paverifier_do_reset($res);
 ipworksllm_c2paverifier_do_verify($res);

Remarks

The C2PAVerifier class reads the Content Credentials embedded in an asset and reports what can be established about them: whether the signature is intact, whether the signer is trusted, and whether the asset bytes still match what was signed.

Supported Formats

JPEG, PNG and PDF are supported. The format is detected from the asset itself, and an asset in any other format is refused rather than reported as carrying no provenance, since those are different answers.

The PDF reader locates the manifest by its file specification's AFRelationship, so it reads manifests written by any conforming tool, not only those this product produced.

Validating an Asset

Set InputFile to the asset and call Verify. Every manifest found is then added to the Manifests properties, and one entry per check performed is added to ValidationResults.

C2PAVerifier verifier = new C2PAVerifier(); verifier.InputFile = "photo-signed.jpg"; verifier.Verify(); foreach (C2PAValidationResult result in verifier.ValidationResults) Console.WriteLine(result.Severity + " " + result.Code + ": " + result.Explanation);

Reading the Results

Validation is not a single boolean. The C2PA specification defines a status code for each individual check, and the class reports them verbatim so an application can decide how much weight to give each one. A signature that verifies but whose signer is not on a trust list is a different situation from one whose content binding fails.

Each entry in ValidationResults carries a Severity of success, informational, or failure. Codes such as claimSignature.validated and assertion.dataHash.match are successes; assertion.dataHash.mismatch means the asset was altered after signing; signingCredential.untrusted means the signature is intact but the signer does not chain to any configured trust anchor.

The ValidationStatus event fires once for each result as it is produced, which is convenient when validation should be reported incrementally rather than inspected afterwards.

The Provenance Chain

An asset may carry more than one manifest: the active manifest describes the most recent edit, and earlier manifests describe the ingredients it was built from. All of them appear in Manifests, with ActiveManifestIndex identifying the active one.

verifier.Verify(); C2PAManifest active = verifier.Manifests[verifier.ActiveManifestIndex]; Console.WriteLine("Produced by " + active.ClaimGenerator + ", signed by " + active.SignerSubject);

Trust Anchors

By default the class validates signing certificates against the built-in C2PA trust list. Additional anchors are supplied through the TrustedCerts properties, and are used in addition to the built-in list rather than instead of it, as the C2PA specification prescribes. Setting UseC2PATrustList to False restricts validation to the supplied anchors alone, which is the correct configuration for a private PKI.

Setting CheckRevocation to True additionally performs online revocation checking. Revocation information stapled into the manifest by the signer is always used when present, whether or not online checking is enabled.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ActiveManifestIndex Property (IPWorksLLM_C2PAVerifier Class)

The index of the active manifest in the Manifests collection.

Object Oriented Interface

public function getActiveManifestIndex();

Procedural Interface

ipworksllm_c2paverifier_get($res, 1);

Default Value

-1

Remarks

This property identifies which item in Manifests is the active manifest, the one describing how the asset reached its current state. The C2PA specification fixes the active manifest as the last one in the manifest store.

The value is -1 when no manifest was found.

This property is read-only and not available at design time.

Data Type

Integer

CheckRevocation Property (IPWorksLLM_C2PAVerifier Class)

Whether online revocation checking is performed.

Object Oriented Interface

public function getCheckRevocation();
public function setCheckRevocation($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 2);
ipworksllm_c2paverifier_set($res, 2, $value);

Default Value

false

Remarks

This property controls whether the class contacts OCSP responders or downloads CRLs to determine whether the signing certificate has been revoked.

Revocation information stapled into the manifest by the signer is always used when present, whether or not this property is set. Setting it to True additionally performs an online check, which requires network access and makes verification slower.

When revocation cannot be determined, verification does not fail; an informational result such as signingCredential.ocsp.inaccessible or signingCredential.ocsp.skipped is reported so the application can decide what that is worth.

The default value is False.

This property is not available at design time.

Data Type

Boolean

IngredientCount Property (IPWorksLLM_C2PAVerifier Class)

The number of records in the Ingredient arrays.

Object Oriented Interface

public function getIngredientCount();
public function setIngredientCount($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 3);
ipworksllm_c2paverifier_set($res, 3, $value);

Default Value

0

Remarks

This property controls the size of the following arrays:

• IngredientFormat
• IngredientInstanceId
• IngredientManifestLabel
• IngredientRelationship
• IngredientTitle

The array indices start at 0 and end at IngredientCount - 1.

This property is not available at design time.

Data Type

Integer

IngredientFormat Property (IPWorksLLM_C2PAVerifier Class)

The media type of the ingredient asset.

Object Oriented Interface

public function getIngredientFormat($ingredientindex);
public function setIngredientFormat($ingredientindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 4, $ingredientindex);
ipworksllm_c2paverifier_set($res, 4, $value, $ingredientindex);

Default Value

''

Remarks

The media type of the ingredient asset.

This field holds the media type of the asset that went into this one, for example image/jpeg, image/png or application/pdf. The class fills it in from the source asset when the ingredient is added.

The $ingredientindex parameter specifies the index of the item in the array. The size of the array is controlled by the IngredientCount property.

This property is not available at design time.

Data Type

String

IngredientInstanceId Property (IPWorksLLM_C2PAVerifier Class)

The instance identifier of the ingredient asset.

Object Oriented Interface

public function getIngredientInstanceId($ingredientindex);
public function setIngredientInstanceId($ingredientindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 5, $ingredientindex);
ipworksllm_c2paverifier_set($res, 5, $value, $ingredientindex);

Default Value

''

Remarks

The instance identifier of the ingredient asset.

This field holds the identifier of the exact version of the asset that went into this one, normally an XMP instance identifier such as xmp:iid:....

When the ingredient carried a C2PA Manifest of its own, the class fills this in from that Manifest's claim, so the reference names the precise version that was used rather than the document in general.

Version 2 of the ingredient assertion also carried a document identifier. Version 3, which this class writes, removed it, so there is no corresponding field.

The $ingredientindex parameter specifies the index of the item in the array. The size of the array is controlled by the IngredientCount property.

This property is not available at design time.

Data Type

String

IngredientManifestLabel Property (IPWorksLLM_C2PAVerifier Class)

The label of the ingredient's own C2PA Manifest.

Object Oriented Interface

public function getIngredientManifestLabel($ingredientindex);
public function setIngredientManifestLabel($ingredientindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 6, $ingredientindex);
ipworksllm_c2paverifier_set($res, 6, $value, $ingredientindex);

Default Value

''

Remarks

The label of the ingredient's own C2PA Manifest.

This field identifies the manifest that describes the ingredient, when the ingredient carried one. It is the urn:c2pa label of that manifest within the same manifest store.

An empty value means the ingredient arrived without provenance data of its own.

The $ingredientindex parameter specifies the index of the item in the array. The size of the array is controlled by the IngredientCount property.

This property is not available at design time.

Data Type

String

IngredientRelationship Property (IPWorksLLM_C2PAVerifier Class)

How the ingredient relates to the asset.

Object Oriented Interface

public function getIngredientRelationship($ingredientindex);
public function setIngredientRelationship($ingredientindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 7, $ingredientindex);
ipworksllm_c2paverifier_set($res, 7, $value, $ingredientindex);

Default Value

'componentOf'

Remarks

How the ingredient relates to the asset.

This field describes the ingredient's role. The C2PA specification defines the following values:

The default value is componentOf.

The $ingredientindex parameter specifies the index of the item in the array. The size of the array is controlled by the IngredientCount property.

This property is not available at design time.

Data Type

String

IngredientTitle Property (IPWorksLLM_C2PAVerifier Class)

A human-readable name for the ingredient.

Object Oriented Interface

public function getIngredientTitle($ingredientindex);
public function setIngredientTitle($ingredientindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 8, $ingredientindex);
ipworksllm_c2paverifier_set($res, 8, $value, $ingredientindex);

Default Value

''

Remarks

A human-readable name for the ingredient.

This field holds a title for the ingredient asset, typically its filename, so a consumer can present the provenance chain in terms a person recognises.

The $ingredientindex parameter specifies the index of the item in the array. The size of the array is controlled by the IngredientCount property.

This property is not available at design time.

Data Type

String

InputData Property (IPWorksLLM_C2PAVerifier Class)

The asset to process, held in memory.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 9);
ipworksllm_c2paverifier_set($res, 9, $value);

Default Value

''

Remarks

This property specifies the asset to be processed as a byte array, for applications that do not work with files on disk.

When both InputFile and this property are set, InputFile takes precedence.

Data Type

Binary String

InputFile Property (IPWorksLLM_C2PAVerifier Class)

The asset to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 10);
ipworksllm_c2paverifier_set($res, 10, $value);

Default Value

''

Remarks

This property specifies the asset to be processed. Set it to the full or relative path of the file.

When both this property and InputData are set, this property takes precedence.

Data Type

String

ManifestCount Property (IPWorksLLM_C2PAVerifier Class)

The number of records in the Manifest arrays.

Object Oriented Interface

public function getManifestCount();

Procedural Interface

ipworksllm_c2paverifier_get($res, 11);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ManifestClaimGenerator
• ManifestIsActive
• ManifestLabel
• ManifestSignerSubject
• ManifestSigningTime

The array indices start at 0 and end at ManifestCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ManifestClaimGenerator Property (IPWorksLLM_C2PAVerifier Class)

The tool that produced this manifest.

Object Oriented Interface

public function getManifestClaimGenerator($manifestindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 12, $manifestindex);

Default Value

''

Remarks

The tool that produced this manifest.

This field names the application that created the claim, as recorded by its signer.

It is a claim, not a verified fact: it says what the signer wrote down. What the signature establishes is who wrote it, which is ManifestSignerSubject.

The $manifestindex parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

This property is read-only and not available at design time.

Data Type

String

ManifestIsActive Property (IPWorksLLM_C2PAVerifier Class)

Whether this is the active manifest.

Object Oriented Interface

public function getManifestIsActive($manifestindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 13, $manifestindex);

Default Value

false

Remarks

Whether this is the active manifest.

This field is True for the manifest that describes how the asset reached its current state, and False for the manifests that came with its ingredients.

The C2PA specification fixes the active manifest as the last one in the manifest store.

The $manifestindex parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ManifestLabel Property (IPWorksLLM_C2PAVerifier Class)

The manifest's identifier.

Object Oriented Interface

public function getManifestLabel($manifestindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 14, $manifestindex);

Default Value

''

Remarks

The manifest's identifier.

This field holds the manifest's label, a urn:c2pa value that uniquely identifies it within the manifest store. Ingredients refer to their manifests by this value.

The $manifestindex parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

This property is read-only and not available at design time.

Data Type

String

ManifestSignerSubject Property (IPWorksLLM_C2PAVerifier Class)

The subject of the certificate that signed the claim.

Object Oriented Interface

public function getManifestSignerSubject($manifestindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 15, $manifestindex);

Default Value

''

Remarks

The subject of the certificate that signed the claim.

This field holds the distinguished name of the signing certificate's subject.

This is the identity the signature actually establishes, provided the certificate chains to a trust anchor. Check the validation results for signingCredential.trusted before treating it as meaningful: an untrusted certificate can carry any subject its issuer chose to put in it.

The $manifestindex parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

This property is read-only and not available at design time.

Data Type

String

ManifestSigningTime Property (IPWorksLLM_C2PAVerifier Class)

When the claim was signed.

Object Oriented Interface

public function getManifestSigningTime($manifestindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 16, $manifestindex);

Default Value

''

Remarks

When the claim was signed.

This field holds the signing time as an RFC 3339 date and time.

When the manifest carries an RFC 3161 time-stamp, this is the time attested by the Time Stamping Authority, and it is what allows the signature to remain verifiable after the signing certificate expires. Without a time-stamp the value is the signer's own claimed time, which carries no more weight than the rest of the claim.

The $manifestindex parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertCount Property (IPWorksLLM_C2PAVerifier Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();
public function setTrustedCertCount($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 17);
ipworksllm_c2paverifier_set($res, 17, $value);

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertEffectiveDate
• TrustedCertEncoded
• TrustedCertExpirationDate
• TrustedCertExtendedKeyUsage
• TrustedCertFingerprint
• TrustedCertFingerprintSHA1
• TrustedCertFingerprintSHA256
• TrustedCertIssuer
• TrustedCertPrivateKey
• TrustedCertPrivateKeyAvailable
• TrustedCertPrivateKeyContainer
• TrustedCertPublicKey
• TrustedCertPublicKeyAlgorithm
• TrustedCertPublicKeyLength
• TrustedCertSerialNumber
• TrustedCertSignatureAlgorithm
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject
• TrustedCertSubjectAltNames
• TrustedCertThumbprintMD5
• TrustedCertThumbprintSHA1
• TrustedCertThumbprintSHA256
• TrustedCertUsage
• TrustedCertUsageFlags
• TrustedCertVersion

The array indices start at 0 and end at TrustedCertCount - 1.

This property is not available at design time.

Data Type

Integer

TrustedCertEffectiveDate Property (IPWorksLLM_C2PAVerifier Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getTrustedCertEffectiveDate($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 18, $trustedcertindex);

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertExpirationDate Property (IPWorksLLM_C2PAVerifier Class)

The date on which the certificate expires.

Object Oriented Interface

public function getTrustedCertExpirationDate($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 19, $trustedcertindex);

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertExtendedKeyUsage Property (IPWorksLLM_C2PAVerifier Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getTrustedCertExtendedKeyUsage($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 20, $trustedcertindex);

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertFingerprint Property (IPWorksLLM_C2PAVerifier Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getTrustedCertFingerprint($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 21, $trustedcertindex);

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertFingerprintSHA1 Property (IPWorksLLM_C2PAVerifier Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getTrustedCertFingerprintSHA1($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 22, $trustedcertindex);

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertFingerprintSHA256 Property (IPWorksLLM_C2PAVerifier Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getTrustedCertFingerprintSHA256($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 23, $trustedcertindex);

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertIssuer Property (IPWorksLLM_C2PAVerifier Class)

The issuer of the certificate.

Object Oriented Interface

public function getTrustedCertIssuer($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 24, $trustedcertindex);

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertPrivateKey Property (IPWorksLLM_C2PAVerifier Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getTrustedCertPrivateKey($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 25, $trustedcertindex);

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The TrustedCertPrivateKey may be available but not exportable. In this case, TrustedCertPrivateKey returns an empty string.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertPrivateKeyAvailable Property (IPWorksLLM_C2PAVerifier Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getTrustedCertPrivateKeyAvailable($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 26, $trustedcertindex);

Default Value

false

Remarks

Whether a TrustedCertPrivateKey is available for the selected certificate. If TrustedCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

Boolean

TrustedCertPrivateKeyContainer Property (IPWorksLLM_C2PAVerifier Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getTrustedCertPrivateKeyContainer($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 27, $trustedcertindex);

Default Value

''

Remarks

The name of the TrustedCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertPublicKey Property (IPWorksLLM_C2PAVerifier Class)

The public key of the certificate.

Object Oriented Interface

public function getTrustedCertPublicKey($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 28, $trustedcertindex);

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertPublicKeyAlgorithm Property (IPWorksLLM_C2PAVerifier Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getTrustedCertPublicKeyAlgorithm($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 29, $trustedcertindex);

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertPublicKeyLength Property (IPWorksLLM_C2PAVerifier Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getTrustedCertPublicKeyLength($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 30, $trustedcertindex);

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

TrustedCertSerialNumber Property (IPWorksLLM_C2PAVerifier Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getTrustedCertSerialNumber($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 31, $trustedcertindex);

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertSignatureAlgorithm Property (IPWorksLLM_C2PAVerifier Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getTrustedCertSignatureAlgorithm($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 32, $trustedcertindex);

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertStore Property (IPWorksLLM_C2PAVerifier Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getTrustedCertStore($trustedcertindex);
public function setTrustedCertStore($trustedcertindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 33, $trustedcertindex);
ipworksllm_c2paverifier_set($res, 33, $value, $trustedcertindex);

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password-protected, specify the password in TrustedCertStorePassword.

TrustedCertStore is used in conjunction with the TrustedCertSubject property to specify client certificates. If TrustedCertStore has a value, and TrustedCertSubject or TrustedCertEncoded is set, a search for a certificate is initiated. Please see the TrustedCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

TrustedCertStorePassword Property (IPWorksLLM_C2PAVerifier Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getTrustedCertStorePassword($trustedcertindex);
public function setTrustedCertStorePassword($trustedcertindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 34, $trustedcertindex);
ipworksllm_c2paverifier_set($res, 34, $value, $trustedcertindex);

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertStoreType Property (IPWorksLLM_C2PAVerifier Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getTrustedCertStoreType($trustedcertindex);
public function setTrustedCertStoreType($trustedcertindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 35, $trustedcertindex);
ipworksllm_c2paverifier_set($res, 35, $value, $trustedcertindex);

Possible Values

C2PAVERIFIER_TRUSTEDCERTSTORETYPE_USER(0), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_MACHINE(1), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PFXFILE(2), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PFXBLOB(3), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_JKSFILE(4), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_JKSBLOB(5), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PEMKEY_FILE(6), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PEMKEY_BLOB(7), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_P7BFILE(11), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_P7BBLOB(12), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PPKFILE(14), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PPKBLOB(15), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_XMLFILE(16), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_XMLBLOB(17), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_JWKFILE(18), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_JWKBLOB(19), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_SECURITY_KEY(20), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_BCFKSFILE(21), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_BCFKSBLOB(22), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_PKCS11(23), 
C2PAVERIFIER_TRUSTEDCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Integer

TrustedCertSubjectAltNames Property (IPWorksLLM_C2PAVerifier Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getTrustedCertSubjectAltNames($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 36, $trustedcertindex);

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertThumbprintMD5 Property (IPWorksLLM_C2PAVerifier Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getTrustedCertThumbprintMD5($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 37, $trustedcertindex);

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertThumbprintSHA1 Property (IPWorksLLM_C2PAVerifier Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getTrustedCertThumbprintSHA1($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 38, $trustedcertindex);

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertThumbprintSHA256 Property (IPWorksLLM_C2PAVerifier Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getTrustedCertThumbprintSHA256($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 39, $trustedcertindex);

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertUsage Property (IPWorksLLM_C2PAVerifier Class)

The text description of UsageFlags .

Object Oriented Interface

public function getTrustedCertUsage($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 40, $trustedcertindex);

Default Value

''

Remarks

The text description of TrustedCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertUsageFlags Property (IPWorksLLM_C2PAVerifier Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getTrustedCertUsageFlags($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 41, $trustedcertindex);

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of TrustedCertUsageFlags is a combination of the following flags:

Please see the TrustedCertUsage property for a text representation of TrustedCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

TrustedCertVersion Property (IPWorksLLM_C2PAVerifier Class)

The certificate's version number.

Object Oriented Interface

public function getTrustedCertVersion($trustedcertindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 42, $trustedcertindex);

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

String

TrustedCertSubject Property (IPWorksLLM_C2PAVerifier Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getTrustedCertSubject($trustedcertindex);
public function setTrustedCertSubject($trustedcertindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 43, $trustedcertindex);
ipworksllm_c2paverifier_set($res, 43, $value, $trustedcertindex);

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertEncoded Property (IPWorksLLM_C2PAVerifier Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getTrustedCertEncoded($trustedcertindex);
public function setTrustedCertEncoded($trustedcertindex, $value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 44, $trustedcertindex);
ipworksllm_c2paverifier_set($res, 44, $value, $trustedcertindex);

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The TrustedCertStore and TrustedCertSubject properties also may be used to specify a certificate.

When TrustedCertEncoded is set, a search is initiated in the current TrustedCertStore for the private key of the certificate. If the key is found, TrustedCertSubject is updated to reflect the full subject of the selected certificate; otherwise, TrustedCertSubject is set to an empty string.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

UseC2PATrustList Property (IPWorksLLM_C2PAVerifier Class)

Whether the built-in C2PA trust list is used.

Object Oriented Interface

public function getUseC2PATrustList();
public function setUseC2PATrustList($value);

Procedural Interface

ipworksllm_c2paverifier_get($res, 45);
ipworksllm_c2paverifier_set($res, 45, $value);

Default Value

true

Remarks

This property controls whether signing certificates are validated against the C2PA trust list built into the class, in addition to any anchors in TrustedCerts.

The default value is True, which is the configuration the C2PA specification describes for a validator: the trust anchors for the claim signing extended key usage include the C2PA trust list, and a user may configure further anchors on top of it.

Set this property to False to validate against TrustedCerts alone, which is appropriate for a private PKI where the public list has no bearing.

The built-in list is a snapshot taken when the class was built. Query the TrustListVersion and TrustListDate configuration settings to determine how current that snapshot is; supply newer anchors through TrustedCerts when it has aged.

This property is not available at design time.

Data Type

Boolean

ValidationResultCount Property (IPWorksLLM_C2PAVerifier Class)

The number of records in the ValidationResult arrays.

Object Oriented Interface

public function getValidationResultCount();

Procedural Interface

ipworksllm_c2paverifier_get($res, 46);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ValidationResultCode
• ValidationResultExplanation
• ValidationResultManifestLabel
• ValidationResultSeverity

The array indices start at 0 and end at ValidationResultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ValidationResultCode Property (IPWorksLLM_C2PAVerifier Class)

The C2PA status code.

Object Oriented Interface

public function getValidationResultCode($validationresultindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 47, $validationresultindex);

Default Value

''

Remarks

The C2PA status code.

This field holds the status code defined by the C2PA specification, reported verbatim so it can be matched against the specification or passed to another conforming implementation.

Frequently encountered values are:

The $validationresultindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationResultCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationResultExplanation Property (IPWorksLLM_C2PAVerifier Class)

A human-readable description of the result.

Object Oriented Interface

public function getValidationResultExplanation($validationresultindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 48, $validationresultindex);

Default Value

''

Remarks

A human-readable description of the result.

This field describes what was checked and what was found, in text suitable for showing to a person or writing to a log.

Application logic should branch on ValidationResultCode rather than on this text, which is not part of the C2PA specification and may be reworded.

The $validationresultindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationResultCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationResultManifestLabel Property (IPWorksLLM_C2PAVerifier Class)

The manifest the result applies to.

Object Oriented Interface

public function getValidationResultManifestLabel($validationresultindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 49, $validationresultindex);

Default Value

''

Remarks

The manifest the result applies to.

This field holds the urn:c2pa label of the manifest that was being checked, so results can be attributed correctly when an asset carries a chain of them.

The $validationresultindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationResultCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationResultSeverity Property (IPWorksLLM_C2PAVerifier Class)

How serious the result is.

Object Oriented Interface

public function getValidationResultSeverity($validationresultindex);

Procedural Interface

ipworksllm_c2paverifier_get($res, 50, $validationresultindex);

Default Value

0

Remarks

How serious the result is.

This field classifies the result:

An asset should be treated as validated only when no result carries a severity of 2 and the successes cover the checks the application requires.

The $validationresultindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

Config Method (IPWorksLLM_C2PAVerifier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksllm_c2paverifier_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Reset Method (IPWorksLLM_C2PAVerifier Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksllm_c2paverifier_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

Verify Method (IPWorksLLM_C2PAVerifier Class)

Extracts and validates the C2PA Manifests in the asset.

Object Oriented Interface

public function doVerify();

Procedural Interface

ipworksllm_c2paverifier_do_verify($res);

Remarks

This method reads the asset named by InputFile (or held in InputData), locates the C2PA Manifest Store, and validates it. Manifests and ValidationResults are populated when it returns.

For the active manifest, the class verifies the claim signature, builds a certificate path from the signing certificate to the active trust anchors, and recomputes the content binding hash over the asset to confirm the bytes still match what was signed.

C2PAVerifier verifier = new C2PAVerifier(); verifier.InputFile = "photo-signed.jpg"; verifier.Verify(); foreach (C2PAValidationResult result in verifier.ValidationResults) Console.WriteLine(result.Severity + " " + result.Code + ": " + result.Explanation);

A failed check does not throw. It is reported through ValidationResults and the ValidationStatus event, so that a partially trustworthy asset can be described accurately rather than merely rejected. An error is thrown only when the asset cannot be read at all, or carries no C2PA Manifest.

Error Event (IPWorksLLM_C2PAVerifier Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksllm_c2paverifier_register_callback($res, 1, array($this, 'fireError'));

Parameter List

'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksLLM_C2PAVerifier Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksllm_c2paverifier_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

'loglevel'
'message'
'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

Message is the log entry.

LogType identifies the type of log entry. Possible values are Info, Manifest, Signature, and Validation.

ManifestFound Event (IPWorksLLM_C2PAVerifier Class)

Fires once for each C2PA Manifest found in the asset.

Object Oriented Interface

public function fireManifestFound($param);

Procedural Interface

ipworksllm_c2paverifier_register_callback($res, 3, array($this, 'fireManifestFound'));

Parameter List

'manifestlabel'
'claimgenerator'
'signersubject'
'isactive'

Remarks

This event fires as each manifest is located, before validation of that manifest completes.

ManifestLabel is the manifest's identifier, a urn:c2pa value. ClaimGenerator names the tool that produced it. SignerSubject is the subject of the certificate that signed the claim. IsActive is True for the active manifest, which is the last one in the store.

The same information is available afterwards through the Manifests properties; this event is for applications that would rather report provenance as it is discovered.

ValidationStatus Event (IPWorksLLM_C2PAVerifier Class)

Fires once for each validation status code produced.

Object Oriented Interface

public function fireValidationStatus($param);

Procedural Interface

ipworksllm_c2paverifier_register_callback($res, 4, array($this, 'fireValidationStatus'));

Parameter List

'code'
'explanation'
'severity'
'manifestlabel'

Remarks

This event fires as each check completes, giving the same information that is appended to ValidationResults.

Code is the status code defined by the C2PA specification, reported verbatim. Common values are claimSignature.validated and assertion.dataHash.match on success, assertion.dataHash.mismatch when the asset was altered after signing, and signingCredential.untrusted when the signature is intact but the signer chains to no configured trust anchor.

Explanation is a human-readable description of the check.

Severity is 0 (success), 1 (informational), or 2 (failure).

ManifestLabel identifies which manifest the result applies to.

Config Settings (C2PAVerifier Class)

The class accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

C2PAVerifier Config Settings

Base Config Settings

Trappable Errors (C2PAVerifier Class)

C2PAVerifier Errors