Cmdlet

Get-OfficeDocumentProvenance

Module: PSWriteOffice
Inputs: System.String[]
Outputs: OfficeIMO.Provenance.OfficeProvenanceAssessmentReport
Source: GetOfficeDocumentProvenanceCommand.cs:28 Edit on GitHub

Collects structural, text-integrity, and optional provider verification evidence for a file.

Syntax

Get-OfficeDocumentProvenance
[-C2paToolPath <String>]
[-Options <Object[]>]
[-Path] <String[]>
[-SignalDetector <IOfficeProvenanceSignalDetector[]>]
[<CommonParameters>]

Parameter set: Path

Get-OfficeDocumentProvenance
[-C2paToolPath <String>]
-LiteralPath <String[]>
[-Options <Object[]>]
[-SignalDetector <IOfficeProvenanceSignalDetector[]>]
[<CommonParameters>]

Parameter set: LiteralPath

Description

The result keeps carrier discovery, cryptographic verification, and provider signals separate; it does not infer authorship from their presence or absence.

Examples

Inspect embedded provenance without invoking an external verifier.

$evidence = Get-OfficeDocumentProvenance -Path .\Published\cover.png
$evidence.Structural | Select-Object Format, HasC2paManifest
$evidence.TextIntegrity

Ask an explicitly supplied c2patool installation to verify Content Credentials.

$evidence = Get-OfficeDocumentProvenance -Path .\Published\cover.png -C2paToolPath C:\Tools\c2patool.exe
$evidence.Verification | Select-Object Status, ProviderName, Findings

Network access remains disabled unless enabled in the supplied assessment options.

Parameters

-C2paToolPath String optional: Explicit c2patool executable path or controlled command name used for cryptographic verification.
-Options Object[] optional: Typed assessment policies or hashtables with Structural, TextIntegrity and Verification groups. The last policy takes precedence.
-Path String[] requiredposition: 0pipeline: True (ByValue)sets: Path: Asset or document paths, including provider wildcards.
-SignalDetector IOfficeProvenanceSignalDetector[] optional: Optional provider-specific watermark or disclosure detectors.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Literal paths, including FileInfo.FullName and provider PSPath pipeline properties.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.