Class OdfSigner

Namespace

OdfKit.Core

Assembly

OdfKit.dll

Provides digital signing and signature validation for ODF packages. 提供 ODF 封裝的數位簽署與簽章驗證功能。

public static class OdfSigner

Inheritance

object

OdfSigner

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Sign(OdfPackage, X509Certificate2)

Performs the Sign operation. 對 ODF 封裝中的關鍵檔案進行數位簽署，支援同僚聯署。

public static void Sign(OdfPackage package, X509Certificate2 certificate)

Parameters

package OdfPackage

要簽署的 ODF 封裝

certificate X509Certificate2

用於簽署的 X.509 憑證

Sign(OdfPackage, X509Certificate2, OdfSigningOptions)

Performs the Sign operation. 對 ODF 封裝中的關鍵檔案進行數位簽署，支援自訂選項。

public static void Sign(OdfPackage package, X509Certificate2 certificate, OdfSigningOptions options)

Parameters

package OdfPackage

要簽署的 ODF 封裝

certificate X509Certificate2

用於簽署的 X.509 憑證

options OdfSigningOptions

簽署選項

Remarks

在 ASP.NET Core 等伺服器環境中，請優先使用 SignAsync(OdfPackage, X509Certificate2, OdfSigningOptions, CancellationToken) 以避免阻塞執行緒

SignAsync(OdfPackage, X509Certificate2)

Asynchronously signs the ODF package with the default XMLDSig options. 以預設 XMLDSig 選項非同步簽署 ODF 封裝。

public static Task SignAsync(OdfPackage package, X509Certificate2 certificate)

Parameters

package OdfPackage

certificate X509Certificate2

Returns

Task

A task representing the asynchronous signing operation. / 代表非同步簽署作業的工作。

SignAsync(OdfPackage, X509Certificate2, OdfSigningOptions)

Asynchronously signs the ODF package with the specified signing options. 使用指定簽署選項非同步簽署 ODF 封裝。

public static Task SignAsync(OdfPackage package, X509Certificate2 certificate, OdfSigningOptions options)

Parameters

package OdfPackage

certificate X509Certificate2

options OdfSigningOptions

Returns

Task

A task representing the asynchronous signing operation. / 代表非同步簽署作業的工作。

Remarks

若 已請求取消，作業會立即以 OperationCanceledException 結束； 否則會在 ZIP 寫入與 HTTP（TSA／CRL）期間協作檢查取消語彙。

SignAsync(OdfPackage, X509Certificate2, OdfSigningOptions, CancellationToken)

Full overload of SignAsync that accepts package, certificate, options, and cancellationToken. SignAsync 完整多載：接受 package、certificate、options 與 cancellationToken。

public static Task SignAsync(OdfPackage package, X509Certificate2 certificate, OdfSigningOptions options, CancellationToken cancellationToken)

Parameters

package OdfPackage

certificate X509Certificate2

options OdfSigningOptions

cancellationToken CancellationToken

Returns

Task

SignAsync(OdfPackage, X509Certificate2, CancellationToken)

Full overload of SignAsync that accepts package, certificate, and cancellationToken. SignAsync 完整多載：接受 package、certificate 與 cancellationToken。

public static Task SignAsync(OdfPackage package, X509Certificate2 certificate, CancellationToken cancellationToken)

Parameters

package OdfPackage

certificate X509Certificate2

cancellationToken CancellationToken

Returns

Task

VerifySignatures(OdfPackage)

Verifies signatures. 驗證 ODF 封裝中的所有數位簽章，並傳回詳細的驗證結果。

public static OdfSignatureValidationResult VerifySignatures(OdfPackage package)

Parameters

package OdfPackage

Returns

OdfSignatureValidationResult

詳細的數位簽章驗證結果

Remarks

Prefer VerifySignaturesAsync(OdfPackage, OdfSigningOptions?, CancellationToken) in server environments to avoid blocking request threads. 在 ASP.NET Core 等伺服器環境中，請優先使用 VerifySignaturesAsync(OdfPackage, OdfSigningOptions?, CancellationToken) 以避免阻塞要求執行緒。

VerifySignatures(OdfPackage, OdfSigningOptions?)

Full overload of VerifySignatures that accepts package and options. VerifySignatures 完整多載：接受 package 與 options。

public static OdfSignatureValidationResult VerifySignatures(OdfPackage package, OdfSigningOptions? options)

Parameters

package OdfPackage

options OdfSigningOptions

Returns

OdfSignatureValidationResult

VerifySignatures(OdfPackage, out X509Certificate2Collection)

Verifies signatures. 驗證 ODF 封裝中的所有數位簽章。

public static bool VerifySignatures(OdfPackage package, out X509Certificate2Collection certificates)

Parameters

package OdfPackage

要驗證的 ODF 封裝

certificates X509Certificate2Collection

輸出參數，包含所有已驗證的憑證集合

Returns

bool

若所有簽章皆有效，則為 true；否則為 false

VerifySignaturesAsync(OdfPackage)

Verifies signatures async. 驗證 ODF 封裝中的所有數位簽章，並傳回詳細的驗證結果（非同步）。

public static Task<OdfSignatureValidationResult> VerifySignaturesAsync(OdfPackage package)

Parameters

package OdfPackage

Returns

Task<OdfSignatureValidationResult>

代表非同步驗證作業的工作，其結果包含詳細的數位簽章驗證結果

Remarks

若 已請求取消，作業會立即以 OperationCanceledException 結束； 否則會在簽章解析與 HTTP（CRL）期間協作檢查取消語彙。

VerifySignaturesAsync(OdfPackage, OdfSigningOptions?)

Short overload of VerifySignaturesAsync that accepts package and options; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 package 與 options；其餘可選參數使用預設值並轉呼叫最長 VerifySignaturesAsync 多載。

public static Task<OdfSignatureValidationResult> VerifySignaturesAsync(OdfPackage package, OdfSigningOptions? options)

Parameters

package OdfPackage

options OdfSigningOptions

Returns

Task<OdfSignatureValidationResult>

VerifySignaturesAsync(OdfPackage, OdfSigningOptions?, CancellationToken)

Short overload of VerifySignaturesAsync that accepts package, options, and cancellationToken; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 package、options 與 cancellationToken；其餘可選參數使用預設值並轉呼叫最長 VerifySignaturesAsync 多載。

public static Task<OdfSignatureValidationResult> VerifySignaturesAsync(OdfPackage package, OdfSigningOptions? options, CancellationToken cancellationToken)

Parameters

package OdfPackage

options OdfSigningOptions

cancellationToken CancellationToken

Returns

Task<OdfSignatureValidationResult>

VerifySignaturesAsync(OdfPackage, CancellationToken)

Asynchronously verifies all digital signatures in the ODF package with a cancellation token. 以取消語彙基元非同步驗證 ODF 封裝中的所有數位簽章。

public static Task<OdfSignatureValidationResult> VerifySignaturesAsync(OdfPackage package, CancellationToken cancellationToken)

Parameters

package OdfPackage

The ODF package to verify. / 要驗證的 ODF 封裝。

cancellationToken CancellationToken

The cancellation token. / 取消語彙基元。

Returns

Task<OdfSignatureValidationResult>

A task whose result is the detailed signature validation result. / 代表非同步驗證作業的工作，其結果包含詳細的數位簽章驗證結果。