c2pa-android/org.contentauth.c2pa

Package-level declarations

Types

data class Action(val action: String, val digitalSourceType: String? = null, val softwareAgent: <Error class: unknown class>? = null, val parameters: Map<String, <Error class: unknown class>>? = null)

Represents a C2PA action that describes an operation performed on content.

Builder

class Builder(ptr: Long) : Closeable

C2PA Builder for creating and signing manifest stores.

BuilderIntent

sealed class BuilderIntent

Specifies what kind of manifest to create when building a C2PA claim.

ByteArrayStream

class ByteArrayStream(initialData: ByteArray? = null) : Stream

Read-write stream with growable byte array. Use this for in-memory operations that need to write output.

C2PA

object C2PA

Main C2PA object for static operations

C2PAContext

class C2PAContext(var ptr: Long) : Closeable

C2PA Context for creating readers and builders with shared configuration.

C2PAError

sealed class C2PAError : Exception

Sealed error hierarchy for C2PA operations.

C2PAJson

object C2PAJson

Centralized JSON configuration for C2PA manifests and settings.

C2PASettings

class C2PASettings(var ptr: Long) : Closeable

C2PA Settings for configuring context-based operations.

CallbackStream

class CallbackStream(reader: StreamReader? = null, seeker: StreamSeeker? = null, writer: StreamWriter? = null, flusher: StreamFlusher? = null) : Stream

Stream implementation with callbacks.

CertificateManager

object CertificateManager

Certificate management for C2PA signing on Android

DataStream

class DataStream(data: ByteArray) : Stream

Stream implementation backed by Data

DigitalSourceType

enum DigitalSourceType : Enum<DigitalSourceType>

Defines the digital source type for content created by the builder.

FileStream

class FileStream(fileURL: File, mode: FileStream.Mode = Mode.READ_WRITE, createIfNeeded: Boolean = true) : Stream

File-based stream implementation

KeyStoreSigner

object KeyStoreSigner

KeyStoreSigner provides signing capabilities using keys stored in the Android KeyStore, with hardware-backed key storage, biometric authentication, and hardware security features.

PredefinedAction

enum PredefinedAction : Enum<PredefinedAction>

Predefined C2PA action types as specified in the C2PA specification.

Reader

class Reader(ptr: Long) : Closeable

C2PA Reader for reading and validating manifest stores from media files.

SeekMode

enum SeekMode : Enum<SeekMode>

Seek modes for stream operations

SignCallback

interface SignCallback

Callback interface for custom signing operations

Signer

class Signer(var ptr: Long) : Closeable

C2PA Signer for signing manifests

SignerException

sealed class SignerException(message: String, cause: Throwable? = null) : Exception

Exceptions specific to signer operations

SignerInfo

data class SignerInfo(val algorithm: SigningAlgorithm, val certificatePEM: String, val privateKeyPEM: String, val tsaURL: String? = null)

Configuration for creating a Signer from PEM-encoded credentials.

SigningAlgorithm

enum SigningAlgorithm : Enum<SigningAlgorithm>

Supported signing algorithms for C2PA manifests.

Stream

abstract class Stream : Closeable

Abstract base class for C2PA streams

StreamFlusher

typealias StreamFlusher = () -> Int

StreamReader

typealias StreamReader = (buffer: ByteArray, count: Int) -> Int

StreamSeeker

typealias StreamSeeker = (offset: Long, origin: SeekMode) -> Long

StreamWriter

typealias StreamWriter = (buffer: ByteArray, count: Int) -> Int

StrongBoxSigner

object StrongBoxSigner

StrongBoxSigner provides signing capabilities using Android's StrongBox Keymaster, which provides hardware-isolated key storage and cryptographic operations.

WebServiceSigner

class WebServiceSigner(configurationURL: String, bearerToken: String? = null, customHeaders: Map<String, String> = emptyMap())

WebServiceSigner provides remote signing capabilities through a C2PA signing server.

Properties

c2paVersion

val c2paVersion: String

The version string of the native C2PA library, lazily fetched once on first access.

Functions

derToRawSignature

fun derToRawSignature(derSignature: ByteArray, componentLength: Int): ByteArray

Converts a DER-encoded ECDSA signature to raw format (r || s) required by COSE.

executeC2PAOperation

internal inline fun <T : Any> executeC2PAOperation(errorMessage: String, operation: () -> T?): T

Execute a C2PA operation with standard error handling

loadC2PALibraries

internal fun loadC2PALibraries()

Load native C2PA libraries. Safe to call multiple times - System.loadLibrary handles duplicates.