Class Provenance

Represents provenance information in an XID document.

Implements

EnvelopeEncodable

Index

Methods

new newWithGenerator mark generator hasGenerator hasEncryptedGenerator generatorSalt setMark setGenerator takeGenerator generatorMut intoEnvelopeOpt intoEnvelope tryFromEnvelope equals clone

Methods

`Static`new

new(mark: ProvenanceMark): Provenance
Create a new Provenance with just a mark.
Parameters
- mark: ProvenanceMark
Returns Provenance
- Defined in xid/src/provenance.ts:73

`Static`newWithGenerator

newWithGenerator(
generator: ProvenanceMarkGenerator,
mark: ProvenanceMark,
): Provenance
Create a new Provenance with a generator and mark.
Parameters
- generator: ProvenanceMarkGenerator
- mark: ProvenanceMark
Returns Provenance
- Defined in xid/src/provenance.ts:80

mark

mark(): ProvenanceMark
Get the provenance mark.

Returns ProvenanceMark
- Defined in xid/src/provenance.ts:88

generator

generator(): ProvenanceMarkGenerator | undefined
Get the generator, if available and decrypted.

Returns ProvenanceMarkGenerator | undefined
- Defined in xid/src/provenance.ts:95

hasGenerator

hasGenerator(): boolean
Check if this provenance has a decrypted generator.

Returns boolean
- Defined in xid/src/provenance.ts:106

hasEncryptedGenerator

hasEncryptedGenerator(): boolean
Check if this provenance has an encrypted generator.

Returns boolean
- Defined in xid/src/provenance.ts:113

generatorSalt

generatorSalt(): Salt | undefined
Get the salt used for generator decorrelation.

Returns Salt | undefined
- Defined in xid/src/provenance.ts:120

setMark

setMark(mark: ProvenanceMark): void
Update the provenance mark.
Parameters
- mark: ProvenanceMark
Returns void
- Defined in xid/src/provenance.ts:127

setGenerator

setGenerator(generator: ProvenanceMarkGenerator): void
Set or replace the generator.
Parameters
- generator: ProvenanceMarkGenerator
Returns void
- Defined in xid/src/provenance.ts:134

takeGenerator

takeGenerator(): { data: GeneratorData; salt: Salt } | undefined
Take and remove the generator.

Returns { data: GeneratorData; salt: Salt } | undefined
- Defined in xid/src/provenance.ts:142

generatorMut

generatorMut(
password?: Uint8Array<ArrayBufferLike>,
): ProvenanceMarkGenerator | undefined
Get a mutable reference to the generator, decrypting if necessary.
Parameters
- Optionalpassword: Uint8Array<ArrayBufferLike>
Returns ProvenanceMarkGenerator | undefined
- Defined in xid/src/provenance.ts:151

intoEnvelopeOpt

intoEnvelopeOpt(generatorOptions?: XIDGeneratorOptionsValue): Envelope$1
Convert to envelope with specified options.
Parameters
- generatorOptions: XIDGeneratorOptionsValue = XIDGeneratorOptions.Omit
Returns Envelope$1
- Defined in xid/src/provenance.ts:193

intoEnvelope

intoEnvelope(): Envelope$1
Returns Envelope$1
Implementation of EnvelopeEncodable.intoEnvelope
- Defined in xid/src/provenance.ts:254

`Static`tryFromEnvelope

tryFromEnvelope(
envelope: Envelope$1,
password?: Uint8Array<ArrayBufferLike>,
): Provenance
Try to extract a Provenance from an envelope, optionally with password for decryption.
Parameters
- envelope: Envelope$1
- Optionalpassword: Uint8Array<ArrayBufferLike>
Returns Provenance
- Defined in xid/src/provenance.ts:261

equals

equals(other: Provenance): boolean
Check equality with another Provenance.
Parameters
- other: Provenance
Returns boolean
- Defined in xid/src/provenance.ts:358

clone

clone(): Provenance
Clone this Provenance. Note: ProvenanceMark is immutable so we can use the same instance.

Returns Provenance
- Defined in xid/src/provenance.ts:366