# IOfficeSecurityProvider

Strongly typed cryptographic provider used by OfficeIMO document packages when security features are explicitly enabled.

Interface 

`OfficeIMO.Security`

**Namespace**

`OfficeIMO.Security`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[IOfficeSecurityProvider.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Security/IOfficeSecurityProvider.cs#L9)

**Modifiers**

abstract

Strongly typed cryptographic provider used by OfficeIMO document packages when security features are explicitly enabled. The contract is dependency-free; implementations such as OfficeIMO.Security may use additional cryptographic packages.

Filter members 

Show inherited

## Methods

`public abstract byte[] CanonicalizeXml(byte[] xml, string algorithm, string? inclusiveNamespacesPrefixList = null, long maxOutputBytes = 16777216)` [#](#method-canonicalizexml-byte-string-string-int64)

Canonicalizes a bounded XML document using an explicitly supported XML DSig algorithm.

Parameters

**xml byte[] required**

**algorithm string required**

**inclusiveNamespacesPrefixList string? = null optional**

**maxOutputBytes long = 16777216 optional**

Returns

`byte[]`

`public abstract ICmsVerificationSession CreateCmsVerificationSession(CmsVerificationOptions options)` [#](#method-createcmsverificationsession-officeimo-security-cmsverificationoptions)

Creates a bounded CMS verification session whose aggregate timestamp limits are shared across every verification performed by that session.

Parameters

**options OfficeIMO.Security.CmsVerificationOptions required**

Returns

`ICmsVerificationSession`

`public abstract byte[] CreateXmlSignature(XmlDigitalSignatureCreationRequest request)` [#](#method-createxmlsignature-officeimo-security-xmldigitalsignaturecreationrequest)

Creates one bounded enveloping XML signature.

Parameters

**request OfficeIMO.Security.XmlDigitalSignatureCreationRequest required**

Returns

`byte[]`

`public abstract CmsDecryptionResult DecryptCms(byte[] encodedCms, X509Certificate2 recipientCertificate, CmsEnvelopeOptions? options = null)` [#](#method-decryptcms-byte-security-cryptography-x509certificates-x509certificate2-officeimo-security-cmsenvelopeoptions)

Decrypts CMS EnvelopedData for a matching recipient certificate.

Parameters

**encodedCms byte[] required**

**recipientCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsEnvelopeOptions? = null optional**

Returns

`CmsDecryptionResult`

`public abstract byte[] EncryptCms(byte[] content, IEnumerable<X509Certificate2> recipients, CmsEnvelopeOptions? options = null)` [#](#method-encryptcms-byte-collections-generic-ienumerable-system-security-cryptography-x509certificates-x509certificate2-officeimo-security-cmsenvelopeoptions)

Creates CMS EnvelopedData for the supplied recipients.

Parameters

**content byte[] required**

**recipients System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2> required**

**options OfficeIMO.Security.CmsEnvelopeOptions? = null optional**

Returns

`byte[]`

`public abstract byte[] NormalizeAsn1Object(byte[] encoded, bool allowTrailingZeroPadding, long maxEncodedBytes)` [#](#method-normalizeasn1object-byte-boolean-int64)

Normalizes one bounded DER/BER object, optionally trimming PDF-style trailing zero padding.

Parameters

**encoded byte[] required**

**allowTrailingZeroPadding bool required**

**maxEncodedBytes long required**

Returns

`byte[]`

`public abstract byte[] SignCmsDetached(byte[] content, X509Certificate2 signingCertificate, CmsSigningOptions? options = null, IEnumerable<X509Certificate2>? certificateChain = null)` [#](#member-615d3c1bbc18fb63d44c5c67)

Creates detached CMS SignedData over the exact supplied content.

Parameters

**content byte[] required**

**signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsSigningOptions? = null optional**

**certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

Returns

`byte[]`

`public abstract byte[] SignCmsEncapsulated(byte[] content, X509Certificate2 signingCertificate, CmsSigningOptions? options = null, IEnumerable<X509Certificate2>? certificateChain = null)` [#](#member-9c54cbd9faf3eed08a0716aa)

Creates encapsulated CMS SignedData containing the supplied content.

Parameters

**content byte[] required**

**signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**options OfficeIMO.Security.CmsSigningOptions? = null optional**

**certificateChain System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

Returns

`byte[]`

`public abstract CertificateTrustValidationResult ValidateCertificate(X509Certificate2 certificate, IEnumerable<X509Certificate2>? additionalCertificates = null, CertificateValidationOptions? options = null, CertificateValidationPurpose purpose = DocumentSigning)` [#](#member-b576393eb00cef9774e25685)

Validates certificate trust, revocation, and intended usage under caller policy.

Parameters

**certificate System.Security.Cryptography.X509Certificates.X509Certificate2 required**

**additionalCertificates System.Collections.Generic.IEnumerable<System.Security.Cryptography.X509Certificates.X509Certificate2>? = null optional**

**options OfficeIMO.Security.CertificateValidationOptions? = null optional**

**purpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CertificateTrustValidationResult`

`public abstract CmsVerificationResult VerifyCms(byte[] encodedCms, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning)` [#](#method-verifycms-byte-officeimo-security-cmsverificationoptions-officeimo-security-certificatevalidationpurpose)

Verifies encapsulated CMS SignedData.

Parameters

**encodedCms byte[] required**

**options OfficeIMO.Security.CmsVerificationOptions? = null optional**

**signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CmsVerificationResult`

`public abstract CmsVerificationResult VerifyCmsDetached(byte[] encodedCms, byte[] detachedContent, CmsVerificationOptions? options = null, CertificateValidationPurpose signerCertificatePurpose = DocumentSigning)` [#](#method-verifycmsdetached-byte-byte-officeimo-security-cmsverificationoptions-officeimo-security-certificatevalidationpurpose)

Verifies detached CMS SignedData against the exact supplied content.

Parameters

**encodedCms byte[] required**

**detachedContent byte[] required**

**options OfficeIMO.Security.CmsVerificationOptions? = null optional**

**signerCertificatePurpose OfficeIMO.Security.CertificateValidationPurpose = DocumentSigning optional**

Returns

`CmsVerificationResult`

`public abstract Rfc3161TimestampVerificationResult VerifyTimestamp(byte[] encodedToken, byte[] timestampedData, CertificateValidationOptions? certificateOptions = null, long maxEncodedBytes = 16777216, int maxCertificates = 64)` [#](#method-verifytimestamp-byte-byte-officeimo-security-certificatevalidationoptions-int64-int32)

Verifies an RFC 3161 timestamp token against the exact timestamped bytes.

Parameters

**encodedToken byte[] required**

**timestampedData byte[] required**

**certificateOptions OfficeIMO.Security.CertificateValidationOptions? = null optional**

**maxEncodedBytes long = 16777216 optional**

**maxCertificates int = 64 optional**

Returns

`Rfc3161TimestampVerificationResult`

`public abstract XmlDigitalSignatureVerificationResult VerifyXmlSignature(XmlDigitalSignatureVerificationRequest request)` [#](#method-verifyxmlsignature-officeimo-security-xmldigitalsignatureverificationrequest)

Verifies XML signature math and bounded local-reference processing independently of trust.

Parameters

**request OfficeIMO.Security.XmlDigitalSignatureVerificationRequest required**

Returns

`XmlDigitalSignatureVerificationResult`

## Properties

`public abstract string Name { get; }` [#](#property-name)

Gets a stable provider name for diagnostics.

<!-- PowerForge markdown artifact sha256:AD0DA76F7EEF3AD4775D3E9B0F86356F2157FDB40F50EB82F17AC32BC1EC3FE4 -->
